REST API Services for CPQ Cloud

Calculate Price

post

/rest/v7/pricing/actions/calculatePrice

The Calculate Price REST API allows an external application to query CPQ Cloud for pricing information. CPQ Cloud executes contract rules and relevant profiles to calculate and return the final list price.

Request

Root Schema : pricing-calculatePriceRequest

Type: object

Show Source

currencyCode: string

Title: Currency Code

Currency code for the currency.
customerId(optional): string

Title: Customer ID

Customer ID of the customer (account).
headerAttributeValues(optional): object Header Attribute Values

Title: Header Attribute Values

Values of pricing attributes at the header level.
items(optional): array Items

Title: Items

Input data for items to be priced.
priceBookVarName(optional): string

Title: Price Book Variable Name

Variable name of the CPQ price book.

{
    "type":"object",
    "properties":{
        "priceBookVarName":{
            "title":"Price Book Variable Name",
            "description":"Variable name of the CPQ price book.",
            "type":"string"
        },
        "customerId":{
            "title":"Customer ID",
            "description":"Customer ID of the customer (account).",
            "type":"string"
        },
        "headerAttributeValues":{
            "$ref":"#/definitions/headerAttributes"
        },
        "currencyCode":{
            "title":"Currency Code",
            "description":"Currency code for the currency.",
            "type":"string"
        },
        "items":{
            "title":"Items",
            "description":"Input data for items to be priced.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "partNumber":{
                        "title":"Part Number",
                        "type":"string",
                        "description":"Part Number of the CPQ product."
                    },
                    "itemIdentifier":{
                        "title":"Item Identifier",
                        "type":"string",
                        "description":"An item's unique identifier. This can be any identifier desired by the client."
                    },
                    "itemAttributeValues":{
                        "$ref":"#/definitions/itemAttributes"
                    }
                },
                "required":[
                    "itemIdentifier",
                    "partNumber"
                ]
            }
        }
    },
    "required":[
        "currencyCode"
    ]
}

Nested Schema : Header Attribute Values

Type: object

Title: Header Attribute Values

Values of pricing attributes at the header level.

Show Source

{
    "type":"object",
    "title":"Header Attribute Values",
    "description":"Values of pricing attributes at the header level.",
    "properties":{
    }
}

Nested Schema : Items

Type: array

Title: Items

Input data for items to be priced.

Show Source

Array of: object items

{
    "title":"Items",
    "description":"Input data for items to be priced.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "partNumber":{
                "title":"Part Number",
                "type":"string",
                "description":"Part Number of the CPQ product."
            },
            "itemIdentifier":{
                "title":"Item Identifier",
                "type":"string",
                "description":"An item's unique identifier. This can be any identifier desired by the client."
            },
            "itemAttributeValues":{
                "$ref":"#/definitions/itemAttributes"
            }
        },
        "required":[
            "itemIdentifier",
            "partNumber"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

itemAttributeValues(optional): object Item Attribute Values

Title: Item Attribute Values

Values of pricing attributes at the item level for a specific item.
itemIdentifier: string

Title: Item Identifier

An item's unique identifier. This can be any identifier desired by the client.
partNumber: string

Title: Part Number

Part Number of the CPQ product.

{
    "type":"object",
    "properties":{
        "partNumber":{
            "title":"Part Number",
            "type":"string",
            "description":"Part Number of the CPQ product."
        },
        "itemIdentifier":{
            "title":"Item Identifier",
            "type":"string",
            "description":"An item's unique identifier. This can be any identifier desired by the client."
        },
        "itemAttributeValues":{
            "$ref":"#/definitions/itemAttributes"
        }
    },
    "required":[
        "itemIdentifier",
        "partNumber"
    ]
}

Nested Schema : Item Attribute Values

Type: object

Title: Item Attribute Values

Values of pricing attributes at the item level for a specific item.

Show Source

{
    "type":"object",
    "title":"Item Attribute Values",
    "description":"Values of pricing attributes at the item level for a specific item.",
    "properties":{
    }
}

Response

Default Response

Root Schema : pricing

Type: object

Show Source

items(optional): array Priced Items

Title: Priced Items

Items with their price calculated.

{
    "type":"object",
    "properties":{
        "items":{
            "title":"Priced Items",
            "description":"Items with their price calculated.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/itemPrice"
            }
        }
    }
}

Nested Schema : Priced Items

Type: array

Title: Priced Items

Items with their price calculated.

Show Source

Array of: object itemPrice

{
    "title":"Priced Items",
    "description":"Items with their price calculated.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/itemPrice"
    }
}

Nested Schema : itemPrice

Type: object

Show Source

calculationInfo(optional): array All Calculation Info

Title: All Calculation Info

Calculation info from each price profile, in order of execution during the price calculation.
itemIdentifier(optional): string

Title: Item Identifier

An item's unique identifier. This matches the item's identifier from the request.
partNumber(optional): string

Title: Part Number

Part Number of the CPQ product.
unitPrice(optional): number

Title: Unit Price

Final calculated unit price of the item.

{
    "properties":{
        "unitPrice":{
            "title":"Unit Price",
            "description":"Final calculated unit price of the item.",
            "type":"number"
        },
        "calculationInfo":{
            "title":"All Calculation Info",
            "description":"Calculation info from each price profile, in order of execution during the price calculation.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/profileCalculationInfo"
            }
        },
        "partNumber":{
            "title":"Part Number",
            "description":"Part Number of the CPQ product.",
            "type":"string"
        },
        "itemIdentifier":{
            "title":"Item Identifier",
            "description":"An item's unique identifier. This matches the item's identifier from the request.",
            "type":"string"
        }
    }
}

Nested Schema : All Calculation Info

Type: array

Title: All Calculation Info

Calculation info from each price profile, in order of execution during the price calculation.

Show Source

Array of: object Profile Calculation Info

Title: Profile Calculation Info

Additional information provided by a single price profile that contributed calculations to the final price.

{
    "title":"All Calculation Info",
    "description":"Calculation info from each price profile, in order of execution during the price calculation.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/profileCalculationInfo"
    }
}

Nested Schema : Profile Calculation Info

Type: object

Title: Profile Calculation Info

Additional information provided by a single price profile that contributed calculations to the final price.

Examples

The following example shows how to access a pricing information by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v7/pricing/actions/calculatePrice

Request Body Sample

{
	"currencyCode": "USD",
	"priceBookVarName": "_default_price_book",
	"customerId": "accountX",
	"headerAttributeValues": {
		"myPricingType": "recurring",
		...
	},
	"items": [{
			"itemIdentifier": "2",
			"partNumber": "part1",
			"itemAttributeValues": {
				"myUsage": 15.2,
				...
			}
		}, {
			"itemIdentifier": "3",
			"partNumber": "part1",
			"itemAttributeValues": {
				"myUsage": 80,
				...
			}
		}, {
			"itemIdentifier": "4",
			"partNumber": "part2"
		}
	]
}

Response Body Sample

{
	"items": [{
			"itemIdentifier": "2",
			"partNumber": "part1",
			"unitPrice": 2.34,
			"calculationInfo": [{
					...
				}, ...]
		}, {
			"itemIdentifier": "3",
			"partNumber": "part1",
			"unitPrice": 5.67,
			"calculationInfo": [{
					...
				}, ...]
		}, {
			"itemIdentifier": "4",
			"partNumber": "part2",
			"unitPrice": 80.00,
			"calculationInfo": [{
					...
				}, ...]
		}
	]
}