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
Copy
Ask AI
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
}'Copy
Ask AI
{
"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"
}
]
}
]
}Assistant
Responses are generated using AI and may contain mistakes.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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
Response
200
application/json
OK
The response is of type object.
Was this page helpful?
Copy
Ask AI
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
}'Copy
Ask AI
{
"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"
}
]
}
]
}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
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
Copy
Ask AI
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
}'Copy
Ask AI
{
"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"
}
]
}
]
}Assistant
Responses are generated using AI and may contain mistakes.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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
Response
200
application/json
OK
The response is of type object.
Was this page helpful?
Copy
Ask AI
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
}'Copy
Ask AI
{
"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"
}
]
}
]
}