Saltar al contenido principal
POST
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Cuerpo

application/json

El pedido y los paquetes a cotizar. Cuando se omite address, la dirección de envío del pedido, o en una devolución la dirección desde la que se envía, se lee de la dirección tal como está escrita.

order_id
string<uuid>
requerido

El ID del pedido de venta que se envía, un UUID.

packages
object[]
requerido

Los bultos, de 1 a 20. Cada etiqueta cubre un bulto.

Required array length: 1 - 20 elements
shipment_id
string<uuid> | null

El ID de un envío contabilizado del pedido. Solo se cotizan sus líneas, y una etiqueta de envío registra en él su transportista y número de seguimiento. Si se omite, se cotizan todas las líneas del pedido.

return_id
string<uuid> | null

El ID de la devolución autorizada a la que corresponde una etiqueta de devolución. Es obligatorio para una etiqueta de devolución y se rechaza para una etiqueta de envío.

address
object | null

Una dirección postal en campos, tal como la comprobó un miembro. Cuando se envía, line1, city, postal_code y country son obligatorios.

insured_value
string | null

El valor por el que se asegura el envío, como cadena decimal en la moneda del pedido. Si no se envía, no se pide seguro.

Pattern: ^\d{1,8}(\.\d{1,4})?$
signature
boolean

Si el transportista debe obtener una firma en la entrega. El valor predeterminado es false.

Respuesta

RateShopResource

data
RateShopResource · object
requerido

Todas las tarifas que cotizaron las conexiones de envío, ordenadas según la regla de la organización, y la tarifa que elige la regla.