Puntos finales
Solicitar detalles de pedido completado
POST | https://api.iglobalstores.com/2.0/order-completed - Crea una nueva solicitud de información relacionada con un pedido completado.
Solicitud HTTPS
| Campo | Notas |
|---|---|
| Método HTTP | POST |
| URL del punto final | https://api.iglobalstores.com/2.0/order-completed |
| Protocolo | HTTPS |
| Formato del mensaje | JSON |
| Encabezado HTTP de aceptación | Accept: application/json |
| Encabezado HTTP de token de seguridad | serviceToken: valor-de-tu-token-de-pruebaAgrega un encabezado a tu solicitud HTTPS llamado serviceToken con un valor de tu token de API de seguridad de prueba. (Contacta a tu Gerente de Cuenta para obtener este token.) |
| Encabezado HTTP de tipo de contenido | Content-Type: application/jsonComo estarás enviando datos JSON al servicio, agrega un encabezado a tu solicitud HTTPS llamado Content-Type con un valor de application/json |
Pares clave/valor JSON en el cuerpo de la solicitud
Formato del mensaje: JSON
Ejemplo de solicitud
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"billingAddress": {
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"countryCode": "CA",
"postalCode": "T2P 5G8",
"state": "Alberta",
"stateCode": null
},
"billingCompany": null,
"billingEmail": "jdoe@jdoe.com",
"billingName": "John E. Doe",
"billingPhone": "+1 555-555-5555",
"orderGrandTotal": 1225.89,
"orderNumber": "854725421",
"paymentTypeCode": "PAYPAL",
"prepaidDutyTax": true,
"shippingQuoteId": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"shipToCompany": null,
"shipToEmail": "jdoe@jdoe.com",
"shipToName": "John Doe",
"shipToPhone": "+1 555-555-5555"
}
Definiciones JSON de solicitud
| Campo | Notas |
|---|---|
billingAddress REQUERIDO | Esta es la dirección de facturación del pedido. Es un mapa que contiene los siguientes campos de dirección: address1, address2, address3, city, state, stateCode, postalCode y countryCode. Estos campos contenidos son requeridos o no requeridos según el país. El punto final de localización devuelve qué campos de dirección específicos son requeridos o no para cada país. Nota: stateCode siempre no es requerido y no se declara en el punto final de localización. Puede pasar stateCode, si está disponible. |
billingCompany OPCIONAL | Este es el nombre de la empresa de facturación del pedido. |
billingEmail REQUERIDO | Esta es la dirección de correo electrónico de facturación del pedido. |
billingName REQUERIDO | Este es el nombre completo de facturación del pedido. |
billingPhone REQUERIDO | Este es el número de teléfono de facturación del pedido. |
items[index].orderGrandTotal REQUERIDO | Este es el total pagado por el comprador por su pedido en USD (Dólares estadounidenses). Por favor, proporcione sin comas, sin el signo de dólar "$" y con dos decimales. Valor de ejemplo: 2102.99 |
items[index].orderNumber REQUERIDO | Este es el número de pedido para el pedido recién completado. Valor de ejemplo: 854725421 |
paymentTypeCode REQUERIDO | El método de pago utilizado por el comprador para pagar su pedido. Valores de ejemplo: PayPal o Visa o MC o AMEX o DISC |
prepaidDutyTax REQUERIDO | ¿El comprador optó por prepay sus aranceles e impuestos de importación o se vio obligado a prepay? Si es así, establezca en true; si no, establezca en false. Valores de ejemplo: true o false |
shippingQuoteId REQUERIDO | Este es el ID de la cotización de envío que eligió el comprador. Los detalles del carrito deben ser los mismos que cuando se obtuvieron las cotizaciones de envío. Si los detalles del carrito han cambiado, entonces debería haber solicitado nuevas cotizaciones de envío antes de completar el pedido del comprador. |
shipToCompany OPCIONAL | Este es el nombre de la empresa de la persona que recibirá el pedido enviado. |
shipToEmail REQUERIDO | Esta es la dirección de correo electrónico de la persona que recibirá el pedido enviado. |
shipToName REQUERIDO | Este es el nombre completo de la persona que recibirá el pedido enviado. |
shipToPhone REQUERIDO | Este es el número de teléfono de la persona que recibirá el pedido enviado. |
Respuesta HTTPS
Formato del mensaje: JSON
Ejemplo de respuesta solo para Canadá y Australia
Nota: Las respuestas reales contendrán todos los países admitidos.
Ejemplo de respuesta
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
Definiciones de respuesta JSON
| Campo | Notas |
|---|---|
deniedParty | Este es un mapa de los resultados de la verificación de partes denegadas. Si se establece en nulo, entonces la verificación de partes denegadas no se realizó. Contacte a su representante de Zonos si se encuentra con esto. |
deniedParty.flagged | Si este pedido ha coincidido con un registro en las listas consolidadas de partes denegadas de Zonos. Si es verdadero, revise este pedido antes de procesarlo. En caso de duda, no procese un pedido que esté marcado como verdadero. Ejemplos de valores: verdadero o falso |
deniedParty.source | Si el campo marcado fue establecido en verdadero, este campo contendrá referencias de origen útiles para revisar por qué el pedido fue marcado como coincidente con una parte denegada. |
igOrderId | Identificador de Zonos para el pedido recién completado. Valor de ejemplo: e55a4efc-e615-49af-b3a4-afcda87e9e5e |
API de Pedido Completado Legacy
Aprende cómo funciona la API de Pedido Completado Legacy.El punto final de Pedido Completado acepta los detalles finales del pedido del comprador, verifica los detalles del pedido para partes denegadas y devuelve los resultados junto con un ID de pedido específico de Zonos.