Skip to main content
POST
/
api-offers
/
price-kind
Get all price kinds
curl --request POST \
  --url https://live.copilot.fabric.inc/api-offers/price-kind \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "limit": 10,
  "page": 1
}
'
[
  {
    "priceKindId": 10000001,
    "name": "PRICE_KIND_01",
    "channel": 123,
    "isActive": true,
    "isSoftDeleted": false
  }
]

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

Body

application/json
​
limit
number
default:10

The maximum number of records per page.

Example:

10

​
page
number

The page number to be returned and page is always paired with limit

Example:

1

Response

OK

​
priceKindId
number

Pricekind ID

Example:

10000001

​
name
string

Name of the price kind

Example:

"PRICE_KIND_01"

​
channel
number

Sales channel of the price kind from which the request is made

Example:

123

​
isActive
boolean

true: price kind is active and being applied to SKUs.
false: price kind is inactive and is not being applied to SKUs at the moment.

Example:

true

​
isSoftDeleted
boolean

true: price kind is removed from the list
false: price kind is active and running, which means it is being applied to the SKUs.

Example:

false