Hva er HTTPS-forespørselsformatet for Checkout API?

HTTPS-forespørselen for Checkout API inkluderer HTTP-metoden (POST), endepunktet, protokollen (HTTPS), meldingsformatet (JSON) og HTTP-headerne (Accept: application/json, Content-Type: application/json).

Hva er JSON nøkkel/verdi-parene i forespørselsteksten for Checkout API?

JSON nøkkel/verdi-parene i forespørselsteksten for Checkout API inkluderer parametere som 'store', 'secret', 'sinceOrderId', 'sinceDate', 'throughDate', 'missingMerchantOrderId' og 'statuses'.

Hva er HTTPS-svarformatet for Checkout API?

HTTPS-svaret for Checkout API er i JSON-format. Det inkluderer parametere som 'totalCount', 'orderCount', 'testOrderCount', 'orders' og 'error' (hvis det oppstår).

Hva er de mulige feil HTTP-svarene for Checkout API?

De mulige feil HTTP-svarene for Checkout API inkluderer 406 (Not Acceptable), 415 (Unsupported media type) og 200 med ulike feilmeldinger.

Checkout•

HjemAPI-referanse Checkout REST API Ordrenummere

Ordrenummere

Q: Hva er Checkout API?

Checkout API brukes til å sikkert hente en liste over ordrenummere som er fullført via Zonos Checkout. Det brukes vanligvis for ordresamstilling for å sikre at alle ordrer ble importert fra en bestemt dato eller ordreID samt ordrer innenfor et datointervall.

Lær hvordan ordrenummere-endepunktet fungerer.

Endepunktet orderNumbers brukes til å sikkert hente en liste over ordrenummere som er fullført via Zonos Checkout. Det brukes vanligvis for ordresamstilling for å sikre at alle ordrer ble importert fra en bestemt dato eller ordreID samt ordrer innenfor et datointervall.

Endepunkt

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

HTTPS-forespørsel

Felt↕	Notater↕
HTTP-metode	POST
Endepunkt	`https://api.iglobalstores.com/v1/orderNumbers`
Protokoll	HTTPS
Meldingsformat	JSON
Accept HTTP-header	Accept: application/json
Content-Type HTTP-header	Content-Type: application/json

JSON nøkkel/verdi i forespørselsteksten

Meldingsformat: JSON

1{

2 "store": "999",

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

4 "sinceOrderId": "999-99999"

5}

Definisjoner for forespørsel JSON

felt↕	notater↕
`missingMerchantOrderId` VALGFRITT, hvis en annen parameteropsjon sendes	Denne parameteren brukes til å spørre et sett med ordrer de siste to ukene som mangler `merchantOrderId`. Når `merchantOrderId` sendes via `updateMerchantOrderID` API-endepunktet, vil ordrer ikke lenger vises i denne forespørselen.`boolean: true/false`
`secret` PÅKREVD	API-hemmelighet GUID levert av Zonos. `string`
`sinceDate` VALGFRITT, hvis `sinceOrderId`-parameter sendes.	Denne parameteren brukes til å spørre et sett med ordrer etter en bestemt dato.`sinceDate` og `sinceOrderId` kan ikke både sendes.`string` - dato UTC/GMT; format: `yyyymmdd`
`sinceOrderId` VALGFRITT, hvis `sinceDate` / `throughDate`-parameter sendes	Zonos-ordre-ID, kan sendes med eller uten butikk-ID og bindestrek (Eksempel: 123-45678 eller 45678).Merk: Denne parameteren brukes til å spørre et sett med ordrer etter en bestemt Zonos-ordre. `sinceDate` og `sinceOrderId` kan ikke både sendes.`integer / string`
`statuses` VALGFRITT	Denne parameteren brukes til å inkludere gjeldende ordrestatus og `merchantOrderId` i svaret. Hvis den finnes i forespørselen, uansett verdi, vil den inkludere statusene.`boolean: true`
`store` PÅKREVD	Butikk-ID levert av Zonos.`integer`
`throughDate` VALGFRITT	Denne parameteren brukes til å spørre et sett med ordrer innenfor et bestemt datointervall.Må sendes sammen med `sinceDate`-parameteren.`string` - dato UTC/GMT; format: `yyyymmdd`

HTTPS-svar

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

Feil HTTP-svar

Feil↕	Betydning↕
406 - Not Acceptable	HTML Entity. HTTP "Accept" header er ugyldig.
415 - Unsupported media type	HTML Entity. HTTP "Content-Type" header er ugyldig.
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"

Definisjoner for svar JSON

felt↕	notater↕
`error`	Denne parameteren vil kun være tilstede i svaret når en feil har oppstått og vil inneholde en beskrivelse av årsaken.`string`
`orderCount`	Det totale antallet live-ordrer som ble hentet.`integer`
`order.testOrderCount`	Det totale antallet test-ordrer som ble hentet.`integer`
`orders`	En liste over ordrekart.`string`
`orders[index].id`	Den fullstendige Zonos-ordre-IDen inkludert butikk-ID og bindestrek.`string`
`orders[index].merchantOrderId`	`MerchantOrderId` assosiert med ordren gjennom `updateMerchantOrderId` API-tjenesteendepunktet.`string`
`orders[index].orderStatus`	Gjeldende ordrestatus for mulige verdier.`string`
`orders[index].orderStatusDate`	Epoken som representerer når statusen sist ble oppdatert.`integer`
`orders[index].orderStatusDateString`	Tidsstemplet som representerer når statusen sist ble oppdatert i UTC/GMT.`timestamp`
`orders[index].testOrder`	Indikerer om ordren var en "test ordre" eller "live ordre".`boolean`
`orders[index].timestamp`	Tidsstemplet som representerer når ordren ble plassert i UTC/GMT.`timestamp`
`totalCount`	Det totale antallet både live- og test-ordrer som ble hentet.`integer`

Bestill en demo