FAfabric
Item

Get price of a specific item

Retrieves price details of an item by itemId

get/api-offers/item/{itemId}

Request

Path parameters

itemIdnumber required

ID of the item to get price details for

Query parameters

priceListIdnumber

ID of the price list to which the item belongs to. If priceListId is not provided, default priceList is considered for search. If the itemId does not belong to the default priceList, then the price object is not returned.

limitnumber

The maximum number of records per page.

offsetnumber

The number of records to skip before returning records. For example, when offset is 20 and limit is 10, this endpoint returns records from 21 to 30.

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

channelnumber[]

Sales channel of the product

startDatestring date-time

Start date of the product

endDatestring date-time

End date of the product

groupstring[]

Item's group/category ID

titlestring

Title of the product

itemIdnumber

Item ID

isDefaultboolean

false for parent product<br /> If a parent product has child items, true represents the default child item to be displayed, under the parent product, on the product listing page.

isActiveboolean

true if the item is active and displayed in the catalog. isActive will be true only when state is READY <br /> false if the state is DRAFT, and item is not displayed in the catalog

parentstring

If the item has a parent product, it displays the parent product ID

itemFamilystring

Parent family to which the item belongs to. All items belongs to an itemFamily

descriptionstring

Description of the product

variantsstring[]

Shows if any variant of the product is available, based on color or size and other details.

statestring

Status of the product. READY indicates the item along with all of its attributes is rady is to be published on the product listing page.

skustring

SKU of the product

isSoftDeletedboolean

true indicates the item is removed from the copilot UI<br /> false indicates item is not removed from the copilot UI

Example response

{
  "channel": [
    12,
    13
  ],
  "startDate": "2020-08-17T07:39:29.092Z",
  "endDate": "2099-12-31T00:00:00.000Z",
  "group": [
    "5e2cfa5245570b000863c4ab"
  ],
  "title": "Arper Dizzie Oval Coffee Table",
  "itemId": 1000000269,
  "price": {
    "id": "5e31832ccaf608b232bb4cdrr",
    "itemId": 1000000269,
    "offerId": 1074,
    "createdAt": "2020-08-19T10:53:29.918Z",
    "updatedAt": "2020-08-19T10:53:29.918Z",
    "offers": [
      {
        "price": {
          "base": 229,
          "currency": "USD"
        },
        "channel": 12,
        "startDate": "2018-10-19T16:46:45Z",
        "endDate": "2099-12-31T00:00:00Z",
        "kind": 12
      }
    ],
    "query": {
      "limit": 10,
      "count": 50
    }
  },
  "attributes": [
    {
      "value": "size"
    }
  ],
  "parent": "5f3a355075cc4900085fb1b1",
  "itemFamily": "5f3a3371d9bf7b0007d699d8",
  "description": "This smart band's OLED display (300 nits) can show up to 48 characters, thereby letting you view everything with a single glance. The display is fingerprint-coated to offer you a clear view every time.",
  "variants": [
    "VARIANT-01",
    "VARIANT-55"
  ],
  "state": "READY",
  "images": [
    {
      "id": "5fd7577251a93f0007e48383",
      "label": "https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067",
      "source": [
        {
          "id": "5fd7577251a93f0007e48383",
          "url": "https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067"
        }
      ]
    }
  ],
  "sku": "XMSH99KLW10"
}

Changes

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