Puntos finales
Solicitar cotizaciones de envío
POST | https://api.iglobalstores.com/2.0/shipping-quotes - Crea una nueva solicitud de cotizaciones de envío sobre los artículos en el carrito de compras que incluye aranceles e impuestos de importación, además de información de verificación de restricciones de artículos.
Solicitud HTTPS
| Campo | Notas |
|---|---|
| Método HTTP | POST |
| URL del punto final | https://api.iglobalstores.com/2.0/shipping-quotes |
| Protocolo | HTTPS |
| Formato del mensaje | JSON |
| Encabezado HTTP de aceptación | Accept: application/json |
| Encabezado HTTP de Token de Seguridad | serviceToken: valor-de-su-token-de-pruebaAgregue un encabezado a su solicitud HTTPS llamado serviceToken con un valor de su Token de API de Seguridad de Prueba. (Póngase en contacto con su Gerente de Cuenta para obtener este token) |
| Encabezado HTTP de Tipo de Contenido | Content-Type: application/jsonComo estará enviando datos JSON al servicio, agregue un encabezado a su solicitud HTTPS llamado Content-Type con un valor de application/json |
PARES DE CLAVE/VALOR JSON en el cuerpo de la solicitud
Formato del mensaje: JSON
Solicitud de ejemplo
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
"boxCount": null,
"items": [
{
"cartItemId": 1,
"detailedDescription": "description including options, material content, etc",
"category": "sunglasses",
"productId": "17898-675234",
"sku": "oakley-123",
"unitPrice": 199.0,
"quantity": 1,
"length": 2.5,
"width": 6.5,
"height": 2.5,
"dimensionalUnits": null,
"weight": 4,
"weightUnits": "OZ",
"hsCode": null,
"brandName": "Oakley",
"countryOfOrigin": "CN"
},
{
"cartItemId": 2,
"detailedDescription": "description including options, material content, etc",
"category": "sunglasses",
"productId": "17898-675235",
"sku": "oakley-125",
"unitPrice": 179.0,
"quantity": 1,
"length": 2.5,
"width": 6.5,
"height": 2.5,
"dimensionalUnits": null,
"weight": 4,
"weightUnits": "OZ",
"hsCode": null,
"brandName": "Oakley",
"countryOfOrigin": "CN"
}
],
"shippingAmountOverride": null,
"shipFromAddress": null,
"shipToAddress": {
"name": "John Doe",
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"state": "Alberta",
"stateCode": "AB",
"postalCode": "T2P 5G8",
"countryCode": "CA"
}
}
Definiciones de JSON de solicitud
| Campo | Notas |
|---|---|
boxCount | Este campo describe las cajas que se utilizarán para enviar el pedido. No se espera que un comerciante sepa esto en el momento del pedido; sin embargo, si se conoce, se puede pasar en el siguiente formato específico.Valor de ejemplo: 22x15x15(1),8x8x4(2),32x22x14(1)Formato: Lista separada por comas de dimensiones y cantidad de cajas. En el ejemplo anterior, hay un total de 4 cajas. La primera caja en la lista tendrá 22 pulgadas de largo, 15 pulgadas de ancho y 15 pulgadas de alto. Solo se utilizará una caja de ese tamaño. Habrá dos cajas de tamaño 8x8x4 pulgadas. Es aceptable pasar la misma dimensión de caja varias veces si eso es fácil para usted, como esto: “22x15x15(1),22x15x15(1)”, lo que significa 2 cajas de tamaño 22x15x15 pulgadas. |
items REQUIRED | Una lista de mapas de artículos |
items[index].brandName | El nombre de la marca del artículo específico ayudará a nuestro motor de reglas a determinar mejor si se aplica una restricción al artículo para el país de destino. Incluso si el nombre de la marca de un artículo coincide o no textualmente con una restricción específica, nuestro motor de reglas utilizará el SKU del artículo y/o productId para decidir mejor si el artículo está de hecho restringido en el país de destino. Por favor, envíe el nombre de la marca si está disponible.Valores de ejemplo: “Oakley” o “Nike” o null |
items[index].cartItemId REQUIRED | Este campo es obligatorio para identificar el artículo, específicamente dentro de la lista de artículos. Puede ser tan simple como un valor de índice. Usaremos este cartItemId para identificar un artículo si está restringido en la respuesta JSON. Así que asegúrese de poder identificar el mismo artículo en su carrito mediante este cartItemId que nos está pasando.Valores de ejemplo: 1 o 2 o 3 |
items[index].category | Las categorías de productos: el producto específico del que forma parte. La categoría ayudará a nuestro motor de reglas a determinar mejor si se aplica una restricción al artículo para el país de destino. Incluso si la categoría de un artículo coincide o no textualmente con una restricción específica, nuestro motor de reglas utilizará el SKU del artículo y/o productId para decidir mejor si el artículo está de hecho restringido en el país de destino.Formato: Una lista de nombres de categorías separadas por barras verticales. Cada nombre de categoría puede ser una o más palabras. Si un artículo existe en más de una categoría, por favor enumérelas ambas separadas por un carácter de barra vertical “”.Valores de ejemplo: “Gafas de sol” o “Accesorios de nocheBolsos de mano” |
items[index].countryOfOrigin | El país de origen es el país en el que se fabricó el artículo o del que proviene originalmente. El país de origen ayudará a nuestro motor de reglas a determinar mejor si una restricción se aplica al artículo para el país de destino. Algunos países no permiten ciertos tipos de mercancías de otros países específicos. Ejemplos de valores: "CN" para China o "US" para Estados Unidos o nulo |
items[index].detailedDescription REQUERIDO | Este campo es simplemente texto, pero debe incluir la mayor cantidad de información posible sobre el artículo que se está comprando. Por ejemplo, el nombre completo y el código del artículo si corresponde, el color u otras opciones seleccionadas, el contenido material y cualquier texto descriptivo que tenga para el artículo. Existen muchos tipos diferentes de restricciones de importación en países extranjeros, como los zapatos de cuero en Italia. A veces, la única forma de detectar estos artículos restringidos es a través de la detailedDescription. Nota: Incluso si la detailedDescription de un artículo coincide o no textualmente con una restricción específica, nuestro motor de reglas utilizará el SKU del artículo y/o el productId para decidir mejor si el artículo está restringido en el país de destino. Para obtener los mejores resultados, por favor envíe la mayor cantidad de información posible en el campo detailedDescription. Ejemplo de valor: "Tory Burch, Robinson - Double Zip' Tote, color: New Carnival, contenido material: cuero, El cuero rico en color aporta un atractivo llamativo a un bolso estructurado de forma ordenada, rematado con hardware de logotipo y asas enrolladas para un aspecto completamente sofisticado. Cierre con broche magnético con compartimentos de doble cremallera. Bolsillos interiores con cremallera, de pared y para teléfono celular. Pies metálicos protectores. Cuero. De Tory Burch; importado." |
items[index].height | Esta es la altura de su artículo. Hay otro campo llamado dimensionalUnits, donde especifica pulgadas o centímetros para esta medida. Por favor, proporcione sin comas y con no más de dos decimales. Ejemplo de valor: 25.5 Sus tarifas de envío serán las más precisas si proporciona este campo. |
items[index].hsCode | Este es el código HS que identifica el artículo en países extranjeros. Pasar el hsCode ayudará a identificar correctamente el arancel de importación correcto rate para el artículo específico. No es obligatorio si no está disponible, nosotros nos encargaremos si no lo tiene. Formato: Ya sea un código de 10 dígitos o de 6 dígitos; puede incluir los caracteres separadores "." o no. Ejemplos de valores: "20.4560.0000" o "20.4560" o "204560" (se aceptan códigos de 10 o 6 dígitos) |
items[index].length | Esta es la longitud de su artículo. Hay otro campo llamado dimensionalUnits, donde especifica pulgadas o centímetros para esta medida. Por favor, proporcione sin comas y con no más de dos decimales. Ejemplo de valor: 25.5 Sus tarifas de envío serán las más precisas si proporciona este campo. |
items[index].productId | Este es su ID de producto para el artículo específico. Nuestro motor de reglas utilizará este valor como un ID para vincular la información del artículo aprendida a su artículo. Ejemplo de valor: "17898-675235" Por favor, pase al menos el productID o el SKU. Se prefiere pasar ambos. |
items[index].quantity REQUERIDO | Esta es la cantidad que se está comprando del artículo específico. Por favor, proporcione un entero positivo, sin comas y sin decimales. Ejemplos de valores: 1 o 9999 (¡preferimos que venda más artículos que menos!) |
items[index].sku | Este es su SKU para el artículo específico. Nuestro motor de reglas utilizará este valor como un ID para vincular la información del artículo aprendida a su artículo. Ejemplo de valor: "oakley-125" Por favor, pase al menos el productId o el SKU. Se prefiere pasar ambos. |
items[index].unitPrice REQUERIDO | Este es el precio unitario de su artículo en USD (dólares estadounidenses). Por favor, proporcione sin comas, sin el signo de dólar "$" y con dos decimales. Ejemplo de valor: 2102.99 |
items[index].weight | Este es el peso de su artículo. Hay otro campo llamado weightUnits, donde especifica libras, onzas, gramos o kilogramos para esta medida. Por favor, proporcione sin comas y con no más de dos decimales. Valor de ejemplo: 4.2 Sus tarifas de envío serán las más precisas si pasa este campo. |
items[index].weightUnits | Por defecto, es "LB" para libras. La unidad de medida para el valor de peso. Si se establece en nulo, se asumirá "LB" (libras). Valores de ejemplo: "LB" para libras, "OZ" para onzas, "G" para gramos, "KG" para kilogramos o nulo. |
items[index].width | Este es el ancho de su artículo. Hay otro campo llamado dimensionalUnits, donde especifica pulgadas o centímetros para esta medida. Por favor, proporcione sin comas y con no más de dos decimales. Valor de ejemplo: 25.5 Sus tarifas de envío serán las más precisas si pasa este campo. |
shipFromAddress | Si se pasa como nulo, utilizaremos una dirección predeterminada shipFromAddress asociada con su cuenta de comerciante. Esta es la dirección desde la cual se enviará el pedido, es decir, su almacén. Este es un mapa que contiene los siguientes campos de dirección: address1, address2, address3, city, state, stateCode, postalCode, 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. |
shippingAmountOverride | Esto solo se usa si conoce el costo de envío antes de llamar a la API. Está en USD (dólares estadounidenses). Por favor, proporcione sin comas, sin el signo de dólar "$" y con dos decimales. Esta función no funcionará sin configurarla con un representante de Zonos. Valor de ejemplo: 212.99 |
shipToAddress REQUERIDO | Esta es la dirección a la que se enviará el pedido. Este es un mapa que contiene los siguientes campos de dirección: name, address1, address2, address3, city, state, stateCode, postalCode, countryCode. Estos campos contenidos son requeridos o no basados en el país. El punto final de localización devuelve qué campos de dirección específicos son requeridos para cada país. Nota: name y stateCode siempre no son requeridos y no se declaran en el punto final de localización. Puede pasar name y/o stateCode, si están disponibles. |
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.
Solicitud de ejemplo
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
{
"shippingQuotes": [
{
"id": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"carrier": "UPS",
"conversionRate": 1.32,
"currencyCode": "CAD",
"displayName": "Express Air 2-4 Day Delivery",
"duty": 10.2,
"dutyTaxBrokerageFee": 5.0,
"dutyTaxCarrierPrepaymentFee": 5.0,
"dutyTaxEnabled": true,
"dutyTaxForced": false,
"dutyTaxTotal": 29.38,
"dutyTaxUnderDeminimus": false,
"restrictedItems": [
{
"cartItemId": 1,
"message": "We are unable to sell Oakley products to your country.",
"reasonCode": "BRAND_COUNTRY"
},
{
"cartItemId": 2,
"message": "We are unable to sell Oakley products to your country.",
"reasonCode": "BRAND_COUNTRY"
}
],
"shippingTotal": 23.62,
"taxOrVat": 9.18
},
{
"id": "80c57724-ab4e-4997-8477-08b668fef103",
"carrier": "USPS",
"conversionRate": 1.32,
"currencyCode": "CAD",
"displayName": "Post 5-10 Day Delivery",
"duty": 9.2,
"dutyTaxBrokerageFee": 5.0,
"dutyTaxCarrierPrepaymentFee": 5.0,
"dutyTaxEnabled": true,
"dutyTaxForced": false,
"dutyTaxTotal": 27.38,
"dutyTaxUnderDeminimus": false,
"restrictedItems": [
{
"cartItemId": 1,
"message": "We are unable to sell Oakley products to your country.",
"reasonCode": "BRAND_COUNTRY"
},
{
"cartItemId": 2,
"message": "We are unable to sell Oakley products to your country.",
"reasonCode": "BRAND_COUNTRY"
}
],
"shippingTotal": 13.62,
"taxOrVat": 8.18
}
]
}
Definiciones de JSON de respuesta
| Campo | Notas |
|---|---|
shippingQuotes | Esta es una lista de mapas de cotizaciones de envío. |
shippingQuotes[index].carrier | La compañía de transporte a la que se refiere la cotización de envío. Solo se establece en nulo si el comerciante ha solicitado configurar perfiles de envío genéricos, no específicos de una compañía de transporte. Las cotizaciones de envío no necesitan ser específicas de una compañía de transporte; pero pueden serlo. Contacte a su Gerente de Cuenta para obtener ayuda en la configuración de sus perfiles de envío. Valores de ejemplo: UPS o FEDEX o DHL o USPS o CAPOST o nulo |
shippingQuotes[index].displayName | Nombre para mostrar de la opción de envío, adecuado para ser mostrado al comprador. Estos valores son personalizables para el comerciante. Contacte a su Gerente de Cuenta para hacerlo. Valor de ejemplo: “Entrega Express en 2-4 días” |
shippingQuotes[index].duty | La cantidad de aranceles de importación incluida en el dutyTaxTotal. Esta cantidad está en USD, no contendrá comas y contendrá dos decimales. Valor de ejemplo: 8.29 |
shippingQuotes[index].dutyTaxBrokerageFee | Esto es lo que el corredor de importación extranjero le cobrará por procesar sus aranceles e impuestos de importación. Esta cantidad está incluida en el dutyTaxTotal. La cantidad está en USD, no contendrá comas y contendrá dos decimales. Valor de ejemplo: 5.00 |
shippingQuotes[index].duyTaxCarrierPrepaymentFee | Esto es lo que la compañía de transporte le cobrará por prepay los aranceles e impuestos al país de importación. Esta cantidad está incluida en el dutyTaxTotal. La cantidad está en USD, no contendrá comas y contendrá dos decimales. Valor de ejemplo: 5.00 |
shippingQuotes[index].duyTaxEnabled | Si esta cotización de envío permite al comprador prepay sus aranceles e impuestos de importación. Si se establece en falso, el dutyTaxTotal debe ser ignorado. Valores de ejemplo: true o false |
shippingQuotes[index].duyTaxForced | Si esta cotización de envío obliga al comprador a prepay sus aranceles e impuestos de importación. Si se establece en true, debe incluir el dutyTaxTotal en el pedido, explicando al comprador que es necesario con esta opción de envío específica. Si se establece en false, puede permitir al comprador elegir si desea prepay sus aranceles e impuestos de importación. Valores de ejemplo: true o false |
shippingQuotes[index].dutyTaxTotal | El costo total de aranceles e impuestos para la cotización de envío dada. Los aranceles e impuestos pueden ser opcionales, no estar disponibles o ser obligatorios para la cotización de envío dada. Esta cantidad no está incluida en el shippingTotal. Esta cantidad está en USD, no contendrá comas y contendrá dos decimales. Valor de ejemplo: 19.55 |
shippingQuotes[index].dutyTaxUnderDeMinimis | Si el total del pedido, utilizando esta opción de envío específica, está por debajo del monto mínimo tanto para el impuesto al valor agregado (IVA) como para el arancel mínimo. Si se establece en true, el dutyTaxTotal se establecerá en 0.00, y debe informar al cliente que no habrá aranceles e impuestos de importación pendientes en su pedido. Además, se debe exigir el pago anticipado de aranceles e impuestos, porque el costo es de 0.00. |
shippingQuotes[index].id | Un identificador para la cotización de envío específica; un UUID de 36 caracteres. Valor de ejemplo: bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a |
shippingQuotes[index].restrictedItems | Esta es una lista de mapas que contiene detalles sobre cualquier artículo en el carrito que está restringido usando esta cotización de envío específica. Cada artículo restringido tiene un reasonCode. La razón puede ser específica o no para la opción de envío. Algunas razones para las restricciones de los artículos son debido a leyes de importación del país, restricciones de marca o incluso reglas creadas por el comerciante. Cada vez que un comprador elige una opción de envío, los artículos del carrito deben ser cotejados con la lista de restrictedItems de la cotización de envío. Si alguno de los artículos del carrito está restringido, se debe mostrar un mensaje al comprador y el/los artículo(s) restringido(s) deben ser eliminados del total del pedido, etc. |
shippingQuotes[index].restrictedItems[index].cartItemId | Este es el cartItemId del JSON de solicitud de un artículo de carrito restringido. Deberías poder vincular este cartItemId a un artículo específico en el carrito de tu comprador. Valores de ejemplo: 1 o 2 o 3 |
shippingQuotes[index].restrictedItems[index].message | Este es un mensaje que puede mostrarse al comprador sobre por qué el artículo está restringido. Estos mensajes son personalizables por el comerciante. Por favor, contacta a tu representante de Zonos para más detalles. Valor de ejemplo: “No podemos vender productos de Oakley a tu país.” |
shippingQuotes[index].restrictedItems[index].reasonCode | Este es el código de razón por la cual el artículo está restringido. Las restricciones son siempre específicas del país y nuestros códigos de razón hacen que eso sea obvio. Valores de ejemplo: BRAND_COUNTRY o IMPORT_COUNTRY o EXPORT_COUNTRY o CARRIER_COUNTRY o MERCHANT_COUNTRY``BRAND_COUNTRY significa que has especificado que no puedes vender una marca a un conjunto específico de países.IMPORT_COUNTRY significa que el país importador no permitirá la importación del artículo.EXPORT_COUNTRY significa que el país exportador (generalmente Estados Unidos) no permitirá la exportación del artículo.CARRIER_COUNTRY significa que el transportista específico no llevará el artículo.MERCHANT_COUNTRY significa que has establecido una regla de restricción personalizada que el artículo ha activado. |
shippingQuotes[index].shippingTotal | El costo total del envío para la cotización de envío dada. Las cotizaciones de envío también pueden tener un monto de dutyTaxTotal, que no está incluido en este shippingTotal. Este monto está en USD, no contendrá comas y contendrá dos decimales. Valor de ejemplo: 25.82 |
shippingQuotes[index].taxOrVat | El monto de impuestos o IVA incluido en el dutyTaxTotal. Para algunos países, esto es un impuesto; para otros, es un IVA. Este monto está en USD, no contendrá comas y contendrá dos decimales. Valor de ejemplo: 4.35 |
API heredada de Landed Cost
Aprenda cómo funciona la API heredada de Landed Cost.La información a continuación es para nuestra API heredada de Landed Cost. Consulte nuestra API de Landed Cost para la versión más reciente.
El punto final de cotizaciones de envío acepta detalles sobre el carrito de compras de su cliente, devuelve cotizaciones de envío completas con aranceles e impuestos de importación, y verifica los artículos en busca de restricciones. Estas cotizaciones de envío devueltas se basan en perfiles de envío que se configuran antes de utilizar este punto final de la API.
Tenemos perfiles de envío predeterminados para fines de prueba, pero deberá trabajar con su Gerente de Cuenta para configurar los perfiles de envío reales y las configuraciones que su empresa desea utilizar.