Wat is de Checkout API?

De Checkout API wordt gebruikt om veilig een lijst met ordernummers op te halen die via Zonos Checkout zijn voltooid. Deze wordt normaal gebruikt voor orderreconciliatie, om te controleren of alle orders zijn geïmporteerd vanaf een datum of orderID, evenals orders binnen een datumbereik.

Wat is het HTTPS-requestformaat voor de Checkout API?

Het HTTPS-request voor de Checkout API bevat de HTTP-methode (POST), het endpoint, het protocol (HTTPS), het berichtformaat (JSON) en de HTTP-headers (Accept: application/json, Content-Type: application/json).

Wat zijn de JSON key/value-pairs in de request body voor de Checkout API?

De JSON key/value-paren in de request body voor de Checkout API omvatten parameters zoals 'store', 'secret', 'sinceOrderId', 'sinceDate', 'throughDate', 'missingMerchantOrderId' en 'statuses'.

Wat is het HTTPS-responseformaat voor de Checkout API?

De HTTPS-response voor de Checkout API is in JSON-formaat. Deze bevat parameters zoals 'totalCount', 'orderCount', 'testOrderCount', 'orders' en 'error' (indien aanwezig).

Wat zijn de mogelijke error HTTP-responses voor de Checkout API?

De mogelijke error HTTP-responses voor de Checkout API omvatten 406 (Not Acceptable), 415 (Unsupported media type) en 200 met verschillende foutmeldingen.

Checkout•

StartpaginaAPI-referentie Checkout REST API Ordernummers

Ordernummers

Leer hoe het Ordernummers-endpoint werkt.

Het orderNumbers-endpoint wordt gebruikt om veilig een lijst met ordernummers op te halen die via Zonos Checkout zijn voltooid. Het wordt normaal gebruikt voor orderreconciliatie om te controleren of alle orders zijn geïmporteerd vanaf een datum of orderID, evenals orders binnen een datumbereik.

Endpoint

POST | https://api.iglobalstores.com/v1/orderNumbers

HTTPS-request

Veld↕	Notities↕
HTTP method	POST
Endpoint	`https://api.iglobalstores.com/v1/orderNumbers`
Protocol	HTTPS
Message format	JSON
Accept HTTP header	Accept: application/json
Content-Type HTTP header	Content-Type: application/json

JSON key/value in de request body

Message format: JSON

1{

2 "store": "999",

3 "secret": "f5bde245-f55e-414d-b722-80b25161c12c",

4 "sinceOrderId": "999-99999"

5}

Request JSON-definities

veld↕	notities↕
`missingMerchantOrderId` OPTIONAL, indien een andere parameteroptie wordt meegegeven	Deze parameter wordt gebruikt om een set orders van de afgelopen twee weken op te vragen waarvoor de `merchantOrderId` ontbreekt. Wanneer de `merchantOrderId` wordt ingediend via het `updateMerchantOrderID`-API-endpoint, verschijnen deze orders niet meer in deze query.`boolean: true/false`
`secret` REQUIRED	API secret GUID verstrekt door Zonos. `string`
`sinceDate` OPTIONAL, indien de `sinceOrderId`-parameter wordt meegegeven.	Deze parameter wordt gebruikt om een set orders na een bepaalde datum op te vragen.`sinceDate` en `sinceOrderId` kunnen niet allebei worden verzonden.`string` - datum UTC/GMT; formaat: `yyyymmdd`
`sinceOrderId` OPTIONAL, indien de `sinceDate`- / `throughDate`-parameter wordt meegegeven	Het Zonos-order-ID kan worden doorgegeven met of zonder uw store-ID en streepje (voorbeeld: 123-45678 of 45678). Opmerking: deze parameter wordt gebruikt om een set orders na een bepaalde Zonos-order op te vragen. `sinceDate` en `sinceOrderId` kunnen niet allebei worden verzonden.`integer / string`
`statuses` OPTIONAL	Deze parameter wordt gebruikt om de huidige orderstatus en `merchantOrderId` in de response op te nemen. Als deze aanwezig is in het request, wordt de status opgenomen, ongeacht de waarde.`boolean: true`
`store` REQUIRED	Store-ID verstrekt door Zonos.`integer`
`throughDate` OPTIONAL	Deze parameter wordt gebruikt om een set orders binnen een bepaald datumbereik op te vragen. Moet samen met de `sinceDate`-parameter worden meegegeven.`string` - datum UTC/GMT; formaat: `yyyymmdd`

HTTPS-response

Message format: 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}

Error HTTP-responses

Fout↕	Betekenis↕
406 - Not Acceptable	HTML Entity. HTTP "Accept"-header is ongeldig.
415 - Unsupported media type	HTML Entity. HTTP "Content-Type"-header is ongeldig.
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"

Response JSON-definities

veld↕	notities↕
`error`	Deze parameter is alleen aanwezig in de response wanneer een fout is opgetreden en bevat een beschrijving van de oorzaak.`string`
`orderCount`	Het totale aantal opgehaalde live orders.`integer`
`order.testOrderCount`	Het totale aantal opgehaalde testorders.`integer`
`orders`	Een lijst met ordermaps.`string`
`orders[index].id`	Het volledige Zonos-order-ID, inclusief store-ID en streepje.`string`
`orders[index].merchantOrderId`	`MerchantOrderId` gekoppeld aan de order via het `updateMerchantOrderId`-API-service-endpoint.`string`
`orders[index].orderStatus`	De huidige orderstatus (zie 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 order een "testorder" of "live order" was.`boolean`
`orders[index].timestamp`	De tijdstempel die aangeeft wanneer de order is geplaatst, in UTC/GMT.`timestamp`
`totalCount`	Het totale aantal opgehaalde live- en testorders.`integer`

Boek een demo