Get category by ID

Retrieves a category using its ID Deprecated. Use https://graphql.enad.io instead.

GET/api/v1/omni/:app_id/:store_group/:market/:locale/category-tree/id/:category_id
API
Shopper
Updated
Apr 26, 2026

shopper-api:GET:/api/v1/omni/:app_id/:store_group/:market/:locale/category-tree/id/:category_id

Retrieves a category using its ID Deprecated. Use https://graphql.enad.io instead.

API ownership

  • API family: Shopper API
  • Best for: Public storefront catalog reads and shopper-facing product discovery.
  • Prefer Search API for: New product discovery, facets, autocomplete, and other search-heavy storefront flows.
  • Do not use from: Trusted admin integrations that create, update, or delete merchant-owned data.
  • Guide route: /apis/shopper/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: GET
  • Path: /api/v1/omni/:app_id/:store_group/:market/:locale/category-tree/id/:category_id
  • Summary: Get category by ID
  • Description: Retrieves a category using its ID Deprecated. Use https://graphql.enad.io instead.
  • OpenAPI contract: shopper-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters9 parameters
NameInRequiredTypeDescription
app_idpathYesstringApp ID
category_idpathYesstringCategory ID
localepathYesstringLocale for translations
marketpathYesstringMarket to select products
pagequeryNointegerPage number (default: 1)
store_grouppathYesstringStore group
only_activequeryNobooleanFilter only active products
per_pagequeryNointegerItems per page (default: 20) (max: 20)
include_child_category_productsqueryNobooleanFetch all child categories products as well
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses
StatusDescriptionContent
200OKapplication/json (object)
400Bad Requestapplication/json (object)
404Not Foundapplication/json (object)
500Internal Server Errorapplication/json (object)

200 - object

Category With Paginated Products Response

PropertyTypeRequiredDetails
dataobjectNo-
Category With Paginated Products
PropertyTypeRequiredDetails
attributesobjectNo-
cover_urlstringNo-
full_path_namestring[]No-
full_uri_translationsobjectNo-
idstringNo-
namestringNo-
parent_idstringNo-
productsobjectNo-
redirectsobjectNo-
slug_translationsobjectNo-
sort_orderintegerNo-
statusstringNo-
sub_categoriesobject[]No-
uristringNo-
PropertyTypeRequiredDetails
dataobject[]No-
pageintegerNo-
totalintegerNo-
total_pagesintegerNo-
Category
PropertyTypeRequiredDetails
attributesobjectNo-
cover_urlstringNo-
full_path_namestring[]No-
full_uri_translationsobjectNo-
idstringNo-
namestringNo-
parent_idstringNo-
redirectsobjectNo-
slug_translationsobjectNo-
sort_orderintegerNo-
statusstringNo-
sub_categoriesobject[]No-
uristringNo-
{
  "data": {
    "attributes": {},
    "cover_url": "string",
    "full_path_name": [
      "string"
    ],
    "full_uri_translations": {},
    "id": "string",
    "name": "string",
    "parent_id": "string",
    "products": {
      "data": [
        {
          "attributes": null,
          "brands": null,
          "categories": null,
          "collections": null,
          "created_at": null,
          "custom_fields": null,
          "description": null,
          "files": null,
          "html_description": null,
          "html_short_description": null,
          "id": null,
          "images": null,
          "in_stock": null,
          "is_active": null,
          "meta_description": null,
          "meta_title": null,
          "product_name": null,
          "product_number": null,
          "rank": null,
          "redirects": null,
          "related_products": null,
          "short_description": null,
          "slug": null,
          "slug_translations": null,
          "status": null,
          "tags": null,
          "third_party_links": null,
          "updated_at": null,
          "variants": null,
          "videos": null
        }
      ],
      "page": 0,
      "total": 0,
      "total_pages": 0
    },
    "redirects": {},
    "slug_translations": {},
    "sort_order": 0,
    "status": "string",
    "sub_categories": [
      {
        "attributes": {},
        "cover_url": "string",
        "full_path_name": [],
        "full_uri_translations": {},
        "id": "string",
        "name": "string",
        "parent_id": "string",
        "redirects": {},
        "slug_translations": {},
        "sort_order": 0,
        "status": "string",
        "sub_categories": [],
        "uri": "string"
      }
    ],
    "uri": "string"
  }
}

400 - object

Error Message

PropertyTypeRequiredDetails
messagestringNo-

Generated example (synthetic):

{
  "message": "string"
}

404 - object

Error Message

PropertyTypeRequiredDetails
messagestringNo-

Generated example (synthetic):

{
  "message": "string"
}

500 - object

Error Message

PropertyTypeRequiredDetails
messagestringNo-

Generated example (synthetic):

