GET
/
api-offers
/
price-guard

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.

Query Parameters

limit
number

The maximum number of records per page.

offset
number

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.

itemId
integer

Item ID for which price guards are to be retrieved

priceListId
integer

The ID of the price list under which price guards are retrieved.

sortBy
enum<string>

Field by which you want to sort the records

Available options:
priceListId,
itemId,
updatedAt
sortOrder
enum<string>

Ascending or Descending

Available options:
desc, asc

Response

200 - application/json
query
object

Pagination details used for selecting list

data
object[]

Price guard details

Was this page helpful?

Update a specific price guardOverview