Uç Nokta
POST | https://api.iglobalstores.com/v1/orderNumbers
HTTPS isteği
| Alan | Notlar |
|---|---|
| HTTP yöntemi | POST |
| Uç nokta | https://api.iglobalstores.com/v1/orderNumbers |
| Protokol | HTTPS |
| Mesaj formatı | JSON |
| Accept HTTP başlığı | Accept: application/json |
| Content-Type HTTP başlığı | Content-Type: application/json |
İstek gövdesindeki JSON anahtar/değer çiftleri
Mesaj formatı: JSON
ÖRNEK İSTEK: sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
ÖRNEK TALEP: sinceDate
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
ÖRNEK TALEP: sinceDate, throughDate
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
ÖRNEK TALEP: missingMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
ÖRNEK TALEP: durumlar
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
İstek JSON tanımları
| alan | notlar |
|---|---|
missingMerchantOrderId İSTEĞE BAĞLI, başka bir parametre seçeneği geçiliyorsa | Bu parametre, son iki hafta içinde merchantOrderId eksik olan bir dizi siparişi sorgulamak için kullanılır. merchantOrderId, updateMerchantOrderID API uç noktası aracılığıyla gönderildiğinde, siparişler bu sorguda artık görünmeyecektir.boolean: true/false |
secret GEREKEN | Zonos tarafından sağlanan API gizli GUID'si. string |
sinceDate İSTEĞE BAĞLI, sinceOrderId parametresi geçiliyorsa. | Bu parametre, belirli bir tarihten sonraki siparişleri sorgulamak için kullanılır.sinceDate ve sinceOrderId birlikte gönderilemez.string - tarih UTC/GMT; format: yyyymmdd |
sinceOrderId İSTEĞE BAĞLI, sinceDate / throughDate parametresi geçiliyorsa | Zonos sipariş ID'si, mağaza ID'nizle veya olmadan ve tire ile birlikte geçilebilir (Örnek: 123-45678 veya 45678). Not: Bu parametre, belirli bir Zonos siparişinden sonraki siparişleri sorgulamak için kullanılacaktır. sinceDate ve sinceOrderId birlikte gönderilemez.integer / string |
statuses İSTEĞE BAĞLI | Bu parametre, mevcut sipariş durumunu ve merchantOrderId'yi yanıtta dahil etmek için kullanılır. İsteğe dahilse, değeri ne olursa olsun, durumları dahil edecektir.boolean: true |
store GEREKEN | Zonos tarafından sağlanan Mağaza ID'si.integer |
throughDate İSTEĞE BAĞLI | Bu parametre, belirli bir tarih aralığında bir dizi siparişi sorgulamak için kullanılır. sinceDate parametresi ile birlikte geçilmelidir.string - tarih UTC/GMT; format: yyyymmdd |
HTTPS yanıtı
Mesaj formatı: JSON
ÖRNEK BAŞARI YANITI
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
"totalCount": 6,
"orderCount": 5,
"testOrderCount": 1,
"orders": [
{
"testOrder": false,
"id": "999-99991",
"timestamp": "2015-01-01 00:33:14.0"
},
{
"testOrder": true,
"id": "999-99992",
"timestamp": "2015-01-01 05:12:46.0"
},
{
"testOrder": false,
"id": "999-99993",
"timestamp": "2015-01-01 14:50:54.0"
},
{
"testOrder": false,
"id": "999-99994",
"timestamp": "2015-01-02 20:14:01.0"
},
{
"testOrder": false,
"id": "999-99995",
"timestamp": "2015-01-02 20:57:47.0"
},
{
"testOrder": false,
"id": "999-99996",
"timestamp": "2015-01-02 22:11:40.0"
}
]
}
Örnek başarı yanıtı 'statuses' parametresi ile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"totalCount": 2,
"orderCount": 1,
"testOrderCount": 1,
"orders": [
{
"testOrder": false,
"id": "999-99991",
"timestamp": "2015-01-01 00:33:14.0",
"merchantOrderId": null,
"orderStatus": "IGLOBAL_FRAUD_REVIEW",
"orderStatusDate": 1420097594000,
"orderStatusDateString": "2015-01-01 14:16:17.0"
},
{
"testOrder": true,
"id": "999-99992",
"timestamp": "2015-01-01 05:12:46.0",
"merchantOrderId": "abc123",
"orderStatus": "IGLOBAL_ORDER_IN_PROCESS",
"orderStatusDate": 1420097594000,
"orderStatusDateString": "2015-01-01 14:16:17.0"
}
]
}
Örnek hata yanıtı
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
Hata HTTP yanıtları
| Hata | Anlamı |
|---|---|
| 406 - Kabul Edilemez | HTML Varlığı. HTTP “Accept” başlığı geçersiz. |
| 415 - Desteklenmeyen medya türü | HTML Varlığı. HTTP “Content-Type” başlığı geçersiz. |
| 200 | “error”:”girdi ayrıştırılamadı” |
| 200 | “error”:”orderId: 999-99999 geçerli bir orderId değil” |
| 200 | “error”:”Parameter orderId veya referenceId gereklidir.” |
| 200 | “error”:”Hem orderId hem de referenceId parametrelerini belirtmek mümkün değil.” |
| 200 | “error”:”Sipariş detayları işlenemedi.” |
| 200 | “error”:”Geçersiz güvenlik kimlik bilgileri” |
Yanıt JSON tanımları
| alan | notlar |
|---|---|
error | Bu parametre yalnızca bir hata meydana geldiğinde yanıt içinde bulunacak ve nedenin açıklamasını içerecektir.string |
orderCount | Alınan canlı siparişlerin toplam sayısı.integer |
order.testOrderCount | Alınan test siparişlerinin toplam sayısı.integer |
orders | Sipariş haritalarının bir listesi.string |
orders[index].id | Mağaza kimliği ve tire dahil tam Zonos Sipariş Kimliği.string |
orders[index].merchantOrderId | updateMerchantOrderId API hizmet uç noktası aracılığıyla siparişle ilişkili MerchantOrderId .string |
orders[index].orderStatus | Olası değerler için mevcut sipariş durumu.string |
orders[index].orderStatusDate | Durumun en son güncellendiği zamanı temsil eden epoch.integer |
orders[index].orderStatusDateString | Durumun en son güncellendiği zamanı UTC/GMT'de temsil eden zaman damgası.timestamp |
orders[index].testOrder | Siparişin “test siparişi” mi yoksa “canlı sipariş” mi olduğunu gösterir.boolean |
orders[index].timestamp | Siparişin UTC/GMT'de verildiği zamanı temsil eden zaman damgası.timestamp |
totalCount | Alınan hem canlı hem de test siparişlerinin toplam sayısı.integer |
Sipariş numaraları
Sipariş numaraları uç noktasının nasıl çalıştığını öğrenin.orderNumbersuç noktası, Zonos Checkout aracılığıyla tamamlanan sipariş numaralarının bir listesini güvenli bir şekilde almak için kullanılır. Genellikle, tüm siparişlerin belirli bir tarih veya siparişID itibarıyla içe aktarıldığından emin olmak ve belirli bir tarih aralığındaki siparişler için sipariş uzlaştırması amacıyla kullanılır.