Skip to main content
GET
/
products
/
category
/
{category}
Get category
curl --request GET \
  --url https://store.salesive.com/api/v1/products/category/{category} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "image": "<string>"
}

​
Request

You can pass the category ID, slug, or name in the category path segment. The API performs a case-insensitive match for category names.
GET /products/category/{category}?page=1&limit=10&q={search-term}

​
Path parameters

ParameterTypeDescription
categorystringCategory ID, slug, or name to filter products by.

​
Query parameters

ParameterTypeDescription
pageintegerPage number to return (default 1).
limitintegerMaximum number of products per page (default 10).
qstringOptional search string applied within the chosen category.

​
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",
            "price": 54.5,
            "currency": "USD",
            "category": "68bc52c7e15404b8e40a7c37",
            "inWishlist": false
        }
    ],
    "total": 42,
    "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.

Path Parameters

​
category
string
required

Category ID, slug, or name.

Response

Category detail response.

​
id
string
required

Unique category identifier.

​
name
string
required

Display name of the category.

​
slug
string
required

URL-friendly identifier for the category.

​
description
string

Optional description of the category.

​
image
string<uri>

Optional image URL for the category.