GET
/
api-offers
/
get-product
/
{sku}

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

sku
string
required

SKU of the product whose details are to be retrieved. If the product has child products, details of the child products are also retrieved.

Query Parameters

priceListId
string

Get product by ID in a given price list. If priceListId is not provided, default priceList is selected to search the details for. If the SKUdoesn't belong to the default price list, price details are 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
id
string

fabric internal ID of the product

channel
number[]

Sales channel of the product

startDate
string

Start date of the product

endDate
string

End date of the product

group
string[]

ID of the group or category the product belongs to

imageSetOnAttributes
string[]

Array of URLs to images of different variants or attributes

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

isSoftDeleted
boolean

true indicates the product is deleted <br /> false indicates the product is not deleted

title
string

Title of the product

itemFamily
object

Family of products the item belongs to

sku
string

SKU of the product

description
string

Description of the product

state
string

Status of the product. It indicates if the product is ready to be published on the product listing page.

itemId
number

Item ID of the product

images
object[]

Details of images of the product displayed on copilot UI

attributes
object[]

Details of product attributes if any

variants
string[]

Different variants of the product

createdAt
string

Creation date of the product

updatedAt
string

Last updated date of the product

items
object[]

Lists fabric objectId of child products if there are any

price
object

Price details of the product if it was setup previously

priceRange
object

Price ranges of the product

livePrice
object[]

Current market price of the product with which the product is sold

promoDates
object

Start date and end date of the offer price