Use this endpoint to retrieve the pricing elements (steps) that exist in a specific published framework version, along with the scope definitions that control how those elements vary across things like product, region, customer segment, and other scoping dimensions.
What you get back
A list of elements for the specified framework version. Each record includes metadata, such as an element ID, name, type, and scope data.
Enter an access token to authenticate your requests. For details, read Get an access token.
Framework identifier.
Framework version identifier.
Elements of a framework version response
{
"data": {
"elements": [
{
"elementId": "33333333-3333",
"displayName": "Base Price",
"elementType": "PRICE",
"stepType": "CALCULATED",
"position": 1,
"scopes": [
{
"elementScopeId": "44444444-4444",
"name": "Default",
"rank": 1,
"isFallback": true,
"scopingAttributes": [
{
"scopingAttributeId": "55555555-5555",
"attributeName": "Product",
"sourceEntityFieldId": "Product.ProductId"
}
]
}
]
}
]
},
"meta": {
"requestId": "req-123"
}
}A list of framework version's elements.
A framework version's element and its key details like a unique ID, name, position, and related scopes.
Results pagination details.
Cursor for pagination.
True if more records are available.
Request identifier for tracing.
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"
}
}