Vad är Checkout API?

Checkout API används för att på ett säkert sätt hämta en lista över ordernummer som har slutförts via Zonos Checkout. Det används normalt för orderavstämning för att säkerställa att alla order importerades från ett datum eller orderID samt order inom ett datumintervall.

Vilket format har HTTPS-begäran för Checkout API?

HTTPS-begäran för Checkout API omfattar HTTP-metoden POST, slutpunkten, protokollet HTTPS, meddelandeformatet JSON och HTTP-huvudena Accept: application/json och Content-Type: application/json.

Vilka JSON-nyckel/värde-par finns i begärandetexten för Checkout API?

JSON-nyckel/värde-paren i begärandetexten för Checkout API omfattar parametrar som store, secret, sinceOrderId, sinceDate, throughDate, missingMerchantOrderId och statuses.

Vilket format har HTTPS-svaret för Checkout API?

HTTPS-svaret för Checkout API har JSON-format. Det omfattar parametrar som totalCount, orderCount, testOrderCount, orders och error, om ett fel uppstår.

Vilka HTTP-felsvar är möjliga för Checkout API?

Möjliga HTTP-felsvar för Checkout API omfattar 406 (Not Acceptable), 415 (Unsupported media type) och 200 med olika felmeddelanden.

Checkout•

HemAPI-referens Checkout REST API Ordernummer

Ordernummer

Lär er hur slutpunkten Ordernummer fungerar.

Slutpunkten orderNumbers används för att på ett säkert sätt hämta en lista över ordernummer som har slutförts via Zonos Checkout. Den används vanligtvis för orderavstämning för att säkerställa att alla order importerades från ett datum eller orderID samt order inom ett datumintervall.

Slutpunkt

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

HTTPS-begäran

Fält↕	Anmärkningar↕
HTTP-metod	POST
Slutpunkt	`https://api.iglobalstores.com/v1/orderNumbers`
Protokoll	HTTPS
Meddelandeformat	JSON
HTTP-huvud Accept	Accept: application/json
HTTP-huvud Content-Type	Content-Type: application/json

JSON-nyckel/värde i begärandetexten

Meddelandeformat: JSON

1{

2 "store": "999",

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

4 "sinceOrderId": "999-99999"

5}

Definitioner för JSON-begäran

fält↕	anmärkningar↕
`missingMerchantOrderId` VALFRITT, om ett annat parameteralternativ skickas	Den här parametern används för att fråga efter en uppsättning order från de senaste två veckorna som saknar `merchantOrderId`. När `merchantOrderId` skickas via API-slutpunkten `updateMerchantOrderID` visas order inte längre i den här frågan.`boolean: true/false`
`secret` OBLIGATORISKT	API-hemlighetens GUID tillhandahålls av Zonos. `string`
`sinceDate` VALFRITT, om parametern `sinceOrderId` skickas.	Den här parametern används för att fråga efter en uppsättning order efter ett visst datum. `sinceDate` och `sinceOrderId` kan inte skickas samtidigt.`string` - datum UTC/GMT; format: `yyyymmdd`
`sinceOrderId` VALFRITT, om parametern `sinceDate` / `throughDate` skickas	Zonos-order-ID:t kan skickas med eller utan ert butiks-ID och bindestreck (exempel: 123-45678 eller 45678). Obs: Den här parametern används för att fråga efter en uppsättning order efter en viss Zonos-order. `sinceDate` och `sinceOrderId` kan inte skickas samtidigt.`integer / string`
`statuses` VALFRITT	Den här parametern används för att inkludera aktuell orderstatus och `merchantOrderId` i svaret. Om den finns i begäran inkluderas statusarna, oavsett värde.`boolean: true`
`store` OBLIGATORISKT	Butiks-ID tillhandahålls av Zonos.`integer`
`throughDate` VALFRITT	Den här parametern används för att fråga efter en uppsättning order inom ett visst datumintervall. Måste skickas med parametern `sinceDate`.`string` - datum UTC/GMT; format: `yyyymmdd`

HTTPS-svar

Meddelandeformat: 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}

HTTP-felsvar

Fel↕	Betydelse↕
406 - Not Acceptable	HTML-entitet. HTTP-huvudet ”Accept” är ogiltigt.
415 - Unsupported media type	HTML-entitet. HTTP-huvudet ”Content-Type” är ogiltigt.
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”

Definitioner för JSON-svar

fält↕	anmärkningar↕
`error`	Den här parametern finns endast i svaret när ett fel har uppstått och innehåller en beskrivning av orsaken.`string`
`orderCount`	Det totala antalet hämtade skarpa order.`integer`
`order.testOrderCount`	Det totala antalet hämtade testorder.`integer`
`orders`	En lista över ordermappningar.`string`
`orders[index].id`	Hela Zonos-order-ID:t inklusive butiks-ID och bindestreck.`string`
`orders[index].merchantOrderId`	`MerchantOrderId` som är kopplat till ordern via API-tjänstslutpunkten `updateMerchantOrderId`.`string`
`orders[index].orderStatus`	Aktuell orderstatus för möjliga värden.`string`
`orders[index].orderStatusDate`	Epochtiden som anger när statusen senast uppdaterades.`integer`
`orders[index].orderStatusDateString`	Tidsstämpeln som anger när statusen senast uppdaterades i UTC/GMT.`timestamp`
`orders[index].testOrder`	Anger om ordern var en ”testorder” eller ”skarp order”.`boolean`
`orders[index].timestamp`	Tidsstämpeln som anger när ordern lades i UTC/GMT.`timestamp`
`totalCount`	Det totala antalet hämtade skarpa order och testorder.`integer`

Boka en demo