List products

Lists catalog entries org-wide, newest first - filter by location_id to see one location’s catalog. Scope: products:read.

Catalogs are per-location because each location can run a different POS with a different menu; the org view unifies them. Cross-location analytics group by sku.

See Pagination.

GET /v1/products

List products

cURL

curl --request GET \
  --url https://api.vexioncards.one/v1/products \
  --header 'Authorization: Bearer <token>'

200

Org-wide catalog

{ "object": "list", "data": [ { "id": "prd_01HW9R7T2CD8N8MTX1RVPRDFW1", "object": "product", "location_id": "loc_01HW9R4P2ZK7N8MTX1RVLOCS01", "name": "Flat White", "sku": "FW-12", "category": "drinks", "tags": [ "coffee", "hot" ], "price_minor": 350, "source": "api", "pos_ref": null, "is_active": true, "created_at": 1750000000, "updated_at": 1750000000 }, { "id": "prd_01HW9R7T2CD8N8MTX1RVPRDESP", "object": "product", "location_id": "loc_01HW9R4P2ZK7N8MTX1RVLOCS01", "name": "Espresso doppio", "sku": "ESP-D", "category": "drinks", "tags": [ "coffee", "hot" ], "price_minor": 250, "source": "pos", "pos_ref": { "external_product_id": "p:nazlrMDNh" }, "is_active": true, "created_at": 1750000000, "updated_at": 1750000000 } ], "has_more": false, "url": "/v1/products" }

Authorizations

Authorization · string · header · required

Your secret API key as a Bearer token: Authorization: Bearer vxn_sk_.... Keys are created and scoped in the dashboard - see Authentication.

Query Parameters

location_id · string

One location's catalog.

Pattern: ^loc_[A-Za-z0-9]+$

sku · string

Exact-match correlation key lookup.

category · string

Exact-match category filter.

source · string

Filter by origin. Known values: pos, manual, api - treat as an open set.

is_active · boolean

true = live catalog only; false = archived only; omit for both.

search · string

Free-text search across name + tags. Case-insensitive partial match.

limit · integer · default: 25

Page size, 1-100. Default 25.

Required range: 1 <= x <= 100

starting_after · string

Cursor - the prd_ id of the last item on the previous page (forward). Numeric offset or page parameters are not supported; cursors are the only supported paging mechanism.

Pattern: ^prd_[A-Za-z0-9]+$

ending_before · string

Reverse cursor - items before this prd_ id.

Pattern: ^prd_[A-Za-z0-9]+$

Response

200

application/json

Paginated product list.

Cursor-paginated product list.

object · string · required

Always "list".

Allowed value: "list"

data · object[] · required

Product rows.

Show child attributes

has_more · boolean · required

True when more pages exist.

next_cursor · string | null

Cursor for the next page in the direction you are already paging, or null when this page ends the collection. has_more: true always comes with a non-null next_cursor.

Feed it back to the SAME parameter you used: starting_after when paging forward (the default), or ending_before when paging backward. Treat it as opaque and do not parse it.

You no longer need to take the last object's id yourself. That still works and is unchanged, but deriving the cursor from the page put the burden of knowing the sort direction on you, and it broke silently on any endpoint whose cursor is not the object id.

Example:

"cus_iofv5j4hn6bphinmmyat27tc5y"

url · string

Stable collection URL.

Example:

"/v1/products"