Get product structure with applicable price rules.

post

https://api.test.bluestonepim.com/price/products/structure-with-rules

Returns products with their hierarchy information and all applicable price rules. This endpoint is not paginated: it returns one entry per resolved product, so "total" always equals the size of "data". Both may be smaller than the number of requested pimProductIds, because duplicate IDs are collapsed and IDs that do not resolve to a product are omitted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request payload for retrieving product structure with applicable price rules.

pimProductIds

array of strings

required

length between 1 and 100

Between 1 and 100 PIM product IDs. Duplicate IDs are collapsed and IDs that do not resolve to a product are omitted from the response.

List of product IDs (PIM product IDs).*

customerGroups

array of strings

Optional filter. When omitted or empty, no customer group filtering is applied and all active price rules are returned, including rules that target specific customer groups. When one or more IDs are supplied, only price rules with no group targeting, or targeting at least one of the supplied groups, are returned; a supplied ID that does not resolve to an existing customer group cannot match any group-targeted rule, it does not switch filtering off.

List of customer group IDs (PIM IDs).

Responses

422

The request data is invalid

500

Cannot retrieve product structure

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Product structure with rules retrieved successfully

400Bad request