Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

Orders Management

You can see the order details of your orders after logging into Digital Commerce. Orders page lists all the orders that you are working with. To view all the orders created by you, click the Menu () icon > My Account > Orders. You can also see the total order number and amount at the top of the Orders page. The total order number and amount will change depending on the filter applied.

Note:

The following API with the appropriate parameters is used to retrieve the selected account's order data. For more information, click here.

GET https://<URL_of_the_Instance>/api/order/v1/orders

Note: The translation feature supports multilingual static labels on the Orders pages. Labels automatically reflect the user's locale and configured language settings.​

From the Orders page, you can:

  • View summary chart: You can view the summary chart for all of the orders that are placed. You can also customize the chart by applying the advanced filters. Orders by Status (bar chart) and Order Amount by Status (pie chart) charts are available with the out-of-the-box template. Hovering the mouse over a status displays the quantity and amount for that status.
  • Search for an order: You can search for the order to refine the order list. Enter a keyword related to the name. It displays all orders that contain that keyword.
    Note:

    The following API with the filter parameter is used to search for the particular order. For more information, click here.

    GET https://<URL_of_the_Instance>/api/order/v1/orders

    For example: https://<URL_of_the_Instance>/api/order/v1/orders?filter=eq(SoldToAccount.Id:'<soldtoaccountID>')&sort=DESC(ModifiedDate)&filter=LIKE(Name:'Test')&Page=1&limit=10

  • Sort the order list: You can sort the order list by clicking the column names.
  • Set pagination: You can specify how many orders should be displayed on a single page. To enable pagination, go to the per page field on the top right bar and select a value from 10, 20, 30, or 40 orders per page.
  • Filter the order list: You can sort the order list by clicking the filter icon. The Advanced Filters pop-up appears. You can filter the order list based on the following fields: You can also add multiple filter criteria by clicking the Add Criteria button.
    • Bill To
    • Created Date
    • Order Amount
    • Status
Note:

The following API with the filter, page, limit, and sort parameters is used for sorting, pagination, and filtering. For more information, click here.

GET https://<URL_of_the_Instance>/api/order/v1/orders

For example: https://<URL_of_the_Instance>/api/order/v1/orders?filter=eq(Status:'Draft')&filter=eq(SoldToAccount.Id:'<soldtoaccountID>')&sort=DESC(ModifiedDate)&Page=1&limit=10



Note: You can click the Order Number or Name link to open the order details page.

As an experienced buyer, you can also use the Quick-Add () button to add multiple products to the cart and create quotes and orders quickly. For more information, see Using CTA (call-to-action) button.

Checking Out an order

You can add products to the cart and create an order by clicking the Place Order button on the cart page. The Checkout page appears.



  1. Enter or select the following details for the order on the Checkout page; however, some of the fields have default values.


    Field Name

    Description

    Billing Address Details

    Bill To

    Shows the Bill To location of the account associated with the primary contact. You can search and select another account to update this field.

    Primary Contact

    Search and select the Primary Contact associated with your account.

    Shipping address is the same as my billing address

    Check this checkbox if you want the Shipping Address to be the same as your Billing Address.

    Shipping Address Details

    Ship To

    Shows the Ship To location of the account associated with the primary contact. You can search and select another account to update this field.

  2. Click Place Order. If the implementor has enabled the CAPTCHA functionality, follow the next step.
    Note:

    By default, CAPTCHA functionality is not enabled. The implementor must set the captchaSiteKey? parameter to the template (see the Configuring Templates topic) and add the captcha property (see the image below) with the Price Summary component while configuring the template. For more information on the Price Summary component, see SDK Reference > Components section > Price Summary component.



  3. Check the captcha checkbox labeled "I'm not a robot". Sometimes, you may need to solve a captcha puzzle after clicking the checkbox.




After successfully verifying the Captcha, a request for an order will be sent out, and you will see a success confirmation popup after the order has been generated.

To see more information about the order, click RE VIEW YOUR ORDER. This opens the Order details page.

Note:

The following API is used for creating an order. For more information, click here.

POST https://<URL_of_the_Instance>/api/cart/v1/carts/{cartId}/order

The following API with the includes parameter is used for reviewing the created order (on the Review Your Order button). For more information, click here.

GET https://<URL_of_the_Instance>/api/order/v1/orders/{orderId}?includes=items

View and Modify a Placed Order

