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.

Parámetros de ruta

order
string
requerido

El ID del pedido de venta, un UUID.

Cuerpo

application/json

Mercancía que sale contra un pedido de venta, con hasta 50 líneas y 20 paquetes.

lines
object[]
requerido

Lo que se envió, de 1 a 50 líneas. Ninguna línea puede enviar más de lo que queda en su línea del pedido.

Required array length: 1 - 50 elements
id
string<uuid> | null

Un UUIDv7 que el cliente eligió para el envío, para poder nombrarlo antes de recibir respuesta.

shipped_on
string<date> | null

La fecha en que se enviaron los productos, como YYYY-MM-DD. Hoy si se omite.

carrier
string | null

El transportista que recogió los productos, como UPS, de hasta 64 caracteres.

Maximum string length: 64
tracking_number
string | null

El número de seguimiento del transportista, de hasta 128 caracteres. También se puede definir después de contabilizar.

Maximum string length: 128
note
string | null

Una nota impresa en la lista de empaque, de hasta 1,000 caracteres.

Maximum string length: 1000
packages
object[] | null

Los bultos en los que salieron los productos, tal como se empacaron, hasta 20.

Maximum array length: 20

Respuesta

ShipmentResource

data
ShipmentResource · object
requerido

Mercancía enviada contra un pedido de venta, con los lotes, números de serie y costo de cada línea.