{
  "message": "string"
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Shopper API
  • Method: GET
  • Path: /api/v1/omni/:app_id/:store_group/:market/:locale/category-tree/id/:category_id
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Categories
  • OpenAPI summary: Get category by ID

Get category by ID

# Get category by ID Retrieves a category using its ID Deprecated. Use https://graphql.enad.io instead.
GET /api/v1/omni/:app_id/:store_group/:market/:locale/category-tree/id/:category_id
Purpose

Retrieves a category using its ID Deprecated.

Required inputs

app_id path category_id path locale path market path store_group path

Primary response

200 ยท OK

Operation key

shopper-api:GET:/api/v1/omni/:app_id/:store_group/:market/:locale/category-tree/id/:category_id

## API ownership - API family: Shopper API - Best for: Public storefront catalog reads and shopper-facing product discovery. - Prefer Search API for: New product discovery, facets, autocomplete, and other search-heavy storefront flows. - Do not use from: Trusted admin integrations that create, update, or delete merchant-owned data. - Guide route: [/apis/shopper/latest](/apis/shopper/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `GET` - Path: `/api/v1/omni/:app_id/:store_group/:market/:locale/category-tree/id/:category_id` - Summary: Get category by ID - Description: Retrieves a category using its ID Deprecated. Use https://graphql.enad.io instead. - OpenAPI contract: shopper-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `shopper-api:GET:/api/v1/omni/:app_id/:store_group/:market/:locale/category-tree/id/:category_id` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_id | path | Yes | string | App ID | | category_id | path | Yes | string | Category ID | | locale | path | Yes | string | Locale for translations | | market | path | Yes | string | Market to select products | | page | query | No | integer | Page number (default: 1) | | store_group | path | Yes | string | Store group | | only_active | query | No | boolean | Filter only active products | | per_page | query | No | integer | Items per page (default: 20) (max: 20) | | include_child_category_products | query | No | boolean | Fetch all child categories products as well | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | OK | application/json (object) | | 400 | Bad Request | application/json (object) | | 404 | Not Found | application/json (object) | | 500 | Internal Server Error | application/json (object) | ### 200 - object #### Category With Paginated Products Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | ##### Category With Paginated Products | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object | No | - | | `cover_url` | string | No | - | | `full_path_name` | string[] | No | - | | `full_uri_translations` | object | No | - | | `id` | string | No | - | | `name` | string | No | - | | `parent_id` | string | No | - | | `products` | object | No | - | | `redirects` | object | No | - | | `slug_translations` | object | No | - | | `sort_order` | integer | No | - | | `status` | string | No | - | | `sub_categories` | object[] | No | - | | `uri` | string | No | - | ##### Paginated Product With Short Related Product List | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object[] | No | - | | `page` | integer | No | - | | `total` | integer | No | - | | `total_pages` | integer | No | - | ##### Category | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object | No | - | | `cover_url` | string | No | - | | `full_path_name` | string[] | No | - | | `full_uri_translations` | object | No | - | | `id` | string | No | - | | `name` | string | No | - | | `parent_id` | string | No | - | | `redirects` | object | No | - | | `slug_translations` | object | No | - | | `sort_order` | integer | No | - | | `status` | string | No | - | | `sub_categories` | object[] | No | - | | `uri` | string | No | - |
Generated example (synthetic) ```json { "data": { "attributes": {}, "cover_url": "string", "full_path_name": [ "string" ], "full_uri_translations": {}, "id": "string", "name": "string", "parent_id": "string", "products": { "data": [ { "attributes": null, "brands": null, "categories": null, "collections": null, "created_at": null, "custom_fields": null, "description": null, "files": null, "html_description": null, "html_short_description": null, "id": null, "images": null, "in_stock": null, "is_active": null, "meta_description": null, "meta_title": null, "product_name": null, "product_number": null, "rank": null, "redirects": null, "related_products": null, "short_description": null, "slug": null, "slug_translations": null, "status": null, "tags": null, "third_party_links": null, "updated_at": null, "variants": null, "videos": null } ], "page": 0, "total": 0, "total_pages": 0 }, "redirects": {}, "slug_translations": {}, "sort_order": 0, "status": "string", "sub_categories": [ { "attributes": {}, "cover_url": "string", "full_path_name": [], "full_uri_translations": {}, "id": "string", "name": "string", "parent_id": "string", "redirects": {}, "slug_translations": {}, "sort_order": 0, "status": "string", "sub_categories": [], "uri": "string" } ], "uri": "string" } } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `message` | string | No | - | **Generated example (synthetic):** ```json { "message": "string" } ``` ### 404 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `message` | string | No | - | **Generated example (synthetic):** ```json { "message": "string" } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `message` | string | No | - | **Generated example (synthetic):** ```json { "message": "string" } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Shopper API - Method: `GET` - Path: `/api/v1/omni/:app_id/:store_group/:market/:locale/category-tree/id/:category_id` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `shopper-api:GET:/api/v1/omni/:app_id/:store_group/:market/:locale/category-tree/id/:category_id` - OpenAPI tag: Categories - OpenAPI summary: Get category by ID