¿Cuál es la solicitud HTTPS para la Checkout API?

La solicitud HTTPS para la Checkout API incluye el método HTTP (POST), el endpoint ('https://api.iglobalstores.com/v2/orderDetail'), el protocolo (HTTPS), el formato del mensaje (JSON) y los encabezados HTTP (Accept: application/json, Content-Type: application/json).

¿Cuáles son los pares clave/valor JSON en el cuerpo de la solicitud?

Los pares clave/valor JSON en el cuerpo de la solicitud incluyen 'orderId', 'referenceId', 'secret' y 'storeId'. 'orderId' y 'referenceId' son opcionales, pero uno de ellos debe enviarse. 'secret' y 'storeId' son obligatorios.

¿Cuáles son las posibles respuestas HTTP de error?

Las posibles respuestas HTTP de error incluyen 415 (Unsupported media type), 406 (Not Acceptable), 400 (Bad Request) y 500 (Internal Server Error). Cada código de error corresponde a un tipo específico de error.

¿Cuáles son las definiciones JSON de la respuesta?

Las definiciones JSON de la respuesta incluyen varios parámetros relacionados con los detalles del pedido, como 'error', 'order', 'order.billingZip', 'orderboxCount', 'order.carrierAccountNumber' y muchos otros. Cada parámetro proporciona información específica sobre el pedido.

Checkout•

InicioReferencia de la API Checkout REST API Detalles del pedido

Detalles del pedido

Q: ¿Qué es el endpoint de la Checkout API?

El endpoint de la Checkout API es 'orderDetail'. Este endpoint de la API se utiliza para recuperar de forma segura los detalles y el estado de un pedido completado a través de Zonos Checkout.

Descubra cómo funciona el endpoint de detalles del pedido.

El endpoint orderDetail se utiliza para recuperar de forma segura los detalles y el estado de un pedido completado a través de Zonos Checkout.

Endpoint

Nota: Las claves de respuesta pueden modificarse y/o pueden añadirse claves adicionales. Si va a utilizar el endpoint, configure su código para contemplar estas posibilidades.

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

Solicitud HTTPS

Campo↕	Notas↕
Método HTTP	POST
Endpoint	`https://api.iglobalstores.com/v2/orderDetail`
Protocolo	HTTPS
Formato del mensaje	JSON
Encabezado HTTP Accept	Accept: application/json
Encabezado HTTP Content-Type	Content-Type: application/json

Pares clave/valor JSON en el cuerpo de la solicitud

campo↕	notas↕
`orderId` OPCIONAL, si se pasa el parámetro `referenceId`	El ID de pedido de Zonos puede enviarse con o sin el ID de su tienda y el guion (Ejemplo: 123-45678 o 45678). Nota: Después de completar el pedido y el pago, el cliente será redirigido a una página de finalización del pedido / agradecimiento del pedido alojada en su dominio. La URL contendrá un parámetro de cadena de consulta "orderId" que incluirá este valor.`integer / string`
`referenceId` OPCIONAL, si se pasa el parámetro "orderId"	Este parámetro se utiliza para consultar los datos de un pedido mediante el `referenceId` único enviado en el endpoint de servicio API `createTempCart`. Este parámetro debe omitirse o dejarse en null cuando se pretenda consultar el detalle del pedido según el parámetro `orderId`.`string`
`secret` REQUERIDO	GUID secreto de la API proporcionado por Zonos`string`
`storeId` REQUERIDO	ID de tienda proporcionado por Zonos.`integer`

Respuestas HTTP de error

Código de error↕	mensaje↕	significado↕
415	Unsupported media type	Entidad HTML. El encabezado HTTP "Content-Type" no es válido.
406	Not Acceptable	Entidad HTML. El encabezado HTTP "Accept" no es válido.
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”

Definiciones JSON de la respuesta

