Get multiple products (items) by id

post

{apiUrl}/ca/v1/agents/{agentId}/catalog/items

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

agentId

string

required

Query Params

skipQuestionSelection

boolean

Defaults to false

Return all stored questions unselected, ignoring limitQuestions. For debugging; not intended for a production UI. PDP endpoints only.

Body Params

itemIds

array of strings

required

length ≥ 1

itemIds*

strict

boolean

Defaults to false

includeVariants

boolean

Defaults to false

limitVariants

int32

limitQuestions

int32

Defaults to 5

Maximum number of questions to select. Ignored with skipQuestionSelection=true, which returns all stored questions.

includeImplicitFilter

boolean

Defaults to false

Filter the returned variants by the agent's implicit query constraint (for example, only variants in stock), when the agent has one configured. Affects only which variants are returned, so only with variants requested; it adds no filter options or other fields to the response, and has no effect for an agent without such a constraint.

boost_config

object

fields

array of strings

Attributes to keep in each product's data, each prefixed with data. and named as in the returned data (e.g. data.title, data.price). A name without the prefix or not in the catalog is ignored without an error, so a list of only such names returns an empty data.

fields

Responses

Language

Credentials

Bearer

API token

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

404Not Found

500Internal Server Error