Quel est le point de terminaison de l'API Checkout ?

Le point de terminaison de l'API Checkout est « orderDetail ». Ce point de terminaison API est utilisé pour récupérer en toute sécurité les détails et le statut d'une commande terminée via le Zonos Checkout.

Quelle est la requête HTTPS pour l'API Checkout ?

La requête HTTPS pour l'API Checkout inclut la méthode HTTP (POST), le point de terminaison (« https://api.iglobalstores.com/v2/orderDetail »), le protocole (HTTPS), le format de message (JSON) et les en-têtes HTTP (Accept: application/json, Content-Type: application/json).

Quelles sont les paires clé/valeur JSON dans le corps de la requête ?

Les paires clé/valeur JSON dans le corps de la requête incluent « orderId », « referenceId », « secret » et « storeId ». « orderId » et « referenceId » sont optionnels, mais l'un d'eux doit être transmis. « secret » et « storeId » sont requis.

Quelles sont les réponses d'erreur HTTP possibles ?

Les réponses d'erreur HTTP possibles incluent 415 (Unsupported media type), 406 (Not Acceptable), 400 (Bad Request) et 500 (Internal Server Error). Chaque code d'erreur correspond à un type d'erreur spécifique.

Quelles sont les définitions JSON de la réponse ?

Les définitions JSON de la réponse incluent divers paramètres relatifs aux détails de commande, tels que « error », « order », « order.billingZip », « orderboxCount », « order.carrierAccountNumber » et bien d'autres. Chaque paramètre fournit des informations spécifiques sur la commande.

Checkout•

AccueilRéférence API API REST Checkout Détails de commande

Détails de commande

Découvrez le fonctionnement du point de terminaison Détails de commande.

Le point de terminaison orderDetail est utilisé pour récupérer en toute sécurité les détails et le statut d'une commande terminé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 comptez utiliser ce point de terminaison, veuillez configurer votre code pour tenir compte de ces possibilités.

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

Requête HTTPS

field↕	notes↕
HTTP method	POST
Endpoint	`https://api.iglobalstores.com/v2/orderDetail`
Protocol	HTTPS
Message format	JSON
Accept HTTP header	Accept: application/json
Content-Type HTTP header	Content-Type: application/json

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

