Overview

Use this API to create and activate a cart for a Proposal if no cart exists, or to retrieve and activate an existing cart for a Proposal or Collaboration Request. This endpoint is part of the Business Object Controller within the Cart service.

Endpoint

Base URL: api/cart/v1/business-objects

Endpoint: POST api/cart/v1/business-objects/{businessObjectId}/carts/activate

Parameters

• businessObjectId (path): Unique identifier (Id) of the business object.
• type: Business object type.
  • Proposal – Create and activate a cart if none exists, or fetch existing.
  • Collaboration Request – Always fetch and activate the associated child configuration cart.
• FlowName (optional): Flow name. Default value is System.

Request body

JSON payload:

{
  "contractNumbers": "string",
  "skipDealGuidance": true,
  "skipApprovalCheck": true,
  "skipPricingForConfigPending": true
}
      

Field descriptions:

1. contractNumbers: Overrides the contract number when launching the business object.
2. skipDealGuidance: When true, skips deal guidance once the cart is launched.
3. skipApprovalCheck: When true, skips the approval check once the cart is launched.
4. skipPricingForConfigPending: When true, skips pricing if configuration is pending when the cart is launched.

Behavior

For Proposals:

• Create: If no existing record matches the criteria, a new cart is created and associated with the Proposal.
• Fetch: If a matching cart exists, the existing cart is returned and activated.

For Collaboration Requests:

• The API always fetches and activates the cart already associated with the Collaboration Request.

Each successful activation call updates the cart’s ActivationDate.

Response

Status: 200 Created on success.

Sample response (truncated):

{
  "ApprovalStatus": "None",
  "BusinessObjectId": "141a860c-1322-4fdb-aba8-d902393efde3",
  "BusinessObjectProfile": "Regular",
  "BusinessObjectType": "Proposal",
  "ContractNumbers": "",
  "EffectiveDate": "2025-10-17T08:43:02.54",
  "EffectivePriceList": {
    "Id": "1d030b2b-b720-476f-9063-f1ec3617672f",
    "Name": "CollaborationPriceList"
  },
  "IsPricePending": false,
  "IsTaskPending": false,
  "IsTransient": false,
  "IsValidationPending": false,
  "NumberOfItems": 0,
  "PriceList": {
    "Id": "1d030b2b-b720-476f-9063-f1ec3617672f",
    "Name": "CollaborationPriceList"
  },
  "PricingDate": "2025-10-17T08:43:02.54",
  "Status": "New",
  "SummaryGroupType": "Category",
  "UseType": "Main",
  "VersionNumber": 0,
  "ActivationDate": "2025-10-17T08:43:34.915",
  "ParentProposal": "141a860c-1322-4fdb-aba8-d902393efde3",
  "Currency": "USD",
  "Owner": {
    "Id": "f776e210-7f8f-b628-2053-ef392a7a57e7",
    "Name": "Test User"
  },
  "Id": "4a9be0c0-97c5-4c5e-8abb-2294c3c17f68",
  "Name": "ProposalName",
  ...
}