Skip to main content
GET
/
api
/
v1
/
omni
/
:app_id
/
:store_group
/
:market
/
:locale
/
category-tree
/
:parent_id
Error
A valid request URL is required to generate request examples
{
  "data": {
    "attributes": {},
    "full_path_name": [
      "<string>"
    ],
    "id": "<string>",
    "name": "<string>",
    "parent_id": "<string>",
    "products": {
      "data": [
        {
          "attributes": {},
          "brands": {
            "name": "<string>",
            "series": {
              "name": "<string>",
              "slug": "<string>"
            },
            "slug": "<string>"
          },
          "categories": [
            {
              "attributes": {},
              "full_path_name": [
                "<string>"
              ],
              "id": "<string>",
              "name": "<string>",
              "order": 123,
              "parent_id": "<string>",
              "redirects": {},
              "sort_order": 123,
              "status": "<string>",
              "sub_categories": [
                {
                  "attributes": {},
                  "full_path_name": [
                    "<string>"
                  ],
                  "id": "<string>",
                  "name": "<string>",
                  "parent_id": "<string>",
                  "redirects": {},
                  "sort_order": 123,
                  "status": "<string>",
                  "sub_categories": "<array>",
                  "uri": "<string>"
                }
              ],
              "uri": "<string>"
            }
          ],
          "collections": [
            {
              "children": [
                {
                  "children": "<array>",
                  "id": "<string>",
                  "parent_id": "<string>",
                  "title": "<string>",
                  "uri": "<string>"
                }
              ],
              "id": "<string>",
              "order": 123,
              "parent_id": "<string>",
              "title": "<string>",
              "uri": "<string>"
            }
          ],
          "created_at": "<string>",
          "custom_fields": {},
          "description": "<string>",
          "files": [
            {
              "attributes": {},
              "title": "<string>",
              "type": "<string>",
              "url": "<string>"
            }
          ],
          "html_description": "<string>",
          "html_short_description": "<string>",
          "id": "<string>",
          "images": [
            {
              "alt": "<string>",
              "attributes": {},
              "blurhash": "<string>",
              "sort": 123,
              "title": "<string>",
              "url": "<string>"
            }
          ],
          "is_active": true,
          "meta_description": "<string>",
          "meta_title": "<string>",
          "product_name": "<string>",
          "product_number": "<string>",
          "rank": 123,
          "redirects": {},
          "related_products": [
            {
              "attributes": {},
              "id": "<string>",
              "image": "<string>",
              "product_name": "<string>",
              "product_number": "<string>",
              "slug": "<string>",
              "type": "<string>"
            }
          ],
          "short_description": "<string>",
          "slug": "<string>",
          "slug_translations": {},
          "status": "<string>",
          "tags": [
            {
              "attributes": {},
              "created_at": "<string>",
              "filterable": true,
              "id": "<string>",
              "key": "<string>",
              "name": "<string>",
              "order": 123,
              "status": "<string>",
              "updated_at": "<string>"
            }
          ],
          "third_party_links": [
            {
              "id": "<string>",
              "title": "<string>",
              "type": "<string>",
              "url": "<string>"
            }
          ],
          "updated_at": "<string>",
          "variants": [
            {
              "attributes": {},
              "description": "<string>",
              "dimensions": {
                "capacity_milliliter": 123,
                "depth": 123,
                "diameter": 123,
                "height": 123,
                "length": 123,
                "weight": 123,
                "width": 123
              },
              "id": "<string>",
              "image_url": "<string>",
              "images": [
                {
                  "alt": "<string>",
                  "attributes": {},
                  "blurhash": "<string>",
                  "sort": 123,
                  "title": "<string>",
                  "url": "<string>"
                }
              ],
              "inventories": [
                {
                  "inventory_date": "<string>",
                  "quantity": 123,
                  "warehouse": {
                    "address": {
                      "city": "<string>",
                      "country": "<string>",
                      "postal_code": "<string>",
                      "region": "<string>",
                      "street_address": "<string>"
                    },
                    "description": "<string>",
                    "id": "<string>",
                    "name": "<string>"
                  }
                }
              ],
              "is_active": true,
              "packaging_dimensions": {
                "capacity_milliliter": 123,
                "depth": 123,
                "diameter": 123,
                "height": 123,
                "length": 123,
                "weight": 123,
                "width": 123
              },
              "prices": [
                {
                  "channel_type": "B2B",
                  "country_of_sale": "<string>",
                  "markets": [
                    {
                      "base_price_amount": 123,
                      "country_code": "<string>",
                      "country_codes": [
                        "<string>"
                      ],
                      "currency": "<string>",
                      "id": "<string>",
                      "market_id": "<string>",
                      "market_slug": "<string>",
                      "on_sale": true,
                      "sale_end_timestamp": "<string>",
                      "sale_price_amount": 123,
                      "sale_start_timestamp": "<string>"
                    }
                  ],
                  "store_group_description": "<string>",
                  "store_group_id": "<string>",
                  "store_group_name": "<string>",
                  "store_group_slug": "<string>"
                }
              ],
              "shipping_attributes": [
                "<string>"
              ],
              "tags": [
                {
                  "attributes": {},
                  "created_at": "<string>",
                  "filterable": true,
                  "id": "<string>",
                  "key": "<string>",
                  "name": "<string>",
                  "status": "<string>",
                  "updated_at": "<string>"
                }
              ],
              "validate_stock": true,
              "variant_name": "<string>",
              "variant_number": "<string>",
              "videos": [
                {
                  "attributes": {},
                  "description": "<string>",
                  "title": "<string>",
                  "url": "<string>"
                }
              ]
            }
          ],
          "videos": [
            {
              "attributes": {},
              "description": "<string>",
              "title": "<string>",
              "url": "<string>"
            }
          ]
        }
      ],
      "page": 123,
      "total": 123,
      "total_pages": 123
    },
    "redirects": {},
    "sort_order": 123,
    "status": "<string>",
    "sub_categories": [
      {
        "attributes": {},
        "full_path_name": [
          "<string>"
        ],
        "id": "<string>",
        "name": "<string>",
        "parent_id": "<string>",
        "redirects": {},
        "sort_order": 123,
        "status": "<string>",
        "sub_categories": "<array>",
        "uri": "<string>"
      }
    ],
    "uri": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and a token.

Path Parameters

app_id
string
required

Application ID

parent_id
string
required

Parent Category ID

locale
string
required

Locale for translations

market
string
required

Market for the categories

store_group
string
required

Store group

Query Parameters

page
integer

Page number (default: 1)

per_page
integer

Items per page (default: 20) (max: 20)

only_active
boolean

Filter only active products

include_child_category_products
boolean

Fetch all child categories products as well

Response

OK

data
object