Detalles del pedido

Aprende cómo funciona el endpoint de Detalles del pedido.

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

Endpoint

Nota: Las claves de respuesta pueden ser modificadas y/o se pueden agregar claves adicionales. Si vas a utilizar el endpoint, por favor configura tu código para adaptarse a 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 se puede pasar con o sin el Id de tu tienda y guion (Ejemplo: 123-45678 o 45678). Nota: Después de la finalización del pedido y el pago, el cliente será redirigido a una página de Finalización de Pedido / Página de Agradecimiento del Pedido alojada en tu dominio. La URL contendrá un parámetro de cadena de consulta "orderId" que contendrá este valor.`integer / string`
`referenceId` OPCIONAL, si se pasa el parámetro “orderId”	Este parámetro se utiliza para buscar los datos de un pedido mediante el `referenceId` único pasado en el endpoint del Servicio API `createTempCart`. Este parámetro debe omitirse o ser nulo cuando se pretende buscar el detalle del pedido basado en 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	Tipo de medio no soportado	Entidad HTML. El encabezado HTTP “Content-Type” no es válido.
406	No Aceptable	Entidad HTML. El encabezado HTTP “Accept” no es válido.
400	Solicitud Incorrecta	“error”:”orderId: 999-99999 no es un orderId válido”“error”:”No se pudo encontrar un pedido con orderId: 999-99999”“error”:”Credenciales de seguridad no válidas”“error”:”Cuerpo de la solicitud no válido”“error”:”Se requiere el parámetro orderId o referenceId”“error”:”No se pueden especificar ambos parámetros orderId y referenceId”“error”:”No se encontró ningún pedido con orderId: 999-99999”“error”:”Se requiere el parámetro store”“error”:”No se encontró ningún pedido con referenceId: 999999 para storeId: 999”“error”:”referenceId: 999999 para storeId: 999 ha sido duplicado”“error”:”No se pudo recuperar el pedido con referenceId: 999999”
500	Error Interno del Servidor	“error”:”No se pudieron procesar los detalles del pedido”

Definiciones de respuesta JSON

