Skip to content
WhiteBeard

Search products

POST
/cms/product/search
curl --request POST \
  --url https://api.example.com/cms/product/search \
  --header 'API-Key: <API-Key>' \
  --header 'Content-Type: application/json' \
  --data '{ "term": "example", "categoryId": 1, "includeChildren": "0", "brandid": 1, "settings": {}, "sort": "price_asc", "page": 1, "limit": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
term

Search term

string
categoryId

Category ID to filter by

integer
includeChildren

If category ID is specified, set this flag to include children categories

string
Allowed values: 0 1
brandid

Brand ID to filter by

integer
settings

A key-value pair of settings and their desired values

object
sort

Sort order

string
Allowed values: price_asc price_desc new
page

Page number

integer
limit

Number of items per page

integer

Responses

Section titled “Responses”

200

Section titled “200”

Search results

Media typeapplication/json
object
data
Array<object>
Product

API representation of an ecommerce product

object
id

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

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

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

Related items

Array<object>
object
images

Images

Array<string>
files

Files

Array<string>
product_details

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

object
translations

Translations

actionData

Action data to be executed when a pricing tier is bought

Array<object>
object
function
string
param
string
group
string
actionDataRenew

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

Array<object>
object
function
string
param
string
group
string
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

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

Related items

Array<object>
object
images

Images

Array<string>
files

Files

Array<string>
product_details

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

object
translations

Translations

actionData

Action data to be executed when a pricing tier is bought

Array<object>
object
function
string
param
string
group
string
actionDataRenew

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

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

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

integer
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
facets
object
brands
Array<object>
Brand

API representation of a brand

object
id

Brand ID

name

Brand name

string
image

Brand image URL

string
available

Is available

count

Product count for brand

integer
total
integer

Example 

{
  "data": [
    {
      "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"
            }
          ]
        }
      ],
      "categories": [
        {
          "settings": [
            {
              "name": "Main News Channel",
              "key": "size",
              "type": "color, text"
            }
          ],
          "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"
        }
      }
    }
  ]
}