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

Una caja para guardar como preajuste de paquete.

name
string
requerido

El nombre de la caja, como Sobre pequeño. Es único en la organización.

Maximum string length: 80
length
string
requerido

El largo de la caja en dimension_unit, como cadena decimal con hasta cuatro decimales.

Pattern: ^\d{1,8}(\.\d{1,4})?$
width
string
requerido

El ancho de la caja en dimension_unit, como cadena decimal con hasta cuatro decimales.

Pattern: ^\d{1,8}(\.\d{1,4})?$
height
string
requerido

La altura de la caja en dimension_unit, como cadena decimal con hasta cuatro decimales.

Pattern: ^\d{1,8}(\.\d{1,4})?$
dimension_unit
enum<string>
requerido

La unidad de length, width y height: mm, cm o in.

Opciones disponibles:
mm,
cm,
in
tare_weight
string
requerido

Lo que pesa la caja vacía en weight_unit, como cadena decimal. Se suma al peso de los artículos cuando un bulto no se pesa.

Pattern: ^\d{1,8}(\.\d{1,4})?$
weight_unit
enum<string>
requerido

La unidad de tare_weight: g, kg, oz o lb.

Opciones disponibles:
g,
kg,
oz,
lb
is_default
boolean

Si el cuadro de diálogo de envío empieza con esta casilla. Al establecerlo, se quita la marca de cualquier otro ajuste preestablecido. El valor predeterminado es false.

Respuesta

PackagePresetResource

data
PackagePresetResource · object
requerido

Un preajuste de paquete: una caja en la que empaca la organización, con su tamaño y su peso vacío.