RestAPI Sipariş Listeleme
Sipariş Listeleme (GetShipmentPackages)
Bilgilendirme: Bu servisi kullanmaya başlamadan önce sellerintegration@n11.com adresine mail atarak RestAPI shipmentPackages servisi için yetkilendirme talebinde bulunabilirsiniz, aksi halde bu servisi çalıştıramamaktasınız.
Kısmi sipariş iptali sonrası, iptal olmayan sipariş ürünleri için yeni paket numarası ile sipariş listelenmesi Ekim ayı içerisinde canlıya alınarak ayrı bir configte düzenlenecektir. Entegratör firma olarak tüm satıcılarınızı Rest API ye taşıdıktan sonra sellerintegration@n11.com adresine mail atarak bu confige dahil olmak için düzenleme talep edebilirsiniz.
GET https://api.n11.com/rest/delivery/v1/shipmentPackages
- Authorization no auth seçiniz.
- Headers alanına appkey ve appsecret bilgisini eklemeniz gerekir.
- Servise 1 dakika içerisinde maksimum 1000 adet istek atılabilir.
- HTTP isteğinizi 'GET' methoduyla ilgili endpoint'e gönderin.
Dikkat Edilmesi Gerekenler;
- Status parametresi her istekte tek bir değer alabilmektedir, birden fazla statü listelemek için statü bazlı istek atmanız gerekmektedir.
- Pagination yapısı kullanıyorsanız page 0 başlatarak responsede dönen totalPages alanını dikkate alarak content boş dönen sayfayı son sayfa olarak belirleyebilirsiniz.
- Paket bölme işleminde bölünen ana sipariş statüsü Cancelled olarak güncellenip yeni oluşan paketler aynı sipariş numarası ve farklı paket numaralı ile UnPacked statüsü ile oluşacaktır.
- Bu servisten dönen sonuçlar son güncelleme tarihine göre sıralanacaktır, sıralamayı orderByDirection parametresini kullanarak DESC ( Yeniden eskiye ) ya da ASC ( Eskiden yeniye ) değeriyle listeleme yapabilirsiniz.
- Response Body içerisindeki parametre değerleri karakter sayısı ve veri tipleri sipariş sayısının doğal artışıyla beraber değişebilmektedir ( Örneğin orderNumber alanı 12 haneden 13 haneye çıkabilir, entegratör üzerinde tanımlama yapılırken bu durumlar göz önünde bulundurulması sağlıklı olacaktır ).
- Yalnızca startDate alanı girildiyse, girilen startDate'den sonraki 1 aylık kayıtlar listelenir.
- Yalnızca endDate alanı girildiyse, girilen endDate'den önceki 1 aylık kayıtlar listelenir.
- StartDate ve endDate alanları girilmiş fakat iki tarih arasında çok fazla fark varsa ( Örnek olarak 6 ay ya da 2 yıl gibi ) girilen endDate'den önceki son 1 aylık kayıtlar listelenecektir.
- Fatura edilecek toplam tutar için lines bloğundaki sellerInvoiceAmount alanını baz alabilirsiniz, bu alan ürün bazlı döneceğinden ürün sayısına göre dönen sellerInvoiceAmount alanlarını toplayarak sonuca ulaşabilirsiniz.
- İndirim hesaplaması yapmak istiyorsanız yine line bazlı price - totalSellerDiscountPrice formülünü kullanabilirsiniz. price - totalSellerDiscountPrice = sellerInvoiceAmount alanını vermektedir.
- Response body alanında, lines bloğunda ürün bazlı detaylar dönmektedir, aşağıda yer alan cevap parametrelerine lines alanı bold olarak belirtilmiştir.
| Parametre | Parametre Değer | Açıklama | Tip |
| startDate | Timestamp (milliseconds) ve GMT +3 olarak gönderilmelidir. | Belirtilen tarihten sonraki siparişleri getirir. | long ( timestamp ) |
| endDate | Timestamp (milliseconds) ve GMT +3 olarak gönderilmelidir. | Belirtilen tarihe kadar olan siparişleri getirir. | long ( timestamp ) |
| page | Sadece belirtilen sayfadaki bilgileri döndürür | int | |
| size | Maksimum 200 | Bir sayfada listelenecek maksimum adeti belirtir. | int |
| orderNumber | Sipariş numarası ile sorgulama yapılır. | string | |
| packageIds | Paket numarası ile sorgulama yapılır. | string | |
| status | Created, Picking, Shipped, Cancelled, Delivered, UnPacked, UnSupplied | Belirtilen statülere göre siparişleri getirir. | string |
| orderByDirection | ASC | Eskiden yeniye doğru sıralar. | string |
| DESC | Yeniden eskiye doğru sıralar. | string |
| Parametre(Cevap) | Açıklama |
| billingAddress | Fatura adresi |
| billingAddress.invoiceType | Fatura tipi, 1: Bireysel 2: Kurumsal |
| shippingAddress | Teslimat adresi |
| orderNumber | Sipariş numarası |
| id | Paket numarası |
| customerEmail | Alıcı mail adresi |
| customerfullName | Alıcı ad soyad |
| customerId | Alıcı ID bilgisi |
| taxId | Vergi no |
| taxOffice | Vergi dairesi |
| tcIdentityNumber | TC kimlik numarası |
| cargoSenderNumber | Kargo takip numarası |
| cargoTrackingNumber | Kargo barkod numarası / Kargo kampanya kodu |
| cargoTrackingLink | Kargo takip linki |
| shipmentCompanyId | Kargo firma id ( GetShipmentCompanies metodu ile listelenebilir ) |
| cargoProviderName | Kargo firma ünvanı ( GetShipmentCompanies metodu ile listelenebilir ) |
| shipmentMethod | Kargo yöntemi, 1: Kargo 2: Diğer ( dijital, hediye, online teslimat ) |
| installmentChargeWithVATprice | KDV dahil vade farkı |
| lines | Sipariş ürün satırları ( Sipariş ürün bilgilerinin tamamını görüntüleyebilirsiniz ) |
| quantity | Sipariş ürün adedi |
| productId | N11 ürün kodu |
| productName | Ürün adı |
| stockCode | Satıcı ürün kodu |
| variantAttributes | Ürün varyant özellikleri |
| customTextOptionValues | Müşteriye özel ürün seçeneği |
| price | Sipariş ürün birim fiyatı ( indirimler hariç ) |
| dueAmount | Tahsil edilecek tutar |
| installmentChargeWithVAT | KDV dahil vade farkı ( ürün bazlı ) |
| sellerCouponDiscount | Mağaza kupon indirimi |
| sellerDiscount | Mağaza indirimi |
| sellerInvoiceAmount | Mağaza fatura tutarı |
| totalSellerDiscountPrice | Mağaza indirim toplamı |
| mallDiscount | Ürün ile ilgili N11 indirimi |
| totalMallDiscountPrice | N11 indirimleri toplamı |
| orderLineId | Sipariş ürün ID |
| orderItemLineItemStatusName | Sipariş ürün statüsü |
| lastModifiedDate | Sipariş son hareket tarihi |
| agreedDeliveryDate | Sipariş onaylanma tarihi |
| totalAmount | Toplam tutar |
| totalDiscountAmount | Toplam indirim tutarı |
| packageHistories | Paket geçmişi ( Paketin geçmiş statülerini tarih bazlı görüntüleyebilirsiniz ) |
| shipmentPackageStatus | Sipariş statüsü |
| sellerId | Satıcı ID bilgisi |
Sipariş listeleme
Örnek Request:
GET : https://api.n11.com/rest/delivery/v1/shipmentPackages?startDate={startDate}&endDate={endDate}&status=Created&orderNumber={orderNumber}&packageIds={id}&page=0&size=200&orderByDirection=ASCYukarıdaki isteği orderNumber ve packageIds parametrelerini kaldırarak GET metodunda çağırdığınızda, startDate ve endDate parametrelerinde girilen tarih aralığındaki Created statülü 1. sayfadaki hareket tarihi eskiden yeniye 200 adet sipariş listelenecektir.
orderNumber (Sipariş Numarası) ve packageIds (Paket Numarası) parametrelerini birlikte ya da ayrı ayrı kullanarak sipariş çağırabilirsiniz.
Dökümandaki request parametrelerine göre özelleştirmeler yapabilirsiniz.
Örnek Response
{
"totalElements": 1,
"totalPages": 1,
"page": 0,
"size": 200,
"content": [
{
"billingAddress": {
"address": "Reşitpaşa Mah İstanbul Teknik Üniversitesi Teknokent Arı 3 4/a-3 D:8-9, 34485 Sarıyer/İstanbul",
"city": "İstanbul",
"district": "Sarıyer",
"neighborhood": "Reşitpaşa",
"fullName": "N11 müşteri",
"gsm": "5xxxxxxxxx",
"tcId": "11111111111",
"postalCode": "34000",
"taxId": null,
"taxHouse": null,
"invoiceType": 1
},
"shippingAddress": {
"address": "Reşitpaşa Mah İstanbul Teknik Üniversitesi Teknokent Arı 3 4/a-3 D:8-9, 34485 Sarıyer/İstanbul",
"city": "İstanbul",
"district": "Sarıyer",
"neighborhood": "Reşitpaşa",
"fullName": "N11 müşteri",
"gsm": "5xxxxxxxxx ",
"tcId": "11111111111",
"postalCode": "34000"
},
"orderNumber": "203872347637",
"id": "112999455244259",
"customerEmail": "n11@n11.com",
"customerfullName": "N11 müşteri",
"customerId": 12345678,
"taxId": "",
"taxOffice": "",
"tcIdentityNumber": "11111111111",
"cargoSenderNumber": null,
"cargoTrackingNumber": "112999455244259",
"cargoTrackingLink": "",
"shipmentCompanyId": 342,
"cargoProviderName": "MNG Kargo",
"shipmentMethod": 1,
"installmentChargeWithVATprice": 0.00,
"lines": [
{
"quantity": 2,
"productId": 123456789,
"productName": "Erkek Spor Ayakkabı Bordo 45",
"stockCode": "20242024",
"variantAttributes": [
{
"name": "Numara",
"value": "45"
},
{
"name": "Renk",
"value": "Bordo"
}
],
"customTextOptionValues": [],
"price": 292.8,
"dueAmount": 536.20,
"installmentChargeWithVAT": 0,
"sellerCouponDiscount": 0,
"sellerDiscount": 2.9,
"mallDiscount": 43.60,
"sellerInvoiceAmount": 579.8,
"totalMallDiscountPrice": 43.60,
"orderLineId": 415490391,
"orderItemLineItemStatusName": "Picking",
"totalSellerDiscountPrice": 5.8
},
{
"quantity": 3,
"productId": 123456799,
"productName": " Erkek Klasik Ayakkabı Kahverengi 42",
"stockCode": "202420241",
"variantAttributes": [
{
"name": "Numara",
"value": "42"
},
{
"name": "Renk",
"value": "Kahverengi"
}
],
"customTextOptionValues": [],
"price": 250,
"dueAmount": 693.60,
"installmentChargeWithVAT": 0,
"sellerCouponDiscount": 0,
"sellerDiscount": 0,
"mallDiscount": 28.20,
"sellerInvoiceAmount": 750,
"totalMallDiscountPrice": 56.40,
"orderLineId": 415490390,
"orderItemLineItemStatusName": "Picking",
"totalSellerDiscountPrice": 0
}
],
"lastModifiedDate": 1724323386203,
"agreedDeliveryDate": 1725310828346,
"totalAmount": 1479.79,
"totalDiscountAmount": 62.3,
"packageHistories": [
{
"createdDate": 1724274054460,
"status": "Created"
},
{
"createdDate": 1724274255751,
"status": "Picking"
},
{
"createdDate": 1724274492082,
"status": " Shipped"
},
{
"createdDate": 1724396400000,
"status": " Delivered"
}
],
"shipmentPackageStatus": "Delivered",
"sellerId": 9876543
}
]
}