Qual è la richiesta HTTPS per l'API Checkout?

La richiesta HTTPS per l'API Checkout include il metodo HTTP (POST), l'endpoint ('https://api.iglobalstores.com/v2/orderDetail'), il protocollo (HTTPS), il formato del messaggio (JSON) e gli header HTTP (Accept: application/json, Content-Type: application/json).

Quali sono le coppie chiave/valore JSON nel corpo della richiesta?

Le coppie chiave/valore JSON nel corpo della richiesta includono 'orderId', 'referenceId', 'secret' e 'storeId'. 'orderId' e 'referenceId' sono opzionali, ma uno dei due deve essere passato. 'secret' e 'storeId' sono obbligatori.

Quali sono le possibili risposte di errore HTTP?

Le possibili risposte di errore HTTP includono 415 (Unsupported media type), 406 (Not Acceptable), 400 (Bad Request) e 500 (Internal Server Error). Ogni codice di errore corrisponde a un tipo specifico di errore.

Quali sono le definizioni JSON della risposta?

Le definizioni JSON della risposta includono vari parametri relativi ai dettagli dell'ordine, come 'error', 'order', 'order.billingZip', 'orderboxCount', 'order.carrierAccountNumber' e molti altri. Ogni parametro fornisce informazioni specifiche sull'ordine.

Checkout•

HomeRiferimento API Checkout REST API Dettagli dell'ordine

Dettagli dell'ordine

Q: Qual è l'endpoint dell'API Checkout?

L'endpoint dell'API Checkout è 'orderDetail'. Questo endpoint API viene utilizzato per recuperare in modo sicuro i dettagli e lo stato di un ordine completato tramite Zonos Checkout.

Scopri come funziona l'endpoint Dettagli dell'ordine.

L'endpoint orderDetail viene utilizzato per recuperare in modo sicuro i dettagli e lo stato di un ordine completato tramite Zonos Checkout.

Endpoint

Nota: le chiavi di risposta possono essere modificate e/o è possibile che vengano aggiunte chiavi aggiuntive. Se utilizzerai l'endpoint, configura il tuo codice per adattarsi a queste possibilità.

POST | `https://api.iglobalstores.com/v2/orderDetail`

Richiesta HTTPS

campo↕	note↕
Metodo HTTP	POST
Endpoint	`https://api.iglobalstores.com/v2/orderDetail`
Protocollo	HTTPS
Formato messaggio	JSON
Header HTTP Accept	Accept: application/json
Header HTTP Content-Type	Content-Type: application/json

Coppie chiave/valore JSON nel corpo della richiesta

campo↕	note↕
`orderId` OPZIONALE, se viene passato il parametro `referenceId`	L'ID ordine Zonos può essere passato con o senza l'ID del tuo negozio e il trattino (esempio: 123-45678 o 45678). Nota: dopo il completamento dell'ordine e il pagamento, il cliente verrà reindirizzato a una pagina di completamento ordine / pagina di ringraziamento ospitata sul tuo dominio. L'URL conterrà un parametro querystring "orderId" che conterrà questo valore.`integer / string`
`referenceId` OPZIONALE, se viene passato il parametro "orderId"	Questo parametro viene utilizzato per cercare i dati di un ordine tramite il `referenceId` univoco passato nell'endpoint del servizio API `createTempCart`. Questo parametro deve essere omesso o nullo quando si intende cercare i dettagli dell'ordine in base al parametro `orderId`.`string`
`secret` OBBLIGATORIO	GUID segreto API fornito da Zonos`string`
`storeId` OBBLIGATORIO	ID negozio fornito da Zonos.`integer`

Risposte di errore HTTP

Codice errore↕	messaggio↕	significato↕
415	Unsupported media type	Entità HTML. L'header HTTP "Content-Type" non è valido.
406	Not Acceptable	Entità HTML. L'header HTTP "Accept" non è valido.
400	Bad Request	"error":"orderId: 999-99999 is not a valid orderId""error":"Could not find an order with orderId: 999-99999""error":"Invalid security credentials""error":"Invalid post body""error":"Parameter orderId or referenceId is required""error":"Cannot specify both Parameters orderId and referenceId""error":"No order found with orderId: 999-99999""error":"Parameter store required""error":"No order found with referenceId: 999999 for storeId: 999""error":"referenceId: 999999 for storeId: 999 has been duplicated""error":"Couldn't retrieve order with referenceId: 999999"
500	Internal Server Error	"error":"Couldn't process order details"

Definizioni JSON della risposta

