Eindpunt
POST | https://api.iglobalstores.com/v1/orderNumbers
HTTPS-verzoek
| Veld | Opmerkingen |
|---|---|
| HTTP-methode | POST |
| Eindpunt | https://api.iglobalstores.com/v1/orderNumbers |
| Protocol | HTTPS |
| Berichtformaat | JSON |
| Accept HTTP-header | Accept: application/json |
| Content-Type HTTP-header | Content-Type: application/json |
JSON sleutel/waarde in de aanvraagbody
Berichtformaat: JSON
VOORBEELD AANVRAAG: sindsOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
VOORBEELDVERZOEK: sindsDatum
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
VOORBEELDVERZOEK: sindsDatum, totDatum
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
VOORBEELDVERZOEK: ontbrekendeMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
VOORBEELDVERZOEK: statussen
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
Verzoek JSON-definities
| veld | opmerkingen |
|---|---|
missingMerchantOrderId OPTIONEEL, als een andere parameteroptie wordt doorgegeven | Deze parameter wordt gebruikt om een set bestellingen binnen de laatste twee weken op te vragen die de merchantOrderId missen. Wanneer de merchantOrderId wordt ingediend via de updateMerchantOrderID API-eindpunt, zullen bestellingen niet langer in deze query verschijnen.boolean: true/false |
secret VERPLICHT | API-geheim GUID verstrekt door Zonos. string |
sinceDate OPTIONEEL, als de parameter sinceOrderId wordt doorgegeven. | Deze parameter wordt gebruikt om een set bestellingen op te vragen na een bepaalde datum.sinceDate en sinceOrderId kunnen niet beide worden verzonden.string - datum UTC/GMT; formaat: yyyymmdd |
sinceOrderId OPTIONEEL, als de parameter sinceDate / throughDate wordt doorgegeven | De Zonos bestel-ID, kan worden doorgegeven met of zonder uw winkel-ID en koppelteken (Voorbeeld: 123-45678 of 45678).Opmerking: Deze parameter zal worden gebruikt om een set bestellingen op te vragen na een bepaalde Zonos bestelling. sinceDate en sinceOrderId kunnen niet beide worden verzonden.integer / string |
statuses OPTIONEEL | Deze parameter wordt gebruikt om de huidige bestelstatus en merchantOrderId in de reactie op te nemen. Als het aanwezig is in het verzoek, ongeacht de waarde, zullen de statussen worden opgenomen.boolean: true |
store VERPLICHT | Winkel-ID verstrekt door Zonos.integer |
throughDate OPTIONEEL | Deze parameter wordt gebruikt om een set bestellingen op te vragen tussen een bepaalde datumbereik.Moet samen met de parameter sinceDate worden doorgegeven.string - datum UTC/GMT; formaat: yyyymmdd |
HTTPS-reactie
Berichtformaat: JSON
VOORBEELD SUCCESREACTIE
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"
}
]
}
Voorbeeld van een succesvolle reactie met de parameter '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"
}
]
}
Voorbeeld foutrespons
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
Fout HTTP-antwoorden
| Fout | Betekenis |
|---|---|
| 406 - Niet Acceptabel | HTML-entiteit. HTTP “Accept”-header is ongeldig. |
| 415 - Ongesteunde mediatype | HTML-entiteit. HTTP “Content-Type”-header is ongeldig. |
| 200 | “error”:”kon invoer niet parseren” |
| 200 | “error”:”orderId: 999-99999 is geen geldige orderId” |
| 200 | “error”:”Parameter orderId of referenceId is vereist.” |
| 200 | “error”:”Kan zowel Parameters orderId als referenceId niet specificeren.” |
| 200 | “error”:”Kon orderdetails niet verwerken.” |
| 200 | “error”:”Ongeldige beveiligingsreferenties” |
Antwoord JSON-definities
| veld | opmerkingen |
|---|---|
error | Deze parameter zal alleen aanwezig zijn in het antwoord wanneer er een fout is opgetreden en zal een beschrijving van de oorzaak bevatten.string |
orderCount | Het totale aantal actieve bestellingen dat is opgehaald.integer |
order.testOrderCount | Het totale aantal testbestellingen dat is opgehaald.integer |
orders | Een lijst van bestellingskaarten.string |
orders[index].id | De volledige Zonos Order Id inclusief winkel-id en streepje.string |
orders[index].merchantOrderId | MerchantOrderId geassocieerd met de bestelling via de updateMerchantOrderId API-service-eindpunt.string |
orders[index].orderStatus | De huidige bestelstatus voor mogelijke waarden.string |
orders[index].orderStatusDate | De epoch die aangeeft wanneer de status voor het laatst is bijgewerkt.integer |
orders[index].orderStatusDateString | De tijdstempel die aangeeft wanneer de status voor het laatst is bijgewerkt in UTC/GMT.timestamp |
orders[index].testOrder | Geeft aan of de bestelling een “testbestelling” of “live bestelling” was.boolean |
orders[index].timestamp | De tijdstempel die aangeeft wanneer de bestelling is geplaatst in UTC/GMT.timestamp |
totalCount | Het totale aantal zowel actieve als testbestellingen dat is opgehaald.integer |
Ordernummers
Leer hoe het Ordernummers eindpunt werkt.Het
orderNumberseindpunt wordt gebruikt om veilig een lijst van ordernummers op te halen die zijn voltooid via de Zonos Checkout. Het wordt normaal gebruikt voor orderverzoening om ervoor te zorgen dat alle bestellingen zijn geïmporteerd vanaf een bepaalde datum of orderID, evenals bestellingen binnen een datumbereik.