Hvad er HTTPS-anmodningsformatet for Checkout API?

HTTPS-anmodningen for Checkout API'en inkluderer HTTP-metoden (POST), slutpunktet, protokollen (HTTPS), meddelelsesformatet (JSON) og HTTP-headerne (Accepter: application/json, Content-Type: application/json).

Hvad er JSON-nøgle/værdi-parrene i anmodningsteksten for Checkout API?

JSON-nøgle/værdi-parrene i anmodningsteksten for Checkout API'et inkluderer parametre som 'store', 'secret', 'sinceOrderId', 'sinceDate', 'throughDate', 'missingMerchantOrderId' og 'statuses'.

Hvad er HTTPS-svarformatet for Checkout API?

HTTPS-svaret for Checkout API er i JSON-format. Det inkluderer parametre som 'totalCount', 'orderCount', 'testOrderCount', 'orders' og 'error' (hvis nogen).

Hvad er de mulige HTTP-fejlsvar for Checkout API'en?

De mulige fejl-HTTP-svar for Checkout API inkluderer 406 (Ikke acceptabelt), 415 (Ikke-understøttet medietype) og 200 med forskellige fejlmeddelelser.

Checkout•

HjemAPI reference Checkout REST API Ordrenumre

Ordrenumre

Q: Hvad er Checkout API?

Checkout API'en bruges til sikkert at hente en liste over ordrenumre, der er afsluttet via Zonos Checkout. Det bruges normalt til ordreafstemning for at sikre, at alle ordrer blev importeret fra en dato eller et ordre-ID samt ordrer mellem et datointerval.

Lær, hvordan ordrenumre-slutpunktet fungerer.

Slutpunktet orderNumbers bruges til sikkert at hente en liste over ordrenumre, der er afsluttet via Zonos Checkout. Det bruges normalt til ordreafstemning for at sikre, at alle ordrer blev importeret fra en dato eller et ordre-ID, samt ordrer mellem et datointerval.

Slutpunkt

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

HTTPS-anmodning

Felt↕	Noter↕
HTTP-metode	POST
Slutpunkt	`https://api.iglobalstores.com/v1/orderNumbers`
Protokol	HTTPS
Meddelelsesformat	JSON
Accept HTTP-header	Accept: application/json
Content-Type HTTP-header	Content-Type: application/json

JSON-nøgle/værdi i anmodningens brødtekst

Meddelelsesformat: JSON

1{

2 "store": "999",

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

4 "sinceOrderId": "999-99999"

5}

Anmodning JSON-definitioner

felt↕	noter↕
`missingMerchantOrderId` VALGFRI, hvis du sender en anden parameter mulighed	Denne parameter bruges til at forespørge et sæt eller ordrer inden for de sidste to uger, der mangler `merchantOrderId`. Når `merchantOrderId` indsendes via `updateMerchantOrderID` API-slutpunkt, ordrer vises ikke længere i denne forespørgsel. `boolean: true/false`
`secret` PÅKRÆVET	API hemmelig GUID leveret af Zonos. `string`
`sinceDate` VALGFRI, hvis bestået `sinceOrderId`-parameter.	Denne parameter bruges til at forespørge et sæt ordrer efter en bestemt dato. `sinceDate` og `sinceOrderId` kan ikke begge sendes. `string` - dato UTC/GMT; format: `yyyymmdd`
`sinceOrderId` VALGFRI, hvis bestået `sinceDate`/`throughDate`-parameter	Zonos-ordre-id'et kan videregives med eller uden dit butiks-id og bindestreg (eksempel: 123-45678 eller 45678). Bemærk: Denne parameter vil blive brugt til at forespørge et sæt ordrer efter en bestemt Zonos-ordre. `sinceDate` og `sinceOrderId` kan ikke begge sendes. `integer / string`
`statuses` VALGFRI	Denne parameter bruges til at inkludere den aktuelle ordrestatus og `merchantOrderId` i svaret. Hvis det er til stede på anmodningen, uanset værdien, vil det inkludere statusserne. `boolean: true`
`store` PÅKRÆVET	Butiks-id leveret af Zonos. `integer`
`throughDate` VALGFRI	Denne parameter bruges til at forespørge et sæt ordrer mellem et bestemt datointerval. Skal sendes sammen med `sinceDate`-parameter. `string` - dato UTC/GMT; format: `yyyymmdd`

HTTPS-svar

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

Fejl i HTTP-svar

Fejl↕	Betydning↕
406 - Ikke acceptabelt	HTML-enhed. HTTP "Accept"-headeren er ugyldig.
415 - Ikke-understøttet medietype	HTML-enhed. HTTP "Content-Type" header er ugyldig.
200	"error": "kunne ikke parse input"
200	“error”:”orderId: 999-99999 er ikke et gyldigt orderId”
200	"error":"Parameter orderId eller referenceId er påkrævet."
200	"error": "Kan ikke angive begge parametre orderId og referenceId."
200	"error":"Kunne ikke behandle ordreoplysninger."
200	"error":"Ugyldige sikkerhedsoplysninger"

Svar JSON definitioner

felt↕	noter↕
`error`	Denne parameter vil kun være til stede i svaret, når der er opstået en fejl, og vil indeholde en beskrivelse af årsagen. `string`
`orderCount`	Det samlede antal af hentede live-ordrer. `integer`
`order.testOrderCount`	Det samlede antal testordrer, der er hentet. `integer`
`orders`	En liste over ordrekort. `string`
`orders[index].id`	Det fulde Zonos ordre-id inklusive butiks-id og bindestreg. `string`
`orders[index].merchantOrderId`	`MerchantOrderId` forbundet med ordren gennem `updateMerchantOrderId` API service slutpunkt. `string`
`orders[index].orderStatus`	Den aktuelle ordrestatus for mulige værdier. `string`
`orders[index].orderStatusDate`	Den epoke, der repræsenterer, hvornår status sidst blev opdateret. `integer`
`orders[index].orderStatusDateString`	Tidsstemplet, der repræsenterer, hvornår status sidst blev opdateret i UTC/GMT. `timestamp`
`orders[index].testOrder`	Angiver, om ordren var en "testordre" eller "liveordre". `boolean`
`orders[index].timestamp`	Tidsstemplet, der repræsenterer, hvornår ordren blev afgivet i UTC/GMT. `timestamp`
`totalCount`	Det samlede antal af hentede live- og testordrer. `integer`

Book en demo