Esplora le coppie chiave/valore coinvolte nella creazione di un checkout.
Questo endpoint API viene utilizzato per inviare le informazioni del carrello e gli 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 a Zonos Checkout per completare l'ordine.
Coppie chiave/valore JSON nel corpo della richiesta
POST https://api.iglobalstores.com/v1/createTempCart
campo↕
note↕
boxCount
Valore di esempio: 22x15x15(1),8x8x4(2),32x22x14(1) Formato: elenco separato da virgole delle dimensioni delle scatole e del relativo conteggio. Nell'esempio sopra, ci sono in totale 4 scatole. La prima scatola dell'elenco sarà lunga 22 pollici, larga 15 pollici e alta 15 pollici. Verrà utilizzata solo una scatola di quella dimensione. Ci saranno due scatole di dimensione: 8x8x4 pollici. È accettabile indicare più volte la stessa dimensione di scatola se per te è più semplice, ad esempio: "22x15x15(1),22x15x15(1)", 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 il commerciante conosca questa informazione al momento dell'ordine; tuttavia, se è nota, può essere fornita nel formato string.
contShoppingURL
Questo campo viene utilizzato per passare un URL che sovrascrive l'HREF del pulsante "Continue Shopping" all'interno di Zonos Checkout. string
domesticShippingCharge
Questo campo viene utilizzato per passare un costo di spedizione nazionale a Zonos Checkout; l'importo verrà aggiunto alla spedizione. Può essere configurato per essere incluso nel totale della spedizione oppure visualizzato come voce separata. positive floating point, two decimal places
externalConfirmationPageURL
Questo campo viene utilizzato per passare l'URL della pagina di conferma dell'ordine / pagina di ringraziamento. Dopo che il cliente completa il pagamento all'interno di Zonos Checkout, verrà reindirizzato a questo URL per la conferma dell'ordine. Questo URL viene spesso utilizzato per attivare una chiamata all'endpoint del servizio API "orderDetail" di Zonos, per recuperare i dettagli dell'ordine e importarlo nel sistema. string
footerHTML
Questo campo viene utilizzato per passare una stringa HTML codificata come URL. Questa stringa HTML verrà decodificata e inserita prima del tag di chiusura body nella pagina di checkout. Comunemente utilizzato per passare codice per remarketing, analytics, ecc. URL encoded string
items
REQUIRED
Questo campo è un elenco di mappe degli articoli. JSON string
items[index].countryOfOrigin
Questo campo viene utilizzato per passare il paese di origine dell'articolo. Il parametro deve essere il codice ISO a due lettere del paese. string
items[index].description
REQUIRED
Questo campo viene utilizzato per passare una descrizione completa dell'articolo della voce del carrello, incluse eventuali opzioni dell'articolo, colori, ecc. string
items[index].height
Questo campo viene utilizzato per passare l'altezza dell'articolo ed è altamente consigliato per preventivi di spedizione precisi. Le unità di altezza sono
REQUIRED
in pollici. string - positive floating point, two decimal places / integer (inches)
items[index].imageURL
REQUIRED
Questo campo viene utilizzato per passare l'URL dell'immagine del prodotto dell'articolo. L'URL deve essere HTTPS per poter essere visualizzato all'interno di Zonos Checkout. string / HTTPS URL
items[index]itemBrand
Questo campo viene utilizzato per passare il brand dell'articolostring
items[index]itemCategory
Questo campo viene utilizzato per passare la categoria dell'articolo e può essere fornito separato da pipe se l'articolo ha più di una categoria. Valori di esempio: "shoes" oppure "shoes|sport-shoes|discount-shoes"string
items[index]itemCustomization
Questo campo viene utilizzato per passare dettagli aggiuntivi sull'articolo che non vengono mostrati in Zonos Checkout; tuttavia, possono essere recuperati tramite l'endpoint del servizio API "orderDetail".
items[index]itemHSCode
Questo campo viene utilizzato per passare il codice HS dell'articolo e può essere fornito con o senza punti. Valori di esempio: "3926901000" oppure "3926.90.1000"string
items[index].itemURL
Questo campo viene utilizzato per passare l'URL della pagina del prodotto dell'articolo. string / URL
items[index].length
Questo campo viene utilizzato per passare la lunghezza dell'articolo ed è altamente consigliato per preventivi di spedizione precisi. Le unità di lunghezza sono
REQUIRED
in pollici. string - positive floating point, two decimal places / integer (inches)
items[index].nonShippable
Questo campo viene utilizzato per indicare se l'articolo deve essere incluso nel calcolo di spedizione, dazi e imposte. Download digitali, codici di sconto, spese di gestione, ecc. devono essere passati con un valore "true". boolean: true or false
items[index].productId
Questo campo viene utilizzato per passare la quantità della voce. string
items[index].quantity
REQUIRED
Questo campo viene utilizzato per passare la quantità della voce. string
items[index].sku
Questo campo viene utilizzato per passare lo SKU / UPC / ecc. dell'articolo. string
items[index].unitPrice
REQUIRED
Questo campo viene utilizzato per passare il prezzo unitario della voce. positive floating point, two decimal places / integer
items[index].weight
Questo campo viene utilizzato per passare il peso dell'articolo ed è altamente consigliato per preventivi di spedizione precisi. Le unità di peso sono impostate su "LBS" per impostazione predefinita, a meno che non venga passata un'altra unità di peso in items[index].itemWeightUnits``string - positive floating point, two decimal places / integer
items[index].weightUnits
Questo campo viene utilizzato per sovrascrivere le unità di peso predefinite dell'articolo. Le unità di peso dell'articolo sono impostate su "LBS" per impostazione predefinita, a meno che non venga passata un'altra unità di peso in questo campo. string - "LB", "OZ", "KG", or "G”
items[index].width
Questo campo viene utilizzato per passare la larghezza dell'articolo ed è altamente consigliato per preventivi di spedizione precisi. Le unità di larghezza sono
REQUIRED
in pollici. string - positive floating point, two decimal places / integer (inches)
misc1 - misc6
Questo campo viene 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 viene utilizzato per passare un valore identificativo di riferimento univoco per il carrello/sessione/ecc. nel tuo sistema. Può essere utilizzato per individuare l'ID ordine Zonos tramite l'endpoint del servizio API "orderDetail" di Zonos. string
Per inviare sconti, coupon e codici promozionali a Zonos tramite il post del server, devono essere passati come articolo separato con un valore negativo per i parametri: "unitPrice" e "nonShippable":true.
Questo parametro conterrà un GUID assegnato al carrello internazionale del tuo cliente e creato nel sistema Zonos. Questo campo verrà passato tramite un parametro query URL string durante il reindirizzamento del browser dell'utente a Zonos Checkout.
Risposte di errore HTTP
Codice di errore↕
significato↕
400
Carattere imprevisto nel corpo della richiesta.
406
Not Acceptable. L'header HTTP "Accept" non è valido.
415
Unsupported media type. L'header HTTP "Content-Type" non è valido.
422
Unprocessable entity.
500
"storeId" non era corretto oppure il corpo JSON non è stato analizzato correttamente.
Dopo aver ricevuto una risposta positiva contenente il tempCartUUID, il tuo server invierà un reindirizzamento dal browser del cliente a Zonos Checkout con gli opportuni parametri della query string dell'URL descritti di seguito.
URL di reindirizzamento di esempio: https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
Nota: [yourassignedsubdomain] - Contatta il membro del team di implementazione Zonos per ricevere il tuo sottodominio Zonos.com.
Parametri della richiesta URL
campo↕
note↕
tempCartUUID
REQUIRED
Questo valore si ottiene chiamando l'endpoint del servizio API Zonos createTempCart. string / GUID
country
Codice ISO a due lettere del paese di destinazione. Consigliamo vivamente di passare questo parametro per una migliore esperienza 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 (Length: 2)
Crea un checkout
Crea un checkout
Esplora le coppie chiave/valore coinvolte nella creazione di un checkout.
Questo endpoint API viene utilizzato per inviare le informazioni del carrello e gli 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 a Zonos Checkout per completare l'ordine.Attributi
Coppie chiave/valore JSON nel corpo della richiesta
POST
https://api.iglobalstores.com/v1/createTempCartboxCountFormato: elenco separato da virgole delle dimensioni delle scatole e del relativo conteggio. Nell'esempio sopra, ci sono in totale 4 scatole. La prima scatola dell'elenco sarà lunga 22 pollici, larga 15 pollici e alta 15 pollici. Verrà utilizzata solo una scatola di quella dimensione. Ci saranno due scatole di dimensione: 8x8x4 pollici. È accettabile indicare più volte la stessa dimensione di scatola se per te è più semplice, ad esempio: "22x15x15(1),22x15x15(1)", 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 il commerciante conosca questa informazione al momento dell'ordine; tuttavia, se è nota, può essere fornita nel formato
string.contShoppingURLstringdomesticShippingChargepositive floating point, two decimal placesexternalConfirmationPageURLstringfooterHTMLURL encoded stringitemsREQUIRED
JSON stringitems[index].countryOfOriginstringitems[index].descriptionREQUIRED
stringitems[index].heightREQUIRED
string - positive floating point, two decimal places / integer (inches)items[index].imageURLREQUIRED
string / HTTPS URLitems[index]itemBrandstringitems[index]itemCategoryValori di esempio: "shoes" oppure "shoes|sport-shoes|discount-shoes"
stringitems[index]itemCustomizationitems[index]itemHSCodeValori di esempio: "3926901000" oppure "3926.90.1000"
stringitems[index].itemURLstring / URLitems[index].lengthREQUIRED
string - positive floating point, two decimal places / integer (inches)items[index].nonShippableboolean: true or falseitems[index].productIdstringitems[index].quantityREQUIRED
stringitems[index].skustringitems[index].unitPriceREQUIRED
positive floating point, two decimal places / integeritems[index].weightitems[index].itemWeightUnits``string - positive floating point, two decimal places / integeritems[index].weightUnitsstring - "LB", "OZ", "KG", or "G”items[index].widthREQUIRED
string - positive floating point, two decimal places / integer (inches)misc1 - misc6stringreferenceIdstringstoreIdREQUIRED
integerTipi di dati stringa aggiuntivi
items[index].itemDescriptionLongitems[index].itemDescriptionDetaileditems[index].itemFabricContentitems[index].itemColoritems[index].itemLtlClassitems[index].statusitems[index].itemMaterialSconti, coupon e codici promozionali
Per inviare sconti, coupon e codici promozionali a Zonos tramite il post del server, devono essere passati come articolo separato con un valore negativo per i parametri:
"unitPrice"e"nonShippable":true.{"description": "Discount (10OFF) - 10% OFF","unitPrice": -15.5,"quantity": 1,"nonShippable": true}Risposta HTTPS
Risposta HTTP di successo
Formato messaggio: JSON
{"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"}Definizioni JSON della risposta
tempCartUUIDstringdurante il reindirizzamento del browser dell'utente a Zonos Checkout.Risposte di errore HTTP
HTTP ERROR 422
Problem accessing /v2/createTempCart. Reason:The request entity had the following errors:
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 gli opportuni parametri della query string dell'URL descritti di seguito.Parametri della richiesta URL
tempCartUUIDREQUIRED
createTempCart.string / GUIDcountrycountrypreselezionerà 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(Length: 2)Tipi di dati stringa aggiuntivi
customerNamecustomerCompanycustomerEmailcustomerPhonecustomerAltPhonecustomerAddress1customerAddress2customerCitycustomerStatecustomerZipQuesta pagina è stata utile?