List product categories

GET

/cms/product/categories

const url = 'https://api.example.com/cms/product/categories?includeChildren=0';
const options = {method: 'GET', headers: {'API-Key': '<API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.example.com/cms/product/categories?includeChildren=0' \
  --header 'API-Key: <API-Key>'

Authorizations

ApiKeyAuth

Parameters

Query Parameters

categoryId

integer

parentId

integer

includeChildren

string

Allowed values: 0 1

page

integer

limit

integer

Responses

200

List of categories

application/json

Array<object>

Ecommerce Category

API representation of an ecommerce category

object

Category ID

name

Category name

string

description

Category description

string

parentId

Parent category ID

nullable

url

Category URL

string

available

Available

featured

Featured

string

image

Image URL

string

cover_photo

Cover photo URL

string

logo

Logo URL

string

products

Products

Array<object>

Product

API representation of an ecommerce product

object

Product ID

name

Product name

string

subtitle

Product subtitle

string

teaser

Product teaser

string

description

Product description

string

text

Product text

string

brand

Brand

object

url

Product URL

string

learnmore_link

Learn more link

string

settings

Settings

object

template

Template

string

photo

Main photo URL

string

secondary_photo

Secondary photo URL

string

thumbnail

Thumbnail URL

string

sku

SKU

string

allowCustomPrice

Allow custom price

accept_reviews

Whether customers who purchased this product can submit reviews

boolean

rating

Average rating of approved reviews (1-5), null when there are none

number format: float

nullable

rating_count

Number of approved reviews

integer

defaultItem

One of:

Pricing Tier

Pricing Tier

API representation of an ecommerce pricing tier (product item)

object

Item ID

description

Description

string

productId

Product ID

product

Product name

string

price

Price

currency

Currency

string

available

Available

item_order

Item order

shippable

Shippable

weight

Weight

installments

Installments

oncePerUser

Once per user

isUpgrade

Is upgrade

upgradeType

Upgrade type

string

upgradeFrom

Upgrade from

string

upgradeExcludeItems

Upgrade exclude items

string

upgradePriceWeb

Upgrade price web

upgradePriceMobile

Upgrade price mobile

settings

Settings

object

hasImage

Has image

additional_label_1

Additional label 1

string

additional_label_2

Additional label 2

string

additional_label_3

Additional label 3

string

diameter

Diameter

length

Length

depth

Depth

width

Width

recurrent

Recurrent

recurrentPrice

Recurrent price

recurrentStart

Recurrent start

string

recurrentSchedule

Recurrent schedule

string

sku

SKU

string

prices

Prices

object

stock_enabled

Stock enabled

stock_available

Stock available

allow_backorder

Whether orders are accepted when out of stock

packageQuantity

Package quantity

relatedItems

Example

[
  {
    "products": [
      {
        "defaultItem": {
          "translations": {
            "en": {
              "name": "Name",
              "subtitle": "Subtitle"
            },
            "fr": {
              "name": "Nom",
              "subtitle": "Sous-titre"
            }
          },
          "actionData": [
            {
              "function": "registerSubscription",
              "param": "365",
              "group": "subscription"
            }
          ],
          "actionDataRenew": [
            {
              "function": "registerSubscription",
              "param": "365",
              "group": "subscription"
            }
          ]
        },
        "items": [
          {
            "translations": {
              "en": {
                "name": "Name",
                "subtitle": "Subtitle"
              },
              "fr": {
                "name": "Nom",
                "subtitle": "Sous-titre"
              }
            },
            "actionData": [
              {
                "function": "registerSubscription",
                "param": "365",
                "group": "subscription"
              }
            ],
            "actionDataRenew": [
              {
                "function": "registerSubscription",
                "param": "365",
                "group": "subscription"
              }
            ]
          }
        ],
        "translations": {
          "en": {
            "description": "Description text",
            "label1": "Label 1",
            "label2": "Label 2",
            "label3": "Label 3"
          },
          "fr": {
            "description": "Texte de description",
            "label1": "Étiquette 1",
            "label2": "Étiquette 2",
            "label3": "Étiquette 3"
          }
        }
      }
    ],
    "settings": [
      {
        "name": "Main News Channel",
        "key": "size",
        "type": "color, text"
      }
    ],
    "translations": {
      "en": {
        "name": "Name",
        "description": "Description"
      },
      "fr": {
        "name": "Nom",
        "description": "Description FR"
      }
    }
  }
]