Skip to content

List products in a category

GET
/cms/product/category/{categoryId}
curl --request GET \
--url 'https://api.example.com/cms/product/category/1?includeChildren=0' \
--header 'API-Key: <API-Key>'
categoryId
required
integer
includeChildren
string
Allowed values: 0 1
page
integer
limit
integer

List of products in category

Media typeapplication/json
Array<object>
Product

API representation of an ecommerce product

object
id

Product ID

name

Product name

string
slug

Product slug, unique among products: GET /cms/product/{id} takes it in place of the ID

string
subtitle

Product subtitle

string
teaser

Product teaser

string
description

Product description

string
text

Product text

string
brand

Brand ({id, name}), or an empty array when the product has no brand

nullable
One of:
object
id
string
name
string
url

Product URL

string
learnmore_link

Learn more link

string
nullable
settings

Field values, keyed by field key (each {name, value, type}), e.g. {“size”: {“name”: “Size”, “value”: “large”, “type”: “list”}}: the same keys the product search takes in settings; an empty array when there are none

One of:
object
key
additional properties
object
name
string
value
string
type
string
template

Template

string
nullable
photo

Main photo URL

string
secondary_photo

Secondary photo URL

string
thumbnail

Thumbnail URL

string
gallery

More images of the product, in order (photo library images, with their sizes)

Array<object>
Attachment

API representation of an attachment (images, video, files)

object
id

Attachment ID (numeric string)

string
name

Name

string
nullable
description

Description

string
nullable
type

Type (image|video|file)

string
url

Public URL

string
nullable
width

Width in pixels

integer format: int32
height

Height in pixels

integer format: int32
focal

Focal point as “x% y%”

string
nullable
transforms

Transforms (list of available image transforms)

Array<object>
object
x

Width in pixels (numeric string)

string
y

Height in pixels (numeric string)

string
url

URL of the transformed image

string
urls

Additional urls per transform

object
url_medium

Search title

string
url_highres

Search description

string
url_original

Social title

string
video

Video object when type is video

nullable
One of:
Video

API representation of a video

object
id

Video ID (numeric string)

string
title

Title

string
url

URL

string
duration

Duration in seconds (numeric string)

string
number

Episode number (numeric string)

string
nullable
status

Status

string
showId

Show ID (numeric string)

string
nullable
showName

Show name

string
nullable
showUrl

Show URL

string
nullable
brief

Brief

string
nullable
thumbnail

Thumbnail URL

string
nullable
thumbnailPlay

ThumbnailPlay URL

string
nullable
filename

Filename/URL

string
nullable
publishDate

Publish date

string
nullable
views

Views (numeric string)

string
publish

Publish flag

nullable
formats

Formats

Array<object>
nullable
Video_Format

API representation of a video format

object
format

Format

string
filename

Filename/URL

string
cdnPath

CDN path

string
nullable
mime

MIME type

string
duration

Duration in seconds

integer format: int32
nullable
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

Default item ID (numeric string, “0” when none)

string
nullable
items

Pricing tiers

Array<object>
Pricing Tier

API representation of an ecommerce pricing tier (product item)

object
id

Item ID

description

Description

string
productId

Product ID

product

Product name

string
price

Price

sale_price

The price it sells at today: its timed offer’s price while one runs, otherwise 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
nullable
upgradeFrom

Upgrade from

string
upgradeExcludeItems

Upgrade exclude items

string
nullable
upgradePriceWeb

Upgrade price web

upgradePriceMobile

Upgrade price mobile

settings

Field values, keyed by field key (each {name, value, type}), e.g. {“size”: {“name”: “Size”, “value”: “large”, “type”: “list”}}: the same keys the product search takes in settings; an empty array when there are none

One of:
object
key
additional properties
object
name
string
value
string
type
string
hasImage

Has image

additional_label_1

Additional label 1

string
nullable
additional_label_2

Additional label 2

string
nullable
additional_label_3

Additional label 3

string
nullable
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 per currency code, or an empty array when none

One of:
object
key
additional properties
object
price
One of:
string
recurrentPrice
One of:
string
stock_enabled

Stock enabled

stock_available

Stock available

allow_backorder

Whether orders are accepted when out of stock

packageQuantity

Package quantity

relatedItems

Related items

Array<object>
object
images

Images (attachments)

Array<object>
object
id
string
name
string
description
string
url

High resolution URL

string
url_original
string
url_thumbnail
string
focal
string
image_width
integer
nullable
image_height
integer
nullable
video

Video (only for video attachments)

object
type
string
duration

Duration (only when present in metadata)

integer
files

Files (attachments)

Array<object>
object
id
string
name
string
description
string
url
string
type
string
duration

Duration (only when present in metadata)

integer
product_details

Product details. Deprecated to avoid circular references. Use productId instead.

object
translations

Translations

action_data

Action data to be executed when a pricing tier is bought

Array<object>
nullable
object
function
string
param
string
group
string
action_data_renew

Action data to be executed when a pricing tier is bought as a renewal

Array<object>
nullable
object
function
string
param
string
group
string
categories

Categories

Array<object>
Ecommerce Category

API representation of an ecommerce category

object
id

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
Array<object> recursive
slug

Slug

string
products_total

Total products count. Deprecated, always 0.

integer
settings

Settings

Array<object>
Ecommerce Category Setting

API representation of an ecommerce category setting

object
name

Name

string
key

Key

string
type

Setting type

string
breadcrumbs

Breadcrumbs

Array<object>
object
id

Category ID (numeric string)

string
name

Category name

string
slug

Category slug

string
translations

Category translations

object
children
Array<object> recursive
translations

Translations

translations
object
key
additional properties
object
description

Translated description

string
label1

Translated label 1

string
label2

Translated label 2

string
label3

Translated label 3

string

Example

[
{
"brand": {
"id": "1",
"name": "Brand name"
},
"gallery": [
{
"id": "110586",
"transforms": [
{
"x": "200",
"y": "100"
}
],
"video": {
"id": "4903",
"duration": "171",
"number": "1",
"showId": "2",
"views": "0"
}
}
],
"defaultItem": "0",
"items": [
{
"prices": {
"ZAR": {
"price": "1",
"recurrentPrice": "1"
}
},
"images": [
{
"id": "4",
"name": "watermarked",
"focal": "50% 50%",
"image_width": 654,
"image_height": 529,
"type": "image"
}
],
"files": [
{
"id": "5",
"type": "file"
}
],
"translations": {
"en": {
"description": "Description text",
"label1": "Label 1",
"label2": "Label 2",
"label3": "Label 3"
}
},
"action_data": [
{
"function": "registerSubscription",
"param": "365",
"group": "subscription"
}
],
"action_data_renew": [
{
"function": "registerSubscription",
"param": "365",
"group": "subscription"
}
]
}
],
"categories": [
{
"settings": [
{
"name": "Main News Channel",
"key": "size",
"type": "color, text"
}
],
"breadcrumbs": [
{
"id": "1"
}
],
"translations": {
"en": {
"name": "Name",
"description": "Description"
},
"fr": {
"name": "Nom",
"description": "Description FR"
}
}
}
],
"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"
}
}
}
]

Category not available

Category not found