Todas las colecciones
API
Cómo funciona la API Get Rates
Cómo funciona la API Get Rates

Descubre todo lo que necesitas saber sobre la API Get Rates

Actualizado hace más de una semana

Este método recopila las tarifas del transportista para un envío específico en +170 transportistas con la misma llamada API.

💡Con este método puedes:

  • Recopilar todas las tarifas de tus transportistas en tiempo real

  • Comparar las tarifas de tus transportistas para escoger la mejor opción durante la preparación del pedido

  • Mejorar la tasa de conversión mostrando las tarifas en tiempo real en el checkout

  • Aplicar un marcado a los gastos de envío

Índice

1. Antes de empezar

Para pruebas puedes utilizar el transportista genérico de ShippyPro para generar tarifas de prueba. Consulta aquí si necesitas ayuda para configurarlo

📌 También puedes agregar el atributo CarrierOptions para obtener tarifas para servicios específicos del transportista.

📌 La API GetRates funcionará de acuerdo a las Reglas de Envío aplicadas. Si tu llamada a GetRates no devuelve Tarifas ni errores para un envío específico, asegúrate de que las Reglas de Envío estén correctamente configuradas y no estén bloqueando esas SKUs.

📌Recuerda rellenar el campo TransactionID del pedido en la API_GetRates para utilizar la regla ShippingService, de lo contrario se omitirá. Si el campo TransactionID no está poblado, no se podrá aplicar el filtro para ShippingService.

Para valorar correctamente el transactionID, necesitará un pedido previamente importado de un marketplace o creado manualmente mediante PutOrder

📌 Si tus tarifas GetRates no coinciden con la tarifa mostrada en "Para enviar", asegúrate de que tanto GetRates como las unidades de medida de Mi perfil > Preferencias coinciden.

📌 Al hacer referencia al RateID de la respuesta de la llamada a la API de envío, también podrás utilizar nuestra función de análisis de facturas. (Esta función no es compatible con todos los servicios de mensajería. Habla con nuestros expertos si el servicio de mensajería que deseas utilizar admite esta función).

📌Puedes filtrar esta llamada para servicios específicos rellenando el campo RateCarriers con el nombre e ID del transportista, que puedes recopilar en la página APIKEYS de ShippyPro. Por ejemplo RateCarriers: ["Nombre|ID,Nombre|ID"]

⚠️ ¿Es lenta la respuesta a la llamada GetRates?

Recomendamos utilizar filtros rellenando el campo RateCarriers.

Si hay varias conexiones de transportista, consultarlas todas para recibir tarifas puede alargar la espera.

📍 Para obtener las tarifas de Amazon y AMF necesitas tener el pedido de referencia ya importado en la plataforma de ShippyPro en la sección "Para enviar"

2. Cómo funciona

Para llamar a la API GetRates hay que copiar estos parámetros del cuerpo:

Nombre

Tipo de info

Requerido

Vacío

Descripción

Longitud máx

to_address

Matriz

true

false

Info dirección destinatario

name

cadena

true

false

Nombre destinatario

company

cadena

true

true

Empresa destinatario

street1

cadena

true

false

Destinatario dirección línea 1

Depende del transportista

street2

cadena

true

true

Destinatario dirección línea 2

Depende del transportista

city

cadena

true

false

Ciudad destinatario

state

cadena

true

false

Estado destinatario

zip

cadena

true

false

Código postal destinatario

Depende del país

country

cadena

true

false

País destinatario (ISO 3166)

2 car

phone

cadena

true

false

Teléfono destinatario

Longitud teléfono según país

email

cadena

false

false

Email destinatario

64 car

from_address

Matriz

true

false

Info dirección remitente

name

cadena

true

false

Nombre remitente

company

cadena

true

true

Empresa remitente

street1

cadena

true

false

Remitente dirección línea 1

street2

cadena

true

true

Remitente dirección línea 2

city

cadena

true

false

Ciudad remitente

state

cadena

false

true

Estado remitente

zip

cadena

true

false

Código postal remitente

Depende del país

country

cadena

true

false

País remitente (ISO 3166)

2 car

phone

cadena

true

false

Teléfono remitente

Depende del país

email

cadena

true

false

Email remitente

parcels

Matriz

true

false

Info paquetes (Mínimo 1)

4 objetos cada uno

dimension_unit

cadena

false

false

Unidad de medida de longitud del paquete "CM" (por defecto), "IN"

2 car

length

int

true

false

Longitud paquete

width

int

true

false

Ancho paquete

height

int

true

false

Altura paquete

weight_unit

cadena

false

false

Unidad de medida del peso del paquete: "KG" (por defecto), "LB", "OZ"

2 car

weight

flotante

true

false

Peso paquete

2 decimales

Insurance

flotante

false

false

Valor de seguro (por defecto: 0)

InsuranceCurrency

cadena

false

false

Divisa del seguro (por defecto: "EUR"), ver aquí

3 car

CashOnDelivery

flotante

false

false

Valor de envío contra reembolso (por defecto: 0)

CashOnDeliveryCurrency

cadena

false

false

Divisa de envío contra reembolso (por defecto: "EUR"), ver aquí

3 car

ContentDescription

cadena

true

false

Descripción del contenido

255 car

TotalValue

cadena

false ⚠️

true

Valor del pedido incluida divisa (p.ej. 120.50 EUR) ⚠️ Requerido para envíos internacionales

ShippingService

cadena

true

true

Servicio de envío seleccionado por el cliente (p.ej. Express, estándar)

RateCarriers

Matriz

false

false

Tarifas solo de transportistas específicos ["DHLExpress", …]

TransactionID

cadena

false

false

Tu número interno de referencia del pedido

35 car

⚠️ Ten en cuenta que el atributo de respuesta delivery_days puede ser tanto un número (por ejemplo, 2) como una cadena (por ejemplo, "2-5").

3. Referencias de la API Get Rates

Visita la Documentación de nuestra API para ver un ejemplo de solicitud y respuesta de la API Get Rates.

💡 ¿Cómo puedo filtrar esta llamada para transportistas conectados específicos?

Puedes filtrar esta llamada para servicios específicos rellenando el campo RateCarriers con el nombre e ID del transportista que puedes obtener en la página APIKEYS.

Por ejemplo, RateCarriers: ["Nombre|ID,Nombre|ID"].

Habla con nuestros expertos para obtener más información sobre nuestras API y llevar tu negocio al siguiente nivel.

:muscolo:
¿Ha quedado contestada tu pregunta?