Factuarea APIDevelopers

Llistar tots els packs

Llista els packs de l'empresa amb paginació per cursor. - Filtra per search, slug (també troba slugs anteriors), sku, tag, channel, status, availability[in] i updated[gte]. - Ordena amb sort per created, name o price (prefix - per a ordre descendent). - view=storefront retorna només els packs a la venda a la web, sense camps interns. - Lectures condicionals: envia If-None-Match per obtenir 304 sense cos.

GET
/companies/{company}/packs

Authorization

AuthorizationBearer <token>

La teva API key com a token Bearer: fact_live_… en producció, fact_test_… en sandbox. Consulta la guia d'autenticació.

A: header

Paràmetres de ruta

company*string

Identificador públic (UUID v7) de l'empresa. Obtén-lo de GET /v1/me (data.scope[].id).

Formatuuid

Paràmetres de consulta

date?|

Dia (YYYY-MM-DD, zona horària de l'empresa) per al qual es resol la promotion. Per defecte, avui. Una data amb hora fa servir el seu dia. Format incorrecte: 400 parameter_invalid_iso8601.

limit?integer

Nombre d'objectes a retornar, entre 1 i 100 (25 per defecte).

Predeterminat25
Rang1 <= value <= 100
starting_after?string

Cursor de paginació cap endavant: passa l'id de l'últim objecte de la pàgina anterior (el next_cursor de la resposta anterior).

Formatuuid
ending_before?string

Cursor de paginació cap enrere: passa l'id del primer objecte de la pàgina actual.

Formatuuid
slug?string

Slug del pack. També troba els packs que el van fer servir abans. Coincidència exacta amb slug.

sku?string

SKU del pack. Coincidència exacta amb sku.

tag?string

Etiqueta de classificació. Coincidència exacta amb tag.

channel?string

Canal de venda per al qual està habilitat el pack: documents o web. Coincidència exacta amb channel.

Valor a"documents" | "web"
status?string

Estat del pack: active, inactive o archived. Coincidència exacta amb status.

Valor a"active" | "inactive" | "archived"
availability?string

Disponibilitat: in_stock, low, out_of_stock o untracked. Admet diversos valors amb availability[in]. Coincidència exacta amb availability.

Valor a"in_stock" | "low" | "out_of_stock" | "untracked"
availability[in]?string

Disponibilitat: in_stock, low, out_of_stock o untracked. Admet diversos valors amb availability[in]. Llista separada per comes. Coincideix qualsevol dels valors.

updated[gte]?string

Data de l'última actualització (ISO 8601). Major o igual que el valor indicat.

Formatdate-time
sort?string

Ordre: created, name, price ascendent, o amb prefix - per a descendent (per defecte created, el més antic primer).

Valor a"created" | "-created" | "name" | "-name" | "price" | "-price"
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
view?string

Forma del pack: all (per defecte) retorna el pack complet i storefront només el que pot mostrar una botiga web, i únicament dels packs a la venda allà. Qualsevol altre pack respon 404.

Predeterminat"all"
Valor a"all" | "storefront"

Headers

If-None-Match?string

Petició condicional: envia l'ETag que has desat d'una resposta anterior d'aquesta operació (entre cometes, tal com es va rebre) per obtenir 304 Not Modified sense body quan el contingut no ha canviat. Omet-lo per rebre sempre la resposta completa.

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

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json