Factuarea APIDevelopers

Listar todos los productos

Lista los productos de tu catálogo con paginación por cursor.

GET
/products
AuthorizationBearer <token>

En: header

Parámetros de consulta

limit?integer

Número de objetos a devolver. Entero entre 1 y 100. Por defecto 25.

Predeterminado25
Rango1 <= value <= 100
starting_after?string

Cursor para paginación hacia delante. Usa el uuid del último objeto de la página anterior.

Formatouuid
ending_before?string

Cursor para paginación hacia atrás. Usa el uuid del primer objeto de la página actual.

Formatouuid
sku?string

SKU del producto. Coincidencia exacta en sku.

sku[in]?string

SKU del producto. Lista separada por comas. Coincide cualquiera de los valores.

sku[contains]?string

SKU del producto. Coincidencia parcial sin distinguir mayúsculas (LIKE %term%) sobre sku.

name?string

Nombre del producto. Coincidencia exacta en name.

name[contains]?string

Nombre del producto. Coincidencia parcial sin distinguir mayúsculas (LIKE %term%) sobre name.

is_active?boolean

Filtra por productos activos / inactivos. Coincidencia exacta en is_active.

created[gte]?string

Fecha de creación (ISO 8601). Mayor o igual que el valor dado.

Formatodate-time
created[lte]?string

Fecha de creación (ISO 8601). Menor o igual que el valor dado.

Formatodate-time
created[gt]?string

Fecha de creación (ISO 8601). Estrictamente mayor que el valor dado.

Formatodate-time
created[lt]?string

Fecha de creación (ISO 8601). Estrictamente menor que el valor dado.

Formatodate-time
price[gte]?number

Precio unitario. Mayor o igual que el valor dado.

price[lte]?number

Precio unitario. Menor o igual que el valor dado.

price[gt]?number

Precio unitario. Estrictamente mayor que el valor dado.

price[lt]?number

Precio unitario. Estrictamente menor que el valor dado.

in_stock?boolean

Filtra por productos con stock disponible (true → stock > 0) o sin stock (false → stock = 0). Coincidencia exacta en in_stock.

low_stock?boolean

Filtra por productos con stock bajo (true → 0 < stock ≤ umbral configurado) o con stock amplio (false → stock > umbral). Coincidencia exacta en low_stock.

tag?string

Filtra por etiqueta de clasificación. Admite múltiples valores con tag[in]. Coincidencia exacta en tag.

tag[in]?string

Filtra por etiqueta de clasificación. Admite múltiples valores con tag[in]. Lista separada por comas. Coincide cualquiera de los valores.

search?string

Búsqueda de texto libre. LIKE %term% escapado (sin distinguir mayúsculas, máx. 80 caracteres) sobre las columnas de texto clave del recurso, combinado con los demás filtros (AND) y compatible con el cursor.

Longitudlength <= 80
metadata?

Filtra por pares clave/valor de metadata usando la sintaxis deepObject metadata[key]=value. Varios pares se combinan con AND. Cada clave debe cumplir [A-Za-z0-9_.-]{1,64}; se permiten un máximo de 50 pares (más → 422).

Headers

Factuarea-Version?string

Fija la versión de la API (YYYY-MM-DD, versionado por fecha estilo Stripe) para esta petición; omítelo para usar la versión fijada de la clave, o la última si no hay ninguna. Versión no soportada → 400 unsupported_api_version; malformada → 400 parameter_invalid_format. La versión efectiva se refleja en la cabecera de respuesta Factuarea-Version. Consulta la guía de Versioning.

Formatodate
X-Active-Profile?string

Opera en nombre de una empresa hija (API key maestra de gestoría): pasa su id público (UUID v7) y la petición se ejecuta contra los datos de esa hija sin cambiar el scope, el tier ni el environment de la clave (omítelo para usar la propia empresa de la clave). UUID inválido → 400 parameter_invalid_uuid; id desconocido o no propio → 404 profile_not_found. Consulta la guía de Acting on behalf.

Formatouuid

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

application/json