List products (inventory items)

GET

/products

GET

/functions/v1/platform-api/products

$ curl https://krjtnboxzkrhejhqtwgm.supabase.co/functions/v1/platform-api/products \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "data": [
3     {
4       "id": "string",
5       "tenant_id": "string",
6       "sku": "string",
7       "name": "string",
8       "item_type": "stock",
9       "status": "active",
10       "default_uom": "string",
11       "cost_method": "weighted_average",
12       "description": "string",
13       "reorder_point": 1.1,
14       "reorder_qty": 1.1,
15       "is_stockable": true,
16       "is_purchasable": true,
17       "is_sellable": true,
18       "is_manufacturable": true,
19       "standard_cost": 1.1,
20       "image_url": "string",
21       "created_at": "2024-01-15T09:30:00Z",
22       "updated_at": "2024-01-15T09:30:00Z"
23     }
24   ],
25   "pagination": {
26     "next_cursor": "string",
27     "has_more": true
28   }
29 }

Authentication

AuthorizationBearer

API key prefixed with uk_live_

Query parameters

limitintegerOptional1-100Defaults to 25

cursorstringOptional

ID of last item from previous page

sortstringOptionalDefaults to created_at

orderenumOptionalDefaults to desc

Allowed values:

statusenumOptional

Allowed values:

item_typeenumOptional

Allowed values:

searchstringOptional

Search by name or SKU

Response

Paginated product list

datalist of objectsOptional

paginationobjectOptional