Search products and assigned prices in a specific price list

We have a brand new Developer Portal!

This page will be expiring soon; be sure to bookmark the new link.

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.

SecurityAuthorizationToken

Request

header Parameters

required	object Valid JSON object that must contain account, stage, date, and channel attributes. eg - {"stage":"prod","account":"5f328bf0b","date":"2020-12-12T08:00:00.000Z","channel":12}
Authorization required	string Authorization token or access token for the user, provided by fabric. It can be obtained after logging into fabric's copilot account. Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Request Body schema: application/json

offset	number Default: 0 Number of records you wish to skip before selecting records
limit	number Default: 10 Number records to return on a single page
keyword	string Search parameter to filter the query
sku	boolean If sku is true then this endpoint returns products which 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

Responses

200

404

Not Found

500

Internal Server Error

post/api-offers/items/search

Request samples

Payload

application/json

{"offset": 0,
"limit": 10,
"keyword": "CAN",
"sku": true,
"isListView": true,
"priceListId": 0
}

Response samples

application/json

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