Skip to main content
GET
Fetch Recommendations via Query Parameters
Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See Authentication & Base URLs.

Headers

x-customer-group-id
string

Optional customer group identifier for segment-specific responses.

x-ecomm-provider
string

eCommerce provider for contextualizing the API call (e.g., shopify, magento, etc.).

Path Parameters

widgetId
string
required

Unique identifier of the widget to retrieve.

Query Parameters

fields
string
required

Comma-separated list of fields to include in the response

locale
string
required

Specifies the language or region for the response data

store_id
string

Identifier of the store within the eCommerce platform.

channel_id
string

Sales or distribution channel identifier.

location_id
string

Identifier for the regional location from the BigCommerce admin panel.

currency
string

Currency code for price displays.

include_fields_meta
boolean

Whether to include metadata about the fields in the response. If true, returns metadata for each filterable field.

context_type
string

Specifies the type of context for the request (e.g., product, category, web_pages, cart, etc)

context_data
string

context-specific data, relevant to the context_type

product_ids
string

Comma-separated product IDs for “similar items” context.

category_ids
string

Comma-separated category IDs for category-based recommendations.

skip
integer

Number of items to skip for pagination offset.

limit
integer

Maximum number of items to return.

filter
string

Logical filter expression to narrow results

user_id
string

Unique identifier for the user ID or user email.

Response

Recommended products response via query parameters.

Status
string
Example:

"success"

Data
object