Launches the cart for a given business object ID and business object type.

Required Fields:

  • businessObjectId (route) - required
  • type (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

  1. Validate businessObjectId (GUID) and business object type.
  2. Load the business object and query for an existing (non-Abandoned) cart.
  3. Reuse, clone, or create the cart based on its status.
  4. Apply overrides (EffectiveDate, ContractNumbers), activate the cart, and return it.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The business object identifier.

Query Params
string
required

Specify the business object type like Proposal/Collaboration Request/Order/Agreement.

boolean
Defaults to false
Body Params

The product configuration to be overridden

Optional overrides applied when launching a cart from a business object.

string | null

Comma-separated contract numbers to associate with this configuration.

boolean | null

When true, skips deal guidance validation during cart launch.

boolean | null

When true, skips approval check during cart launch.

boolean | null

When true, skips pricing for line items in config-pending state.

Headers
string
Defaults to system

Header param FlowName

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

500

An unexpected error occurred while launching the cart.

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json