Endpunkt
POST | https://api.iglobalstores.com/v1/orderNumbers
HTTPS-Anfrage
| Feld | Hinweise |
|---|---|
| HTTP-Methode | POST |
| Endpunkt | https://api.iglobalstores.com/v1/orderNumbers |
| Protokoll | HTTPS |
| Nachrichtenformat | JSON |
| Akzeptieren HTTP-Header | Accept: application/json |
| Content-Type HTTP-Header | Content-Type: application/json |
JSON-Schlüssel/Wert im Anfragekörper
Nachrichtenformat: JSON
BEISPIELANFRAGE: sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
BEISPIELANFRAGE: sinceDate
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
BEISPIELANFRAGE: sinceDate, throughDate
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
BEISPIELANFRAGE: fehlende Händlerbestellungs-ID
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
BEISPIELANFRAGE: Status
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
Anforderungs-JSON-Definitionen
| Feld | Hinweise |
|---|---|
missingMerchantOrderId OPTIONAL, wenn ein anderer Parameter übergeben wird | Dieser Parameter wird verwendet, um eine Reihe von Bestellungen innerhalb der letzten zwei Wochen abzufragen, bei denen die merchantOrderId fehlt. Wenn die merchantOrderId über den updateMerchantOrderID API-Endpunkt übermittelt wird, werden die Bestellungen nicht mehr in dieser Abfrage angezeigt. boolean: true/false |
secret ERFORDERLICH | API-Geheimcode GUID, bereitgestellt von Zonos. string |
sinceDate OPTIONAL, wenn der sinceOrderId Parameter übergeben wird. | Dieser Parameter wird verwendet, um eine Reihe von Bestellungen nach einem bestimmten Datum abzufragen. sinceDate und sinceOrderId können nicht gleichzeitig gesendet werden. string - Datum UTC/GMT; Format: yyyymmdd |
sinceOrderId OPTIONAL, wenn der sinceDate / throughDate Parameter übergeben wird | Die Zonos Bestell-ID kann mit oder ohne Ihre Shop-ID und Bindestrich übergeben werden (Beispiel: 123-45678 oder 45678).Hinweis: Dieser Parameter wird verwendet, um eine Reihe von Bestellungen nach einer bestimmten Zonos Bestellung abzufragen. sinceDate und sinceOrderId können nicht gleichzeitig gesendet werden. integer / string |
statuses OPTIONAL | Dieser Parameter wird verwendet, um den aktuellen Bestellstatus und die merchantOrderId in der Antwort einzuschließen. Wenn er in der Anfrage vorhanden ist, unabhängig vom Wert, werden die Status eingefügt. boolean: true |
store ERFORDERLICH | Shop-ID, bereitgestellt von Zonos. integer |
throughDate OPTIONAL | Dieser Parameter wird verwendet, um eine Reihe von Bestellungen innerhalb eines bestimmten Datumsbereichs abzufragen. Muss zusammen mit dem sinceDate Parameter übergeben werden. string - Datum UTC/GMT; Format: yyyymmdd |
HTTPS-Antwort
Nachrichtenformat: JSON
BEISPIEL ERFOLGREICHE ANTWORT
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"
}
]
}
Beispiel für eine erfolgreiche Antwort mit dem Parameter 'statuses'
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"
}
]
}
Beispiel Fehlerantwort
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
HTTP-Fehlerantworten
| Fehler | Bedeutung |
|---|---|
| 406 - Nicht akzeptabel | HTML-Entität. Der HTTP-"Accept"-Header ist ungültig. |
| 415 - Nicht unterstützter Medientyp | HTML-Entität. Der HTTP-"Content-Type"-Header ist ungültig. |
| 200 | "Fehler": "Eingabe konnte nicht geparst werden" |
| 200 | "Fehler": "Bestellnummer: 999-99999 ist keine gültige Bestellnummer" |
| 200 | "Fehler": "Parameter Bestellnummer oder Referenznummer ist erforderlich." |
| 200 | "Fehler": "Kann nicht beide Parameter Bestellnummer und Referenznummer angeben." |
| 200 | "Fehler": "Bestelldetails konnten nicht verarbeitet werden." |
| 200 | "Fehler": "Ungültige Sicherheitsanmeldeinformationen" |
Definitionen der JSON-Antworten
| Feld | Hinweise |
|---|---|
error | Dieser Parameter wird nur in der Antwort angezeigt, wenn ein Fehler aufgetreten ist, und enthält eine Beschreibung der Ursache. string |
orderCount | Die Gesamtanzahl der abgerufenen Live-Bestellungen. integer |
order.testOrderCount | Die Gesamtanzahl der abgerufenen Testbestellungen. integer |
orders | Eine Liste von Bestellkarten. string |
orders[index].id | Die vollständige Zonos Bestell-ID einschließlich Store-ID und Bindestrich. string |
orders[index].merchantOrderId | MerchantOrderId, die mit der Bestellung über den API-Dienstendpunkt updateMerchantOrderId verknüpft ist. string |
orders[index].orderStatus | Der aktuelle Bestellstatus für mögliche Werte. string |
orders[index].orderStatusDate | Die Epoche, die angibt, wann der Status zuletzt aktualisiert wurde. integer |
orders[index].orderStatusDateString | Der Zeitstempel, der angibt, wann der Status zuletzt in UTC/GMT aktualisiert wurde. timestamp |
orders[index].testOrder | Gibt an, ob es sich bei der Bestellung um eine "Testbestellung" oder "Live-Bestellung" handelte. boolean |
orders[index].timestamp | Der Zeitstempel, der angibt, wann die Bestellung in UTC/GMT aufgegeben wurde. timestamp |
totalCount | Die Gesamtanzahl der abgerufenen Live- und Testbestellungen. integer |
Bestellnummern
Erfahren Sie, wie der Endpunkt für Bestellnummern funktioniert.
Der Endpunkt
orderNumberswird verwendet, um sicher eine Liste von Bestellnummern abzurufen, die über das Zonos Checkout abgeschlossen wurden. Er wird normalerweise für die Bestellabstimmung verwendet, um sicherzustellen, dass alle Bestellungen ab einem bestimmten Datum oder einer Bestell-ID importiert wurden, sowie für Bestellungen innerhalb eines Datumsbereichs.