GET
/
api-product
/
v1
/
product
/
search

Authorizations

Authorization
string
headerrequired

S2S access token (JWT) from fabric Identity service (during Login)

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Query Parameters

keyword
string

Keywords related to SKU or title

skus
string[]

Searches for items based on SKU. <br /> Note: If omitted, all items are retrieved. <br /> Applicable only when keyword is omitted.

itemIds
string[]

Item IDs. <br /> Note: If omitted, all items are retrieved <br /> Applicable only when keyword and skus are omitted.

page
number

Page number to be retrieved.

size
integer

Number of records per page. <br />Note: 1) Always paired with page. <br />2) Applicable only in a paginated response.

type
enum<string>

Item type

Available options:
ITEM,
BUNDLE,
ALL
allAttributes
boolean

true: Gets all attributes. false: Gets only the mapped attributes. <br /> Note: Always clubbed with page and size. When they are not specified, you will get up to 10 records.

excludeChildren
boolean

true: Excludes children items <br /> false: Includes children items

onlyChildren
boolean

true: Excludes parent items <br /> false: Includes parent items

Response

200 - application/json
totalSize
number

Total number of records

pageSize
number

Number of records per page

pages
number

Number of pages for the given pageSize

products
object[]