GET
/
api-offers
/
price
/
{priceId}
/
priceList
/
{priceListId}
curl --request GET \
  --url https://live.copilot.fabric.inc/api-offers/price/{priceId}/priceList/{priceListId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "_id": "62583d6e2d4b944f747127a5",
  "isSoftDeleted": false,
  "itemId": 1000000051,
  "itemSku": "SKU123456",
  "priceListId": 100000,
  "offers": [
    {
      "kind": 12,
      "channel": 12,
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "price": {
        "base": 299,
        "sale": 199,
        "cost": 149,
        "currency": "USD"
      },
      "range": [
        {
          "minQuantity": 3,
          "maxQuantity": "Infinity",
          "price": 299,
          "width": [
            {
              "minQuantity": 3,
              "maxQuantity": "Infinity",
              "price": 299
            }
          ]
        }
      ],
      "priceMethodType": "Range-Base",
      "priceAttributes": [
        {
          "blindMotor": 30
        }
      ],
      "additionalAttributes": [
        {
          "customSkuTitle": "HOUSE TREE",
          "customCategory": "HOME"
        }
      ]
    }
  ],
  "createdAt": "2020-02-02T17:22:48.570Z",
  "updatedAt": "2020-02-02T17:22:48.570Z",
  "job": false,
  "offerId": 1074,
  "query": {
    "count": 15,
    "page": 1,
    "limit": 10
  }
}

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\"}"

Path Parameters

​
priceId
string
required

Value for this field can be database ID (_id) of the price or itemSku or itemId based on the type mentioned in the type query parameter.<br /> If a type is not specified in the type query parameter, you must provide itemSku in this priceId field.

Example:

"SKU123456"

​
priceListId
number
required

ID of the priceList to search the price for.

Example:

100000

Query Parameters

​
type
enum<string>

The priceId path parameter will be treated as itemSku, itemId or _id based on the value of this field. The default search will be done by itemSku.

Available options:
itemSku,
itemId,
_id
Example:

"itemId"

​
limit
number
default:10

The maximum number of records per page. If the isActive flag is sent, the limit will be ignored.

Example:

10

​
page
number

Number of pages you wish to retrieve when selecting records in the price offers array. Default is 1. If the isActive flag is true, page will be ignored.

Example:

1

​
isActive
boolean

If isActive is false, offers array response based on limit and page parameters.<br /> If isActive is true, only the offer object whose price is active will be returned in the offers array.<br /> Default value is false.

Example:

false

Response

200
application/json
OK

The response is of type object.