GET
/
api-offers
/
item
/
{itemId}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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.

Path Parameters

itemId
number
required

ID of the item to get price details for

Query Parameters

priceListId
number

ID of the price list to which the item belongs to. If priceListId is not provided, default priceList is considered for search. If the itemId does not belong to the default priceList, then the price object is not returned.

limit
number
default: 10

The maximum number of records per page.

Required range: x > 1
offset
number
default: 0

The number of records to skip before returning records. For example, when offset is 20 and limit is 10, this endpoint returns records from 21 to 30.

Required range: x > 0

Response

200 - application/json
channel
number[]

Sales channel of the product

startDate
string

Start date of the product

endDate
string

End date of the product

group
string[]

Item's group/category ID

title
string

Title of the product

itemId
number

Item ID

price
object

Price of the product. It displays price details if the price was setup previously. If price is not setup previously, it displays null

isDefault
boolean

false for parent product<br /> If a parent product has child items, true represents the default child item to be displayed, under the parent product, on the product listing page.

isActive
boolean

true if the item is active and displayed in the catalog. isActive will be true only when state is READY <br /> false if the state is DRAFT, and item is not displayed in the catalog

attributes
object[]
parent
string

If the item has a parent product, it displays the parent product ID

itemFamily
string

Parent family to which the item belongs to. All items belongs to an itemFamily

description
string

Description of the product

variants
string[]

Shows if any variant of the product is available, based on color or size and other details.

state
string

Status of the product. READY indicates the item along with all of its attributes is rady is to be published on the product listing page.

images
object[]

Details of images of the item displayed on the copilot UI

sku
string

SKU of the product

isSoftDeleted
boolean

true indicates the item is removed from the copilot UI<br /> false indicates item is not removed from the copilot UI

Was this page helpful?

Get Skus and itemIds in a specific pricelistOverview