Factuarea APIDevelopers

Llistar tots els productes

Llista els productes del teu catàleg amb paginació per cursor.

GET
/products
AuthorizationBearer <token>

A: header

Paràmetres de consulta

limit?integer

Nombre d'objectes a retornar. Enter entre 1 i 100. Per defecte 25.

Predeterminat25
Rang1 <= value <= 100
starting_after?string

Cursor per a paginació cap endavant. Fes servir l'uuid de l'últim objecte de la pàgina anterior.

Formatuuid
ending_before?string

Cursor per a paginació cap enrere. Fes servir l'uuid del primer objecte de la pàgina actual.

Formatuuid
sku?string

SKU del producte. Coincidència exacta en sku.

sku[in]?string

SKU del producte. Llista separada per comes. Coincideix qualsevol dels valors.

sku[contains]?string

SKU del producte. Coincidència parcial sense distingir majúscules (LIKE %term%) sobre sku.

name?string

Nom del producte. Coincidència exacta en name.

name[contains]?string

Nom del producte. Coincidència parcial sense distingir majúscules (LIKE %term%) sobre name.

is_active?boolean

Filtra per productes actius / inactius. Coincidència exacta en is_active.

created[gte]?string

Data de creació (ISO 8601). Major o igual que el valor donat.

Formatdate-time
created[lte]?string

Data de creació (ISO 8601). Menor o igual que el valor donat.

Formatdate-time
created[gt]?string

Data de creació (ISO 8601). Estrictament major que el valor donat.

Formatdate-time
created[lt]?string

Data de creació (ISO 8601). Estrictament menor que el valor donat.

Formatdate-time
price[gte]?number

Preu unitari. Major o igual que el valor donat.

price[lte]?number

Preu unitari. Menor o igual que el valor donat.

price[gt]?number

Preu unitari. Estrictament major que el valor donat.

price[lt]?number

Preu unitari. Estrictament menor que el valor donat.

in_stock?boolean

Filtra per productes amb stock disponible (true → stock > 0) o sense stock (false → stock = 0). Coincidència exacta en in_stock.

low_stock?boolean

Filtra per productes amb stock baix (true → 0 < stock ≤ llindar configurat) o amb stock ampli (false → stock > llindar). Coincidència exacta en low_stock.

tag?string

Filtra per etiqueta de classificació. Admet múltiples valors amb tag[in]. Coincidència exacta en tag.

tag[in]?string

Filtra per etiqueta de classificació. Admet múltiples valors amb tag[in]. Llista separada per comes. Coincideix qualsevol dels valors.

search?string

Cerca de text lliure. LIKE %term% escapat (sense distingir majúscules, màx. 80 caràcters) sobre les columnes de text clau del recurs, combinat amb la resta de filtres (AND) i compatible amb el cursor.

Longitudlength <= 80
metadata?

Filtra per parells clau/valor de metadata usant la sintaxi deepObject metadata[key]=value. Diversos parells es combinen amb AND. Cada clau ha de complir [A-Za-z0-9_.-]{1,64}; es permeten un màxim de 50 parells (més → 422).

Headers

Factuarea-Version?string

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate
X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json