Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cart - V1 Business Object API

5 actions 5 updates phrasing extends openapi/conga-business-object-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/cart/v1/business-objects/{businessObjectId}/carts/activate'].post
$.paths['/api/cart/v1/business-objects/{businessObjectId}/carts/active'].get
$.paths['/api/cart/v1/business-objects/{businessObjectId}/carts/reactivate'].post
$.paths['/api/cart/v1/business-objects/{businessObjectId}/reactivate'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cart - V1 Business Object API
  version: 1.0.0
extends: openapi/conga-business-object-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/api/cart/v1/business-objects/{businessObjectId}/carts/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch the cart for a quote or business object
      effect: write
      questions:
      - How do I open a cart for a quote in Conga CPQ?
      - Can I launch a cart and skip deal guidance or the approval check?
      - Which contracts can I pass in when activating a cart for a business object?
      instructions:
      - text: Launch the cart for business object {businessObjectId} of type {type}.
        slots:
          businessObjectId: path.businessObjectId
          type: query.type
      - text: 'Activate a cart for {type} {businessObjectId} and skip deal guidance: {skipDealGuidance}.'
        slots:
          type: query.type
          businessObjectId: path.businessObjectId
          skipDealGuidance: requestBody.skipDealGuidance
      - text: Open the cart for {businessObjectId} ({type}) tied to contract numbers {contractNumbers}.
        slots:
          businessObjectId: path.businessObjectId
          type: query.type
          contractNumbers: requestBody.contractNumbers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/business-objects/{businessObjectId}/carts/active'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the read-only active cart for a business object
      effect: read
      questions:
      - What is the current active cart on a quote, without opening it for edits?
      - Can I view a business object's cart in read-only mode?
      instructions:
      - text: Show the read-only active cart for business object {businessObjectId} of type {type}.
        slots:
          businessObjectId: path.businessObjectId
          type: query.type
      - text: Look up which cart is currently active on {type} {businessObjectId}.
        slots:
          type: query.type
          businessObjectId: path.businessObjectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/business-objects/{businessObjectId}/carts/reactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Reactivate a cart and sync quote fields into it
      effect: write
      questions:
      - How do I push updated quote fields like bill-to or ship-to account back into the cart?
      - Which quote fields get synced to the cart when it is reactivated?
      - Does reactivating a cart re-run pricing and config rules on the line items?
      instructions:
      - text: Reactivate the cart for {type} {businessObjectId}, syncing quote fields and repricing line items.
        slots:
          type: query.type
          businessObjectId: path.businessObjectId
      - text: Resync account, location and date fields from quote {businessObjectId} ({type}) into its cart.
        slots:
          businessObjectId: path.businessObjectId
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/business-objects/{businessObjectId}/reactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Reactivate a cart via the legacy endpoint
      effect: write
      questions:
      - Is there an older reactivate endpoint that re-evaluates pricing without syncing any quote fields?
      - What does the deprecated business object reactivate call still do?
      instructions:
      - text: Use the legacy reactivate call on {type} {businessObjectId} to re-evaluate rules and pricing only.
        slots:
          type: query.type
          businessObjectId: path.businessObjectId
      - text: Run the deprecated business-object reactivate for {businessObjectId} of type {type}.
        slots:
          businessObjectId: path.businessObjectId
          type: query.type
      method: generated
      generated: '2026-10-01'