Required Fields:
businessObjectId(route) - requiredtype(query) - required; e.g. Proposal, Collaboration Request, Order, Agreement
Launches (activates) a cart for the specified business object. If an active cart already exists it is
reused; otherwise a new cart is created from the business object, initialized, and activated in a single request.
Requirements
-
businessObjectId (route): required; must be a valid GUID.
-
type (query): required; the business object type (e.g., Proposal, Collaboration Request, Order, Agreement).
-
When the business-object-agnostic cart service is disabled, only "Proposal" and "Collaboration Request" types are supported.
-
When the business-object-agnostic cart service is enabled, the type is validated against protected metadata containing the required fields.
Request Payload (optional body)
Optional fields (ProductConfigurationOverride): -
PricingDate: overrides the cart EffectiveDate.
-
ContractNumbers: applied to the cart after validation.
-
Other product configuration overrides applied during activation.
Optional headers -
FlowName: identifies the calling flow (defaults to the system flow).
-
AcquireLock: when "true", a lock is acquired on the cart during activation.
Optional query -
updateDerivedFrom: when true (versioned flow), updates the "derived from" reference on clone.
Behavior -
An existing Finalized cart is returned as-is; a non-Finalized cart returns the latest activated cart by ActivationDate.
-
An Abandoned cart is cloned into a new editable cart before activation.
-
When no cart exists, one is created from the business object (copies properties, validates PriceList, populates Location/Currency) using a lock-checked creation with retry.
-
When cart versioning is enabled, a Finalized cart is cloned atomically with an incremented version number.
Processing Order
- Validate businessObjectId (GUID) and business object type.
- Load the business object and query for an existing (non-Abandoned) cart.
- Reuse, clone, or create the cart based on its status.
- Apply overrides (EffectiveDate, ContractNumbers), activate the cart, and return it.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
500An unexpected error occurred while launching the cart.
