Product DocumentationConga Community
Guides

Getting the Application Context

Suggest Edits

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

Getting a Storefront

You can retrieve storefront details using the "Get storefronts" API.

  • Method: GET
  • Endpoint: /storefronts

For example, the following request gets you the storefront details.

'GET' 'https:///api/revenue-admin/v1/storefronts

Getting an Active Pricelist

You can retrieve price lists using the "Get active pricelist" API.

  • Method: GET
  • Endpoint: /price-lists/active

For example, the following request gets you the active price lists.

'GET' 'https:///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 the global level, the flow-level settings take precedence over global settings in the API response.

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 aforementioned custom settings are categorized as:

  • 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 request defines custom settings for a flow.

'GET' 'https:///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:///api/user-management/v1/users Get

Account Details

You can retrieve account details using the "Get account details" API .

Method: GET

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

For example, the following request gets account details.

'GET' 'https:///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 a cart does not exist for the provided quote, this API creates a new one. If a cart already exists, 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 are 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 request gets the active cart.

'GET' 'https:///api/cart/v1/quotes/{quoteId}/carts/active

Updated 11 months ago