Use this endpoint to retrieve published adjustment records for a specific pricing element in a framework. Adjustments are the modifiers alter cost or price values in a specific way, such as a percentage increase, a percentage decrease, a flat value increase, or a flat value decrease.
Because pricing data can be large, the endpoint accepts query parameters so you can:
- Pin the request to the right pricing context: which framework/version and which pricing element to query
- Narrow the result set to just the products and scope combinations you need
- Ask for adjustments as of a specific date, so you get the records that were effective at that point in time
- Page through results safely when there are many records
A list of adjustment records. Each record includes the adjustment value and supporting fields that explain where it applies, such as product, element scope, scenario, and effective date range.
Enter an access token to authenticate your requests. For details, read Get an access token.
Identifier of a framework's pricing element whose prices you want to get.
Framework version identifier. Together with elementId, this defines the published pricing dataset to query.
Provide either frameworkVersionId or frameworkId. They are mutually exclusive, but one of them is required.
Framework identifier. Together with elementId, this defines the published pricing dataset to query.
Provide either frameworkVersionId or frameworkId. They are mutually exclusive, but one of them is required.
Identifiers of products whose prices you want to get.
Scope filters that allow you to request prices only for certain scopes supported by the element. Use the following format for this query parameter: scope.<key>=<value>, where <key> must match a scope attribute defined on the element’s scopes.
Note: The Try it & see response feature on this page can’t execute requests that use dynamic query parameter names, such as scope.ProductId=SKU-1. To use this query parameter, run the request from your preferred tool and manually add it to the request URL.
Date in the YYYY-MM-DD format. The API returns the records that are effective at that time. If you don’t specify a date, the API uses today’s date.
The date must be within the retention window, otherwise the API returns the 400 validation error.
Cursor for pagination.
Сontrols how many records to return per page.
Adjustment records response
{
"data": {
"records": [
{
"AdjustmentRecordId": "0221852-52320",
"AdjustmentValue": 5,
"AdjustmentName": "Discount",
"ScenarioId": "1254891-54593",
"ElementScopeId": "0231589-203258",
"ProductId": "SKU-001",
"EffectiveFrom": "2025-01-01",
"EffectiveTo": "9999-12-31"
}
]
},
"pagination": {
"cursor": "200",
"hasMore": true
},
"meta": {
"requestId": "req-123",
"effectiveAt": "2025-01-01",
"frameworkVersionId": "0325620-84236",
"pricingView": "published_flattened",
"scenarioId": "1254891-54593"
}
}A list of adjustment records.
A pricing adjustment, such as a discount or surcharge, and its key details like a unique ID, name, value, and product it applies to.
Results pagination details.
Cursor for pagination.
True if more records are available.
Request identifier for tracing.
Framework version identifier.
Related scenario identifier.
Adjustment records response
{
"data": {
"records": [
{
"AdjustmentRecordId": "0221852-52320",
"AdjustmentValue": 5,
"AdjustmentName": "Discount",
"ScenarioId": "1254891-54593",
"ElementScopeId": "0231589-203258",
"ProductId": "SKU-001",
"EffectiveFrom": "2025-01-01",
"EffectiveTo": "9999-12-31"
}
]
},
"pagination": {
"cursor": "200",
"hasMore": true
},
"meta": {
"requestId": "req-123",
"effectiveAt": "2025-01-01",
"frameworkVersionId": "0325620-84236",
"pricingView": "published_flattened",
"scenarioId": "1254891-54593"
}
}A list of adjustment records.
A pricing adjustment, such as a discount or surcharge, and its key details like a unique ID, name, value, and product it applies to.
Results pagination details.
Cursor for pagination.
True if more records are available.
Request identifier for tracing.
Framework version identifier.
Related scenario identifier.
Validation error
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request",
"requestId": "req-123",
"details": {}
}
}Unauthorized
{
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized",
"requestId": "req-123"
}
}Forbidden
{
"error": {
"code": "FORBIDDEN",
"message": "Forbidden",
"requestId": "req-123"
}
}Queried element not found
{
"error": {
"code": "NOT_FOUND",
"message": "Not found",
"requestId": "req-123"
}
}Internal error
{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal error",
"requestId": "req-123"
}
}Upstream error
{
"error": {
"code": "UPSTREAM_ERROR",
"message": "Upstream dependency failed",
"requestId": "req-123"
}
}