Skip to main content
GET
/
api-price
/
price
/
{priceId}
Get Price Details by Price ID
curl --request GET \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-price/price/{priceId} \
  --header 'x-site-context: <x-site-context>'
{
  "query": {
    "limit": 10,
    "count": 40,
    "page": 1
  },
  "prices": [
    {
      "_id": "616e011037a3810008cfb256",
      "priceListId": 100000,
      "isSoftDeleted": false,
      "itemId": 1000011218,
      "itemSku": "1234XYZ",
      "offerId": 371922,
      "offers": [
        {
          "kind": 12,
          "channel": 12,
          "startDate": "2021-12-30T02:05:00.000Z",
          "endDate": "2099-12-31T00:00:00.000Z",
          "price": {
            "base": 2000,
            "sale": 1000,
            "cost": 800,
            "currency": "USD"
          },
          "range": [
            {
              "_id": "616e143828d0b800086dd84a",
              "minQuantity": 2,
              "price": 500
            }
          ]
        }
      ],
      "createdAt": "2021-10-18T23:19:44.852Z",
      "updatedAt": "2021-10-19T00:40:30.341Z",
      "job": false
    }
  ]
}

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
priceId
string
required

The ID associated with the price of an item

Query Parameters

​
priceListId
string
required

PriceListId to get the price from.

​
type
enum<string>

The type of id that is provided in path for priceId.

Available options:
id,
itemId,
itemSku

Response

Successfully retrieves price details.

Get Price Response

​
query
object

Object containing the size, count and amount of pages in the response.

​
prices
object[]

An array containing all the prices in the service.