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

download

Getting the Application Context

Understanding the settings and configurations helps you to configure products, calculate pricing, and generate quotes quickly.

Getting Storefront

You can retrieve the storefront details.

Method: GET

Endpoint: /storefronts

For example, the following sample code enables you to get the storefront details.

Request

'GET' \ 'https://<URL_of_the_Instance>/api/revenue-admin/v1/storefronts

Getting Active Pricelist

You can retrieve the price lists.

Method: GET

Endpoint: /price-lists/active

For example, the following sample code enables you to get the active price lists.

Request

'GET' \ 'https://<URL_of_the_Instance>/api/catalog/v1/price-lists/active

Get Application Settings

You can retrieve the custom settings defined for a flow name provided in the parameter. When custom settings are defined at both flow-level and global-level, flow-level take precedence over global settings in response the API retrieves.

The API retrieves the following custom settings:

  • Config System Properties
  • Config Select Config Products Settings
  • Config Select Bundle Options Settings
  • Incentive System Properties
  • Installed Products Settings

The above-mentioned custom settings are categorized into the following:

  • Config Page Settings
  • Catalog Page Settings
  • Cart Page Settings
  • Pricing Engine
  • Configuration Engine
  • Promotions Settings
  • Asset Settings
  • Incentives Settings
  • Favorite Settings

Method: GET

Endpoint: /flows/{flowName}/settings

For example, the following sample code enables you to get custom settings defined for a flow.

Request

'GET' \ 'https://<URL_of_the_Instance>/flows/{flowName}/settings

Get User Details

You can retrieve the user details.

Method: GET

Endpoint: /api/user-management/v1/users

For example, the following sample code enables you to get the user details.

Request

'GET' \ 'https://<URL_of_the_Instance>/api/user-management/v1/users

Get Account Details

You can retrieve the account details.

Method: GET

Endpoint: /api/data/v1/objects/{objectName}

For example, the following sample code enables you to get the account details.

Request

'GET' \ 'https://<URL_of_the_Instance>/api/data/v1/objects/account

Getting the Active Cart

You can retrieve the latest active cart for a given quote/proposal. Pass the Quote ID in the parameters. If the cart does not exist for the provided quote, this API will create a new cart. In the case of an existing cart, the saved cart ID is returned.

For a newly created cart, the cart status is New and a new Cart ID is generated. The following fields will be passed from the quote header to the newly created cart - Account, Price List, Status, Business Object, Business Object Type, cart Effective Date, Expected Start Date, Expected End Date, Location, Quote/Proposal, Pricing Date, Payment Term, and Cart Name.

Method: GET

Endpoint: /quotes/{quoteId}/carts/active

For example, the following sample code enables you to get the active cart.

Request

'GET' \ 'https://<URL_of_the_Instance>/api/cart/v1/quotes/{quoteId}/carts/active