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 |
| Intestazione HTTP di accettazione | Accept: application/json |
| Intestazione HTTP Content-Type | Content-Type: application/json |
Chiave/valore JSON nel corpo della richiesta
Formato messaggio: JSON
ESEMPIO RICHIESTA: sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
ESEMPIO DI RICHIESTA: sinceDate
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
ESEMPIO DI RICHIESTA: sinceDate, throughDate
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
ESEMPIO DI RICHIESTA: missingMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
ESEMPIO DI RICHIESTA: stati
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
Definizioni JSON della richiesta
| campo | note |
|---|---|
missingMerchantOrderId OPZIONALE, se si passa un'altra opzione di parametro | Questo parametro viene utilizzato per interrogare un insieme di ordini nell'ultima settimana che mancano del merchantOrderId. Quando il merchantOrderId viene inviato tramite l'endpoint API updateMerchantOrderID, gli ordini non appariranno più in questa query.booleano: true/false |
secret OBBLIGATORIO | GUID segreto API fornito da Zonos. stringa |
sinceDate OPZIONALE, se si passa il parametro sinceOrderId. | Questo parametro viene utilizzato per interrogare un insieme di ordini dopo una data particolare.sinceDate e sinceOrderId non possono essere inviati entrambi.stringa - data UTC/GMT; formato: yyyymmdd |
sinceOrderId OPZIONALE, se si passa 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 dopo un particolare ordine Zonos. sinceDate e sinceOrderId non possono essere inviati entrambi.intero / stringa |
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.booleano: true |
store OBBLIGATORIO | ID negozio fornito da Zonos.intero |
throughDate OPZIONALE | Questo parametro viene utilizzato per interrogare un insieme di ordini tra un particolare intervallo di date.Deve essere passato insieme al parametro sinceDate .stringa - data UTC/GMT; formato: yyyymmdd |
Risposta HTTPS
Formato messaggio: JSON
ESEMPIO DI RISPOSTA DI SUCCESSO
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"
}
]
}
Esempio di risposta di successo con il parametro '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"
}
]
}
Esempio di risposta di errore
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
Risposte di errore HTTP
| Errore | Significato |
|---|---|
| 406 - Non accettabile | Entità HTML. L'intestazione HTTP “Accept” non è valida. |
| 415 - Tipo di media non supportato | Entità HTML. L'intestazione HTTP “Content-Type” non è valida. |
| 200 | “errore”:”impossibile analizzare l'input” |
| 200 | “errore”:”orderId: 999-99999 non è un orderId valido” |
| 200 | “errore”:”Il parametro orderId o referenceId è richiesto.” |
| 200 | “errore”:”Non è possibile specificare entrambi i parametri orderId e referenceId.” |
| 200 | “errore”:”Impossibile elaborare i dettagli dell'ordine.” |
| 200 | “errore”:”Credenziali di sicurezza non valide” |
Definizioni JSON di risposta
| campo | note |
|---|---|
errore | 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 attivi recuperati.integer |
order.testOrderCount | Il conteggio totale degli ordini di prova recuperati.integer |
ordini | Un elenco di mappe degli ordini.string |
ordini[indice].id | L'intero Zonos Order Id incluso l'id del negozio e il trattino.string |
ordini[indice].merchantOrderId | MerchantOrderId associato all'ordine tramite il servizio API updateMerchantOrderId endpoint.string |
ordini[indice].orderStatus | Lo stato attuale dell'ordine per i possibili valori.string |
ordini[indice].orderStatusDate | L'epoca che rappresenta quando lo stato è stato aggiornato per l'ultima volta.integer |
ordini[indice].orderStatusDateString | Il timestamp che rappresenta quando lo stato è stato aggiornato per l'ultima volta in UTC/GMT.timestamp |
ordini[indice].testOrder | Indica se l'ordine era un “ordine di prova” o “ordine attivo”.boolean |
ordini[indice].timestamp | Il timestamp che rappresenta quando l'ordine è stato effettuato in UTC/GMT.timestamp |
totalCount | Il conteggio totale di ordini attivi e di prova recuperati.integer |
Numeri d'ordine
Scopri come funziona l'endpoint dei numeri d'ordine.L'endpoint
orderNumbersviene utilizzato per recuperare in modo sicuro un elenco di numeri d'ordine completati tramite il 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 un orderID, così come per gli ordini all'interno di un intervallo di date.