DOCS

Order details

/

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

camponotas
Método HTTPPOST
Endpointhttps://api.iglobalstores.com/v2/orderDetail
ProtocoloHTTPS
Formato del mensajeJSON
Encabezado HTTP AcceptAccept: application/json
Encabezado HTTP Content-TypeContent-Type: application/json

Pares clave/valor JSON en el cuerpo de la solicitud

camponotas
orderId OPCIONAL, si se pasa el parámetro referenceIdEl 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 REQUERIDOGUID secreto de la API proporcionado por Zonosstring
storeId REQUERIDOID de tienda proporcionado por Zonos.integer

Respuestas HTTP de error

Código de errormensajesignificado
415Tipo de medio no soportadoEntidad HTML. El encabezado HTTP “Content-Type” no es válido.
406No AceptableEntidad HTML. El encabezado HTTP “Accept” no es válido.
400Solicitud 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”
500Error Interno del Servidor“error”:”No se pudieron procesar los detalles del pedido”

Definiciones JSON de respuesta

camponotas
errorEste parámetro está presente solo cuando ha ocurrido un error y contendrá una descripción del error.string
orderEste es un mapa de los detalles del pedido.JSON string
order.billingZipDirección de facturación para el pedido - los valores se ingresaron en el Zonos Checkout.string
orderboxCountEste campo describe las cajas que se utilizarán para enviar el pedido, pasadas a la solicitud de createTempCart .string
order.carrierAccountNumberNúmero de cuenta del transportista de envío del visitante; utilizado cuando las cuentas de transportista del visitante están habilitadasstring
order.carrierAccountShippingMethodEl método de envío seleccionado en la cuenta de transportista de envío del visitante; utilizado cuando las cuentas de transportista del visitante están habilitadasstring
order.cslListMatchCoincidencia de la Lista de Filtrado Consolidada (CSL). Un booleano que indica cuando la información del cliente ha producido una coincidencia en la Lista de Filtrado Consolidada de EE. UU. y debe ser revisada por posible afiliación a partes denegadas.boolean
order.customerSelectedShippingNameNombre de visualización de la opción de envío dentro del Zonos Checkoutstring
order.dutyTaxesBreakdownUn mapa del desglose de derechos/impuestosNota - Si corresponde, la IPF (Tarifa de Procesamiento Internacional) no está incluida.JSON string
order.dutyTaxesBreakdown.brokerageFeeMonto de la tarifa de corretaje en USD; punto flotante positivo, dos decimalesinteger
order.dutyTaxesBreakdown.dispursementFeeMonto de la tarifa de desembolso en USD; punto flotante positivo, dos decimalesinteger
order.dutyTaxesBreakdown.dutyMonto de derechos en USD; punto flotante positivo, dos decimalesinteger
order.dutyTaxesBreakdown.prepaymentFeeMonto de la tarifa de prepago en USD; punto flotante positivo, dos decimalesinteger
order.dutyTaxesBreakdown.vatOnDispursementFeeMonto del IVA/impuesto sobre la tarifa de desembolso en USD; punto flotante positivo, dos decimalesinteger
order.dutyTaxesBreakdown.vatTaxMonto del IVA/impuesto en USD, no incluye el IVA/impuesto sobre la tarifa de desembolso; punto flotante positivo, dos decimalesinteger
order.dutyTaxesTotalTotal de derechos e impuestos en USD; punto flotante positivo, dos decimalesinteger
order.foreignCurrencyCodeEl código de moneda en el que se liquidó el pago del pedido.string
remittance_amountLa cantidad de dinero que necesita ser remitida a un país específico, por ejemplo, _ IVA del Reino Unido_.decimal
order.grandTotalTotal general en USD; punto flotante positivo, dos decimalesinteger
order.grandTotalForeignTotal general en moneda liquidada; punto flotante positivo, dos decimalesinteger
order.itemsUna lista de mapas de artículosEl mapa de artículos contiene detalles sobre el artículo que se pasaron al Zonos Checkout al crear el carrito temporalPara más detalles sobre las propiedades del artículo, revise la documentación de la API de createTempCart JSON string
order.itemsCountConteo de artículos de línea del pedidointeger
order.itemsTotalTotal de artículos / productos en USD; punto flotante positivo, dos decimalesinteger
order.itemsTotalForeignTotal de artículos / productos en la moneda liquidada; punto flotante positivo, dos decimalesinteger
order.items[index].heightPunto flotante positivo, dos decimalesinteger
order.items[index].itemNonShippableboolean
order.items[index].lengthPunto flotante positivo, dos decimalesinteger
order.items[index].quantityinteger
order.items[index].weightPunto flotante positivo, dos decimales entero
order.items[index].widthPunto flotante positivo, dos decimales entero
order.items[index].unitPricePunto flotante positivo, dos decimales entero
order.merchantOrderIdMerchantOrderId asociado con el pedido a través del endpoint de servicio de API updateMerchantOrderId. cadena
order.misc1Valor adicional asociado con el pedido a través del endpoint de servicio de API createTempCart. cadena
order.misc2Valor adicional asociado con el pedido a través del endpoint de servicio de API createTempCart. cadena
order.misc3Valor adicional asociado con el pedido a través del endpoint de servicio de API createTempCart. cadena
order.misc4Valor adicional asociado con el pedido a través del endpoint de servicio de API createTempCart. cadena
order.misc5Valor adicional asociado con el pedido a través del endpoint de servicio de API createTempCart. cadena
order.misc6Valor adicional asociado con el pedido a través del endpoint de servicio de API createTempCart. cadena
order.nationalIdentifierInformació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.notesUna lista de mapas de notas; el mapa de notas contiene detalles sobre la nota del pedido. cadena JSON
order.notes[index].createdByUsercadena
order.notes[index].customerNoteUn booleano que indica si esta fue una nota creada por el cliente sobre el pedido, envío, etc. booleano
order.notes[index].dateCreatedmillis
order.notes[index].dateCreatedStringcadena
order.notes[index].flaggedUn booleano que indica si esta nota fue marcada como importante
order.notes[index].noteContenido de la nota cadena
order.optInEmailIndica 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.orderIdEl número de identificación del pedido en el sistema de Zonos. cadena
order.orderDateLa marca de tiempo de creación del pedido en millis en UTC/GMT. millis
order.orderDateStringLa marca de tiempo de creación del pedido en formato de cadena en UTC/GMT. cadena
order.orderStatusEl 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.orderStatusDateLa marca de tiempo en millis en UTC/GMT del cambio más reciente de orderStatus en el sistema de Zonos. millis
order.orderStatusDateStringLa marca de tiempo en formato de cadena en UTC/GMT del cambio más reciente de orderStatus en el sistema de Zonos. cadena
order.paymentProcessingUn 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.captureDateLa 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.captureDateStringLa 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.cardTypeMarca de tarjeta de crédito. Si Zonos está procesando el pago, este nodo se excluye de la respuesta. cadena
order.paymentProcessing.lastFourLos ú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.paymentGatewayNombre de la pasarela de pago. Si Zonos está procesando el pago, indicará “iGlobal_CC” o “iGlobal_PayPal”.string
order.paymentProcessing.transactionTypeIndica 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.poNumberUn 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.quotedDutyTaxesDerechos e impuestos cotizados en Zonos Checkout, mostrados en USD; punto flotante positivo, dos decimales.integer
order.quotedDutyTaxesForeignDerechos e impuestos cotizados en Zonos Checkout. Mostrados en la moneda liquidada; punto flotante positivo, dos decimales.integer
order.referenceIdreferenceId único asociado con el pedido a través del punto final del servicio API createTempCart.string
order.shipCompleteIndica si el pedido debe enviarse en múltiples partes.boolean
order.shippingCarrierServiceLevelIdentificador del transportista y nivel de servicio para la opción de envío seleccionada.string
order.shippingInstructionsInstrucciones personalizables para el nivel de servicio de envío.string
order.shippingTotalTotal de envío en USD; punto flotante positivo, dos decimales.integer
order.shippingTotalForeignTotal de envío en la moneda liquidada; punto flotante positivo, dos decimales.integer
order.testOrderIndica si el pedido es un pedido de prueba.boolean
order.trackingNumberNúmero de seguimiento generado para el envío, si corresponde.string
order.zipDirecció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?