Skip to main content
GET
/
products
/
categories
/
{category}
Get category
curl --request GET \
  --url https://store.salesive.com/api/v1/products/categories/{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/categories/{category}

​
Path parameters

ParameterTypeDescription
categorystringCategory ID, slug, or name.

​
200 response

{
    "id": "68bc52c7e15404b8e40a7c37",
    "name": "Apparel",
    "slug": "apparel",
    "description": "Wearables and fashion accessories",
    "image": "https://cdn.salesive.com/categories/apparel.png"
}

​
404 response

Returned when no category matches the provided identifier. 
{
    "status": 404,
    "success": false,
    "message": "Category not found"
}

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.