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.
* ile belirtilen alanlar zorunlu parametrelerdir.
| Parametre Ad | Açıklama |
|---|---|
| ids | Shipment numarası bazında sorgulama yapılabilir. Birden fazla değer virgül (,) ile gönderilebilir. |
| orderNumber | Shipment’ın idefix sistemindeki ana sipariş numarasına karşılık gelir. |
| state | Shipment statüsüne göre sorgulama yapılabilir. Gönderilebilecek state değerleri response tablosunda yer almaktadır. |
| startDate | Belirli bir tarihten sonraki shipment’lar için sorgulama yapılabilir. Örnek format: 2022/09/30 23:59:59 |
| endDate | Belirtilen tarihe kadar olan shipment’lar için sorgulama yapılabilir. Örnek format: 2022/09/30 23:59:59 |
| lastUpdatedAt | Shipment’ın durumunun son güncellenme tarihini baz alır. Örnek format: 2022/09/30 23:59:59 |
| page | Sadece belirtilen sayfadaki verileri döndürür. Default değer: 1 |
| limit | Bir sayfada listelenecek maksimum kayıt adedini belirtir. Default değer: 10 |
| sortByField | Sıralama alanını belirtir. Varsayılan olarak shipment ID’ye göre sıralanır. id, createAt, updateAt parametreleri ile sorgulanabilir. |
| sortDirection | Sıralama yönünü belirtir. Varsayılan olarak güncel ID’den eski ID’ye doğru sıralanı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": "",
"isLikeCommercial": "",
"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": "",
"isLikeCommercial": "",
"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",
"vatRate": 0,
"commissionAmount": 0,
"earningAmount": 32.4,
"withholdingAmount": null,
"lastShipmentDate": "2023-07-04T15:00:59+03:00",
"customizableNote": null,
"iban": null
}
]
}
]
}| Parametre Ad | Açıklama |
|---|---|
| totalPrice | Header: İlgili sevkiyatın indirimler düşülmeden önceki toplam tutarıdır. |
| totalDiscount | Header: Sevkiyat bazında platform ve vendor indirimlerinin toplamıdır. Items: Item bazında platform ve vendor indirimlerinin toplam tutarıdır. |
| discountedTotalPrice | Header: Sevkiyat bazında indirimler düşüldükten sonraki toplam shipment tutarıdır. Items: İndirimler düşüldükten sonraki toplam item tutarıdır. |
| totalPlatformDiscount | Header: Sevkiyat bazında platform tarafından uygulanan toplam indirim tutarıdır. |
| totalVendorDiscount | Header: Sevkiyat bazında vendor tarafından uygulanan toplam indirim tutarıdır. |
| platformDiscount | Items: Item bazında platform tarafından uygulanan indirim tutarıdır. |
| vendorDiscount | Items: Item bazında vendor tarafından uygulanan indirim tutarıdır. |
| commissionAmount | Items: Item bazında komisyon tutarıdır. |
| earningAmount | Items: Item bazında satıcının hak ediş tutarıdır. |
| Parametre Ad | Açıklama |
|---|---|
| created | Shipment idefix sisteminde ödemesi başarılı şekilde oluşturulmuştur. Shipment henüz toplanmaya hazır değildir. |
| shipment_ready | Shipment’in hazırlanmaya başlanabileceğini belirten statüdür. |
| shipment_picking | Shipment’in artık iptal edilemeyeceğini belirten statüdür. Shipment toplanmaya veya paket hazırlanmaya başlandığında bu statü bildirilmelidir. Bu statüyü beslemek için update-shipment-status servisi kullanılmalıdır. |
| shipment_invoiced | Shipment’in faturası kesildiğinde bu statü bildirilmelidir. Bu statüyü beslemek için update-shipment-status servisi kullanılmalıdır. |
| shipment_cancelled | İlgili shipment müşteri tarafından iptal edildiğinde dönen statüdür. |
| shipment_unsupplied | İlgili shipment temin edilemedi olarak bildirildiğinde dönen statüdür. |
| shipment_split | İlgili shipment için parçalı işlem yapıldığı durumda dönen statüdür. |
| shipment_in_cargo | Shipment kargoya verildiğinde dönen statüdür. |
| shipment_delivered | Shipment müşteriye teslim edildiğinde dönen statüdür. |
| shipment_undeliver | Shipment müşteriye teslim edilemediğinde dönen statüdür. |
| shipment_approved | Shipment için tüm süreçler tamamlandığında ve satıcı hak ediş hesaplama sürecine geçildiğinde dönen statüdür. |