Skip to main content
GET
/
api-offers
/
price
Get all prices
curl --request GET \
  --url https://live.copilot.fabric.inc/api-offers/price \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "query": {
    "limit": 10,
    "count": 8,
    "page": 1
  },
  "prices": [
    {
      "_id": "616e011037a3810012345678",
      "isSoftDeleted": false,
      "itemId": 1000000051,
      "itemSku": "SKU123456",
      "offerId": 2386,
      "createdAt": "2020-02-02T17:22:48.570Z",
      "updatedAt": "2020-02-02T17:22:48.570Z",
      "job": false,
      "priceListId": 100000,
      "offers": [
        {
          "kind": 12,
          "channel": 12,
          "startDate": "2020-02-03T17:22:48.570Z",
          "endDate": "2020-02-05T17:22:48.570Z",
          "price": {
            "base": 299,
            "sale": 199,
            "cost": 149,
            "currency": "USD"
          },
          "offerCode": 130283400,
          "range": [
            {
              "minQuantity": 3,
              "price": 299,
              "maxQuantity": "Infinity",
              "width": [
                {}
              ]
            }
          ],
          "priceAttributes": [
            {
              "_id": "614dc5b0af8ee70008698202",
              "id": "614dc5b0af8ee70008698202"
            }
          ],
          "priceMethodType": "Range-Base"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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.

Example:

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

Query Parameters

​
limit
number
default:10

The maximum number of records per page.

Required range: 1 <= x <= 100
​
page
number
default:1

Page number you want to get the record for.

Required range: x >= 1
​
priceListId
number

ID of the price list for which you want to get the price details

​
sortBy
enum<string>
default:updatedAt

Field by which you want to sort the records

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

Sorting order the records- ascending or descending

Available options:
asc,
desc

Response

OK

​
query
object

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

Example:
{ "limit": 10, "count": 8, "page": 1 }
​
prices
object[]

An array containing all the prices in service