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,
      "currency": "<string>",
      "category": "<string>",
      "description": "<string>",
      "status": "<string>",
      "images": [
        "<string>"
      ],
      "variants": [
        {
          "sku": "<string>",
          "options": {},
          "stock": 1
        }
      ]
    }
  ],
  "total": 1,
  "page": 2,
  "limit": 2
}

​
Request

GET /products?page=1&limit=10&q={search-term}

​
Query parameters

ParameterTypeDescription
pageintegerPage number to return (default 1).
limitintegerMaximum number of products per page (default 10).
qstringOptional search string applied to product name or description.

​
200 response

When the user is authenticated, each product includes an inWishlist boolean indicating whether the product is in the user’s wishlist.
{
    "products": [
        {
            "id": "68c4f1cab50803b7b1310c60",
            "name": "Premium Hoodie",
            "description": "Lightweight fleece hoodie",
            "price": 54.5,
            "currency": "USD",
            "category": "apparel",
            "status": "active",
            "inWishlist": false
        }
    ],
    "total": 120,
    "page": 1,
    "limit": 10
}

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
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
limit
integer
required
Required range: x >= 1