Skip to main content
POST

Authorizations

Authorization
string
header
required

Access token

Headers

x-customer-group-id
string

This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned.

Body

application/json

Payload for searching products.

query
string
required

String for searching products, considers the first ten words of any given search query.

page
integer
default:1

To request a specific page of results.

Required range: x >= 1
limit
integer
default:25

Maximum number of records returned for a page.

Required range: x >= 1
facets
string[]

provide list of attributes for specific facets or * for all facets. All attributes supported in the filter parameter are also supported here. Values are trimmed and must not be blank.

Minimum string length: 1
filter

Filter expression(s) to narrow results. Omit or send null for no filtering.

Syntax: attribute OPERATOR value

Operators:

Important rules:

  • Operators are case-sensitive — must be uppercase (AND, not and).
  • String value comparison is case-insensitive — product_type = Physical matches physical.
  • Operator precedence: NOT > AND > OR. Use parentheses to override.
  • String values containing whitespace must be wrapped in single quotes.
  • IN takes comma-separated values in square brackets.
  • Maximum array nesting depth is 2 levels.

Supported attributes: product_type, categories.name, attributes.key, pricing.listing_price, pricing.selling_price, pricing.tax_rate, product_id, variant_id, product_name, variant_name, tags, sku, stock_available, rating

Combining conditions:

  • String: Use AND/OR operators inline — "rating > 4 AND product_type = physical"
  • Array of strings: Conditions are combined with AND — ["rating > 4", "product_type = physical"]
  • Nested arrays: Inner arrays express OR, outer array expresses AND — ["product_type = physical", ["product_type = bundle", "rating > 4"]]
sort
string[] | null

Sort results by attributes. Use asc for ascending order and desc for descending order. Values are trimmed and must not be blank.

Minimum string length: 1
Examples:

"product_type:desc"

"product_name:asc"

Response

Success response

message
string
required
success
boolean
required
content
object
required