Endpoint
POST | https://api.iglobalstores.com/v1/orderNumbers
HTTPS-anmodning
| Felt | Bemærkninger |
|---|---|
| HTTP-metode | POST |
| Endpoint | 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 anmodningskroppen
Meddelelsesformat: JSON
EKSEMPEL ANMODNING: sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
EKSEMPEL ANMODNING: sidenDato
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
EKSEMPEL ANMODNING: sidenDato, gennemDato
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
EKSEMPEL PÅ ANMODNING: missingMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
EKSEMPEL ANMODNING: statuser
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
Anmodning JSON definitioner
| felt | noter |
|---|---|
missingMerchantOrderId VALGFRI, hvis der sendes en anden parameter mulighed | Denne parameter bruges til at forespørge et sæt ordrer inden for de sidste to uger, der mangler merchantOrderId. Når merchantOrderId sendes via updateMerchantOrderID API-endepunktet, vil ordrer ikke længere vises i denne forespørgsel.boolean: true/false |
secret PÅKRÆVET | API hemmelig GUID leveret af Zonos. string |
sinceDate VALGFRI, hvis der sendes 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 der sendes sinceDate / throughDate parameter | Den Zonos ordre-ID, kan sendes med eller uden din butik-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 den er til stede i anmodningen, uanset værdien, vil den inkludere statusserne.boolean: true |
store PÅKRÆVET | Butik-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
Beskedformat: JSON
EKSEMPEL PÅ SUCCES SVAR
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"
}
]
}
Eksempel på succesrespons med 'statuses' parameter
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"
}
]
}
Eksempel på fejlrespons
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
HTTP fejl svar
| Fejl | Betydning |
|---|---|
| 406 - Ikke Acceptabel | HTML Enhed. HTTP “Accept” header er ugyldig. |
| 415 - Ustøttet medietype | HTML Enhed. HTTP “Content-Type” header er ugyldig. |
| 200 | “error”:”kunne ikke analysere 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 specificere både parametre orderId og referenceId.” |
| 200 | “error”:”Kunne ikke behandle ordre detaljer.” |
| 200 | “error”:”Ugyldige sikkerhedsgodkendelser” |
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 aktive ordrer hentet.integer |
order.testOrderCount | Det samlede antal testordrer hentet.integer |
orders | En liste over ordre kort.string |
orders[index].id | Det fulde Zonos Ordre Id inklusive butik id og bindestreg.string |
orders[index].merchantOrderId | MerchantOrderId tilknyttet ordren gennem updateMerchantOrderId API service endpoint.string |
orders[index].orderStatus | Den nuværende ordrestatus for mulige værdier.string |
orders[index].orderStatusDate | Epoch 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 “aktiv ordre”.boolean |
orders[index].timestamp | Tidsstemplet der repræsenterer, hvornår ordren blev afgivet i UTC/GMT.timestamp |
totalCount | Det samlede antal både aktive og testordrer hentet.integer |
Ordrenumre
Lær hvordan endpointet for ordrenumre fungerer.orderNumbersendpointet bruges til sikkert at hente en liste over ordrenumre, der er afsluttet via Zonos Checkout. Det bruges normalt til ordregodkendelse for at sikre, at alle ordrer blev importeret pr. en dato eller orderID samt ordrer mellem et datointerval.