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.

Parámetros de ruta

item
string
requerido

El ID del artículo, un UUID.

Cuerpo

application/json

Los campos de un artículo, para crearlo o editarlo. Un SKU son letras, dígitos y . _ - /, y empieza con una letra o un dígito. El peso, el tamaño y el código aduanero son lo que un transportista necesita para enviar el artículo.

sku
string
requerido

El SKU del artículo, de hasta 64 letras, dígitos y . _ - /, y debe empezar con una letra o un dígito. Es único en la organización, sin distinguir mayúsculas, así que ab-1 se rechaza cuando existe AB-1.

Maximum string length: 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9._\/-]*$
name
string
requerido

El nombre del artículo tal como aparece en los documentos y las etiquetas, de hasta 255 caracteres.

Maximum string length: 255
type
enum<string>
requerido

Qué tipo de artículo es: stocked se cuenta en existencias, non_stocked se compra o se usa sin contarse y service es trabajo, como un cargo de preparación.

Opciones disponibles:
stocked,
non_stocked,
service
make_or_buy
enum<string>
requerido

Si la organización fabrica el artículo, lo compra o hace ambas cosas: make, buy o both.

Opciones disponibles:
make,
buy,
both
description
string | null

Una descripción más larga del artículo, de máximo 5,000 caracteres. Omítela o envía null para dejarla vacía.

Maximum string length: 5000
brand
string | null

La marca bajo la que se vende el artículo, de máximo 255 caracteres.

Maximum string length: 255
custom_fields
object

Valores de campos personalizados por clave de campo: texto, un número (una cadena decimal es exacta), una fecha YYYY-MM-DD, un booleano o una de las opciones de un campo de selección. Los campos que se omiten se borran.

weight
string | null

El peso de una unidad base, como cadena decimal mayor que cero con hasta ocho dígitos y cuatro decimales. Se usa para tarifar y etiquetar los envíos.

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

La unidad en la que está weight: g, kg, oz o lb. Es obligatoria con un peso.

Opciones disponibles:
g,
kg,
oz,
lb
length
string | null

El largo de una unidad base, como cadena decimal mayor que cero con hasta ocho dígitos y cuatro decimales. Envía length, width y height juntos o ninguno.

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

El ancho de una unidad base, en el mismo formato que length. Es obligatorio con length o height.

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

La altura de una unidad base, en el mismo formato que length. Es obligatoria con length o width.

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

La unidad en la que están length, width y height: mm, cm o in. Es obligatoria con las dimensiones.

Opciones disponibles:
mm,
cm,
in
hs_code
string | null

El código del Sistema Armonizado con el que la aduana clasifica el artículo, de 6 a 10 dígitos sin puntos.

Pattern: ^\d{6,10}$

Respuesta

ItemResource

data
ItemResource · object
requerido

Un artículo que la organización fabrica, compra, almacena o vende, con los valores de sus campos personalizados y sus datos de envío.