Sipariş numaraları uç noktasının nasıl çalıştığını öğrenin.
orderNumbers uç noktası, Zonos Checkout aracılığıyla tamamlanan bir sipariş numaraları listesini güvenli bir şekilde almak için kullanılır. Normalde bir tarih veya sipariş kimliği itibariyle tüm siparişlerin alındığından emin olmak için sipariş uzlaştırması ve ayrıca bir tarih aralığındaki siparişler için kullanılır.
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
İleti biçimi
JSON
Accept HTTP başlığı
Accept: application/json
Content-Type HTTP başlığı
Content-Type: application/json
İstek gövdesindeki JSON anahtar/değer
İleti biçimi: JSON
1{
2"store":"999",
3"secret":"f5bde245-f55e-414d-b722-80b25161c12c",
4"sinceOrderId":"999-99999"
5}
İstek JSON tanımları
alan↕
notlar↕
missingMerchantOrderId İSTEĞE BAĞLI, başka bir parametre seçeneği iletiyorsanız
Bu parametre, son iki hafta içinde merchantOrderId eksik olan bir sipariş seti sorgulamak için kullanılır. merchantOrderIdupdateMerchantOrderID API uç noktası aracılığıyla gönderildiğinde, siparişler artık bu sorguda görünmeyecektir.boolean: true/false
secret GEREKLI
Zonos tarafından sağlanan API gizli anahtarı GUID. string
Bu parametre, belirli bir tarihten sonra bir sipariş seti sorgulamak için kullanılır.sinceDate ve sinceOrderId her ikisi de gönderilemez.string - tarih UTC/GMT; biçim: yyyymmdd
Zonos sipariş kimliği, mağaza kimliğiniz ve tire ile veya tire olmadan iletilir (Örnek: 123-45678 veya 45678).Not: Bu parametre, belirli bir Zonos siparişinden sonra bir sipariş seti sorgulamak için kullanılır. sinceDate ve sinceOrderId her ikisi de gönderilemez.integer / string
statuses İSTEĞE BAĞLI
Bu parametre, yanıta güncel sipariş durumu ve merchantOrderId eklemek için kullanılır. Talep üzerinde mevcut olduğu takdirde, değerden bağımsız olarak durumları içerecektir.boolean: true
store GEREKLI
Zonos tarafından sağlanan Mağaza Kimliği.integer
throughDate İSTEĞE BAĞLI
Bu parametre, belirli bir tarih aralığı içinde bir sipariş seti sorgulamak için kullanılır.sinceDate parametresiyle birlikte iletilmelidir.string - tarih UTC/GMT; biçim: yyyymmdd
HTTPS yanıtı
İleti biçimi: JSON
1{
2"totalCount":6,
3"orderCount":5,
4"testOrderCount":1,
5"orders":[
6{
7"testOrder":false,
8"id":"999-99991",
9"timestamp":"2015-01-01 00:33:14.0"
10},
11{
12"testOrder":true,
13"id":"999-99992",
14"timestamp":"2015-01-01 05:12:46.0"
15},
16{
17"testOrder":false,
18"id":"999-99993",
19"timestamp":"2015-01-01 14:50:54.0"
20},
21{
22"testOrder":false,
23"id":"999-99994",
24"timestamp":"2015-01-02 20:14:01.0"
25},
26{
27"testOrder":false,
28"id":"999-99995",
29"timestamp":"2015-01-02 20:57:47.0"
30},
31{
32"testOrder":false,
33"id":"999-99996",
34"timestamp":"2015-01-02 22:11:40.0"
35}
36]
37}
Hata HTTP yanıtları
Hata↕
Anlamı↕
406 - Not Acceptable
HTML Entity. HTTP "Accept" başlığı geçersiz.
415 - Unsupported media type
HTML Entity. HTTP "Content-Type" başlığı geçersiz.
200
"error":"could not parse input"
200
"error":"orderId: 999-99999 is not a valid orderId"
200
"error":"Parameter orderId or referenceId is required."
200
"error":"Cannot specify both Parameters orderId and referenceId."
200
"error":"Could not process order details."
200
"error":"Invalid security credentials"
Yanıt JSON tanımları
alan↕
notlar↕
error
Bu parametre yalnızca bir hata oluştuğunda yanıtta bulunur ve nedenin açıklamasını içerir.string
orderCount
Alınan canlı siparişlerin toplam sayısı.integer
order.testOrderCount
Alınan test siparişlerin toplam sayısı.integer
orders
Sipariş haritalarının listesi.string
orders[index].id
Mağaza kimliğini ve tiresi içeren 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 geçerli sipariş durumu.string
orders[index].orderStatusDate
Durumun son güncellendiğini temsil eden dönem.integer
orders[index].orderStatusDateString
Durumun UTC/GMT'de son güncellendiğini temsil eden zaman damgası.timestamp
orders[index].testOrder
Siparişin bir "test sipariş" mi yoksa "canlı sipariş" mi olduğunu gösterir.boolean
orders[index].timestamp
Siparişin UTC/GMT'de yerleştirildiğini temsil eden zaman damgası.timestamp
totalCount
Alınan canlı ve test siparişlerin toplam sayısı.integer
Sipariş numaraları
Sipariş numaraları
Sipariş numaraları uç noktasının nasıl çalıştığını öğrenin.orderNumbersuç noktası, Zonos Checkout aracılığıyla tamamlanan bir sipariş numaraları listesini güvenli bir şekilde almak için kullanılır. Normalde bir tarih veya sipariş kimliği itibariyle tüm siparişlerin alındığından emin olmak için sipariş uzlaştırması ve ayrıca bir tarih aralığındaki siparişler için kullanılır.Uç nokta
POST |
https://api.iglobalstores.com/v1/orderNumbersHTTPS isteği
https://api.iglobalstores.com/v1/orderNumbersİstek gövdesindeki JSON anahtar/değer
İleti biçimi: JSON
{"store": "999","secret": "f5bde245-f55e-414d-b722-80b25161c12c","sinceOrderId": "999-99999"}İstek JSON tanımları
missingMerchantOrderIdİSTEĞE BAĞLI, başka bir parametre seçeneği iletiyorsanızmerchantOrderIdeksik olan bir sipariş seti sorgulamak için kullanılır.merchantOrderIdupdateMerchantOrderIDAPI uç noktası aracılığıyla gönderildiğinde, siparişler artık bu sorguda görünmeyecektir.boolean: true/falsesecretGEREKLIstringsinceDateİSTEĞE BAĞLI,sinceOrderIdparametresi iletiyorsanız.sinceDatevesinceOrderIdher ikisi de gönderilemez.string- tarih UTC/GMT; biçim:yyyymmddsinceOrderIdİSTEĞE BAĞLI,sinceDate/throughDateparametresi iletiyorsanızsinceDatevesinceOrderIdher ikisi de gönderilemez.integer / stringstatusesİSTEĞE BAĞLImerchantOrderIdeklemek için kullanılır. Talep üzerinde mevcut olduğu takdirde, değerden bağımsız olarak durumları içerecektir.boolean: truestoreGEREKLIintegerthroughDateİSTEĞE BAĞLIsinceDateparametresiyle birlikte iletilmelidir.string- tarih UTC/GMT; biçim:yyyymmddHTTPS yanıtı
İleti biçimi: JSON
{"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"}]}Hata HTTP yanıtları
Yanıt JSON tanımları
errorstringorderCountintegerorder.testOrderCountintegerordersstringorders[index].idstringorders[index].merchantOrderIdupdateMerchantOrderIdAPI hizmet uç noktası aracılığıyla siparişle ilişkiliMerchantOrderId.stringorders[index].orderStatusstringorders[index].orderStatusDateintegerorders[index].orderStatusDateStringtimestamporders[index].testOrderbooleanorders[index].timestamptimestamptotalCountintegerBu sayfa faydalı mıydı?