Dowiedz się, jak działa punkt końcowy numerów zamówień.
Punkt końcowy orderNumbers jest używany do bezpiecznego pobierania listy numerów zamówień ukończonych za pośrednictwem Zonos Checkout. Zwykle jest używany do uzgadniania zamówień w celu upewnienia się, że wszystkie zamówienia zostały zaimportowane od określonej daty lub identyfikatora zamówienia, a także zamówienia w określonym zakresie dat.
POST | https://api.iglobalstores.com/v1/orderNumbers
Żądanie HTTPS
Pole↕
Notatki↕
Metoda HTTP
POST
Punkt końcowy
https://api.iglobalstores.com/v1/orderNumbers
Protokół
HTTPS
Format wiadomości
JSON
Nagłówek HTTP Accept
Accept: application/json
Nagłówek HTTP Content-Type
Content-Type: application/json
Pary klucz/wartość JSON w treści żądania
Format wiadomości: JSON
1{
2"store":"999",
3"secret":"f5bde245-f55e-414d-b722-80b25161c12c",
4"sinceOrderId":"999-99999"
5}
Definicje JSON żądania
pole↕
notatki↕
missingMerchantOrderId OPCJONALNIE, jeśli przekazujesz inną opcję parametru
Ten parametr jest używany do zapytania zestawu zamówień z ostatnich dwóch tygodni, w których brakuje merchantOrderId. Gdy merchantOrderId zostanie przesłany za pośrednictwem punktu końcowego API updateMerchantOrderID, zamówienia nie będą się już pojawiać w tym zapytaniu.boolean: true/false
secret WYMAGANE
Tajny klucz API GUID dostarczony przez Zonos. string
sinceDate OPCJONALNIE, jeśli przekazujesz parametr sinceOrderId.
Ten parametr jest używany do zapytania zestawu zamówień po określonej dacie.sinceDate i sinceOrderId nie mogą być wysyłane razem.string - data UTC/GMT; format: yyyymmdd
sinceOrderId OPCJONALNIE, jeśli przekazujesz parametr sinceDate / throughDate
Identyfikator zamówienia Zonos, można przekazać z identyfikatorem sklepu i myślnikiem lub bez niego (Przykład: 123-45678 lub 45678).Uwaga: Ten parametr będzie używany do zapytania zestawu zamówień po określonym zamówieniu Zonos. sinceDate i sinceOrderId nie mogą być wysyłane razem.integer / string
statuses OPCJONALNIE
Ten parametr jest używany do włączenia bieżącego statusu zamówienia i merchantOrderId w odpowiedzi. Jeśli jest obecny w żądaniu, niezależnie od wartości, będzie zawierać statusy.boolean: true
store WYMAGANE
Identyfikator sklepu dostarczony przez Zonos.integer
throughDate OPCJONALNIE
Ten parametr jest używany do zapytania zestawu zamówień w określonym zakresie dat.Musi być przekazany razem z parametrem sinceDate.string - data UTC/GMT; format: yyyymmdd
Odpowiedź HTTPS
Format wiadomości: 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}
Odpowiedzi błędu HTTP
Błąd↕
Znaczenie↕
406 - Not Acceptable
Element HTML. Nagłówek HTTP "Accept" jest nieprawidłowy.
415 - Unsupported media type
Element HTML. Nagłówek HTTP "Content-Type" jest nieprawidłowy.
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"
Definicje JSON odpowiedzi
pole↕
notatki↕
error
Ten parametr będzie obecny w odpowiedzi tylko wtedy, gdy wystąpił błąd i będzie zawierać opis przyczyny.string
orderCount
Całkowita liczba pobranych aktywnych zamówień.integer
order.testOrderCount
Całkowita liczba pobranych zamówień testowych.integer
orders
Lista map zamówień.string
orders[index].id
Pełny identyfikator zamówienia Zonos, w tym identyfikator sklepu i myślnik.string
orders[index].merchantOrderId
MerchantOrderId powiązany z zamówieniem za pośrednictwem punktu końcowego usługi API updateMerchantOrderId.string
orders[index].orderStatus
Bieżący status zamówienia dla możliwych wartości.string
orders[index].orderStatusDate
Epoka reprezentująca, kiedy status został ostatnio zaktualizowany.integer
orders[index].orderStatusDateString
Znacznik czasu reprezentujący, kiedy status został ostatnio zaktualizowany w UTC/GMT.timestamp
orders[index].testOrder
Wskazuje, czy zamówienie było zamówieniem testowym czy zamówieniem na żywo.boolean
orders[index].timestamp
Znacznik czasu reprezentujący, kiedy zamówienie zostało złożone w UTC/GMT.timestamp
totalCount
Całkowita liczba pobranych aktywnych i testowych zamówień.integer
Numery zamówień
Numery zamówień
Dowiedz się, jak działa punkt końcowy numerów zamówień.Punkt końcowy
orderNumbersjest używany do bezpiecznego pobierania listy numerów zamówień ukończonych za pośrednictwem Zonos Checkout. Zwykle jest używany do uzgadniania zamówień w celu upewnienia się, że wszystkie zamówienia zostały zaimportowane od określonej daty lub identyfikatora zamówienia, a także zamówienia w określonym zakresie dat.Punkt końcowy
POST |
https://api.iglobalstores.com/v1/orderNumbersŻądanie HTTPS
https://api.iglobalstores.com/v1/orderNumbersPary klucz/wartość JSON w treści żądania
Format wiadomości: JSON
{"store": "999","secret": "f5bde245-f55e-414d-b722-80b25161c12c","sinceOrderId": "999-99999"}Definicje JSON żądania
missingMerchantOrderIdOPCJONALNIE, jeśli przekazujesz inną opcję parametrumerchantOrderId. GdymerchantOrderIdzostanie przesłany za pośrednictwem punktu końcowego APIupdateMerchantOrderID, zamówienia nie będą się już pojawiać w tym zapytaniu.boolean: true/falsesecretWYMAGANEstringsinceDateOPCJONALNIE, jeśli przekazujesz parametrsinceOrderId.sinceDateisinceOrderIdnie mogą być wysyłane razem.string- data UTC/GMT; format:yyyymmddsinceOrderIdOPCJONALNIE, jeśli przekazujesz parametrsinceDate/throughDatesinceDateisinceOrderIdnie mogą być wysyłane razem.integer / stringstatusesOPCJONALNIEmerchantOrderIdw odpowiedzi. Jeśli jest obecny w żądaniu, niezależnie od wartości, będzie zawierać statusy.boolean: truestoreWYMAGANEintegerthroughDateOPCJONALNIEsinceDate.string- data UTC/GMT; format:yyyymmddOdpowiedź HTTPS
Format wiadomości: 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"}]}Odpowiedzi błędu HTTP
Definicje JSON odpowiedzi
errorstringorderCountintegerorder.testOrderCountintegerordersstringorders[index].idstringorders[index].merchantOrderIdMerchantOrderIdpowiązany z zamówieniem za pośrednictwem punktu końcowego usługi APIupdateMerchantOrderId.stringorders[index].orderStatusstringorders[index].orderStatusDateintegerorders[index].orderStatusDateStringtimestamporders[index].testOrderbooleanorders[index].timestamptimestamptotalCountintegerCzy ta strona była pomocna?