Unlock Transaction (POST)

Unlock a quote or order whose calculation is stuck in a non-terminal status so that you can retry the transaction.

Use this API when a Place Sales Transaction call is stuck in a non-terminal calculation status. The API sets the calculation status to the appropriate failure status, such as ConfigurationFailed or PriceCalculationFailed so that you can retry the transaction. To use this API, you need the userCanAccessRLMPlaceSalesTransaction or userCanAccessCoreCPQ permission.

Keep these considerations in mind when you use this API.

This release supports only one record ID in the salesTransactionIds property.
If the calculation status is already one of the terminal statuses, such as CompletedWithPricing, CompletedWithoutPricing, CompletedWithTax, PriceCalculationFailed, or ConfigurationFailed, the API returns an error and doesn’t change the status.

Resource

1/revenue/transaction-management/sales-transactions/actions/unlock-transaction

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/revenue/transaction-management/sales-transactions/actions/unlock-transaction

Available Version

68.0

HTTP Methods

POST

Request Body for POST

JSON Example

This example shows a sample request to unlock a stuck sales transaction calculation.

1{
2  "salesTransactionIds": ["0Q0xx0000004CIiCAM"]
3}

Properties

Name	Type	Description	Required or Optional	Available Version
`salesTransactionIds`	String[]	List of record IDs, such as a quote or an order, whose calculation status is unlocked. This release supports only one record ID.	Required	68.0

Response Body for POST

Unlock Transaction