Attributi
Coppie chiave/valore JSON nel corpo della richiesta
POST https://api.iglobalstores.com/v1/createTempCart
campo | note |
---|---|
boxCount | Esempio di valore: 22x15x15(1),8x8x4(2),32x22x14(1) Formato: Elenco separato da virgole delle dimensioni delle scatole e del conteggio. Nell'esempio sopra, ci sono un totale di 4 scatole. La prima scatola nell'elenco sarà lunga 22 pollici, larga 15 pollici e alta 15 pollici. Ci sarà solo una scatola utilizzata per quella dimensione. Ci saranno due scatole di dimensione: 8x8x4 pollici. È accettabile passare la stessa dimensione della scatola più volte se è più facile per te, in questo modo: “22x15x15(1),22x15x15(1)”, il che significa 2 scatole di dimensione: 22x15x15 pollici. Questo campo descrive le scatole che verranno utilizzate per spedire l'ordine. Non ci si aspetta che un commerciante conosca questo al momento dell'ordine; tuttavia, se è noto, può essere passato nel formato string . |
contShoppingURL | Questo campo viene utilizzato per passare un URL per sovrascrivere l'HREF del pulsante “Continua a fare acquisti” all'interno del Zonos Checkout. string |
domesticShippingCharge | Questo campo viene utilizzato per passare un costo di spedizione domestica al Zonos Checkout, e l'importo verrà aggiunto alla spedizione. Questo può essere configurato per aggiungere il totale della spedizione o essere suddiviso come un elemento separato. numero positivo in virgola mobile, due decimali |
externalConfirmationPageURL | Questo campo viene utilizzato per passare un URL della tua pagina di conferma dell'ordine / pagina di ringraziamento. Dopo che un cliente ha completato il pagamento all'interno del Zonos Checkout, verrà reindirizzato a questo URL per la conferma dell'ordine. Questo URL è frequentemente utilizzato per attivare una chiamata all'endpoint del servizio API “orderDetail” di Zonos per recuperare i dettagli dell'ordine e importare l'ordine nel sistema. string |
footerHTML | Questo campo viene utilizzato per passare una stringa HTML codificata in URL. Questa stringa HTML verrà decodificata e posizionata prima del tag di chiusura del corpo nella pagina checkout. Comunemente utilizzata per passare codice per re-marketing, analisi, ecc. string codificata in URL |
items OBBLIGATORIO | Questo campo è un elenco di mappe di articoli. string JSON |
items[index].countryOfOrigin | Questo campo viene utilizzato per passare il paese di origine dell'articolo. Il parametro deve essere il paese codice ISO a due lettere. string |
items[index].description OBBLIGATORIO | Questo campo viene utilizzato per passare una descrizione completa dell'articolo della riga del carrello, comprese eventuali opzioni, colori, ecc. string |
items[index].height | Questo campo viene utilizzato per passare l'altezza dell'articolo ed è altamente raccomandato per preventivi di spedizione accurati. Le unità di altezza sono OBBLIGATORIE string - numero positivo in virgola mobile, due decimali / intero (pollici) |
items[index].imageURL OBBLIGATORIO | Questo campo viene utilizzato per passare l'URL all'immagine del prodotto dell'articolo. L'URL deve essere HTTPS per essere visualizzato all'interno del Zonos Checkout. string / URL HTTPS |
items[index]itemBrand | Questo campo viene utilizzato per passare il marchio dell'articolo string |
items[index]itemCategory | Questo campo è utilizzato per passare la categoria dell'oggetto e può essere passato delimitato da pipe se l'oggetto ha più di una categoria. Valori di esempio: “scarpe” o “scarpe|scarpe-sportive|scarpe-scontate” string |
items[index]itemCustomization | Questo campo è utilizzato per passare dettagli aggiuntivi sull'oggetto che non sono mostrati nel Zonos Checkout; tuttavia, questi possono essere recuperati tramite l'endpoint del servizio API “orderDetail”. |
items[index]itemHSCode | Questo campo è utilizzato per passare il codice HS dell'oggetto e può essere con o senza punti. Valori di esempio: “3926901000” o “3926.90.1000” string |
items[index].itemURL | Questo campo è utilizzato per passare l'URL alla pagina del prodotto dell'oggetto. string / URL |
items[index].length | Questo campo è utilizzato per passare la lunghezza dell'oggetto ed è altamente raccomandato per preventivi di spedizione accurati. Le unità di lunghezza sono OBBLIGATORIE string - numero decimale positivo, due decimali / intero (pollici) |
items[index].nonShippable | Questo campo è utilizzato per indicare se l'oggetto deve essere incluso nei calcoli di spedizione, dazi e tasse. Download digitali, codici sconto, spese di gestione, ecc. devono essere passati con un valore di “true”. booleano: true o false |
items[index].productId | Questo campo è utilizzato per passare la quantità dell'oggetto. string |
items[index].quantity OBBLIGATORIO | Questo campo è utilizzato per passare la quantità dell'oggetto. string |
items[index].sku | Questo campo è utilizzato per passare lo SKU / UPC / ecc. dell'oggetto. string |
items[index].unitPrice OBBLIGATORIO | Questo campo è utilizzato per passare il prezzo unitario dell'oggetto. numero decimale positivo, due decimali / intero |
items[index].weight | Questo campo è utilizzato per passare il peso dell'oggetto ed è altamente raccomandato per preventivi di spedizione accurati. Le unità di peso sono predefinite in “LBS” a meno che non venga passata un'altra unità di peso in items[index].itemWeightUnits``string - numero decimale positivo, due decimali / intero |
items[index].weightUnits | Questo campo è utilizzato per sovrascrivere le unità di peso predefinite dell'oggetto. Le unità di peso dell'oggetto sono predefinite in “LBS” a meno che non venga passata un'altra unità di peso in questo campo. string - "LB", "OZ", "KG", o "G” |
items[index].width | Questo campo è utilizzato per passare la larghezza dell'oggetto ed è altamente raccomandato per preventivi di spedizione accurati. Le unità di larghezza sono OBBLIGATORIE string - numero decimale positivo, due decimali / intero (pollici) |
misc1 - misc6 | Questo campo è utilizzato per passare dati vari associati all'ordine tramite l'API Zonos da recuperare insieme ai dati dell'ordine restituiti dall'endpoint del servizio API “orderDetail” di Zonos. string |
referenceId | Questo campo è utilizzato per passare un valore di identificazione di riferimento unico per il carrello/sessione/ecc. nel tuo sistema. Questo può essere utilizzato per cercare l'ID ordine di Zonos tramite l'endpoint del servizio API “orderDetail” di Zonos. string |
storeId OBBLIGATORIO | ID del negozio fornito da Zonos. intero |
Tipi di dati string aggiuntivi
items[index].itemDescriptionLong
items[index].itemDescriptionDetailed
items[index].itemFabricContent
items[index].itemColor
items[index].itemLtlClass
items[index].status
items[index].itemMaterial
Sconti, coupon e codici promozionali
Per inviare sconti, coupon e codici promozionali a Zonos tramite il post del server, devono essere passati come un oggetto separato con un valore negativo per i parametri: “unitPrice”
e “nonShippable”:true
.
ESEMPIO MAPPATURA SCONTO
{
"description": "Discount (10OFF) - 10% OFF",
"unitPrice": -15.5,
"quantity": 1,
"nonShippable": true
}
Risposta HTTPS
Risposta HTTP di successo
Formato del messaggio: JSON
ESEMPIO DI RISPOSTA DI SUCCESSO
{
"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"
}
Definizioni JSON di risposta
campo | note |
---|---|
tempCartUUID | Questo parametro conterrà un GUID assegnato al carrello internazionale del tuo cliente e creato nel sistema Zonos. Questo campo sarà passato tramite un parametro string di query URL mentre si reindirizza il browser dell'utente a Zonos Checkout. |
Risposte HTTP di errore
Codice di errore | significato |
---|---|
400 | Carattere imprevisto nel corpo della richiesta. |
406 | Non accettabile. L'intestazione HTTP per "Accept" è non valida. |
415 | Tipo di media non supportato. L'intestazione HTTP per "Content-Type" è non valida. |
422 | Entità non elaborabile. |
500 | "storeId" era errato o il corpo JSON non poteva essere analizzato. |
ESEMPIO DI RISPOSTA DI ERRORE
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Error 422 Unprocessable Entity</title>
</head>
<body>
<h2>HTTP ERROR 422</h2>
<p>
Problem accessing /v2/createTempCart. Reason:
<pre>Unprocessable Entity</pre>
</p>
<h2>The request entity had the following errors:</h2>
<ul>
<li>items may not be empty (was null)</li>
<li>items may not be null (was null)</li>
</ul>
</body>
</html>
Reindirizzamento a Zonos Checkout
Dopo aver ricevuto una risposta positiva contenente il tempCartUUID
, il tuo server invierà un reindirizzamento dal browser del cliente a Zonos Checkout con i parametri della stringa URL appropriati trattati di seguito.
Esempio di URL di reindirizzamento: https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
Nota: [yourassignedsubdomain] - Contatta un membro del tuo team di implementazione Zonos per ricevere il tuo sottodominio Zonos.com.
Parametri della richiesta URL
campo | note |
---|---|
tempCartUUID OBBLIGATORIO | Questo valore viene ottenuto chiamando l'endpoint del servizio API createTempCart di Zonos. string / GUID |
country | Codice ISO a due lettere del paese di destinazione codice ISO dei paesi. Ti consigliamo vivamente di passare questo parametro per migliorare l'esperienza dell'utente. Il parametro country preselezionerà il paese di destinazione all'interno di Zonos Checkout. Quando utilizzi Zonos Hello JS (JavaScript) sul sito, puoi ottenere questo valore chiamando il metodo JavaScript: zonos.country() . string (Lunghezza: 2) |
Ulteriori tipi di dati stringa
customerName
customerCompany
customerEmail
customerPhone
customerAltPhone
customerAddress1
customerAddress2
customerCity
customerState
customerZip
Crea un checkout
Esplora le coppie chiave/valore coinvolte nella creazione di un checkout.
Questo endpoint API viene utilizzato per inviare informazioni sul carrello e sugli articoli dal carrello del cliente all'API Zonos.
Riceverai una risposta JSON contenente un
tempCartUUID
, un identificatore univoco del carrello nel sistema Zonos. Questo verrà utilizzato per reindirizzare il cliente al Zonos Checkout per completare l'ordine.