After creating an order, you can view and modify some of the fields. To view all the orders created by you, click the Menu () icon > My Account > Orders.

Click the Order Name link from the Order list page or click the REVIEW YOUR ORDER button from the Checkout confirmation popup. The order page appears where you can view and update the following details:

Order Summary

You can update the Primary Contact, Description, Ship To Account, and Bill To Account fields.

Note:

The following API is used for updating the value. For more information, click here.

PATCH https://<URL_of_the_Instance>/api/order/v1/orders/{orderId}

Line Items

  1. Click the Edit button to edit the line items in a created order to add, clone, modify, and delete items.
  2. After the changes are done, click Confirm Changes.
Note:

You can also open the Product Details and Configuration by clicking the product name and wrench icon respectively.

Attachments

If you want to upload some required document(s) in a particular order, you can upload it from the Attachments section.

Note:

Prerequisites

The implementer must create an IsPrivate custom field with a Boolean data type and default value as false on the DocumentMetadata object. Use the Admin User Interface or the following API and sample payload: POST https://<URL_of_the_Instance>/api​/schema​/v1​/objects​/{objectName}​/fields

Sample Payload
{
    "FieldName": "IsPrivate",
    "DisplayName": "IsPrivate",     
    "DataType": "Boolean",
    "DefaultValue": "false"
}
Note:

Guest users will not be able to upload or delete any documents from the Attachments section. They can only view documents associated with the order.

  1. From the order details page, click the Attachments tab.
  2. Drag and drop the file or click the browse link and select the file(s).

    Refer to the following image for the supported file type.

  3. Check the Make visibility private checkbox to make the attachment only visible to you on the order details page.
  4. Click Clear if you want to remove the selected file.
  5. Click Upload to upload the selected file to the order.

You can File Name, Size, Type, Created By, and Created Date information under the Attachments section. The file types listed in the following image are supported. You can upload up to 28 MB of document(s).



Note:

The following API is used for uploading the document. For more information, click here.

POST https://<URL_of_the_Instance>/api/document-management/v1/documents/upload

For example: https://<URL_of_the_Instance>/api/document-management/v1/documents/upload?objectType=order&objectId={objectID}

Note:

You can only modify the line items when the order is in the Draft stage.

Adding Purchase Order Number (PO Number)

The Purchase Order (PO) Number feature allows business and guest users to include internal purchase references while placing an order. You can enter a PO number and upload supporting document such as Word, PDF, or image files during checkout. This helps organizations track orders against their internal procurement systems.

The Order Summary on the Order Details page displays the entered PO number, payment status, and any attached document for reference. When you upload a document through the PO modal, the file is automatically added to the order and appear in the Attachments section on the Order Details page.

Note: Administrators must add the PO Number and Payment Status fields to the OrderOverrideAllowedParams settings for them to appear in the Order Summary section.
  1. Go to the desired product and click Add to Cart.
  2. Click the cart icon beside account name.
  3. Click View Cart.
  4. Click Place Order from the Cart Summary. The Checkout screen appears.
  5. Enter and select the primary contact from the list.
    Note: The Primary Contact field is mandatory. The PO Number button becomes enabled only after you enter and select a primary contact.
  6. Click PO Number. The Add PO Number screen appears.
  7. Enter the desired PO Number and attach PO Document (optional).
    Note: The system allows you to attach only one document..
  8. Click Submit.
PO Number is added and appears in the Order Summary.

Using Pay Later

Pay Later feature allows registered users to place the order while choosing to pay at a later time, providing a flexible checkout experience.

When selected, the Payment Status field appears in the Order Summary section of the Order Details page for reference and tracking.
Important:

The Pay Later option is unavailable for guest users.

Note: Administrators must add the Payment Status field to the OrderOverrideAllowedParams settings for it to appear in the Order Summary section.
  1. Go to the desired product, click Add to Cart, then click the cart icon beside the account name and select View Cart.
  2. Click Place Order from the cart summary page.
  3. Select the Primary Contact from the list.
    Note: The Primary Contact field is mandatory. The Pay Later button becomes enabled only after you enter and select a primary contact.
  4. Click Pay Later.
Order is created and the Payment Status is set to Pending and appears in the Order Summary.

Using Pay Now

You can use "Pay Now" to place an order and complete payment immediately during checkout. The order is created after successful payment, and the payment status is shown in the Order Details page for tracking. This functionality applies to both logged-in and guest users.

