Search products and assigned prices in a specific price list

Authentication v1

Identity APIs
User
Address
Auth

User Self Service APIs

Introduction
User Self Service APIs
Authentication APIs

Experiences v2 (XM v2)

XM
Pages
Global Components
Menu

Experiences v1 (XM v1)

XM
Pages
Global Components
Menu

Product Catalog

Product Catalog
Category
Product
Attributes
Bulk Import

Orders v2 (OMS v2)

Order Management System
Order
Order Attribute
Developer Guide
Order Return
Payment Status
Package Tracking
Cross Border
Order Cancellation
Appeasement
Allocation
Configuration
Fraud Configuration
Target Configuration
Location
Location Attribute
Inventory Network
Inventory
Inventory Counter
Inventory Bulk Operation
Inventory Attribute
Inventory Upload Log
Shipment
Shipping Method
Webhook
Notification
Export
Invoice
Fraud
Backorder Preorder Reservation
List

Orders v1 (OMS v1)

Order Management System
Cart
Bill To
Ship To
Wishlist
Cart Decoupled
Warehouse
Inventory
Attributes
List
Tax/Address Validate
Shipping
Payments
Order

Offers v2

Offers
Developer Guide
Promotion
Price Kind
Dynamic Pricing Engine
Segment
Coupon
Coupon Codes
Product
Price List
Attributes
Item
Price Guard
Global Exclusion
Upload Price CSV
Pricing
Redemption
Exports

Offers v1

Offers
Login API
Promotions
Pricing

Subscriptions (SMT API)

Subscriptions API
Cancellation Reasons
Subscription Discounts
Subscriptions
Subscribers
Orders

Loyalty (Member)

Member APIs
Inquire
Discounts
Redeem
Earn
Members

Dropship

Dropship API
Shipments
Products
Invoices
Connections
Inventory
Developer Guide
Returns
Orders

Cart API

Cart
Order Draft
Attribute
Adjustments
Shipping
Cart

Checkout API

Checkout
Checkout

Customer

Core Concepts
Customer Service
Organization
User Party
Organization Group Addresses
User Internal Party
Organization Contracts
Party
Party Contracts
Contracts
User
Search
User Trait
Organization Users
Address
User Address
Trait
Party Address
Party Trait
Organization Group Users
Internal Party
Contract Pricelist
Internal Parties Party
Account
Party Account
Organization Addresses
Organization Groups
Individual Addresses
Users Organization
Individual

POST

api-offers

items

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
}'

{
  "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.

Body

application/json

offset

number

default:

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.

limit

number

default:

The maximum number of records per page.

keyword

string

Search parameter to filter the query

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

query

object

results

object[]

results.variants

string[]

Variants of the product

results.itemId

number

Item ID

results.channel

number[]

Sales channel of the product

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.

results.createdAt

string

Creation date of the record

results.updatedAt

string

Last updated date of the record

results.startDate

string

Start date of the product

results.endDate

string

End date of the product

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

results.title

string

Title of the product

results.images

object[]

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

results.price

object

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

results.kind

object

results.priceStartDate

string

Start date of the active price

results.priceEndDate

string

End date of the active price

results.priceLastUpdatedAt

string

Last updated date of the price

results.status

string

Status of the price

results.basePriceRange

object

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

results.salePriceRange

object

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

results.costPriceRange

object

Minimum and maximum cost price if it was set up earlier

results.items

object[]

results.items.variants

string[]

Child item variants

results.items.itemId

number

Child item ID

results.items.channel

number[]

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.

results.items.createdAt

string

Creation date of the child itemn

results.items.updatedAt

string

Last updated date of the child item

results.items.startDate

string

Date from which the child item is available to be sold

results.items.endDate

string

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

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

results.items.title

string

Title of the child item

results.items.images

object[]

Image details of the child item

results.items.price

object

Price details of the child item

results.items.kind

object

results.items.priceStartDate

string

Start date of active price

results.items.priceEndDate

string

End date of active price

results.items.status

string

Item status

Was this page helpful?

Overview Get Skus and itemIds in a specific pricelist

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
}'

{
  "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"
        }
      ]
    }
  ]
}