FAfabric
Pricing

Get price by priceId

Retrieves paginated list of price details based on priceListId and priceId or itemSku or itemId.

get/api-offers/price/{priceId}/priceList/{priceListId}

Request

Path parameters

priceIdstring required
Example:SKU123456

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.

priceListIdnumber required
Example:100000

ID of the priceList to search the price for.

Query parameters

type'itemSku' | 'itemId' | '_id'
Example:itemId

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.

limitnumber
Example:10

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

pagenumber
Example:1

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.

isActiveboolean

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.

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

_idstring required

fabric internal ID

isSoftDeletedboolean

true: record is deleted<br /> false: record is not deleted

itemIdnumber required

Item ID

itemSkustring

SKU of the item

priceListIdnumber required

ID of the priceList related to the SKU or item

createdAtstring date-time required

Date of creation of the price.

updatedAtstring date-time required

Last updated date of the price.

jobboolean

true: Job is running<br /> false: Job operation is either completed or not running for some reason

offerIdnumber

ID of the created offer for the itemId or itemSku

Example response

{
  "_id": "62583d6e2d4b944f747127a5",
  "itemId": 1000000051,
  "itemSku": "SKU123456",
  "priceListId": 100000,
  "offers": [
    {
      "kind": 12,
      "channel": 12,
      "price": {
        "base": 299,
        "sale": 199,
        "cost": 149,
        "currency": "USD"
      },
      "range": [
        {
          "minQuantity": 3,
          "price": 299,
          "width": [
            {
              "minQuantity": 3,
              "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",
  "offerId": 1074,
  "query": {
    "count": 15,
    "page": 1,
    "limit": 10
  }
}

Changes

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