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

search
string | null

Texto que se busca en el SKU o el nombre, sin distinguir mayúsculas. Hasta 255 caracteres.

Maximum string length: 255
type
enum<string> | null

Solo los artículos de este tipo: stocked, non_stocked o service. Omítelo para todos los tipos.

Opciones disponibles:
stocked,
non_stocked,
service
status
enum<string> | null

Qué artículos incluir: active, archived o all. El valor predeterminado es active.

Opciones disponibles:
active,
archived,
all
after
string<uuid> | null

El next_cursor de la página anterior. Omítelo para la primera página.

fields[]
string[]

Valores de campos personalizados que deben tener los artículos, cada uno como key:value, como fields[]=material:Steel. Hasta 10. No se puede filtrar por campos confidenciales.

Pattern: ^[a-z][a-z0-9_]*:.+$

Respuesta

ItemPageResource

data
ItemPageResource · object
requerido

Una página de artículos, los más recientes primero.