Détails de la commande

Découvrez comment fonctionne le point de terminaison des détails de la commande.

Le point de terminaison orderDetail est utilisé pour récupérer en toute sécurité les détails de la commande et le statut d'une commande effectuée via le Zonos Checkout.

Point de terminaison

Remarque : Les clés de réponse peuvent être modifiées et/ou des clés supplémentaires peuvent être ajoutées. Si vous utilisez le point de terminaison, veuillez configurer votre code pour prendre en compte ces possibilités.

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

Requête HTTPS

champ	notes
Méthode HTTP	POST
Point de terminaison	`https://api.iglobalstores.com/v2/orderDetail`
Protocole	HTTPS
Format du message	JSON
En-tête HTTP Accept	Accepter : application/json
En-tête HTTP Content-Type	Content-Type : application/json

Paires clé/valeur JSON dans le corps de la requête

champ	notes
`orderId` FACULTATIF, si le paramètre `referenceId` est passé	L'identifiant de commande Zonos peut être passé avec ou sans l'identifiant de votre magasin et le trait d'union (Exemple : 123-45678 ou 45678). Remarque : Après la finalisation de la commande et le paiement, le client sera redirigé vers une page de confirmation de commande / page de remerciement hébergée sur votre domaine. L'URL contiendra un paramètre de chaîne de requête "orderId" qui contiendra cette valeur. `entier / chaîne de caractères`
`referenceId` FACULTATIF, si le paramètre "orderId" est passé	Ce paramètre est utilisé pour rechercher les données d'une commande par l'identifiant de référence unique passé dans le point de terminaison du service API `createTempCart`. Ce paramètre doit être omis ou nul lorsqu'on souhaite rechercher les détails de la commande en fonction du paramètre `orderId`. `chaîne de caractères`
`secret` REQUIS	GUID secret de l'API fourni par Zonos `chaîne de caractères`
`storeId` REQUIS	Identifiant de magasin fourni par Zonos `entier`

Réponses d'erreur HTTP

Code d'erreur	message	signification
415	Type de support non pris en charge	Entité HTML. L'en-tête HTTP "Content-Type" est invalide.
406	Non acceptable	Entité HTML. L'en-tête HTTP "Accept" est invalide.
400	Requête incorrecte	"error": "orderId: 999-99999 n'est pas un identifiant de commande valide" "error": "Impossible de trouver une commande avec l'identifiant de commande : 999-99999" "error": "Informations d'identification de sécurité invalides" "error": "Corps de message invalide" "error": "Le paramètre orderId ou referenceId est requis" "error": "Impossible de spécifier à la fois les paramètres orderId et referenceId" "error": "Aucune commande trouvée avec l'identifiant de commande : 999-99999" "error": "Paramètre de magasin requis" "error": "Aucune commande trouvée avec referenceId : 999999 pour storeId : 999" "error": "referenceId : 999999 pour storeId : 999 a été dupliqué" "error": "Impossible de récupérer la commande avec referenceId : 999999"
500	Erreur interne du serveur	"error": "Impossible de traiter les détails de la commande"

Définitions JSON de réponse

