API reference
List products
GET
Products on sale online, a page at a time: search by name, filter by collection, sort by name or newest. Pass nextCursor back as cursor for the next page.
publishableKeyheader
AuthorizationBearer <pk_live_…>The shop’s publishable key, from Settings, Developers in Cashiar. Safe to use in a browser.
limit?integerRange
1 <= value <= 200Default
50cursor?stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidq?stringLength
length <= 100collection?stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidsort?stringValue in
"name""-name""newest""-newest"application/json- response
items*array<>nextCursor*string|nullcurl -X GET 'https://api.cashiar.app/v1/storefront/products'Example Response200
{
"items": [
{
"id": "string",
"name": "string",
"description": "string",
"unitName": "string",
"category": "string",
"imageUrl": "string",
"priceTypes": [
{
"id": "string",
"name": "string"
}
],
"versions": [
{
"variantId": "string",
"name": "string",
"imageUrl": "string",
"sellingPrice": 0,
"prices": [
{
"priceListId": "string",
"sellingPrice": 0
}
],
"inStock": true,
"sellingUnits": [
{
"id": "string",
"name": "string",
"sellingPrice": 0,
"prices": [
{
"priceListId": "string",
"sellingPrice": 0
}
]
}
]
}
],
"addonGroups": [
{
"id": "string",
"name": "string",
"mode": "one",
"required": true,
"options": [
{
"id": "string",
"name": "string",
"sellingPrice": 0,
"preselected": true
}
]
}
],
"soldOut": true
}
],
"nextCursor": "string"
}