Offers User Guides
- Overview
- Pricing
- Promotions
- Coupons
- Settings
Offers API
- Offers (3.0.0)
- Developer Guide
- Real-time Pricing Engine
- Price Lists
- Prices
- Price Types
- Price Controls
- Price Methods
- Priced Products
- Add-ons
- Promotions
- Coupons
- Coupon Codes
- Redemptions
- Product Exclusion Lists
- Segments
- Imports
- Exports
- Attributes
Get priced products
Get a paginated list of products and prices for the specified price list ID.
curl --request GET \
--url https://api.fabric.inc/v3/priced-products \
--header 'Authorization: Bearer <token>' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
"query": {
"size": 10,
"offset": 10,
"count": 50
},
"data": [
{
"query": {
"size": 10,
"offset": 10,
"count": 50
},
"data": {
"id": "AASSBCC12334FCD12334V",
"attributes": [
{
"id": "CAZZX1234567DDDDD",
"type": "string",
"value": "Blue"
}
],
"sku": "CAASSBCC12334FCD12334V",
"status": "ACTIVE",
"parentProductId": "WWQQSCD123456III",
"type": "PRODUCT",
"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"
}
]
}
],
"priceLastUpdatedAt": "2099-12-31T18:59:00+00:00",
"variants": [
{
"id": "AASSBCC12334FCD12334V",
"attributes": [
{
"id": "CAZZX1234567DDDDD",
"type": "string",
"value": "Blue"
}
],
"sku": "CAASSBCC12334FCD12334V",
"status": "ACTIVE",
"price": {
"itemId": 1000000051,
"itemSku": "SKU123456",
"priceListId": 100000,
"isDeleted": false,
"channelId": "12",
"currency": "USD",
"offers": [
{
"startAt": "2020-02-02T17:22:48.570Z",
"endAt": "2020-02-02T17:22:48.570Z",
"price": {
"base": 2.99,
"sale": 99.99,
"cost": 149
}
}
],
"createdAt": "2019-08-20T14:15:22.000Z",
"updatedAt": "2019-08-20T14:15:22.000Z"
}
}
],
"priceRange": {
"minimum": 3500,
"maximum": 12000
},
"promotionDates": {
"startAt": "2099-12-31T10:51:00.000Z",
"endAt": "2099-12-31T10:51:00.000Z"
}
}
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
24
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
"12"
A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.
A unique request ID.
"263e731c-45c8-11ed-b878-0242ac120002"
Query Parameters
The maximum number of records per page.
1 <= x <= 100
The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.
x >= 0
0
Price list ID to which the item belongs. If not sent, the default price list is considered.
100000
Specifies the response format. <br>true: Returns the response in a list view format.<br>false: Returns the response in a tile view format.
false
Search parameter to filter the response by SKU.
"COFFEE"
Search parameter to filter the response by product name.
"COFFEE MACHINE"
Response
List format priced products list
Provides pagination data.
The maximum number of records per page.
1 <= x <= 100
10
The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.
x >= 0
10
The total number of available records.
50
Products list
The products list.
Provides pagination data.
The maximum number of records per page.
1 <= x <= 100
10
The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.
x >= 0
10
The total number of available records.
50
Priced product detail
The product ID.
"AASSBCC12334FCD12334V"
Product SKU
"CAASSBCC12334FCD12334V"
The status of the product.
"ACTIVE"
The ID of the parent product.
"WWQQSCD123456III"
The type of product.
"PRODUCT"
The title of the product.
"wall posters"
The images of the product.
The details of product images displayed on the Copilot UI.
A 24-character system-generated ID of the product image.
"5fd7577251a93f0007e48383"
The order of appearance of the image of a product. A value of 0 indicates the image will appear first.
0
The label of the image.
"https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067"
A 24-character system-generated ID of the source from which the image is generated.
"5fd7577251a93f0007e48383"
The URL of the image.
"https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067"
The date and time when the price was last updated, formatted according to the ISO 8601 standard.
"2099-12-31T18:59:00+00:00"
The list of item variants.
The item ID.
"AASSBCC12334FCD12334V"
The item attributes.
The details of product attributes.
The Stock Keeping Unit (SKU) of the item.
"CAASSBCC12334FCD12334V"
The status of the item.
"ACTIVE"
ID of the price list for which price details are created or updated
100000
Channel ID
"12"
Price list currency type
"USD"
Item prices
Price details including offer price
Product item ID whose price is created or updated
1000000051
Item SKU
"SKU123456"
true: Record is deleted<br>false: Record isn't deleted
false
Record's creation time
"2019-08-20T14:15:22.000Z"
Record's last updated time
"2019-08-20T14:15:22.000Z"
The price range information.
The minimum price at which the product can be sold in the smallest denomination. For example, 3500 represents $35 if the smallest denomination is cents.
3500
The maximum price the product can be sold in the smallest denomination, for example, 12000 to represent $120 if the smallest denomination is cents.
12000
List format priced products list
Provides pagination data.
The maximum number of records per page.
1 <= x <= 100
10
The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.
x >= 0
10
The total number of available records.
50
Products list
The products list.
Provides pagination data.
The maximum number of records per page.
1 <= x <= 100
10
The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.
x >= 0
10
The total number of available records.
50
Priced product detail
The product ID.
"AASSBCC12334FCD12334V"
Product SKU
"CAASSBCC12334FCD12334V"
The status of the product.
"ACTIVE"
The ID of the parent product.
"WWQQSCD123456III"
The type of product.
"PRODUCT"
The title of the product.
"wall posters"
The images of the product.
The details of product images displayed on the Copilot UI.
A 24-character system-generated ID of the product image.
"5fd7577251a93f0007e48383"
The order of appearance of the image of a product. A value of 0 indicates the image will appear first.
0
The label of the image.
"https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067"
A 24-character system-generated ID of the source from which the image is generated.
"5fd7577251a93f0007e48383"
The URL of the image.
"https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067"
The date and time when the price was last updated, formatted according to the ISO 8601 standard.
"2099-12-31T18:59:00+00:00"
The list of item variants.
The item ID.
"AASSBCC12334FCD12334V"
The item attributes.
The details of product attributes.
The Stock Keeping Unit (SKU) of the item.
"CAASSBCC12334FCD12334V"
The status of the item.
"ACTIVE"
ID of the price list for which price details are created or updated
100000
Channel ID
"12"
Price list currency type
"USD"
Item prices
Price details including offer price
Product item ID whose price is created or updated
1000000051
Item SKU
"SKU123456"
true: Record is deleted<br>false: Record isn't deleted
false
Record's creation time
"2019-08-20T14:15:22.000Z"
Record's last updated time
"2019-08-20T14:15:22.000Z"
The price range information.
The minimum price at which the product can be sold in the smallest denomination. For example, 3500 represents $35 if the smallest denomination is cents.
3500
The maximum price the product can be sold in the smallest denomination, for example, 12000 to represent $120 if the smallest denomination is cents.
12000
The list of priced products to be displayed in a tile view.
Provides pagination data.
The maximum number of records per page.
1 <= x <= 100
10
The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.
x >= 0
10
The total number of available records.
50
Products list
Priced product detail
A 24-character system-generated product ID.
"AASSBCC12334FCD12334V"
The Stock Keeping Unit (SKU) of the product.
"CAASSBCC12334FCD12334V"
The status of the product.
ACTIVE
, INACTIVE
, DELETED
"ACTIVE"
The number of variants of the product.
2
The type of product.
PRODUCT
, VARIANT
, BUNDLE
"PRODUCT"
The title of the product.
"wall posters"
The details of the product images.
A 24-character system-generated ID of the product image from fabric Product Catalog.
"5fd7577251a93f0007e48383"
The order of appearance of the image. If the order is set to 0, that image will appear first.
0
The label of the image.
"https://abchome-xpm-images.s3.amazonaws.com/12.01.20+Giving+Tuesday/Homepage/HP_HolidaySix_GI_1.jpg?w=1067"
The date and time when the price was last updated, formatted according to the ISO 8601 standard.
"2099-12-31T18:59:00+00:00"
ID of the price list for which price details are created or updated
100000
Channel ID
"12"
Price list currency type
"USD"
Item prices
Price details including offer price
Price start time
"2020-02-02T17:22:48.570Z"
Price end time
"2020-02-02T17:22:48.570Z"
Price details
Item base price. It's the minimum fixed price of the item before any taxes or other charges added.
2.99
Item sale price. It's the discounted price at which the item is sold to clear inventory.
99.99
Cost of the item set by the manufacturer. It's the amount that costs the manufacturer to produce or acquire the product.
149
Product item ID whose price is created or updated
1000000051
Item SKU
"SKU123456"
true: Record is deleted<br>false: Record isn't deleted
false
Record's creation time
"2019-08-20T14:15:22.000Z"
Record's last updated time
"2019-08-20T14:15:22.000Z"
The price range information.
The minimum price at which the product can be sold in the smallest denomination. For example, 3500 represents $35 if the smallest denomination is cents.
3500
The maximum price the product can be sold in the smallest denomination, for example, 12000 to represent $120 if the smallest denomination is cents.
12000
Was this page helpful?
curl --request GET \
--url https://api.fabric.inc/v3/priced-products \
--header 'Authorization: Bearer <token>' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
"query": {
"size": 10,
"offset": 10,
"count": 50
},
"data": [
{
"query": {
"size": 10,
"offset": 10,
"count": 50
},
"data": {
"id": "AASSBCC12334FCD12334V",
"attributes": [
{
"id": "CAZZX1234567DDDDD",
"type": "string",
"value": "Blue"
}
],
"sku": "CAASSBCC12334FCD12334V",
"status": "ACTIVE",
"parentProductId": "WWQQSCD123456III",
"type": "PRODUCT",
"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"
}
]
}
],
"priceLastUpdatedAt": "2099-12-31T18:59:00+00:00",
"variants": [
{
"id": "AASSBCC12334FCD12334V",
"attributes": [
{
"id": "CAZZX1234567DDDDD",
"type": "string",
"value": "Blue"
}
],
"sku": "CAASSBCC12334FCD12334V",
"status": "ACTIVE",
"price": {
"itemId": 1000000051,
"itemSku": "SKU123456",
"priceListId": 100000,
"isDeleted": false,
"channelId": "12",
"currency": "USD",
"offers": [
{
"startAt": "2020-02-02T17:22:48.570Z",
"endAt": "2020-02-02T17:22:48.570Z",
"price": {
"base": 2.99,
"sale": 99.99,
"cost": 149
}
}
],
"createdAt": "2019-08-20T14:15:22.000Z",
"updatedAt": "2019-08-20T14:15:22.000Z"
}
}
],
"priceRange": {
"minimum": 3500,
"maximum": 12000
},
"promotionDates": {
"startAt": "2099-12-31T10:51:00.000Z",
"endAt": "2099-12-31T10:51:00.000Z"
}
}
}
]
}