Dettagli dell'ordine

Scopri come funziona l'endpoint dei dettagli dell'ordine.

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

Endpoint

Nota: Le chiavi di risposta potrebbero essere modificate e/o potrebbero essere aggiunte chiavi aggiuntive. Se utilizzerai l'endpoint, ti preghiamo di configurare il tuo codice per tenere conto di 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
Intestazione Accept HTTP	Accept: application/json
Intestazione Content-Type HTTP	Content-Type: application/json

Coppie chiave/valore JSON nel corpo della richiesta

campo	note
`orderId` OPZIONALE, se si passa il parametro `referenceId`	L'ID dell'ordine Zonos può essere passato con o senza il tuo ID 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 dell'ordine / pagina di ringraziamento per l'ordine ospitata sul tuo dominio. L'URL conterrà un parametro di querystring “orderId” che conterrà questo valore.`integer / string`
`referenceId` OPZIONALE, se si passa il parametro “orderId”	Questo parametro viene utilizzato per cercare i dati di un ordine tramite il `referenceId` unico passato nell'endpoint del servizio API `createTempCart`. Questo parametro dovrebbe essere omesso o nullo quando si intende cercare i dettagli dell'ordine basati sul parametro `orderId` .`string`
`secret` OBBLIGATORIO	GUID segreto API fornito da Zonos`string`
`storeId` OBBLIGATORIO	ID negozio fornito da Zonos.`integer`

Risposte HTTP di errore

Codice errore	messaggio	significato
415	Tipo di media non supportato	Entità HTML. L'intestazione HTTP “Content-Type” è non valida.
406	Non accettabile	Entità HTML. L'intestazione HTTP “Accept” è non valida.
400	Richiesta non valida	“error”:”orderId: 999-99999 non è un orderId valido”“error”:”Impossibile trovare un ordine con orderId: 999-99999”“error”:”Credenziali di sicurezza non valide”“error”:”Corpo post non valido”“error”:”Il parametro orderId o referenceId è richiesto”“error”:”Non è possibile specificare entrambi i parametri orderId e referenceId”“error”:”Nessun ordine trovato con orderId: 999-99999”“error”:”Parametro store richiesto”“error”:”Nessun ordine trovato con referenceId: 999999 per storeId: 999”“error”:”referenceId: 999999 per storeId: 999 è stato duplicato”“error”:”Impossibile recuperare l'ordine con referenceId: 999999”
500	Errore interno del server	“error”:”Impossibile elaborare i dettagli dell'ordine”