campo↕	note↕
`error`	Questo parametro è presente solo quando si è verificato un errore e conterrà una descrizione dell'errore.`string`
`order`	Questa è una mappa dei dettagli dell'ordine.`JSON string`
`order.billingZip`	Indirizzo di fatturazione per l'ordine - i valori sono stati inseriti in Zonos Checkout.`string`
`orderboxCount`	Questo campo descrive le scatole che verranno utilizzate per spedire l'ordine, passate nella richiesta createTempCart .`string`
`order.carrierAccountNumber`	Il numero di account del corriere di spedizione proprio di un visitatore; utilizzato quando gli account del corriere del visitatore sono abilitati`string`
`order.carrierAccountShippingMethod`	Il metodo di spedizione selezionato sull'account del corriere di spedizione proprio del visitatore; utilizzato quando gli account del corriere del visitatore sono abilitati`string`
`order.cslListMatch`	Corrispondenza con la Consolidated Screening List (CSL). Un booleano che indica quando le informazioni del cliente hanno prodotto una corrispondenza nella US Consolidated Screening List e devono essere revisionate per una possibile affiliazione con parti negate.`boolean`
`order.customerSelectedShippingName`	Nome visualizzato dell'opzione di spedizione all'interno di Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Una mappa della ripartizione di dazi/imposteNota - Se applicabile, l'IPF (International Processing Fee) non è incluso.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Importo della commissione di intermediazione in USD; numero decimale positivo, due cifre decimali`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Importo della commissione di disborso in USD; numero decimale positivo, due cifre decimali`integer`
`order.dutyTaxesBreakdown.duty`	Importo del dazio in USD; numero decimale positivo, due cifre decimali`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Importo della commissione di prepagamento in USD; numero decimale positivo, due cifre decimali`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Importo IVA/imposta sulla commissione di disborso in USD; numero decimale positivo, due cifre decimali`integer`
`order.dutyTaxesBreakdown.vatTax`	Importo IVA/imposta in USD, non include l'IVA/imposta sulla commissione di disborso; numero decimale positivo, due cifre decimali`integer`
`order.dutyTaxesTotal`	Totale dazi e imposte in USD; numero decimale positivo, due cifre decimali`integer`
`order.foreignCurrencyCode`	Il codice valuta in cui è stato regolato il pagamento dell'ordine.`string`
`remittance_amount`	L'importo di denaro che deve essere rimesso a un determinato paese, ad es. IVA UK.`decimal`
`order.grandTotal`	Totale generale in USD; numero decimale positivo, due cifre decimali`integer`
`order.grandTotalForeign`	Totale generale nella valuta regolata; numero decimale positivo, due cifre decimali`integer`
`order.items`	Un elenco di mappe di articoliLa mappa dell'articolo contiene i dettagli sull'articolo passati a Zonos Checkout al momento della creazione del carrello temporaneoPer maggiori dettagli sulle proprietà degli articoli, consulta la documentazione API createTempCart `JSON string`
`order.itemsCount`	Conteggio delle voci dell'ordine`integer`
`order.itemsTotal`	Totale articoli / prodotti in USD; numero decimale positivo, due cifre decimali`integer`
`order.itemsTotalForeign`	Totale articoli / prodotti nella valuta regolata; numero decimale positivo, due cifre decimali`integer`
`order.items[index].height`	Numero decimale positivo, due cifre decimali`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Numero decimale positivo, due cifre decimali`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Numero decimale positivo, due cifre decimali`integer`
`order.items[index].width`	Numero decimale positivo, due cifre decimali`integer`
`order.items[index].unitPrice`	Numero decimale positivo, due cifre decimali`integer`
`order.merchantOrderId`	`MerchantOrderId` associato all'ordine tramite l'endpoint del servizio API updateMerchantOrderId .`string`
`order.misc1`	Valore aggiuntivo associato all'ordine tramite l'endpoint del servizio API createTempCart .`string`
`order.misc2`	Valore aggiuntivo associato all'ordine tramite l'endpoint del servizio API createTempCart .`string`
`order.misc3`	Valore aggiuntivo associato all'ordine tramite l'endpoint del servizio API createTempCart .`string`
`order.misc4`	Valore aggiuntivo associato all'ordine tramite l'endpoint del servizio API createTempCart .`string`
`order.misc5`	Valore aggiuntivo associato all'ordine tramite l'endpoint del servizio API createTempCart .`string`
`order.misc6`	Valore aggiuntivo associato all'ordine tramite l'endpoint del servizio API createTempCart .`string`
`order.nationalIdentifier`	Informazioni aggiuntive sull'indirizzo di fatturazione internazionale per l'ordine, quando richiesto. I valori sono stati inseriti in Zonos Checkout.`string`
`order.notes`	Un elenco di mappe di note; la mappa della nota contiene i dettagli sulla nota dell'ordine.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Un booleano che indica se questa era una nota creata dal cliente sull'ordine, la spedizione, ecc.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Un `boolean` che indica se questa nota è stata contrassegnata come importante
`order.notes[index].note`	Il contenuto della nota`string`
`order.optInEmail`	Indica che il cliente ha selezionato la casella di controllo per "iscriviti alla nostra newsletter" all'interno di Zonos CheckoutApplicabile solo se hai scelto di visualizzare questa casella di controllo nella pagina di checkout`boolean`
`order.orderId`	Il numero identificativo dell'ordine nel sistema Zonos`string`
`order.orderDate`	Il timestamp millis di creazione dell'ordine in UTC/GMT.`millis`
`order.orderDateString`	La stringa del timestamp di creazione dell'ordine in UTC/GMT.`string`
`order.orderStatus`	Lo stato dell'ordine nel sistema Zonos. Per maggiori dettagli sull'utilizzo di `orderStatus`, consulta il documento Recupera un ordine qui. Informazioni aggiuntive sugli stati degli ordini si trovano nel documento Aggiorna un ordine qui.`string`
`order.orderStatusDate`	Il timestamp millis in UTC/GMT dell'ultima modifica di `orderStatus` nel sistema Zonos.`millis`
`order.orderStatusDateString`	La stringa del timestamp in UTC/GMT dell'ultima modifica di `orderStatus` nel sistema Zonos.`string`
`order.paymentProcessing`	Una mappa dei dettagli di `paymentProcessing`. Alcuni parametri potrebbero non essere applicabili al tuo account e saranno esclusi dalla risposta.`JSON string`
`order.paymentProcessing.captureDate`	La data di acquisizione del pagamento in millis, se disponibile.Se Zonos elabora il pagamento, questo nodo è escluso dalla risposta.`millis`
`order.paymentProcessing.captureDateString`	La data di acquisizione del pagamento come stringa, se disponibile.Se Zonos elabora il pagamento, questo nodo è escluso dalla risposta.`string`
`order.paymentProcessing.cardType`	Marchio della carta di creditoSe Zonos elabora il pagamento, questo nodo è escluso dalla risposta.`string`
`order.paymentProcessing.lastFour`	Le ultime quattro cifre del numero della carta di credito di fatturazione.Se Zonos elabora il pagamento, questo nodo è escluso dalla risposta.`string`
`order.paymentProcessing.paymentGateway`	Nome del gateway di pagamentoSe Zonos elabora il pagamento, indicherà "iGlobal_CC" o "iGlobal_PayPal".`string`
`order.paymentProcessing.transactionType`	Indica il tipo di transazione"AUTH_CAPTURE" o "AUTH_ONLY".Se Zonos elabora il pagamento, questo nodo è escluso dalla risposta.`string`
`order.poNumber`	Un numero di ordine d'acquisto per l'ordine specificato all'interno di Zonos Checkout; utilizzato quando gli ordini d'acquisto sono abilitati`string`
`order.quotedDutyTaxes`	Dazi e imposte preventivati in Zonos Checkout, visualizzati in USD; numero decimale positivo, due cifre decimali`integer`
`order.quotedDutyTaxesForeign`	Dazi e imposte preventivati in Zonos Checkout. Visualizzati nella valuta regolata; numero decimale positivo, due cifre decimali`integer`
`order.referenceId`	`referenceId` univoco associato all'ordine tramite l'endpoint del servizio API createTempCart.`string`
`order.shipComplete`	Indica se l'ordine deve essere spedito in più parti`boolean`
`order.shippingCarrierServiceLevel`	Identificatore del corriere e del livello di servizio per l'opzione di spedizione selezionata`string`
`order.shippingInstructions`	Istruzioni personalizzabili per il livello di servizio di spedizione`string`
`order.shippingTotal`	Totale spedizione in USD; numero decimale positivo, due cifre decimali `integer`
`order.shippingTotalForeign`	Totale spedizione nella valuta regolata; numero decimale positivo, due cifre decimali`integer`
`order.testOrder`	Indica se l'ordine è un ordine di test.`boolean`
`order.trackingNumber`	Numero di tracciamento generato per la spedizione, se applicabile.`string`
`order.zip`	Indirizzo di destinazione / spedizione per l'ordine - i valori sono stati inseriti in Zonos Checkout o sono stati passati all'ordine tramite il reindirizzamento a Zonos Checkout.`string`

Tipi di dati aggiuntivi:

order.address1
order.address2
order.address3
order.altPhone
order.billingAddress1
order.billingAddress2
order.billingAddress3
order.billingAltPhone
order.billingCity
order.birthDate
order.billingCompany
order.billingCountryCode
order.billingCountryName
order.billingEmail
order.billingName
order.billingPhone
order.billingState
order.city
order.company
order.countryCode
order.countryName
order.email
order.items[index].countryOfOrigin
order.items[index].description
order.items[index].imageURL
order.items[index].itemBrand
order.items[index].itemCategory
order.items[index].itemColor
order.items[index].itemCustomization
order.items[index].itemDescriptionDetailed
order.items[index].itemDescriptionLong
order.items[index].itemFabricContent
order.items[index].itemHSCode
order.items[index].itemLtlClass
order.items[index].itemMaterial
order.items[index].itemURL
order.items[index].productId
order.items[index].sku
order.items[index].productId
order.items[index].weightUnits
order.name
order.phone
order.state

Prenota una demo