idefix sistemine ilettiğiniz ürünler için müşteriler tarafından sipariş edilen ve ödeme kontrolünden geçmiş olan her shipmentin bilgisini bu method ile alabilirsiniz. Satıcı bazında oluşturulan siparişler dokümanlarda shipment olarak adlandırılacaktır.
shipment datası alınırken gelen orderNumber değeri ilgili shipmentin idefix sistemindeki ana sipariş numarasına karşılık gelir. Aynı seviyede yer alan id değeri ise o sipariş numarasına karşılık oluşturulmuş sevkiyati temsil eder.
vendor her satıcının unique bir tanımlayıcısıdır. Zorunlu bir alandır.
Kurumsal fatura için "isCommercial" değeri kontrol edilmelidir. Kurumsal fatura kesilmesi gereken durumda bu değer "1" olarak dönecek, bireysel fatura olması durumunda "' '" olarak dönecektir. (isCommercial=1) "company" , "taxNumber" ve "taxOffice" bilgilerini invoiceAddress alanından alabilirsiniz. Bireysel faturada (isCommercial=' ' ) platformun uygulamış olduğu indirim ve kuponlar için response'da ilgili parametreler 0 olarak dönecektir.
https://merchantapi.idefix.com/oms/{vendorId}/list
| Parametre Ad | Açıklama |
|---|---|
| ids | Shipment numarası bazında sorgulama yapılabilir. Birden fazla sorgulama yapilabilir, virgüller ile gönderim sağlanabilir. |
| orderNumber | Shipmentin idefix sistemindeki ana sipariş numarasına karşılık gelir. |
| state | Shipment statüsüne göre sorgulama yapılabilir. Gönderebileceginiz statelere response tablosunda yer verilmiştir. |
| startDate | Belirli bir tarihten sonraki shipmentler için sorgulama yapılabilir. Örnek Format : 2022/09/30 23:59:59 |
| endDate | Belirtilen tarihe kadar olan shipmentler için sorgulama yapılabilir. Örnek Format : 2022/09/30 23:59:59 |
| lastUpdatedAt | Shipmentin durumunun son güncellenme tarihini baz alır.Ornek Format : 2022/09/30 23:59:59 |
| page | Sadece belirtilen sayfadaki bilgileri dondurur. default deger 1 |
| limit | Bir sayfada listelenecek maksimum adeti belirtir. limit default deger 10 |
| sortByField | Son güncellenme tarihini baz alır. Herhangi bir seçim yapılmazsa default olarak; shipmentin id sine göre listelenecektir. id, createAt, updateAt parametreleri ile sorgulanabilir. |
| sortDirection | Sıralama tipini seçerek filtreleme yapılabilir. Herhangi bir seçim yapılmadı ise güncel id den eski id ye göre sıralayacak şekilde default çalışacaktır. desc, asc parametreleri ile sorgulanabilir. |
| vendor * | İlgili satıcının ID bilgisidir. |
{
"totalCount": 1,
"itemCount": 1,
"pageCount": 1,
"currentPage": 1,
"limit": 20,
"items": [
{
"invoiceAddress": {
"isCommercial": "",
"id": 21403112,
"firstName": "Derya",
"lastName": "Kaya",
"company": null,
"address1": "Test adresidir.",
"city": "İstanbul",
"cityId": 34,
"cityPlate": "34",
"postalCode": "",
"neighboorhood": "Çengelköy",
"neighboorhoodId": 34000,
"county": "Üsküdar",
"countyId": 1708,
"countryCode": "TR",
"phone": "5555555555",
"fullName": "Derya Kaya",
"fullAddress": "Test adresidir. Çengelköy İstanbul ",
"taxOffice": "",
"taxNumber": "",
"identificationNumber": "52369854125",
"floor": "1",
"buildingNumber": "29",
"doorNumber": "1"
},
"shippingAddress": {
"isCommercial": "",
"id": 21403112,
"firstName": "Derya",
"lastName": "Kaya",
"company": null,
"address1": "Test adresidir.",
"city": "İstanbul",
"cityId": 34,
"cityPlate": "34",
"postalCode": "",
"neighboorhood": "Çengelköy",
"neighboorhoodId": 34000,
"county": "Üsküdar",
"countyId": 1708,
"countryCode": "TR",
"phone": "5555555555",
"fullName": "Derya Kaya",
"fullAddress": "Test adresidir.Çengelköy İstanbul ",
"taxOffice": "",
"taxNumber": "",
"identificationNumber": "52369854125",
"floor": "1",
"buildingNumber": "29",
"doorNumber": "1"
},
"id": 60000003,
"orderNumber": "IDE642eabe9bd3b2",
"totalPrice": 54.9,
"totalDiscount": 0,
"discountedTotalPrice": 54.9,
"totalPlatformDiscount": 0,
"totalVendorDiscount": 0,
"customerId": 104710723,
"customerContactName": "Derya Kaya",
"customerContactMail": "1000019@idefixcustomer.com",
"customerTcNumber": null,
"cargoTrackingNumber": "11111",
"cargoTrackingUrl": "aaa.com",
"cargoCompany": "Yurtiçi Kargo",
"cargoTypeId": 1,
"cargoTypeName": "delivery",
"cargoProfileId": 3,
"cargoProfileName": "Yurtiçi Kargo Satıcı Öder",
"geoCode": null,
"createdAt": "2023-04-06T14:27:52+03:00",
"updatedAt": "2023-04-07T17:23:56+03:00",
"orderDate": "2023-04-06T11:24:25+03:00",
"histories": [
{
"state": "created",
"createdAt": "2023-04-06T14:27:52+03:00"
},
{
"state": "shipment_ready",
"createdAt": "2023-04-06T14:27:52+03:00"
},
{
"state": "shipment_in_cargo",
"createdAt": "2023-04-07T17:23:56+03:00"
},
{
"state": "shipment_picking",
"createdAt": "2023-04-07T14:02:56+03:00"
},
{
"state": "shipment_invoiced",
"createdAt": "2023-04-07T14:04:09+03:00"
}
],
"status": "shipment_in_cargo",
"statusUpdatedAt": "2023-04-07T17:23:56+03:00",
"deliveryType": "regular",
"estimatedDeliveryDate": "2023-04-07T15:00:59+03:00",
"vendorTitle": "idefix",
"vendorId": 3,
"statusDescription": "Kargoya Verildi",
"cargoKey": null,
"items": [
{
"productName": "İnsanın Anlam Arayışı",
"id": 10000043,
"barcode": "9786054054206",
"erpId": "1284814001",
"image": "https://static.idefix.net/resize/{size}product/26388/insanin-anlam-arayisi-642e3f0068526.jpg",
"price": 54.9,
"totalDiscount": null,
"platformDiscount": 0,
"vendorDiscount": 0,
"discountedTotalPrice": 54.9,
"currency": "TL",
"itemStatus": "in_delivery",
"comparePrice": 0,
"vendorAmount": 54.9,
"stateDescription": null,
"brandName": "Okuyan Us Yayınları",
"merchantSku": "9786054054206",
"lastShipmentDate": "2023-04-07T15:00:59+03:00"
}
]
}
]
}| Parametre Ad | Açıklama |
|---|---|
| totalPrice | Header; İlgili sevkiyatın indirimleri düşülmemiş toplamıdır. |
| totalDiscount | Header; Sevkiyat bazında platform ve vendor indirimlerinin toplamıdır. Items; , item in platform ve vendor indirimlerinin toplam indirimleridir. |
| discountedTotalPrice | Header; Sevkiyat bazında indirimlerin düşülmüş olduğu toplam shipment tutarıdır. Items; , indirimlerin düşülmüş olduğu toplam item tutarıdır. |
| totalPlatformDiscount | Header; Sevkiyat bazında platformun yapmış olduğu toplam indirim tutarıdır. |
| totalVendorDiscount | Header; Sevkiyat bazında vendorun yapmış olduğu toplam indirim tutarıdır. |
| platformDiscount | Items; Platformun uyguladığı toplam indirim tutarıdır. |
| vendorDiscount | Items; Vendor tarafından uygulanan toplam indirim tutarıdır. |
| commissionAmount | Items; item bazında komisyon tutarıdır. |
| earningAmount | Items; item bazında satıcının hakediş tutarıdır. |
| Parametre Ad | Açıklama |
|---|---|
| created | Shipment idefix sisteminde ödemesi başarılı şekilde oluşturuldu. Shipment henüz toplanmaya hazır değildir. |
| shipment_ready | Shipmentin hazırlanmaya başlanabileceğini belirten statüdür. |
| shipment_picking ** | Shipmentin artık iptal edilemeyeceğini belirleyen statüdür. Shipment toplanmaya başlandığında veya paket hazırlanmaya başlandığında bu statü bildirilmelidir. Bu statüyü beslemek için update-shipment-status servisini kullanılmalıdır. |
| shipment_invoiced ** | Shipmentin faturası kesildiğinde bu statü bildirilmelidir. Bu statüyü beslemek için update-shipment-status servisini kullanılmalıdır. |
| shipment_cancelled | İlgili shipment müşteri tarafından iptal edildiğinde dönecek statüdür. |
| shipment_unsupplied | İlgili shipment temin edilemedi olarak bildirildiğinde dönecek statüdür. |
| shipment_split | İlgili shipment için parçalı işlem yapıldığı durumda dönecek statüdür. |
| shipment_in_cargo | Shipment kargoya verildiğinde dönecek statüdür. |
| shipment_delivered | Shipment müsteriye teslim edildiğinde dönecek statüdür. |
| shipment_undeliver | Shipment müsteriye teslim edilemediğinde dönecek statüdür. |
| shipment_approved | Shipment için ilgili tüm süreçlerin tamamlanıp satıcı hakedişlerini hesaplama kısmına geçildiğini belirten statüdür. |