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

Try it

Search products and assigned prices in a specific price list

cURL

curl --request POST \
  --url https://live.copilot.fabric.inc/api-offers/items/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "offset": 0,
  "limit": 10,
  "keyword": "CAN",
  "sku": true,
  "isListView": true,
  "priceListId": 123
}
'

200

{
  "query": {
    "limit": 10,
    "offset": 0,
    "count": 50
  },
  "results": [
    {
      "variants": [
        "VARIANT-01",
        "VARIANT-55"
      ],
      "itemId": 1000002411,
      "channel": [
        12,
        13
      ],
      "isDefault": true,
      "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",
      "isActive": true,
      "sku": "WALL123",
      "title": "wall posters",
      "images": [
        {
          "id": "5fd7577251a93f0007e48383",
          "order": 0,
          "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
          ],
          "isDefault": true,
          "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",
          "isActive": true,
          "sku": "WALL123",
          "title": "wall posters",
          "images": [
            {
              "id": "5fd7577251a93f0007e48383",
              "order": 0,
              "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"
        }
      ]
    }
  ]
}

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

offset · number · default: 0

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.

Example:

0

limit · number · default: 10

The maximum number of records per page.

Example:

10

keyword · string

Search parameter to filter the query

Example:

"CAN"

sku · boolean

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

isListView · boolean

true indicates that the response data will be displayed in list
false indicates that the response data will be displayed in a tile view

priceListId · number

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

Response

200

application/json

OK

query · object

Show child attributes

query. limit · number · default: 10

The maximum number of records per page.

Example:

10

query. offset · number · default: 0

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.

Example:

0

query. count · number

The total number of records.

Example:

50

results · object[]

Show child attributes

results. variants · string[]

Variants of the product

Example:

["VARIANT-01", "VARIANT-55"]

results. itemId · number

Item ID

Example:

1000002411

results. channel · number[]

Sales channel of the product

Example:

[12, 13]

results. isDefault · boolean

false for parent product
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.

results. state · string

Status of the product. READY indicates the product is ready to be published on the product listing page for shopper's consumption.

Example:

"READY"

results. createdAt · string

Creation date of the record

Example:

"2020-12-14T12:15:43.646Z"

results. updatedAt · string

Last updated date of the record

Example:

"2020-12-14T12:15:43.646Z"

results. startDate · string

Start date of the product

Example:

"2020-12-14T12:14:35.331Z"

results. endDate · string

End date of the product

Example:

"2020-12-14T12:14:35.331Z"

results. isActive · boolean

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

results. sku · string

SKU of the product

Example:

"WALL123"

results. title · string

Title of the product

Example:

"wall posters"

results. images · object[]

Details of images of item to be displayed on the copilot UI

Show child attributes

results.images. id · string

Example:

"5fd7577251a93f0007e48383"

results.images. order · number

Example:

0

results.images. label · string

Example:

"https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067"

results.images. source · object[]

Show child attributes

results.images.source. id · string

Example:

"5fd7577251a93f0007e48383"

results.images.source. url · string

Example:

"https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067"

results. price · object

Price of the product, it will only exist if the price was set up for the product.

Show child attributes

results.price. sale · number

Price at which the product is offered for sale

Example:

2800

results.price. cost · number

Cost of item if any

Example:

2500

results.price. currency · string

3 letter currency code for price

Example:

"USD"

results.price. base · number

Minimum fixed price of the product

Example:

3000

results. kind · object

Show child attributes

results.kind. priceKindId · number

Pricekind ID. This ID helps to identify if the price is base price or clearance price or any other additional price.

Example:

12

results.kind. name · string

Example:

"Clearance"

results.kind. channel · number

Example:

12

results. priceStartDate · string<date-time>

Start date of the active price

Example:

"2021-01-06T19:00:00+00:00"

results. priceEndDate · string<date-time>

End date of the active price

Example:

"2099-12-31T18:59:00+00:00"

results. priceLastUpdatedAt · string<date-time>

Last updated date of the price

Example:

"2099-12-31T18:59:00+00:00"

results. status · string

Status of the price

Example:

"ACTIVE"

results. basePriceRange · object

Minimum and maximum base price of the item if it was set up earlier

Show child attributes

results.basePriceRange. min · number

Example:

100

results.basePriceRange. max · number

Example:

300

results. salePriceRange · object

Minimum and maximum price at which the product is offered for a sale

Show child attributes

results.salePriceRange. min · number

Example:

100

results.salePriceRange. max · number

Example:

300

results. costPriceRange · object

Minimum and maximum cost price if it was set up earlier

Show child attributes

results.costPriceRange. min · number

Example:

100

results.costPriceRange. max · number

Example:

300

results. items · object[]

Show child attributes

results.items. variants · string[]

Child item variants

Example:

["VARIANT-01", "VARIANT-55"]

results.items. itemId · number

Child item ID

Example:

1000002411

results.items. channel · number[]

Example:

[12, 13]

results.items. isDefault · boolean

true: child item is the default child item to be displayed, under the parent product, on the product listing page.
false: child item is not the default item of the parent product

results.items. state · string

Child item's state. READY indicates the child item is active and ready to be consumed by the shoppers.

Example:

"READY"

results.items. createdAt · string

Creation date of the child itemn

Example:

"2020-12-14T12:15:43.646Z"

results.items. updatedAt · string

Last updated date of the child item

Example:

"2020-12-14T12:15:43.646Z"

results.items. startDate · string

Date from which the child item is available to be sold

Example:

"2020-12-14T12:14:35.331Z"

results.items. endDate · string

Date from which the child item is not available to be sold

Example:

"2020-12-14T12:14:35.331Z"

results.items. isActive · boolean

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

results.items. sku · string

Child item sku

Example:

"WALL123"

results.items. title · string

Title of the child item

Example:

"wall posters"

results.items. images · object[]

Image details of the child item

Show child attributes

results.items.images. id · string

Example:

"5fd7577251a93f0007e48383"

results.items.images. order · number

Example:

0

results.items.images. label · string

Example:

"https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067"

results.items.images. source · object[]

Show child attributes

results.items.images.source. id · string

Example:

"5fd7577251a93f0007e48383"

results.items.images.source. url · string

Example:

"https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067"

results.items. price · object

Price details of the child item

Show child attributes

results.items.price. sale · number

Price at which the product is offered for sale

Example:

2800

results.items.price. cost · number

Cost of item if any

Example:

2500

results.items.price. currency · string

3 letter currency code for price

Example:

"USD"

results.items.price. base · number

Minimum fixed price of the product

Example:

3000

results.items. kind · object

Show child attributes

results.items.kind. priceKindId · number

Indicates if the offer price of the item is promotional price or clearance price

Example:

12

results.items.kind. name · string

Example:

"Clearance"

results.items.kind. channel · number

Example:

12

results.items. priceStartDate · string<date-time>

Start date of active price

Example:

"2021-01-06T19:00:00+00:00"

results.items. priceEndDate · string<date-time>

End date of active price

Example:

"2099-12-31T18:59:00+00:00"

results.items. status · string

Item status

Example:

"ACTIVE"