Endpoint
POST | https://api.iglobalstores.com/v1/orderNumbers
Richiesta HTTPS
| Campo↕ | Note↕ |
|---|---|
| Metodo HTTP | POST |
| Endpoint | https://api.iglobalstores.com/v1/orderNumbers |
| Protocollo | HTTPS |
| Formato messaggio | JSON |
| Header HTTP Accept | Accept: application/json |
| Header HTTP Content-Type | Content-Type: application/json |
Chiave/valore JSON nel corpo della richiesta
Formato messaggio: JSON
1
{2
"store": "999",3
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",4
"sinceOrderId": "999-99999"5
}Definizioni JSON della richiesta
| campo↕ | note↕ |
|---|---|
missingMerchantOrderId OPZIONALE, se viene passata un'altra opzione di parametro | Questo parametro viene utilizzato per interrogare un insieme di ordini nelle ultime due settimane a cui manca il merchantOrderId. Quando il merchantOrderId viene inviato tramite l'endpoint API updateMerchantOrderID, gli ordini non appariranno più in questa query.boolean: true/false |
secret OBBLIGATORIO | GUID segreto API fornito da Zonos. string |
sinceDate OPZIONALE, se viene passato il parametro sinceOrderId. | Questo parametro viene utilizzato per interrogare un insieme di ordini successivi a una determinata data.sinceDate e sinceOrderId non possono essere inviati entrambi.string - data UTC/GMT; formato: yyyymmdd |
sinceOrderId OPZIONALE, se viene passato il parametro sinceDate / throughDate | L'ID ordine Zonos, può essere passato con o senza l'ID del tuo negozio e il trattino (esempio: 123-45678 o 45678).Nota: questo parametro verrà utilizzato per interrogare un insieme di ordini successivi a un particolare ordine Zonos. sinceDate e sinceOrderId non possono essere inviati entrambi.integer / string |
statuses OPZIONALE | Questo parametro viene utilizzato per includere lo stato attuale dell'ordine e il merchantOrderId nella risposta. Se è presente nella richiesta, indipendentemente dal valore, includerà gli stati.boolean: true |
store OBBLIGATORIO | ID negozio fornito da Zonos.integer |
throughDate OPZIONALE | Questo parametro viene utilizzato per interrogare un insieme di ordini in un determinato intervallo di date.Deve essere passato insieme al parametro sinceDate.string - data UTC/GMT; formato: yyyymmdd |
Risposta HTTPS
Formato messaggio: 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
}Risposte di errore HTTP
| Errore↕ | Significato↕ |
|---|---|
| 406 - Not Acceptable | Entità HTML. L'header HTTP "Accept" non è valido. |
| 415 - Unsupported media type | Entità HTML. L'header HTTP "Content-Type" non è valido. |
| 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" |
Definizioni JSON della risposta
| campo↕ | note↕ |
|---|---|
error | Questo parametro sarà presente nella risposta solo quando si è verificato un errore e conterrà una descrizione della causa.string |
orderCount | Il conteggio totale degli ordini live recuperati.integer |
order.testOrderCount | Il conteggio totale degli ordini di test recuperati.integer |
orders | Un elenco di mappe di ordini.string |
orders[index].id | L'ID ordine Zonos completo, incluso l'ID del negozio e il trattino.string |
orders[index].merchantOrderId | MerchantOrderId associato all'ordine tramite l'endpoint del servizio API updateMerchantOrderId.string |
orders[index].orderStatus | Lo stato attuale dell'ordine, per i possibili valori.string |
orders[index].orderStatusDate | L'epoch che rappresenta il momento in cui lo stato è stato aggiornato per l'ultima volta.integer |
orders[index].orderStatusDateString | Il timestamp che rappresenta il momento in cui lo stato è stato aggiornato per l'ultima volta in UTC/GMT.timestamp |
orders[index].testOrder | Indica se l'ordine era un "ordine di test" o un "ordine live".boolean |
orders[index].timestamp | Il timestamp che rappresenta il momento in cui l'ordine è stato effettuato in UTC/GMT.timestamp |
totalCount | Il conteggio totale degli ordini live e di test recuperati.integer |
Order numbers
Scopri come funziona l'endpoint Order numbers.L'endpoint
orderNumbersviene utilizzato per recuperare in modo sicuro un elenco di numeri d'ordine completati tramite Zonos Checkout. Viene normalmente utilizzato per la riconciliazione degli ordini, per garantire che tutti gli ordini siano stati importati a partire da una data o da un orderID, così come gli ordini in un intervallo di date.