Skip to main content
GET
/
products
List products
curl --request GET \
  --url https://store.salesive.com/api/v1/products \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "products": [
    {
      "id": "<string>",
      "name": "<string>",
      "price": 123,
      "description": "<string>",
      "currency": "<string>",
      "category": "<string>",
      "status": "<string>",
      "images": [
        "<string>"
      ],
      "addons": [
        {
          "name": "<string>",
          "price": 123,
          "maxQuantity": 2,
          "available": true,
          "_id": "<string>",
          "description": "<string>",
          "image": "<string>"
        }
      ],
      "variants": [
        {
          "sku": "<string>",
          "options": {},
          "stock": 1
        }
      ]
    }
  ],
  "foods": [
    {
      "id": "<string>",
      "name": "<string>",
      "price": 123,
      "description": "<string>",
      "currency": "<string>",
      "category": "<string>",
      "status": "<string>",
      "images": [
        "<string>"
      ],
      "addons": [
        {
          "name": "<string>",
          "price": 123,
          "maxQuantity": 2,
          "available": true,
          "_id": "<string>",
          "description": "<string>",
          "image": "<string>"
        }
      ],
      "variants": [
        {
          "sku": "<string>",
          "options": {},
          "stock": 1
        }
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "page": 2,
    "limit": 2,
    "pages": 2,
    "hasNext": true,
    "hasPrev": true,
    "nextPage": 123,
    "prevPage": 123
  }
}
Returns a paginated list of the store’s products (the ecommerce catalog), newest first, with shop, currency and category populated. Supports filtering by category, free-text search, exact barcode and stock status. Requires the READ_INVENTORY scope.

Authorizations

​
Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

​
x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

​
x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Query Parameters

​
page
integer
default:1

Page number to return (defaults to 1).

Required range: x >= 1
​
limit
integer
default:10

Maximum number of products per page (defaults to 10).

Required range: x >= 1
​
q
string

Optional search phrase applied to product names or descriptions.

Response

200 - application/json

Paginated products response.

​
products
object[]
required
​
foods
object[]

Compatibility alias returned for food storefronts.

​
catalogType
enum<string>
Available options:
product,
food,
service
​
pagination
object