campo↕	notas↕
`error`	Este parámetro solo estará presente cuando haya ocurrido un error y contendrá una descripción del error.`string`
`order`	Este es un mapa de los detalles del pedido.`JSON string`
`order.billingZip`	Dirección de facturación del pedido: los valores se introdujeron en Zonos Checkout.`string`
`orderboxCount`	Este campo describe las cajas que se utilizarán para enviar el pedido, pasadas en la solicitud createTempCart request.`string`
`order.carrierAccountNumber`	Número de cuenta de transportista de envío propio del visitante; se utiliza cuando las cuentas de transportista del visitante están habilitadas`string`
`order.carrierAccountShippingMethod`	Método de envío seleccionado en la cuenta de transportista propia del visitante; se utiliza cuando las cuentas de transportista del visitante están habilitadas`string`
`order.cslListMatch`	Coincidencia en la Consolidated Screening List (CSL). Un booleano que indica cuándo la información del cliente ha producido una coincidencia en la US Consolidated Screening List y debe revisarse por posible afiliación a partes denegadas.`boolean`
`order.customerSelectedShippingName`	Nombre para mostrar de la opción de envío dentro de Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Un mapa del desglose de aranceles/impuestosNota: Si corresponde, la IPF (International Processing Fee) no está incluida.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Importe de la tarifa de corretaje en USD; punto flotante positivo, dos decimales`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Importe de la tarifa de disposición en USD; punto flotante positivo, dos decimales`integer`
`order.dutyTaxesBreakdown.duty`	Importe de aranceles en USD; punto flotante positivo, dos decimales`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Importe de la tarifa de prepago en USD; punto flotante positivo, dos decimales`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Importe de IVA/impuesto sobre la tarifa de disposición en USD; punto flotante positivo, dos decimales`integer`
`order.dutyTaxesBreakdown.vatTax`	Importe de IVA/impuesto en USD, no incluye el IVA/impuesto sobre la tarifa de disposición; punto flotante positivo, dos decimales`integer`
`order.dutyTaxesTotal`	Total de aranceles e impuestos en USD; punto flotante positivo, dos decimales`integer`
`order.foreignCurrencyCode`	Código de moneda en la que se liquidó el pago del pedido.`string`
`remittance_amount`	El importe de dinero que debe remitirse a un país específico, p. ej., _ UK VAT_.`decimal`
`order.grandTotal`	Total general en USD; punto flotante positivo, dos decimales`integer`
`order.grandTotalForeign`	Total general en la moneda de liquidación; punto flotante positivo, dos decimales`integer`
`order.items`	Una lista de mapas de artículosEl mapa de artículos contiene detalles sobre el artículo que se enviaron a Zonos Checkout al crear el carrito temporalPara obtener más detalles sobre las propiedades del artículo, consulte createTempCart doc. de la API`JSON string`
`order.itemsCount`	Recuento de líneas de artículos del pedido`integer`
`order.itemsTotal`	Total de artículos / productos en USD; punto flotante positivo, dos decimales`integer`
`order.itemsTotalForeign`	Total de artículos / productos en la moneda de liquidación; punto flotante positivo, dos decimales`integer`
`order.items[index].height`	Punto flotante positivo, dos decimales`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Punto flotante positivo, dos decimales`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Punto flotante positivo, dos decimales`integer`
`order.items[index].width`	Punto flotante positivo, dos decimales`integer`
`order.items[index].unitPrice`	Punto flotante positivo, dos decimales`integer`
`order.merchantOrderId`	`MerchantOrderId` asociado con el pedido a través del updateMerchantOrderId endpoint de servicio API.`string`
`order.misc1`	Valor adicional asociado con el pedido a través del createTempCart endpoint de servicio API.`string`
`order.misc2`	Valor adicional asociado con el pedido a través del createTempCart endpoint de servicio API.`string`
`order.misc3`	Valor adicional asociado con el pedido a través del createTempCart endpoint de servicio API.`string`
`order.misc4`	Valor adicional asociado con el pedido a través del createTempCart endpoint de servicio API.`string`
`order.misc5`	Valor adicional asociado con el pedido a través del createTempCart endpoint de servicio API.`string`
`order.misc6`	Valor adicional asociado con el pedido a través del createTempCart endpoint de servicio API.`string`
`order.nationalIdentifier`	Información adicional de dirección de facturación internacional para el pedido cuando sea necesaria. Los valores se introdujeron en Zonos Checkout.`string`
`order.notes`	Una lista de mapas de notas; el mapa de notas contiene detalles sobre la nota del pedido.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Un booleano que indica si esta fue una nota creada por el cliente sobre el pedido, el envío, etc.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Un `boolean` que indica si esta nota se marcó como importante
`order.notes[index].note`	Contenido de la nota`string`
`order.optInEmail`	Indica que el cliente seleccionó la casilla de verificación "sign up for our newsletter" dentro de Zonos CheckoutAplicable solo si ha elegido mostrar esta casilla de verificación en la página de checkout`boolean`
`order.orderId`	Número de identificación del pedido en el sistema Zonos`string`
`order.orderDate`	Marca de tiempo de creación del pedido en millis en UTC/GMT.`millis`
`order.orderDateString`	Cadena de marca de tiempo de creación del pedido en UTC/GMT.`string`
`order.orderStatus`	El estado del pedido en el sistema Zonos. Para obtener más detalles sobre el uso de `orderStatus`, consulte el documento Recuperar un pedido aquí.Información adicional sobre los estados del pedido se encuentra en el documento Actualizar un pedido aquí.`string`
`order.orderStatusDate`	Marca de tiempo en millis en UTC/GMT del cambio más reciente de `orderStatus` en el sistema Zonos.`millis`
`order.orderStatusDateString`	Cadena de marca de tiempo en UTC/GMT del cambio más reciente de `orderStatus` en el sistema Zonos.`string`
`order.paymentProcessing`	Un mapa de los detalles de `paymentProcessing`. Es posible que algunos parámetros no sean aplicables a su cuenta y se excluirán de la respuesta.`JSON string`
`order.paymentProcessing.captureDate`	Fecha de captura del pago en millis, si está disponible.Si Zonos procesa el pago, este nodo se excluye de la respuesta.`millis`
`order.paymentProcessing.captureDateString`	Fecha de captura del pago como cadena, si está disponible.Si Zonos procesa el pago, este nodo se excluye de la respuesta.`string`
`order.paymentProcessing.cardType`	Marca de tarjeta de créditoSi Zonos procesa el pago, este nodo se excluye de la respuesta.`string`
`order.paymentProcessing.lastFour`	Los últimos cuatro dígitos del número de la tarjeta de crédito de facturación.Si Zonos procesa el pago, este nodo se excluye de la respuesta.`string`
`order.paymentProcessing.paymentGateway`	Nombre de la pasarela de pagoSi Zonos procesa el pago, indicará "iGlobal_CC" o "iGlobal_PayPal".`string`
`order.paymentProcessing.transactionType`	Indica el tipo de transacción"AUTH_CAPTURE" o "AUTH_ONLY".Si Zonos procesa el pago, este nodo se excluye de la respuesta.`string`
`order.poNumber`	Número de orden de compra del pedido especificado dentro de Zonos Checkout; se utiliza cuando las órdenes de compra están habilitadas`string`
`order.quotedDutyTaxes`	Aranceles e impuestos cotizados en Zonos Checkout, mostrados en USD; punto flotante positivo, dos decimales`integer`
`order.quotedDutyTaxesForeign`	Aranceles e impuestos cotizados en Zonos Checkout. Mostrados en la moneda de liquidación; punto flotante positivo, dos decimales`integer`
`order.referenceId`	`referenceId` único asociado con el pedido a través del createTempCart endpoint de servicio API.`string`
`order.shipComplete`	Indica si el pedido debe enviarse en varias partes`boolean`
`order.shippingCarrierServiceLevel`	Identificador de transportista y nivel de servicio de la opción de envío seleccionada`string`
`order.shippingInstructions`	Instrucciones personalizables para el nivel de servicio de envío`string`
`order.shippingTotal`	Total de envío en USD; punto flotante positivo, dos decimales `integer`
`order.shippingTotalForeign`	Total de envío en la moneda de liquidación; punto flotante positivo, dos decimales`integer`
`order.testOrder`	Indica si el pedido es un pedido de prueba.`boolean`
`order.trackingNumber`	Número de seguimiento generado para el envío, si corresponde.`string`
`order.zip`	Dirección de destino / envío del pedido: los valores se introdujeron en Zonos Checkout o se enviaron al pedido mediante la redirección a Zonos Checkout.`string`

Tipos de datos adicionales:

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

Reservar una demostración