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 familia de variantes nueva: su código, qué tipo de artículos son sus variantes, sus campos compartidos y las opciones en que difieren sus variantes.

code
string
requerido

El código de la familia, 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. Un patrón de SKU lo escribe como {family}.

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

Qué tipo de artículo es cada variante: stocked, non_stocked o service.

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

Si cada variante se fabrica, se compra o ambas cosas: make, buy o both.

Opciones disponibles:
make,
buy,
both
name
string
requerido

El nombre de la familia, de hasta 255 caracteres.

Maximum string length: 255
options
object[]
requerido

Las opciones en las que difieren las variantes, como Size y Color: de una a tres, en orden. Cada una tiene un name de hasta 50 letras, dígitos y espacios, único sin distinguir mayúsculas, y una lista de 1 a 50 values, cada uno de hasta 50 caracteres y único dentro de la opción, sin distinguir mayúsculas.

Required array length: 1 - 3 elements
description
string | null

Una descripción que comparten todas las variantes salvo que tengan la suya, de máximo 5,000 caracteres.

Maximum string length: 5000
custom_fields
object

Valores de campos personalizados que comparten las variantes de la familia: 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.

Respuesta

ItemFamilyPageResource

data
ItemFamilyPageResource · object
requerido

Una familia y sus variantes, por SKU.