campo	notas
`error`	Este parámetro está presente solo cuando se produce un error y contendrá una descripción del error.`cadena`
`order`	Este es un mapa de los detalles del pedido.`cadena JSON`
`order.billingZip`	Dirección de facturación para el pedido: los valores se ingresaron en el Zonos Checkout.`cadena`
`orderboxCount`	Este campo describe las cajas que se utilizarán para enviar el pedido, pasadas en la solicitud createTempCart .`cadena`
`order.carrierAccountNumber`	Número de cuenta de envío propio de un visitante; se utiliza cuando las cuentas de transportistas de visitantes están habilitadas.`cadena`
`order.carrierAccountShippingMethod`	El método de envío seleccionado en la cuenta de envío propia del visitante; se utiliza cuando las cuentas de transportistas de visitantes están habilitadas.`cadena`
`order.cslListMatch`	Coincidencia en la Lista de Control de Consolidación (CSL). Un booleano que indica cuando la información del cliente ha producido una coincidencia en la Lista de Control de Consolidación de EE. UU. y debe revisarse para posibles afiliaciones a partes denegadas.`booleano`
`order.customerSelectedShippingName`	Nombre de visualización de la opción de envío dentro del Zonos Checkout`cadena`
`order.dutyTaxesBreakdown`	Un mapa del desglose de impuestos/derechosNota: si corresponde, la Tarifa de Procesamiento Internacional (IPF) no está incluida.`cadena JSON`
`order.dutyTaxesBreakdown.brokerageFee`	Monto de la tarifa de corretaje en USD; punto flotante positivo, dos decimales`entero`
`order.dutyTaxesBreakdown.dispursementFee`	Monto de la tarifa de desembolso en USD; punto flotante positivo, dos decimales`entero`
`order.dutyTaxesBreakdown.duty`	Monto de los derechos en USD; punto flotante positivo, dos decimales`entero`
`order.dutyTaxesBreakdown.prepaymentFee`	Monto de la tarifa de prepago en USD; punto flotante positivo, dos decimales`entero`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Monto de IVA/impuesto sobre la tarifa de desembolso en USD; punto flotante positivo, dos decimales`entero`
`order.dutyTaxesBreakdown.vatTax`	Monto de IVA/impuesto en USD, no incluye el IVA/impuesto sobre la tarifa de desembolso; punto flotante positivo, dos decimales`entero`
`order.dutyTaxesTotal`	Total de impuestos y derechos en USD; punto flotante positivo, dos decimales`entero`
`order.foreignCurrencyCode`	El código de moneda en el que se liquidó el pago del pedido.`cadena`
`remittance_amount`	La cantidad de dinero que debe ser remitida a un país específico (por ejemplo, el IVA del Reino Unido).`decimal`
`order.grandTotal`	Total general en USD; punto flotante positivo, dos decimales`entero`
`order.grandTotalForeign`	Total general en la moneda liquidada; punto flotante positivo, dos decimales`entero`
`order.items`	Una lista de mapas de elementosEl mapa de elementos contiene detalles sobre el elemento que se pasaron al Zonos Checkout al crear el carrito temporalPara obtener más detalles sobre las propiedades de los elementos, consulte la documentación de la API createTempCart `cadena JSON`
`order.itemsCount`	Cantidad de elementos de línea del pedido`entero`
`order.itemsTotal`	Total de elementos/productos en USD; punto flotante positivo, dos decimales`entero`
`order.itemsTotalForeign`	Total de elementos/productos en la moneda liquidada; punto flotante positivo, dos decimales`entero`
`order.items[index].height`	Punto flotante positivo, dos decimales`entero`
`order.items[index].itemNonShippable`	`booleano`
`order.items[index].length`	Punto flotante positivo, dos decimales`entero`
`order.items[index].quantity`	`entero`
`order.items[index].weight`	Punto flotante positivo, dos decimales `entero`
`order.items[index].width`	Punto flotante positivo, dos decimales `entero`
`order.items[index].unitPrice`	Punto flotante positivo, dos decimales `entero`
`order.merchantOrderId`	`MerchantOrderId` asociado con el pedido a través del endpoint de servicio de API updateMerchantOrderId. `cadena`
`order.misc1`	Valor adicional asociado con el pedido a través del endpoint de servicio de API createTempCart. `cadena`
`order.misc2`	Valor adicional asociado con el pedido a través del endpoint de servicio de API createTempCart. `cadena`
`order.misc3`	Valor adicional asociado con el pedido a través del endpoint de servicio de API createTempCart. `cadena`
`order.misc4`	Valor adicional asociado con el pedido a través del endpoint de servicio de API createTempCart. `cadena`
`order.misc5`	Valor adicional asociado con el pedido a través del endpoint de servicio de API createTempCart. `cadena`
`order.misc6`	Valor adicional asociado con el pedido a través del endpoint de servicio de API createTempCart. `cadena`
`order.nationalIdentifier`	Información adicional de dirección de facturación internacional para el pedido cuando sea necesario. Los valores se ingresaron en el Zonos Checkout. `cadena`
`order.notes`	Una lista de mapas de notas; el mapa de notas contiene detalles sobre la nota del pedido. `cadena JSON`
`order.notes[index].createdByUser`	`cadena`
`order.notes[index].customerNote`	Un booleano que indica si esta fue una nota creada por el cliente sobre el pedido, envío, etc. `booleano`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`cadena`
`order.notes[index].flagged`	Un `booleano` que indica si esta nota fue marcada como importante
`order.notes[index].note`	Contenido de la nota `cadena`
`order.optInEmail`	Indica que el cliente seleccionó la casilla de "suscribirse a nuestro boletín" dentro de Zonos Checkout. Aplicable solo si ha elegido mostrar esta casilla en la página de checkout. `booleano`
`order.orderId`	El número de identificación del pedido en el sistema de Zonos. `cadena`
`order.orderDate`	La marca de tiempo de creación del pedido en millis en UTC/GMT. `millis`
`order.orderDateString`	La marca de tiempo de creación del pedido en formato de cadena en UTC/GMT. `cadena`
`order.orderStatus`	El estado del pedido en el sistema de Zonos. Para obtener más detalles sobre el uso de `orderStatus`, revise el documento Recuperar un pedido aquí. Se puede encontrar información adicional sobre los estados de pedido en el documento Actualizar un pedido aquí. `cadena`
`order.orderStatusDate`	La marca de tiempo en millis en UTC/GMT del cambio más reciente de `orderStatus` en el sistema de Zonos. `millis`
`order.orderStatusDateString`	La marca de tiempo en formato de cadena en UTC/GMT del cambio más reciente de `orderStatus` en el sistema de Zonos. `cadena`
`order.paymentProcessing`	Un mapa de detalles de `paymentProcessing`. Algunos parámetros pueden no ser aplicables a su cuenta y se excluirán de la respuesta. `cadena JSON`
`order.paymentProcessing.captureDate`	La fecha de captura de pago en millis, si está disponible. Si Zonos está procesando el pago, este nodo se excluye de la respuesta. `millis`
`order.paymentProcessing.captureDateString`	La fecha de captura de pago en formato de cadena, si está disponible. Si Zonos está procesando el pago, este nodo se excluye de la respuesta. `cadena`
`order.paymentProcessing.cardType`	Marca de tarjeta de crédito. Si Zonos está procesando el pago, este nodo se excluye de la respuesta. `cadena`
`order.paymentProcessing.lastFour`	Los últimos cuatro números del número de la tarjeta de crédito de facturación. Si Zonos está procesando el pago, este nodo se excluye de la respuesta.`string`
`order.paymentProcessing.paymentGateway`	Nombre de la pasarela de pago. Si Zonos está procesando 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 está procesando el pago, este nodo se excluye de la respuesta.`string`
`order.poNumber`	Un número de orden de compra para el pedido especificado dentro de Zonos Checkout; se usa cuando las órdenes de compra están habilitadas.`string`
`order.quotedDutyTaxes`	Derechos e impuestos cotizados en Zonos Checkout, mostrados en USD; punto flotante positivo, dos decimales.`integer`
`order.quotedDutyTaxesForeign`	Derechos e impuestos cotizados en Zonos Checkout. Mostrados en la moneda liquidada; punto flotante positivo, dos decimales.`integer`
`order.referenceId`	`referenceId` único asociado con el pedido a través del punto final del servicio API createTempCart.`string`
`order.shipComplete`	Indica si el pedido debe enviarse en múltiples partes.`boolean`
`order.shippingCarrierServiceLevel`	Identificador del transportista y nivel de servicio para 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 liquidada; 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 para el pedido: los valores se ingresaron en Zonos Checkout o se pasaron al pedido a través de 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

¿Fue útil esta página?

¿Preguntas?

Contáctenos.

Ver Zonos

políticas y acuerdos