field↕	notes↕
`orderId` OPTIONAL, if passing `referenceId` parameter	L'identifiant de commande Zonos peut être transmis avec ou sans l'identifiant de votre magasin et le tiret (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 / remerciement hébergée sur votre domaine. L'URL contiendra un paramètre de chaîne de requête « orderId » qui contiendra cette valeur. `integer / string`
`referenceId` OPTIONAL, if passing “orderId” parameter	Ce paramètre est utilisé pour rechercher les données d'une commande par le `referenceId` unique transmis dans le point de terminaison API `createTempCart`. Ce paramètre doit être omis ou null lorsque vous souhaitez rechercher le détail de commande basé sur le paramètre `orderId`. `string`
`secret` REQUIRED	GUID secret API fourni par Zonos. `string`
`storeId` REQUIRED	Identifiant de magasin fourni par Zonos. `integer`

Réponses HTTP d'erreur

Error code↕	message↕	meaning↕
415	Unsupported media type	Entité HTML. L'en-tête HTTP « Content-Type » est invalide.
406	Not Acceptable	Entité HTML. L'en-tête HTTP « Accept » est invalide.
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 »

Définitions JSON de la réponse

field↕	notes↕
`error`	Ce paramètre n'est présent qu'en cas d'erreur et contiendra une description de l'erreur. `string`
`order`	Il s'agit d'une map des détails de commande. `JSON string`
`order.billingZip`	Adresse de facturation de la commande — les valeurs ont été saisies dans le Zonos Checkout. `string`
`orderboxCount`	Ce champ décrit les colis qui seront utilisés pour expédier la commande, transmis dans la requête createTempCart. `string`
`order.carrierAccountNumber`	Le numéro de compte transporteur propre au visiteur ; utilisé lorsque les comptes transporteur visiteur sont activés. `string`
`order.carrierAccountShippingMethod`	La méthode d'expédition sélectionnée sur le compte transporteur propre au visiteur ; utilisée lorsque les comptes transporteur visiteur sont activés. `string`
`order.cslListMatch`	Correspondance Consolidated Screening List (CSL). Un booléen indiquant lorsque les informations client ont produit une correspondance dans la US Consolidated Screening List et doivent être examinées pour une possible affiliation à une partie refusée. `boolean`
`order.customerSelectedShippingName`	Nom d'affichage de l'option d'expédition dans le Zonos Checkout. `string`
`order.dutyTaxesBreakdown`	Une map de la ventilation droits/taxes. Remarque — le cas échéant, l'IPF (International Processing Fee) n'est pas inclus. `JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Montant des frais de courtage en USD ; nombre flottant positif, deux décimales. `integer`
`order.dutyTaxesBreakdown.dispursementFee`	Montant des frais de déboursement en USD ; nombre flottant positif, deux décimales. `integer`
`order.dutyTaxesBreakdown.duty`	Montant des droits en USD ; nombre flottant positif, deux décimales. `integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Montant des frais de prépaiement en USD ; nombre flottant positif, deux décimales. `integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Montant TVA/taxe sur les frais de déboursement en USD ; nombre flottant positif, deux décimales. `integer`
`order.dutyTaxesBreakdown.vatTax`	Montant TVA/taxe en USD, n'inclut pas la TVA/taxe sur les frais de déboursement ; nombre flottant positif, deux décimales. `integer`
`order.dutyTaxesTotal`	Total droits et taxes en USD ; nombre flottant positif, deux décimales. `integer`
`order.foreignCurrencyCode`	Le code devise dans lequel le paiement de la commande a été réglé. `string`
`remittance_amount`	Le montant d'argent qui doit être remis à un pays spécifique, par ex. _ UK VAT_. `decimal`
`order.grandTotal`	Total général en USD ; nombre flottant positif, deux décimales. `integer`
`order.grandTotalForeign`	Total général en devise de règlement ; nombre flottant positif, deux décimales. `integer`
`order.items`	Une liste de maps d'articles. La map d'article contient des détails sur l'article transmis au Zonos Checkout lors de la création du panier temporaire. Pour plus de détails sur les propriétés d'article, consultez la documentation createTempCart. `JSON string`
`order.itemsCount`	Nombre de lignes de commande. `integer`
`order.itemsTotal`	Total articles / produits en USD ; nombre flottant positif, deux décimales. `integer`
`order.itemsTotalForeign`	Total articles / produits en devise de règlement ; nombre flottant positif, deux décimales. `integer`
`order.items[index].height`	Nombre flottant positif, deux décimales. `integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Nombre flottant positif, deux décimales. `integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Nombre flottant positif, deux décimales. `integer`
`order.items[index].width`	Nombre flottant positif, deux décimales. `integer`
`order.items[index].unitPrice`	Nombre flottant positif, deux décimales. `integer`
`order.merchantOrderId`	`MerchantOrderId` associé à la commande via le point de terminaison API updateMerchantOrderId. `string`
`order.misc1`	Valeur supplémentaire associée à la commande via le point de terminaison API createTempCart. `string`
`order.misc2`	Valeur supplémentaire associée à la commande via le point de terminaison API createTempCart. `string`
`order.misc3`	Valeur supplémentaire associée à la commande via le point de terminaison API createTempCart. `string`
`order.misc4`	Valeur supplémentaire associée à la commande via le point de terminaison API createTempCart. `string`
`order.misc5`	Valeur supplémentaire associée à la commande via le point de terminaison API createTempCart. `string`
`order.misc6`	Valeur supplémentaire associée à la commande via le point de terminaison API createTempCart. `string`
`order.nationalIdentifier`	Informations supplémentaires d'adresse de facturation internationale pour la commande lorsque requis. Les valeurs ont été saisies dans le Zonos Checkout. `string`
`order.notes`	Une liste de maps de notes ; la map de note contient des détails sur la note de commande. `JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Un booléen indiquant s'il s'agissait d'une note créée par le client concernant la commande, l'expédition, etc. `boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Un `boolean` indiquant si cette note a été signalée comme importante.
`order.notes[index].note`	Le contenu de la note. `string`
`order.optInEmail`	Indique que le client a coché la case « sign up for our newsletter » dans le Zonos Checkout. Applicable uniquement si vous avez choisi d'afficher cette case sur la page de checkout. `boolean`
`order.orderId`	Le numéro d'identification de la commande dans le système Zonos. `string`
`order.orderDate`	L'horodatage millis de création de la commande en UTC/GMT. `millis`
`order.orderDateString`	La chaîne d'horodatage de création de la commande en UTC/GMT. `string`
`order.orderStatus`	Le statut/état de la commande dans le système Zonos. Pour plus de détails sur l'utilisation de `orderStatus`, consultez le document Retrieve an order ici. Des informations supplémentaires sur les statuts de commande se trouvent dans le document Update an order ici. `string`
`order.orderStatusDate`	L'horodatage millis en UTC/GMT du changement de `orderStatus` le plus récent dans le système Zonos. `millis`
`order.orderStatusDateString`	La chaîne d'horodatage en UTC/GMT du changement de `orderStatus` le plus récent dans le système Zonos. `string`
`order.paymentProcessing`	Une map des détails de `paymentProcessing`. Certains paramètres peuvent ne pas s'appliquer à votre compte et seront exclus de la réponse. `JSON string`
`order.paymentProcessing.captureDate`	La date de capture du paiement en millis, si disponible. Si Zonos traite le paiement, ce nœud est exclu de la réponse. `millis`
`order.paymentProcessing.captureDateString`	La date de capture du paiement en chaîne, si disponible. Si Zonos traite le paiement, ce nœud est exclu de la réponse. `string`
`order.paymentProcessing.cardType`	Marque de carte de crédit. Si Zonos traite le paiement, ce nœud est exclu de la réponse. `string`
`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é 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 ; nombre flottant positif, deux décimales. `integer`
`order.quotedDutyTaxesForeign`	Droits et taxes indiqués dans le Zonos Checkout. Affichés en devise de règlement ; nombre flottant positif, deux décimales. `integer`
`order.referenceId`	`referenceId` unique associé à la commande via le point de terminaison API createTempCart. `string`
`order.shipComplete`	Indique si la commande doit être expédiée en plusieurs parties. `boolean`
`order.shippingCarrierServiceLevel`	Identifiant transporteur et 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 expédition en USD ; nombre flottant positif, deux décimales. `integer`
`order.shippingTotalForeign`	Total expédition en devise de règlement ; nombre 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 / expédition de la commande — les valeurs ont été saisies dans le Zonos Checkout ou 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

Réserver une démo