Punkt końcowy
POST | https://api.iglobalstores.com/v1/orderNumbers
Żądanie HTTPS
| Pole | Uwagi |
|---|---|
| Metoda HTTP | POST |
| Punkt końcowy | https://api.iglobalstores.com/v1/orderNumbers |
| Protokół | HTTPS |
| Format wiadomości | JSON |
| Nagłówek Accept HTTP | Accept: application/json |
| Nagłówek Content-Type HTTP | Content-Type: application/json |
Klucz/wartość JSON w ciele żądania
Format wiadomości: JSON
PRZYKŁADOWE ŻĄDANIE: sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
PRZYKŁADOWA PROŚBA: sinceDate
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
PRZYKŁADOWA PROŚBA: sinceDate, throughDate
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
PRZYKŁADOWE ŻĄDANIE: brakującyMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
PRZYKŁADOWE ŻĄDANIE: statusy
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
Definicje JSON żądania
| pole | uwagi |
|---|---|
missingMerchantOrderId OPCJONALNE, jeśli przekazywana jest inna opcja parametru | Ten parametr jest używany do zapytania o zestaw zamówień w ciągu ostatnich dwóch tygodni, które nie mają merchantOrderId. Gdy merchantOrderId jest przesyłane za pośrednictwem punktu końcowego API updateMerchantOrderID, zamówienia nie będą już wyświetlane w tym zapytaniu.boolean: true/false |
secret WYMAGANE | Sekret API GUID dostarczony przez Zonos. string |
sinceDate OPCJONALNE, jeśli przekazywany jest parametr sinceOrderId. | Ten parametr jest używany do zapytania o zestaw zamówień po określonej dacie.sinceDate i sinceOrderId nie mogą być przesyłane jednocześnie.string - data UTC/GMT; format: yyyymmdd |
sinceOrderId OPCJONALNE, jeśli przekazywany jest parametr sinceDate / throughDate | ID zamówienia Zonos, może być przesyłane z lub bez ID sklepu i myślnika (Przykład: 123-45678 lub 45678).Uwaga: Ten parametr będzie używany do zapytania o zestaw zamówień po określonym zamówieniu Zonos. sinceDate i sinceOrderId nie mogą być przesyłane jednocześnie.integer / string |
statuses OPCJONALNE | Ten parametr jest używany do uwzględnienia bieżącego statusu zamówienia i merchantOrderId w odpowiedzi. Jeśli jest obecny w żądaniu, niezależnie od wartości, uwzględni statusy.boolean: true |
store WYMAGANE | ID sklepu dostarczone przez Zonos.integer |
throughDate OPCJONALNE | Ten parametr jest używany do zapytania o zestaw zamówień w określonym zakresie dat. Musi być przesyłany wraz z parametrem sinceDate .string - data UTC/GMT; format: yyyymmdd |
Odpowiedź HTTPS
Format wiadomości: JSON
PRZYKŁAD UDANEJ ODPOWIEDZI
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"
}
]
}
Przykładowa odpowiedź sukcesu z parametrem 'statuses'
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"
}
]
}
Przykładowa odpowiedź błędu
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
Odpowiedzi błędów HTTP
| Błąd | Znaczenie |
|---|---|
| 406 - Not Acceptable | Encja HTML. Nagłówek HTTP “Accept” jest nieprawidłowy. |
| 415 - Unsupported media type | Encja HTML. Nagłówek HTTP “Content-Type” jest nieprawidłowy. |
| 200 | “error”:”nie można przetworzyć wejścia” |
| 200 | “error”:”orderId: 999-99999 nie jest prawidłowym orderId” |
| 200 | “error”:”Parametr orderId lub referenceId jest wymagany.” |
| 200 | “error”:”Nie można określić obu parametrów orderId i referenceId.” |
| 200 | “error”:”Nie można przetworzyć szczegółów zamówienia.” |
| 200 | “error”:”Nieprawidłowe dane uwierzytelniające” |
Definicje odpowiedzi JSON
| pole | uwagi |
|---|---|
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 aktywnych zamówień pobranych.integer |
order.testOrderCount | Całkowita liczba zamówień testowych pobranych.integer |
orders | Lista map zamówień.string |
orders[index].id | Pełne Zonos Id zamówienia, w tym id sklepu i myślnik.string |
orders[index].merchantOrderId | MerchantOrderId powiązane z zamówieniem przez punkt końcowy API updateMerchantOrderId .string |
orders[index].orderStatus | Aktualny 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 “aktywnym zamówieniem”.boolean |
orders[index].timestamp | Znacznik czasu reprezentujący, kiedy zamówienie zostało złożone w UTC/GMT.timestamp |
totalCount | Całkowita liczba zarówno aktywnych, jak i testowych zamówień pobranych.integer |
Numery zamówień
Dowiedz się, jak działa punkt końcowy numerów zamówień.Punkt końcowy
orderNumberssłuży do bezpiecznego pobierania listy numerów zamówień zrealizowanych za pośrednictwem Zonos Checkout. Zwykle jest używany do uzgadniania zamówień, aby upewnić się, że wszystkie zamówienia zostały zaimportowane na dany dzień lub według orderID, a także zamówienia w określonym zakresie dat.