Endpunkt
POST | https://api.iglobalstores.com/v1/orderNumbers
HTTPS-Anfrage
| Feld↕ | Hinweise↕ |
|---|---|
| HTTP method | POST |
| Endpoint | https://api.iglobalstores.com/v1/orderNumbers |
| Protocol | HTTPS |
| Message format | JSON |
| Accept HTTP header | Accept: application/json |
| Content-Type HTTP header | Content-Type: application/json |
JSON-Schlüssel-Wert im Request-Body
Nachrichtenformat: JSON
1
{2
"store": "999",3
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",4
"sinceOrderId": "999-99999"5
}Definitionen der Request-JSON
| Feld↕ | Hinweise↕ |
|---|---|
missingMerchantOrderId OPTIONAL, if passing another parameter option | Abfrage von Bestellungen der letzten zwei Wochen ohne merchantOrderId. Nach Übermittlung über updateMerchantOrderID erscheinen Bestellungen nicht mehr in dieser Abfrage.boolean: true/false |
secret REQUIRED | Von Zonos bereitgestelltes API-Secret-GUID. string |
sinceDate OPTIONAL, if passing sinceOrderId parameter. | Abfrage von Bestellungen nach einem bestimmten Datum. sinceDate und sinceOrderId dürfen nicht beide gesendet werden.string - date UTC/GMT; format: yyyymmdd |
sinceOrderId OPTIONAL, if passing sinceDate / throughDate parameter | Zonos-Bestell-ID, mit oder ohne Store-ID und Bindestrich (Beispiel: 123-45678 oder 45678). Abfrage von Bestellungen nach einer bestimmten Zonos-Bestellung. sinceDate und sinceOrderId dürfen nicht beide gesendet werden.integer / string |
statuses OPTIONAL | Aktuellen Bestellstatus und merchantOrderId in der Antwort einschließen. Bei Vorhandensein im Request werden Status unabhängig vom Wert mitgeliefert.boolean: true |
store REQUIRED | Von Zonos bereitgestellte Store-ID.integer |
throughDate OPTIONAL | Abfrage von Bestellungen in einem Datumsbereich. Muss zusammen mit sinceDate übergeben werden.string - date UTC/GMT; format: yyyymmdd |
HTTPS-Antwort
Nachrichtenformat: 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
}Fehler-HTTP-Antworten
| Fehler↕ | Bedeutung↕ |
|---|---|
| 406 - Not Acceptable | HTML Entity. HTTP-Header „Accept“ ist ungültig. |
| 415 - Unsupported media type | HTML Entity. HTTP-Header „Content-Type“ ist ungültig. |
| 200 | „error“:”could not parse input” |
| 200 | „error“:”orderId: 999-99999 is not a valid orderId” |
| 200 | „error“:”Parameter orderId or referenceId is required.” |
| 200 | „error“:”Cannot specify both Parameters orderId and referenceId.” |
| 200 | „error“:”Could not process order details.” |
| 200 | „error“:”Invalid security credentials” |
Definitionen der Antwort-JSON
| Feld↕ | Hinweise↕ |
|---|---|
error | Nur bei Fehlern in der Antwort; enthält eine Fehlerbeschreibung.string |
orderCount | Gesamtanzahl abgerufener Live-Bestellungen.integer |
order.testOrderCount | Gesamtanzahl abgerufener Testbestellungen.integer |
orders | Liste von Bestell-Maps.string |
orders[index].id | Vollständige Zonos-Bestell-ID inkl. Store-ID und Bindestrich.string |
orders[index].merchantOrderId | MerchantOrderId über den updateMerchantOrderId-API-Endpunkt.string |
orders[index].orderStatus | Aktueller Bestellstatus.string |
orders[index].orderStatusDate | Epoch-Zeitstempel der letzten Statusaktualisierung.integer |
orders[index].orderStatusDateString | Zeitstempel der letzten Statusaktualisierung in UTC/GMT.timestamp |
orders[index].testOrder | Gibt an, ob es eine Test- oder Live-Bestellung war.boolean |
orders[index].timestamp | Zeitstempel der Bestellung in UTC/GMT.timestamp |
totalCount | Gesamtanzahl abgerufener Live- und Testbestellungen.integer |
Bestellnummern
Erfahren Sie, wie der Bestellnummern-Endpunkt funktioniert.Der
orderNumbers-Endpunkt ruft sicher eine Liste der über Zonos Checkout abgeschlossenen Bestellnummern ab. Er wird üblicherweise zur Bestellabstimmung genutzt, um sicherzustellen, dass alle Bestellungen ab einem Datum oder einer orderID sowie Bestellungen in einem Datumsbereich importiert wurden.