Saltar al contenido principal
PUT
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

Cómo envía la organización: cómo se elige una tarifa, el formato de la etiqueta, los correos electrónicos al cliente y la dirección de devolución en ship_from. Si se omite ship_from, las etiquetas salen desde la dirección de la ubicación del pedido.

rate_rule
enum<string>
requerido

Cómo se elige una tarifa entre las cotizaciones: cheapest, fastest o preferred.

Opciones disponibles:
cheapest,
fastest,
preferred
label_format
enum<string>
requerido

El formato de archivo en que se compran las etiquetas: pdf, zpl o png.

Opciones disponibles:
pdf,
zpl,
png
preferred_carrier
string | null

El transportista que la regla preferred pone primero, comparado con el carrier de una cotización sin distinguir mayúsculas. Es obligatorio cuando rate_rule es preferred.

Maximum string length: 60
preferred_service
string | null

El servicio del transportista preferido que se pone primero, comparado con el service o service_code de una cotización sin distinguir mayúsculas de minúsculas. Si no se envía, todos los servicios de ese transportista quedan en el mismo lugar.

Maximum string length: 120
max_transit_days
integer | null

Se descartan las tarifas más lentas que esta cantidad de días, y también las que no tienen tiempo de tránsito. Si se omite, ninguna tarifa se descarta por su tiempo de tránsito.

Rango requerido: 1 <= x <= 60
notify_customer
boolean

Si se envía un correo electrónico a los clientes a medida que avanza su paquete. El valor predeterminado es false.

ship_from
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.

Respuesta

ShippingSettingsResource

data
ShippingSettingsResource · object
requerido

Cómo envía la organización: cómo se elige una tarifa, el formato de la etiqueta, los correos electrónicos al cliente y la dirección de devolución.