Definizioni JSON di 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 nel Zonos Checkout.`string`
`orderboxCount`	Questo campo descrive le scatole che verranno utilizzate per spedire l'ordine, passate nella richiesta createTempCart .`string`
`order.carrierAccountNumber`	Numero di conto del vettore di spedizione del visitatore; utilizzato quando i conti del vettore del visitatore sono abilitati`string`
`order.carrierAccountShippingMethod`	Il metodo di spedizione selezionato sul conto del vettore di spedizione del visitatore; utilizzato quando i conti del vettore del visitatore sono abilitati`string`
`order.cslListMatch`	Corrispondenza della Consolidated Screening List (CSL). Un booleano che indica quando le informazioni del cliente hanno prodotto una corrispondenza nella Consolidated Screening List degli Stati Uniti e devono essere esaminate per una possibile affiliazione a una parte negata.`boolean`
`order.customerSelectedShippingName`	Nome visualizzato dell'opzione di spedizione all'interno del Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Una mappa della ripartizione dei dazi/tasseNota - 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 decimali`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Importo della commissione di erogazione in USD; numero decimale positivo, due decimali`integer`
`order.dutyTaxesBreakdown.duty`	Importo del dazio in USD; numero decimale positivo, due decimali`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Importo della commissione di prepagamento in USD; numero decimale positivo, due decimali`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Importo dell'IVA/tassa sulla commissione di erogazione in USD; numero decimale positivo, due decimali`integer`
`order.dutyTaxesBreakdown.vatTax`	Importo dell'IVA/tassa in USD, non include l'IVA/tassa sulla commissione di erogazione; numero decimale positivo, due decimali`integer`
`order.dutyTaxesTotal`	Totale dei dazi e delle tasse in USD; numero decimale positivo, due decimali`integer`
`order.foreignCurrencyCode`	Il codice della valuta in cui è stato regolato il pagamento dell'ordine.`string`
`remittance_amount`	L'importo di denaro che deve essere inviato a un paese specifico (ad es. IVA del Regno Unito).`decimal`
`order.grandTotal`	Totale generale in USD; numero decimale positivo, due decimali`integer`
`order.grandTotalForeign`	Totale generale nella valuta regolata; numero decimale positivo, due decimali`integer`
`order.items`	Un elenco di mappe di articoliLa mappa dell'articolo contiene dettagli sull'articolo che sono stati passati al Zonos Checkout al momento della creazione del carrello temporaneoPer ulteriori dettagli sulle proprietà degli articoli, si prega di consultare la documentazione API createTempCart `JSON string`
`order.itemsCount`	Conteggio degli articoli dell'ordine`integer`
`order.itemsTotal`	Totale articoli/prodotti in USD; numero decimale positivo, due decimali`integer`
`order.itemsTotalForeign`	Totale articoli/prodotti nella valuta regolata; numero decimale positivo, due decimali`integer`
`order.items[index].height`	Numero decimale positivo, due decimali`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Numero decimale positivo, due decimali`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Punto flottante positivo, due decimali`integer`
`order.items[index].width`	Punto flottante positivo, due decimali`integer`
`order.items[index].unitPrice`	Punto flottante positivo, due decimali`integer`
`order.merchantOrderId`	`MerchantOrderId` associato all'ordine tramite il servizio API updateMerchantOrderId .`string`
`order.misc1`	Valore aggiuntivo associato all'ordine tramite il servizio API createTempCart .`string`
`order.misc2`	Valore aggiuntivo associato all'ordine tramite il servizio API createTempCart .`string`
`order.misc3`	Valore aggiuntivo associato all'ordine tramite il servizio API createTempCart .`string`
`order.misc4`	Valore aggiuntivo associato all'ordine tramite il servizio API createTempCart .`string`
`order.misc5`	Valore aggiuntivo associato all'ordine tramite il servizio API createTempCart .`string`
`order.misc6`	Valore aggiuntivo associato all'ordine tramite il servizio API createTempCart .`string`
`order.nationalIdentifier`	Ulteriori informazioni sull'indirizzo di fatturazione internazionale per l'ordine quando richiesto. I valori sono stati inseriti nel Zonos Checkout.`string`
`order.notes`	Un elenco di mappe di note; la mappa delle note contiene dettagli sulla nota dell'ordine.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Un booleano che indica se questa è stata una nota creata dal cliente riguardo all'ordine, alla 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 del Zonos Checkout. Applicabile solo se hai scelto di visualizzare questa casella di controllo nella pagina checkout`boolean`
`order.orderId`	Il numero di identificazione dell'ordine nel sistema Zonos`string`
`order.orderDate`	Il timestamp di creazione dell'ordine in millis in UTC/GMT.`millis`
`order.orderDateString`	La stringa del timestamp di creazione dell'ordine in UTC/GMT.`string`
`order.orderStatus`	Lo stato/stato dell'ordine nel sistema Zonos. Per ulteriori dettagli sull'uso di `orderStatus`, si prega di consultare il Recupera un documento d'ordine qui. Ulteriori informazioni sugli stati degli ordini possono essere trovate nel Aggiorna un documento d'ordine qui.`string`
`order.orderStatusDate`	Il timestamp in millis in UTC/GMT dell'ultimo cambiamento di `orderStatus` nel sistema Zonos.`millis`
`order.orderStatusDateString`	La stringa del timestamp in UTC/GMT dell'ultimo cambiamento 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 cattura del pagamento in millis, se disponibile. Se Zonos sta elaborando il pagamento, questo nodo è escluso dalla risposta.`millis`
`order.paymentProcessing.captureDateString`	La data di cattura del pagamento come stringa, se disponibile. Se Zonos sta elaborando il pagamento, questo nodo è escluso dalla risposta.`string`
`order.paymentProcessing.cardType`	Marca della carta di credito. Se Zonos sta elaborando 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 sta elaborando il pagamento, questo nodo è escluso dalla risposta.`string`
`order.paymentProcessing.paymentGateway`	Nome del gateway di pagamento. Se Zonos sta elaborando il pagamento, indicherà “iGlobal_CC” o “iGlobal_PayPal”.`string`
`order.paymentProcessing.transactionType`	Indica il tipo di transazione “AUTH_CAPTURE” o “AUTH_ONLY”. Se Zonos sta elaborando il pagamento, questo nodo è escluso dalla risposta.`string`
`order.poNumber`	Un numero d'ordine di acquisto per l'ordine specificato all'interno del Zonos Checkout; utilizzato quando gli ordini di acquisto sono abilitati.`string`
`order.quotedDutyTaxes`	Dazi e tasse quotati nel Zonos Checkout, visualizzati in USD; numero decimale positivo, due decimali.`integer`
`order.quotedDutyTaxesForeign`	Dazi e tasse quotati nel Zonos Checkout. Visualizzati nella valuta di regolamento; numero decimale positivo, due decimali.`integer`
`order.referenceId`	Unico `referenceId` associato all'ordine tramite il servizio API createTempCart.`string`
`order.shipComplete`	Indica se l'ordine deve essere spedito in più parti.`boolean`
`order.shippingCarrierServiceLevel`	Identificatore del vettore 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 della spedizione in USD; numero decimale positivo, due decimali.`integer`
`order.shippingTotalForeign`	Totale della spedizione nella valuta di regolamento; numero decimale positivo, due decimali.`integer`
`order.testOrder`	Indica se l'ordine è un ordine di prova.`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 nel Zonos Checkout o sono stati passati all'ordine tramite il reindirizzamento al 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

Questa pagina è stata utile?

Domande?

Contattaci.

Vedi Zonos

politiche e accordi