Slutpunkt
POST | https://api.iglobalstores.com/v1/orderNumbers
HTTPS-begäran
| Fält | Anteckningar |
|---|---|
| HTTP-metod | POST |
| Slutpunkt | https://api.iglobalstores.com/v1/orderNumbers |
| Protokoll | HTTPS |
| Meddelandeformat | JSON |
| Accept HTTP-header | Accept: application/json |
| Content-Type HTTP-header | Content-Type: application/json |
JSON nyckel/värde i begärans kropp
Meddelandeformat: JSON
EXEMPEL BEGÄRAN: sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
EXEMPEL FÖR FRÅGA: sinceDate
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
EXEMPEL FÖR FRÅGA: sinceDate, throughDate
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
EXEMPEL FÖR FRÅGA: missingMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
EXEMPEL FÖR FRÅGA: statusar
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
Begäran JSON-definitioner
| fält | anteckningar |
|---|---|
missingMerchantOrderId VALFRI, om en annan parameteroption skickas | Denna parameter används för att fråga en uppsättning beställningar inom de senaste två veckorna som saknar merchantOrderId. När merchantOrderId skickas via updateMerchantOrderID API-slutpunkt, kommer beställningar inte längre att visas i denna fråga.boolean: true/false |
secret KRÄVS | API-hemlig GUID som tillhandahålls av Zonos. string |
sinceDate VALFRI, om sinceOrderId-parametern skickas. | Denna parameter används för att fråga en uppsättning beställningar efter ett visst datum.sinceDate och sinceOrderId kan inte båda skickas.string - datum UTC/GMT; format: yyyymmdd |
sinceOrderId VALFRI, om sinceDate / throughDate-parametern skickas | Zonos beställnings-ID, kan skickas med eller utan din butik-ID och bindestreck (Exempel: 123-45678 eller 45678).Obs: Denna parameter kommer att användas för att fråga en uppsättning beställningar efter en viss Zonos beställning. sinceDate och sinceOrderId kan inte båda skickas.integer / string |
statuses VALFRI | Denna parameter används för att inkludera den aktuella beställningsstatusen och merchantOrderId i svaret. Om den finns i begäran, oavsett värdet, kommer den att inkludera statusarna.boolean: true |
store KRÄVS | Butik-ID som tillhandahålls av Zonos.integer |
throughDate VALFRI | Denna parameter används för att fråga en uppsättning beställningar mellan ett visst dataintervall.Måste skickas tillsammans med sinceDate-parametern.string - datum UTC/GMT; format: yyyymmdd |
HTTPS-svar
Meddelandformat: JSON
EXEMPEL PÅ FRAMGÅNGSSVAR
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"
}
]
}
Exempel på framgångssvar 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"
}
]
}
Exempel på felrespons
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
HTTP-felmeddelanden
| Fel | Betydelse |
|---|---|
| 406 - Inte acceptabel | HTML-enhet. HTTP "Accept"-huvudet är ogiltigt. |
| 415 - Ogiltig mediatyp | HTML-enhet. HTTP "Content-Type"-huvudet är ogiltigt. |
| 200 | “error”:”kunde inte analysera indata” |
| 200 | “error”:”orderId: 999-99999 är inte ett giltigt orderId” |
| 200 | “error”:”Parameter orderId eller referenceId krävs.” |
| 200 | “error”:”Kan inte specificera både parametrar orderId och referenceId.” |
| 200 | “error”:”Kunde inte bearbeta orderdetaljer.” |
| 200 | “error”:”Ogiltiga säkerhetsuppgifter” |
Svars-JOSN-definitioner
| fält | anteckningar |
|---|---|
error | Denna parameter kommer endast att finnas i svaret när ett fel har inträffat och kommer att innehålla en beskrivning av orsaken.string |
orderCount | Det totala antalet aktiva beställningar som hämtats.integer |
order.testOrderCount | Det totala antalet testbeställningar som hämtats.integer |
orders | En lista över orderkartor.string |
orders[index].id | Det fullständiga Zonos order-id inklusive butikens id och bindestreck.string |
orders[index].merchantOrderId | MerchantOrderId kopplad till beställningen genom updateMerchantOrderId API-tjänstpunkt.string |
orders[index].orderStatus | Den aktuella orderstatusen för möjliga värden.string |
orders[index].orderStatusDate | Epoch som representerar när statusen senast uppdaterades.integer |
orders[index].orderStatusDateString | Tidsstämpeln som representerar när statusen senast uppdaterades i UTC/GMT.timestamp |
orders[index].testOrder | Indikerar om beställningen var en “testbeställning” eller “aktiv beställning”.boolean |
orders[index].timestamp | Tidsstämpeln som representerar när beställningen lades i UTC/GMT.timestamp |
totalCount | Det totala antalet både aktiva och testbeställningar som hämtats.integer |
Ordernummer
Lär dig hur slutpunkten för ordernummer fungerar.Den
orderNumbersslutpunkten används för att säkert hämta en lista över ordernummer som slutförts via Zonos Checkout. Den används normalt för orderavstämning för att säkerställa att alla beställningar importerades per ett datum eller orderID samt beställningar mellan ett dataintervall.