FAfabric
Price Kind

Get all price kinds

Retrieves a paginated list of all normal price kinds that are setup earlier. It returns only price-kinds, not the price information. Price kinds indicate if the offer is under clearance or promotion or base price status. If clearance or promotion price is not set up earlier, a price kind is considered as base price.

post/api-offers/price-kind

Request

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.

Request body

limitnumber

The maximum number of records per page.

pagenumber

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

Example request

{
  "limit": 10,
  "page": 1
}

Response

OK

priceKindIdnumber

Pricekind ID

namestring

Name of the price kind

channelnumber

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

isActiveboolean

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

isSoftDeletedboolean

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

Example response

[
  {
    "priceKindId": 10000001,
    "name": "PRICE_KIND_01",
    "channel": 123,
    "isActive": true
  }
]

Changes

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