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 |
| Aksepter HTTP-header | Accept: application/json |
| Content-Type HTTP-header | Content-Type: application/json |
JSON nøkkel/verdi i forespørselens kropp
Meldingsformat: JSON
EKSEMPEL PÅ FORESPORSEL: sidenOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
EKSEMPEL PÅ FORESPØRSEL: sidenDato
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
EKSEMPEL PÅ FORESPØRSEL: sidenDato, gjennomDato
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
EKSEMPEL PÅ FORESPØRSEL: missingMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
EKSEMPEL PÅ FORESPØRSEL: statuser
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
Forespørsel JSON-definisjoner
| felt | notater |
|---|---|
missingMerchantOrderId VALGFRI, hvis du sender en annen parameter | Denne parameteren brukes til å forespørre et sett med bestillinger innen de siste to ukene som mangler merchantOrderId. Når merchantOrderId sendes via updateMerchantOrderID API-endepunktet, vil bestillingene ikke lenger vises i denne forespørselen.boolean: true/false |
secret PÅKREVET | API-hemmelig GUID gitt av Zonos. string |
sinceDate VALGFRI, hvis du sender sinceOrderId parameter. | Denne parameteren brukes til å forespørre et sett med bestillinger etter en bestemt dato.sinceDate og sinceOrderId kan ikke sendes samtidig.string - dato UTC/GMT; format: yyyymmdd |
sinceOrderId VALGFRI, hvis du sender sinceDate / throughDate parameter | Zonos bestillings-ID, kan sendes med eller uten butikk-ID og bindestrek (Eksempel: 123-45678 eller 45678).Merk: Denne parameteren vil bli brukt til å forespørre et sett med bestillinger etter en bestemt Zonos bestilling. sinceDate og sinceOrderId kan ikke sendes samtidig.integer / string |
statuses VALGFRI | Denne parameteren brukes til å inkludere den nåværende bestillingsstatusen og merchantOrderId i svaret. Hvis den er til stede i forespørselen, uavhengig av verdien, vil den inkludere statusene.boolean: true |
store PÅKREVET | Butikk-ID gitt av Zonos.integer |
throughDate VALGFRI | Denne parameteren brukes til å forespørre et sett med bestillinger mellom et bestemt datointervall.Må sendes sammen med sinceDate parameter.string - dato UTC/GMT; format: yyyymmdd |
HTTPS-svar
Meldingsformat: JSON
EKSEMPEL PÅ SUKSESSRESPONS
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å suksessrespons 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å feilmelding
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
HTTP-feilrespons
| Feil | Betydning |
|---|---|
| 406 - Ikke akseptabel | HTML-enhet. HTTP "Accept"-headeren er ugyldig. |
| 415 - Ugyldig mediatype | HTML-enhet. HTTP "Content-Type"-headeren er ugyldig. |
| 200 | “error”:”kunne ikke analysere input” |
| 200 | “error”:”orderId: 999-99999 er ikke en gyldig orderId” |
| 200 | “error”:”Parameter orderId eller referenceId er påkrevd.” |
| 200 | “error”:”Kan ikke spesifisere både parameterne orderId og referenceId.” |
| 200 | “error”:”Kunne ikke behandle ordre detaljer.” |
| 200 | “error”:”Ugyldige sikkerhetslegitimasjoner” |
Respons JSON-definisjoner
| felt | notater |
|---|---|
error | Denne parameteren vil kun være til stede i responsen når det har oppstått en feil og vil inneholde en beskrivelse av årsaken.string |
orderCount | Det totale antallet aktive bestillinger hentet.integer |
order.testOrderCount | Det totale antallet testbestillinger hentet.integer |
orders | En liste over ordre kart.string |
orders[index].id | Den fullstendige Zonos bestillings-ID-en inkludert butikk-ID og bindestrek.string |
orders[index].merchantOrderId | MerchantOrderId assosiert med bestillingen gjennom updateMerchantOrderId API-tjenestepunktet.string |
orders[index].orderStatus | Den nåværende ordrestatusen for mulige verdier.string |
orders[index].orderStatusDate | Epoken som representerer når statusen sist ble oppdatert.integer |
orders[index].orderStatusDateString | Tidsstempelet som representerer når statusen sist ble oppdatert i UTC/GMT.timestamp |
orders[index].testOrder | Indikerer om bestillingen var en “testbestilling” eller “aktiv bestilling”.boolean |
orders[index].timestamp | Tidsstempelet som representerer når bestillingen ble lagt inn i UTC/GMT.timestamp |
totalCount | Det totale antallet både aktive og testbestillinger hentet.integer |
Ordrenumre
Lær hvordan endepunktet for ordrenumre fungerer.Endepunktet
orderNumbersbrukes til å sikkert hente en liste over ordrenumre som er fullført via Zonos Checkout. Det brukes vanligvis for ordregjennomgang for å sikre at alle bestillinger ble importert fra en dato eller orderID, samt bestillinger mellom et datointervall.