GET
/
prices
/
{itemId}
{
  "query": {
    "size": 10,
    "offset": 0
  },
  "priceMetadata": {
    "priceListId": 100000,
    "itemId": 10000001,
    "itemSku": "SKU0123456",
    "isDeleted": false,
    "channelId": "12",
    "currency": "USD",
    "createdAt": "2019-08-20T14:15:22.000Z",
    "updatedAt": "2019-08-20T14:15:22.000Z"
  },
  "data": {
    "startAt": "2019-08-24T14:15:22.000Z",
    "endAt": "2019-08-25T14:15:22.000Z",
    "price": {
      "base": 299.99,
      "sale": 199.99,
      "cost": 148.99
    }
  }
}

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 through which the API request is being made; primarily for multichannel use cases. It is a required field.

​
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
number
required

The item ID from which prices are retrieved.

Query Parameters

​
size
integer
default: 10

The maximum number of records per page.

Required range: 1 < x < 100
​
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
​
priceListId
integer

The price list ID to which the item belongs. If not provided, the default price list is used.

​
status
enum<string>
default: ALL

The status used to filter prices. The following statuses are available:

  • ACTIVE: Displays current prices or regular prices. These are the prices that are actively displayed and applied to products on an ongoing basis.
  • SCHEDULED: Displays prices that will be applied to products in the future. Retailers often use scheduled prices for marketing campaigns to attract customers, generate sales, clear inventory, or create a sense of urgency.
  • ALL: Displays both ACTIVE and SCHEDULED prices.
Available options:
ACTIVE,
SCHEDULED,
ALL

Response

200 - application/json
​
query
object

Provides pagination data.

​
priceMetadata
object
​
data
object[]

Was this page helpful?

Delete price by SKUDelete price by itemId