Factuarea APIDevelopers

Retrieve a pack

Retrieve a pack by its id, with its price, components, gallery and, in view=all, its availability and internal state. - view=storefront returns the web view; a pack that is not on sale there answers 404 like an unknown id. - Conditional reads: send If-None-Match to get 304 with no body.

GET
/companies/{company}/packs/{pack}

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

company*string

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Formatuuid
pack*string

Public identifier (UUID v7) of the pack.

Formatuuid

Query Parameters

date?|

Day (YYYY-MM-DD, company time zone) the promotion is resolved for; default today. A date-time uses its day. Malformed: 400 parameter_invalid_iso8601.

view?string

Shape of the pack: all (default) returns the full pack, storefront only what a web shop may show, and only for packs on sale there; any other pack answers 404.

Default"all"
Value in"all" | "storefront"

Headers

If-None-Match?string

Conditional request: send the ETag you stored from a previous response of this operation (quoted, as received) to get 304 Not Modified without a body when the content has not changed. Omit it to always receive the full response.

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json