champ	notes
`error`	Ce paramètre n'est présent que lorsqu'une erreur s'est produite et contiendra une description de l'erreur.`chaîne de caractères`
`order`	Il s'agit d'une carte des détails de la commande.`chaîne de caractères JSON`
`order.billingZip`	Adresse de facturation pour la commande - les valeurs ont été saisies dans le Zonos Checkout.`chaîne de caractères`
`orderboxCount`	Ce champ décrit les boîtes qui seront utilisées pour expédier la commande, transmises dans la demande createTempCart .`chaîne de caractères`
`order.carrierAccountNumber`	Numéro de compte de transporteur propre au visiteur; utilisé lorsque les comptes de transporteur des visiteurs sont activés`chaîne de caractères`
`order.carrierAccountShippingMethod`	La méthode d'expédition sélectionnée sur le compte de transporteur propre au visiteur; utilisée lorsque les comptes de transporteur des visiteurs sont activés`chaîne de caractères`
`order.cslListMatch`	Correspondance avec la liste de contrôle consolidée (CSL). Un booléen qui indique si les informations du client ont produit une correspondance dans la liste de contrôle consolidée des États-Unis et doivent être examinées pour une éventuelle affiliation à des parties refusées.`booléen`
`order.customerSelectedShippingName`	Nom d'affichage de l'option d'expédition à l'intérieur du Zonos Checkout`chaîne de caractères`
`order.dutyTaxesBreakdown`	Une carte de la répartition des droits/taxesRemarque - Si applicable, les frais de traitement international (IPF) ne sont pas inclus.`chaîne de caractères JSON`
`order.dutyTaxesBreakdown.brokerageFee`	Montant des frais de courtage en USD; nombre flottant positif, deux décimales`entier`
`order.dutyTaxesBreakdown.dispursementFee`	Montant des frais de décaissement en USD; nombre flottant positif, deux décimales`entier`
`order.dutyTaxesBreakdown.duty`	Montant des droits en USD; nombre flottant positif, deux décimales`entier`
`order.dutyTaxesBreakdown.prepaymentFee`	Montant des frais de prépaiement en USD; nombre flottant positif, deux décimales`entier`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Montant de la TVA/taxe sur les frais de décaissement en USD; nombre flottant positif, deux décimales`entier`
`order.dutyTaxesBreakdown.vatTax`	Montant de la TVA/taxe en USD, ne comprend pas la TVA/taxe sur les frais de décaissement; nombre flottant positif, deux décimales`entier`
`order.dutyTaxesTotal`	Total des droits et taxes en USD; nombre flottant positif, deux décimales`entier`
`order.foreignCurrencyCode`	Le code de devise dans lequel le paiement de la commande a été effectué.`chaîne de caractères`
`remittance_amount`	Le montant d'argent qui doit être remis à un pays spécifique (par exemple, la TVA britannique).`décimal`
`order.grandTotal`	Total général en USD; nombre flottant positif, deux décimales`entier`
`order.grandTotalForeign`	Total général dans la devise réglée; nombre flottant positif, deux décimales`entier`
`order.items`	Une liste de cartes d'articlesLa carte d'article contient des détails sur l'article qui ont été transmis au Zonos Checkout lors de la création du panier temporairePour plus de détails sur les propriétés des articles, veuillez consulter la documentation de l'API createTempCart `chaîne de caractères JSON`
`order.itemsCount`	Nombre d'articles de ligne de commande`entier`
`order.itemsTotal`	Total des articles/produits en USD; nombre flottant positif, deux décimales`entier`
`order.itemsTotalForeign`	Total des articles/produits dans la devise réglée; nombre flottant positif, deux décimales`entier`
`order.items[index].height`	Nombre flottant positif, deux décimales`entier`
`order.items[index].itemNonShippable`	`booléen`
`order.items[index].length`	Nombre flottant positif, deux décimales`entier`
`order.items[index].quantity`	`entier`
`order.items[index].weight`	Nombre flottant positif, deux décimales `entier`
`order.items[index].width`	Nombre flottant positif, deux décimales `entier`
`order.items[index].unitPrice`	Nombre flottant positif, deux décimales `entier`
`order.merchantOrderId`	`MerchantOrderId` associé à la commande via le point de terminaison du service API updateMerchantOrderId. `chaîne de caractères`
`order.misc1`	Valeur supplémentaire associée à la commande via le point de terminaison du service API createTempCart. `chaîne de caractères`
`order.misc2`	Valeur supplémentaire associée à la commande via le point de terminaison du service API createTempCart. `chaîne de caractères`
`order.misc3`	Valeur supplémentaire associée à la commande via le point de terminaison du service API createTempCart. `chaîne de caractères`
`order.misc4`	Valeur supplémentaire associée à la commande via le point de terminaison du service API createTempCart. `chaîne de caractères`
`order.misc5`	Valeur supplémentaire associée à la commande via le point de terminaison du service API createTempCart. `chaîne de caractères`
`order.misc6`	Valeur supplémentaire associée à la commande via le point de terminaison du service API createTempCart. `chaîne de caractères`
`order.nationalIdentifier`	Informations supplémentaires sur l'adresse de facturation internationale de la commande lorsque nécessaire. Les valeurs ont été saisies dans le Zonos Checkout. `chaîne de caractères`
`order.notes`	Une liste de cartes de notes; la carte de notes contient des détails sur la note de commande. `chaîne JSON`
`order.notes[index].createdByUser`	`chaîne de caractères`
`order.notes[index].customerNote`	Un booléen indiquant s'il s'agit d'une note créée par le client concernant la commande, l'expédition, etc. `booléen`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`chaîne de caractères`
`order.notes[index].flagged`	Un booléen indiquant si cette note a été signalée comme importante
`order.notes[index].note`	Contenu de la note `chaîne de caractères`
`order.optInEmail`	Indique que le client a sélectionné la case à cocher "s'inscrire à notre newsletter" dans l'application Zonos Checkout. Applicable uniquement si vous avez choisi d'afficher cette case à cocher sur la page de checkout. `booléen`
`order.orderId`	Numéro d'identification de la commande dans le système Zonos. `chaîne de caractères`
`order.orderDate`	Horodatage de création de la commande en millisecondes en UTC/GMT. `millis`
`order.orderDateString`	Chaîne de caractères de l'horodatage de création de la commande en UTC/GMT. `chaîne de caractères`
`order.orderStatus`	État de la commande dans le système Zonos. Pour plus de détails sur l'utilisation de `orderStatus`, veuillez consulter le document de récupération de commande ici. Des informations supplémentaires sur les statuts de commande peuvent être trouvées dans le document de mise à jour de commande ici. `chaîne de caractères`
`order.orderStatusDate`	Horodatage en millisecondes en UTC/GMT du changement le plus récent de `orderStatus` dans le système Zonos. `millis`
`order.orderStatusDateString`	Chaîne de caractères de l'horodatage du changement le plus récent de `orderStatus` dans le système Zonos. `chaîne de caractères`
`order.paymentProcessing`	Un ensemble de détails de `paymentProcessing`. Certains paramètres peuvent ne pas être applicables à votre compte et seront exclus de la réponse. `chaîne JSON`
`order.paymentProcessing.captureDate`	Date de capture du paiement en millisecondes, si disponible. Si Zonos traite le paiement, ce nœud est exclu de la réponse. `millis`
`order.paymentProcessing.captureDateString`	Date de capture du paiement en tant que chaîne, si disponible. Si Zonos traite le paiement, ce nœud est exclu de la réponse. `chaîne de caractères`
`order.paymentProcessing.cardType`	Marque de carte de crédit. Si Zonos traite le paiement, ce nœud est exclu de la réponse. `chaîne de caractères`
`order.paymentProcessing.lastFour`	Les quatre derniers chiffres du numéro de carte de crédit de facturation. Si Zonos traite le paiement, ce nœud est exclu de la réponse.`string`
`order.paymentProcessing.paymentGateway`	Nom de la passerelle de paiement. Si Zonos traite le paiement, indiquera “iGlobal_CC” ou “iGlobal_PayPal”.`string`
`order.paymentProcessing.transactionType`	Indique le type de transaction “AUTH_CAPTURE” ou “AUTH_ONLY”. Si Zonos traite le paiement, ce nœud est exclu de la réponse.`string`
`order.poNumber`	Un numéro de bon de commande pour la commande spécifiée dans le Zonos Checkout; utilisé lorsque les bons de commande sont activés.`string`
`order.quotedDutyTaxes`	Droits et taxes indiqués dans le Zonos Checkout, affichés en USD; point flottant positif, deux décimales.`integer`
`order.quotedDutyTaxesForeign`	Droits et taxes indiqués dans le Zonos Checkout. Affichés dans la devise réglée; point flottant positif, deux décimales.`integer`
`order.referenceId`	`referenceId` unique associé à la commande via le point de terminaison du service API createTempCart.`string`
`order.shipComplete`	Indique si la commande doit être expédiée en plusieurs parties.`boolean`
`order.shippingCarrierServiceLevel`	Identifiant du transporteur et du niveau de service pour l'option d'expédition sélectionnée.`string`
`order.shippingInstructions`	Instructions personnalisables pour le niveau de service d'expédition.`string`
`order.shippingTotal`	Total des frais d'expédition en USD; point flottant positif, deux décimales.`integer`
`order.shippingTotalForeign`	Total des frais d'expédition dans la devise réglée; point flottant positif, deux décimales.`integer`
`order.testOrder`	Indique si la commande est une commande de test.`boolean`
`order.trackingNumber`	Numéro de suivi généré pour l'expédition, le cas échéant.`string`
`order.zip`	Adresse de destination / d'expédition pour la commande - les valeurs ont été saisies dans le Zonos Checkout ou ont été transmises à la commande via la redirection vers le Zonos Checkout.`string`

Types de données supplémentaires :

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

Cette page était-elle utile?

Des questions ?

Contactez-nous.

Voir Zonos

politiques et accords