List products in a category
const url = 'https://api.example.com/cms/product/category/1?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/category/1?includeChildren=0' \ --header 'API-Key: <API-Key>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Responses
Section titled “Responses”List of products in category
API representation of an ecommerce product
object
Product ID
Product name
Product slug, unique among products: GET /cms/product/{id} takes it in place of the ID
Product subtitle
Product teaser
Product description
Product text
Product URL
Learn more link
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
object
object
Template
Main photo URL
Secondary photo URL
Thumbnail URL
More images of the product, in order (photo library images, with their sizes)
API representation of an attachment (images, video, files)
object
Attachment ID (numeric string)
Name
Description
Type (image|video|file)
Public URL
Width in pixels
Height in pixels
Focal point as “x% y%”
Transforms (list of available image transforms)
object
Width in pixels (numeric string)
Height in pixels (numeric string)
URL of the transformed image
Additional urls per transform
object
Search title
Search description
Social title
Video object when type is video
API representation of a video
object
Video ID (numeric string)
Title
URL
Duration in seconds (numeric string)
Episode number (numeric string)
Status
Show ID (numeric string)
Show name
Show URL
Brief
Thumbnail URL
ThumbnailPlay URL
Filename/URL
Publish date
Views (numeric string)
Publish flag
Formats
API representation of a video format
object
Format
Filename/URL
CDN path
MIME type
Duration in seconds
SKU
Allow custom price
Whether customers who purchased this product can submit reviews
Average rating of approved reviews (1-5), null when there are none
Number of approved reviews
Default item ID (numeric string, “0” when none)
Pricing tiers
API representation of an ecommerce pricing tier (product item)
object
Item ID
Description
Product ID
Product name
Price
The price it sells at today: its timed offer’s price while one runs, otherwise price
Currency
Available
Item order
Shippable
Weight
Installments
Once per user
Is upgrade
Upgrade type
Upgrade from
Upgrade exclude items
Upgrade price web
Upgrade price mobile
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
object
object
Has image
Additional label 1
Additional label 2
Additional label 3
Diameter
Length
Depth
Width
Recurrent
Recurrent price
Recurrent start
Recurrent schedule
SKU
Stock enabled
Stock available
Whether orders are accepted when out of stock
Package quantity
Related items
object
Images (attachments)
object
High resolution URL
Video (only for video attachments)
object
Duration (only when present in metadata)
Files (attachments)
object
Duration (only when present in metadata)
Product details. Deprecated to avoid circular references. Use productId instead.
object
Translations
Action data to be executed when a pricing tier is bought
object
Action data to be executed when a pricing tier is bought as a renewal
object
Categories
API representation of an ecommerce category
object
Category ID
Category name
Category description
Parent category ID
Category URL
Available
Featured
Image URL
Cover photo URL
Logo URL
Slug
Total products count. Deprecated, always 0.
Settings
API representation of an ecommerce category setting
object
Name
Key
Setting type
Breadcrumbs
object
Category ID (numeric string)
Category name
Category slug
Category translations
object
Translations
object
object
Translated description
Translated label 1
Translated label 2
Translated label 3
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