FAfabric
Item

Search products and assigned prices in a specific price list

Retrieves a paginated list of products and assigned prices in a specific price list based on priceListId and other search parameters as passed in the request body. If price list ID is not provided, default price list is selected for the search.

post/api-offers/items/search

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

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.

limitnumber

The maximum number of records per page.

keywordstring

Search parameter to filter the query

skuboolean

If SKU is true then this endpoint returns products that have SKU value mentioned.

isListViewboolean

true indicates that the response data will be displayed in list<br /> false indicates that the response data will be displayed in a tile view

priceListIdnumber

ID of the priceList for which the price and product information are to be retrieved

Example request

{
  "limit": 10,
  "keyword": "CAN"
}

Response

OK

Example response

{
  "query": {
    "limit": 10,
    "count": 50
  },
  "results": [
    {
      "variants": [
        "VARIANT-01",
        "VARIANT-55"
      ],
      "itemId": 1000002411,
      "channel": [
        12,
        13
      ],
      "state": "READY",
      "createdAt": "2020-12-14T12:15:43.646Z",
      "updatedAt": "2020-12-14T12:15:43.646Z",
      "startDate": "2020-12-14T12:14:35.331Z",
      "endDate": "2020-12-14T12:14:35.331Z",
      "sku": "WALL123",
      "title": "wall posters",
      "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"
            }
          ]
        }
      ],
      "price": {
        "sale": 2800,
        "cost": 2500,
        "currency": "USD",
        "base": 3000
      },
      "kind": {
        "priceKindId": 12,
        "name": "Clearance",
        "channel": 12
      },
      "priceStartDate": "2021-01-06T19:00:00+00:00",
      "priceEndDate": "2099-12-31T18:59:00+00:00",
      "priceLastUpdatedAt": "2099-12-31T18:59:00+00:00",
      "status": "ACTIVE",
      "basePriceRange": {
        "min": 100,
        "max": 300
      },
      "salePriceRange": {
        "min": 100,
        "max": 300
      },
      "costPriceRange": {
        "min": 100,
        "max": 300
      },
      "items": [
        {
          "variants": [
            "VARIANT-01",
            "VARIANT-55"
          ],
          "itemId": 1000002411,
          "channel": [
            12,
            13
          ],
          "state": "READY",
          "createdAt": "2020-12-14T12:15:43.646Z",
          "updatedAt": "2020-12-14T12:15:43.646Z",
          "startDate": "2020-12-14T12:14:35.331Z",
          "endDate": "2020-12-14T12:14:35.331Z",
          "sku": "WALL123",
          "title": "wall posters",
          "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"
                }
              ]
            }
          ],
          "price": {
            "sale": 2800,
            "cost": 2500,
            "currency": "USD",
            "base": 3000
          },
          "kind": {
            "priceKindId": 12,
            "name": "Clearance",
            "channel": 12
          },
          "priceStartDate": "2021-01-06T19:00:00+00:00",
          "priceEndDate": "2099-12-31T18:59:00+00:00",
          "status": "ACTIVE"
        }
      ]
    }
  ]
}

Changes

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