FAfabric
Pricing

Get all prices

Gets a paginated list of all prices.

get/api-offers/price

Request

Query parameters

limitnumber

The maximum number of records per page.

pagenumber

Page number you want to get the record for.

priceListIdnumber

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

sortBy'itemId' | 'priceListId' | 'updatedAt'

Field by which you want to sort the records

sortOrder'asc' | 'desc'

Sorting order the records- ascending or descending

Headers

x-site-contextstring required
Example:{"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account": "1234abcd5678efgh9ijklmno","stage":"production"}

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.

Response

OK

queryobject

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

Example response

{
  "query": {
    "limit": 10,
    "count": 8,
    "page": 1
  },
  "prices": [
    {
      "_id": "616e011037a3810012345678",
      "itemId": 1000000051,
      "itemSku": "SKU123456",
      "offerId": 2386,
      "createdAt": "2020-02-02T17:22:48.570Z",
      "updatedAt": "2020-02-02T17:22:48.570Z",
      "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": [
                {
                  "minQuantity": 1,
                  "maxQuantity": "Infinity",
                  "price": 20.75
                }
              ]
            }
          ],
          "priceAttributes": [
            {
              "_id": "614dc5b0af8ee70008698202",
              "id": "614dc5b0af8ee70008698202"
            }
          ],
          "priceMethodType": "Range-Base"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.