Retrieve categories

GET

api

omni

:app_id

:store_group

:market

:locale

categories

Error

A valid request URL is required to generate request examples

{
  "data": [
    {
      "attributes": {},
      "cover_url": "<string>",
      "full_path_name": [
        "<string>"
      ],
      "full_uri_translations": {},
      "id": "<string>",
      "name": "<string>",
      "parent_id": "<string>",
      "redirects": {},
      "slug_translations": {},
      "sort_order": 123,
      "status": "<string>",
      "sub_categories": "<array>",
      "uri": "<string>"
    }
  ],
  "page": 123,
  "total": 123,
  "total_pages": 123
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

app_id

string

required

Application ID

locale

string

required

Locale for translations (e.g., 'sv', 'en')

store_group

string

required

Store group

Query Parameters

page

integer

Page number (default: 1)

per_page

integer

Number of items per page (default: 20, max: 100)

only_active

boolean

Filter to include only active categories (true/false)

string[]

Filter by category ID(s); repeat the parameter for each ID (e.g. id=uuid1&id=uuid2)

Response

data

object[]

Show child attributes

page

integer

total

integer

total_pages

integer

Error

A valid request URL is required to generate request examples

{
  "data": [
    {
      "attributes": {},
      "cover_url": "<string>",
      "full_path_name": [
        "<string>"
      ],
      "full_uri_translations": {},
      "id": "<string>",
      "name": "<string>",
      "parent_id": "<string>",
      "redirects": {},
      "slug_translations": {},
      "sort_order": 123,
      "status": "<string>",
      "sub_categories": "<array>",
      "uri": "<string>"
    }
  ],
  "page": 123,
  "total": 123,
  "total_pages": 123
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Management API

Shopper API

Customers API

Digital Assets Management API

Authorizations

Path Parameters

Query Parameters

Response