GET
/
price-controls
/
{itemId}

Authorizations

Authorization
string
headerrequired

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

Headers

x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Required string length: 24
x-fabric-channel-id
string

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-client-id
string

A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.

x-fabric-request-id
string

A unique request ID.

Path Parameters

itemId
integer
required

ID of the item whose price control records are to be retrieved

Query Parameters

offset
integer
default: 0

The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.

Required range: x > 0
size
integer
default: 10

The maximum number of records per page.

Required range: 1 < x < 100
priceListId
integer

Price list ID to which the item belongs. If not sent, the default price list is considered.

Response

200 - application/json

The sample response for price control request.

priceListId
integer
required

The price list ID for which the prices are created or updated.

itemId
integer
required

The item ID for which the prices are created or updated.

isDeleted
boolean
required

true: Record is deleted<br>false: Record isn't deleted

createdAt
string
required

Record's creation time

updatedAt
string
required

Record's last updated time

itemSku
string

The Stock Keeping Unit (SKU) of the item for which prices are created or updated.

msrp
number | null

The manufacturer-suggested retail price for the item. It's the price that the manufacturer suggests the retailer should sell the product for in order to make a reasonable profit.

map
number | null

The minimum price advertised for the item. It's the lowest price that a manufacturer or supplier allows its retailers or distributors to advertise a product for sale.

floor
number | null

The lowest price at which the product can be sold. Price created for the item ID or item SKU under the specified price list shouldn't be lower than the given floor price.

ceiling
number | null

The maximum price the seller is allowed to charge for the product. The price created for the item ID or item SKU under the specified price list shouldn't exceed the given ceiling price.

channelId
string

The sales channel ID for the created prices.

Was this page helpful?

Get all price controlsDelete price controls by itemId