Prerequisites

Administrators must enable:
  • Stripe Payment Integration to activate payment functionality. A valid Stripe account and a configured integration user in Conga are required.The Conga Secret Management API is required to securely store Stripe API keys and webhook secrets. For more information, see Configuring Stripe Payment Integration

  • EnablePaymentIntegration using the Get a configuration API to use the payment integration functionality. API Endpoint:GET /api/config-management/v1/configurations/cpq/featuresettings

  • As a temporary workaround, the administrator must grant View All, Create, Read, and Update permissions for the PaymentStatus object to the User. This access resolves user-context–related issues. If the PaymentStatus permission is not granted, refer to Assigning Object Permissions topic for to grant the required access.

  1. Go to the desired product, click Add to Cart, then click the cart icon beside the account name and select View Cart.
  2. Click Place Order from the cart summary page.
  3. Select the Primary Contact from the list.
    Note: The Primary Contact field is mandatory. The Pay Now button becomes enabled only after you enter and select a primary contact.
  4. Click Pay Now.
Order is created and the Payment Status is set to Processed and appears in the Order Summary.

Calculating Tax

You can calculate and review applicable sales tax during checkout before placing an order. The system calculates tax based on the based on shipping address, product details, and tax categories and updates tax details when relevant cart information changes.

Prerequisites:

Administrators must enable:
  • Adding TaxBreakup object for the guest user. For more information, see Guest User Tax Integration.

  • Configuring the Avalara tax integration for the tenant with valid API credentials and set up product tax categories and required address fields to support Avalara-based tax calculation. For more information, see Configuring Avalara Tax Integration Connectors.

  • Enabling the Taxable? toggle on the product's Price List Item (PLI) in Revenue Admin UI and EnableTaxIntegration using the Get a configuration API to use the tax integration functionality. For more information, see Configuring Tax Billing and Invoicing Revenue Admin UI topic from CPQ for Administrators.

  • Granting View All, Create, Read, and Update permissions for the TaxBreakup object to the User. This access resolves user-context–related issues. If the TaxBreakup permission is not granted, refer to Assigning Object Permissions topic for to grant the required access.

  1. Go to the desired product and click Add to Cart.
  2. Click the Cart icon next to the account name and select View Cart.
  3. Click Place Order from the cart summary page.
  4. Select the Primary Contact from the list.
  5. Click Calculate Tax to calculate tax based on the shipping address, product details, and tax categories.

The system calculates sales tax based on the shipping address and product details. The cart and order summary display the tax amount, and include tax in the total price.

Use Case: Payment Processing with Stripe in Digital Commerce

Business Context

In many B2B and B2C sales flows, payment collection happens outside the digital storefront, requiring manual follow-ups and external systems. This results in delays, errors, and a disconnected buying experience. Integrating payments directly into Digital Commerce helps streamline checkout and accelerate the quote-to-cash cycle.

Objective

Enabling buyers to complete payments securely and seamlessly within Digital Commerce using an integrated payment gateway, starting with Stripe, while supporting future payment gateways.

Roles

  • Buyer: Completes payment during checkout.

  • Sales Representative: Creates and shares quotes for checkout.

  • Digital Commerce Platform: Manages checkout and payment flow.

  • Payment Gateway (Stripe): Processes secure payment transactions.

Prerequisites

A quote or cart is ready for checkout. Stripe payment integration is configured in Digital Commerce. The buyer is authorized for the selected payment method.

Scenario

A buyer receives a finalized quote shared by a Sales Representative and opens it in the Digital Commerce storefront. After reviewing the products, pricing, and terms, the buyer is ready to place the order and chooses to complete payment during checkout using one of the available payment options.

Task

Buyers can complete payments directly within the Conga Digital Commerce storefront during checkout. The integrated payment flow supports secure online payments through Stripe, along with flexible options such as PO Number, Pay Later, and Pay Now, enabling a streamlined and efficient checkout experience.
Note: Pay Later option is available only for logged-in user.

Refer Adding Purchase Order Number (PO Number), Using Pay Later, Using Pay Now topics.

Result

The payment is completed securely within the storefront. No sensitive payment details are stored in Digital Commerce. The order progresses without manual payment follow-up.

Best Practices

Offer multiple payment options to support different buyer purchasing models. Use embedded payment flows to reduce checkout drop-offs.