Endpoints
Richiedi dettagli ordine completato
POST | https://api.iglobalstores.com/2.0/order-completed - Crea una nuova richiesta per informazioni relative a un ordine completato.
Richiesta HTTPS
| Campo | Note |
|---|---|
| Metodo HTTP | POST |
| URL endpoint | https://api.iglobalstores.com/2.0/order-completed |
| Protocollo | HTTPS |
| Formato messaggio | JSON |
| Intestazione HTTP di accettazione | Accept: application/json |
| Intestazione HTTP del token di sicurezza | serviceToken: your-test-token-valueAggiungi un'intestazione alla tua richiesta HTTPS chiamata serviceToken con un valore del tuo token di sicurezza API di test. (Contatta il tuo Account Manager per questo token.) |
| Intestazione HTTP Content-Type | Content-Type: application/jsonPoiché invierai dati JSON al servizio, aggiungi un'intestazione alla tua richiesta HTTPS chiamata Content-Type con un valore di application/json |
Coppie chiave/valore JSON nel corpo della richiesta
Formato messaggio: JSON
Esempio di richiesta
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
{
"billingAddress": {
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"countryCode": "CA",
"postalCode": "T2P 5G8",
"state": "Alberta",
"stateCode": null
},
"billingCompany": null,
"billingEmail": "jdoe@jdoe.com",
"billingName": "John E. Doe",
"billingPhone": "+1 555-555-5555",
"orderGrandTotal": 1225.89,
"orderNumber": "854725421",
"paymentTypeCode": "PAYPAL",
"prepaidDutyTax": true,
"shippingQuoteId": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"shipToCompany": null,
"shipToEmail": "jdoe@jdoe.com",
"shipToName": "John Doe",
"shipToPhone": "+1 555-555-5555"
}
Definizioni JSON della richiesta
| Campo | Note |
|---|---|
billingAddress OBBLIGATORIO | Questo è l'indirizzo di fatturazione dell'ordine. Questo è una mappa contenente i seguenti campi di indirizzo: address1, address2, address3, city, state, stateCode, postalCode e countryCode. Questi campi contenuti sono obbligatori o non obbligatori in base al paese. L'endpoint di localizzazione restituisce quali specifici campi di indirizzo sono obbligatori o meno per ciascun paese. Nota: stateCode non è mai obbligatorio e non è dichiarato nell'endpoint di localizzazione. Puoi passare stateCode, se disponibile. |
billingCompany OPZIONALE | Questo è il nome della compagnia di fatturazione dell'ordine. |
billingEmail OBBLIGATORIO | Questo è l'indirizzo email di fatturazione dell'ordine. |
billingName OBBLIGATORIO | Questo è il nome completo di fatturazione dell'ordine. |
billingPhone OBBLIGATORIO | Questo è il numero di telefono di fatturazione dell'ordine. |
items[index].orderGrandTotal OBBLIGATORIO | Questo è il totale complessivo pagato dallo shopper per il loro ordine in USD (Dollari Statunitensi). Si prega di fornire senza virgole, senza il simbolo del dollaro “$”, e con due decimali. Esempio di valore: 2102.99 |
items[index].orderNumber OBBLIGATORIO | Questo è il numero dell'ordine per il nuovo ordine completato. Esempio di valore: 854725421 |
paymentTypeCode OBBLIGATORIO | Il metodo di pagamento utilizzato dallo shopper per pagare il loro ordine. Esempi di valori: PayPal o Visa o MC o AMEX o DISC |
prepaidDutyTax OBBLIGATORIO | Lo shopper ha scelto di prepay i propri dazi e tasse di importazione o è stato costretto a prepay? In tal caso, impostare su true; se no, impostare su false. Esempi di valori: true o false |
shippingQuoteId OBBLIGATORIO | Questo è l'ID del preventivo di spedizione scelto dallo shopper. I dettagli del carrello devono essere gli stessi di quando sono stati recuperati i preventivi di spedizione. Se i dettagli del carrello sono cambiati, allora dovresti aver richiesto nuovi preventivi di spedizione prima di completare l'ordine dello shopper. |
shipToCompany OPZIONALE | Questo è il nome della compagnia della persona che riceverà l'ordine spedito. |
shipToEmail OBBLIGATORIO | Questo è l'indirizzo email della persona che riceverà l'ordine spedito. |
shipToName OBBLIGATORIO | Questo è il nome completo della persona che riceverà l'ordine spedito. |
shipToPhone OBBLIGATORIO | Questo è il numero di telefono della persona che riceverà l'ordine spedito. |
Risposta HTTPS
Formato del messaggio: JSON
Esempio di risposta solo per Canada e Australia
Nota: Le risposte effettive conterranno tutti i paesi supportati.
Esempio di risposta
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
Definizioni JSON di risposta
| Campo | Note |
|---|---|
deniedParty | Questa è una mappa dei risultati dello screening delle parti negate. Se impostato su null, allora lo screening delle parti negate non è stato eseguito. Contatta il tuo rappresentante Zonos se incontri questo problema. |
deniedParty.flagged | Se questo ordine ha corrisposto a un record nelle liste consolidate delle parti negate di Zonos. Se vero, rivedi questo ordine prima di elaborarlo. In caso di dubbio, non elaborare un ordine contrassegnato come vero. Valori di esempio: true o false |
deniedParty.source | Se il campo contrassegnato è stato impostato su true, questo campo conterrà riferimenti alla fonte utili per rivedere il motivo per cui l'ordine è stato contrassegnato come corrispondente a una parte negata. |
igOrderId | Identificatore Zonos per l'ordine appena completato. Valore di esempio: e55a4efc-e615-49af-b3a4-afcda87e9e5e |
API Legacy Order Completed
Scopri come funziona l'API Legacy Order Complete.L'endpoint Order Completed accetta i dettagli finali dell'ordine del cliente, verifica i dettagli dell'ordine per le parti negate e restituisce i risultati insieme a un ID ordine specifico per Zonos.