Comviva

Checkout service provides a set of APIs to define and execute a dynamic checkout flow based on the context data which can consists of shopping cart, quote, customer and product inventories, channel, market segment etc. Checkout service APIs can be divided into three groups:

Configuration Management - Provides set of APIs which Blue Marble Back Office checkout configurator UI uses to create and manage checkout configurations.
Checkout Data Management (Shopping Cart) - Provides set of APIs which commerce UI application uses to dynamically render checkout flow and capture the checkout data from the user. It is mandatory to have a validated shopping cart to use these APIs.
Checkout Data Management (Quote) - Provides set of APIs which B2B commerce application uses to dynamically render checkout flow and capture the checkout data from the user. It is mandatory to have a quote to use these APIs.

<br /><b>Key Features:</b>

- Dynamic checkout data capture flow

- Channel and Market Segment based checkout flow - Each channel can maintain completely separate checkout configuration based on different market segments.

- Dynamic UI level validation - Checkout service provides all the instructions for UI to validate data dynamically during the capture data flow

- Pre-defaulting of data - Checkout service provides field data for the UI client to show fields pre populated in the capture data flow

- Capture Data Validation - Checkout service validates capture data. For e.g. mandatory field validation, data type validation etc.

- Dynamic Endpoint - Checkout service provides endpoint details, request and response mapping so that UI client can call end points and populate step data with the data received from the end point.

- External data verification - To ensure that exterdal data is mapped to captured data as received from external system, checkout service supports signature verification of external data.

- Data Encryption - Personal sensitive information are stored in the database in encrypted format.

- Bulk Data Capture - Support to capture bulk checkout data using a excel sheet.

- Checkout Action - Pre-configured actions are executed at the end of the step. For e.g. apply eligible promotions, add shipping charges etc.

Introduction

Manage Checkout

This API generates a JSON-based checkout structure, comprising user interface (UI) elements integrated with underlying business logic. The generated structure is designed to be interpreted and executed within the UI by the client, dynamically rendering the checkout interface. The checkout engine processes a configuration defining sections, steps, and fields necessary for capturing data, executing rules embedded within UI components to generate a contextually appropriate structure for the ongoing flow. It leverages contextual data such as shopping cart details, customer information, product availability, serviceability, channel and market segmentation, among others, to apply defined rules and tailor the checkout structure accordingly.


Get Checkout Structure

This API facilitates the storage of checkout data within the checkout service. It expects the context and checkout data provided as an array of sections within the input request. The context is necessary for the service to identify eligible sections and steps for capture and validation of the checkout data. If the sections and steps passed in the capture data request do not align with the checkout structure, an error is returned. The checkout data is transmitted in the request as a list of sections, steps, and fields.

A checkout step is uniquely identified by its sectionId, stepId, offerContainerId, cartItemId, siteId, and sequence. Each unique combination of these keys corresponds to a single checkout step. The capture data process does not overwrite the entire checkout data; instead, it processes each step individually. The initial check ensures that a step with the unique key exists in the checkout structure given the current context.

The unique key is utilized by the checkout service to determine whether to create a new step or update an existing one. It verifies if a step with the same unique key already exists in the checkout data stored within the checkout service.

- If the step exists, its data is overwritten with the information received in the request. This complete replacement of step data implies that any previously captured field values must also be included in the request.

- If no such step exists in the database, a step UID is generated and stored in the database. The step UID is then returned in the response.

If the associated section also does not exist in the stored checkout data, a section UID is generated.

Both Section UID and Step UID are system-generated and are unique across sections and steps. To delete a specific section or step, the Section UID must be provided in the request.

<b>Additional mandatory fields :</b>
- context.shoppingCart.validityToken


Capture Data

The API allows to retrieve the stored checkout data based on the shopping cart identifier.


Get Checkout

This API can be used to remove a section and its associated steps from checkout data.


Remove Section

This API  can be used to remove a step from a section in checkout data.


Remove Step

This API can be used to delete checkout data for a specific shopping cart along with all sections within it.


Delete Checkout

This API can be used to trigger a checkout action.


Apply Checkout Action

This API can be used to revert a checkout action.


Revert Checkout Action

Prior to order creation, it's imperative to validate checkout data to prevent order failure caused by invalid or missing information. The Validate Checkout API must be invoked before order creation to ensure all essential data required for order processing is both captured and valid within the checkout process. Upon successful validation, the shopping cart signature is imprinted within the checkout.

When querying the shopping cart from the shopping cart service and checkout data from the checkout service using the shopping cart ID, the order management system must validate the following:

- The validity of the shopping cart signature: This ensures that product offering validation has been conducted using Validate Shopping API of Product Offering Qualification service after finalizing the shopping cart.

- The consistency of the shopping cart signature in both the shopping cart and the checkout: This confirms that checkout data has been validated using the same shopping cart.

The following validations are conducted:

- Verification of the shopping cart signature.

- Confirmation that all required sections and steps, based on the current context, have been captured.

- Validation of mandatory fields within the request, ensuring they possess valid values.

- Execution of Step Validation Rules.


Validate Checkout

Bulk Import / Export

This API generates a template in excel format for a specific section
which can be used for bulk import of checkout data for that section


Export Template

This API allows bulk update of checkout steps by importing excel file containing data in a predefined format


Import Checkout Data

Default

Checkout

<p class="slate-p" placeholder="Type / for widgets">Checkout service provides a set of APIs to define and execute a dynamic checkout flow based on context data, which can consist of shopping cart, quote, customer and product inventories, channel, market segment, etc. Checkout service APIs can be divided into three groups:</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Configuration Management:</strong> Provides a set of APIs that the bluemarble Back Office checkout configurator UI uses to create and manage checkout configurations.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Checkout Data Management (Shopping Cart):</strong> Provides a set of APIs that commerce UI applications use to dynamically render the checkout flow and capture checkout data from the user. It is mandatory to have a validated shopping cart to use these APIs.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Checkout Data Management (Quote):</strong> Provides a set of APIs that B2B commerce applications use to dynamically render the checkout flow and capture checkout data from the user. It is mandatory to have a quote to use these APIs.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Key Features:</strong></p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Dynamic checkout data capture flow</div></li><li class="slate-li"><div style="position:relative">Channel and Market Segment-based checkout flow: Each channel can maintain a completely separate checkout configuration based on different market segments.</div></li><li class="slate-li"><div style="position:relative">Dynamic UI-level validation: Checkout service provides all the instructions for the UI to validate data dynamically during the capture data flow.</div></li><li class="slate-li"><div style="position:relative">Pre-defaulting of data: Checkout service provides field data for the UI client to show fields pre-populated in the capture data flow.</div></li><li class="slate-li"><div style="position:relative">Capture Data Validation: Checkout service validates captured data, such as mandatory field validation, data type validation, etc.</div></li><li class="slate-li"><div style="position:relative">Dynamic Endpoint: Checkout service provides endpoint details, request, and response mapping so that the UI client can call endpoints and populate step data with the data received from the endpoint.</div></li><li class="slate-li"><div style="position:relative">External data verification: To ensure that external data is mapped to captured data as received from the external system, checkout service supports signature verification of external data.</div></li><li class="slate-li"><div style="position:relative">Data Encryption: Personal sensitive information is stored in the database in encrypted format.</div></li><li class="slate-li"><div style="position:relative">Bulk Data Capture: Supports capturing bulk checkout data using an Excel sheet.</div></li><li class="slate-li"><div style="position:relative">Checkout Action: Pre-configured actions are executed at the end of the step, such as applying eligible promotions, adding shipping charges, etc.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

Checkout service provides a set of APIs to define and execute a dynamic checkout flow based on context data, which can consist of shopping cart, quote, customer and product inventories, channel, market segment, etc. Checkout service APIs can be divided into three groups:

 Provides a set of APIs that the bluemarble Back Office checkout configurator UI uses to create and manage checkout configurations.

Checkout Data Management (Shopping Cart):

 Provides a set of APIs that commerce UI applications use to dynamically render the checkout flow and capture checkout data from the user. It is mandatory to have a validated shopping cart to use these APIs.

 Provides a set of APIs that B2B commerce applications use to dynamically render the checkout flow and capture checkout data from the user. It is mandatory to have a quote to use these APIs.

<p class="slate-p" placeholder="Type / for widgets">Offers a suite of APIs utilized by commerce UI applications to dynamically generate the checkout flow and gather checkout data from users.</p><p class="slate-p" placeholder="Type / for widgets"></p>

Offers a suite of APIs utilized by commerce UI applications to dynamically generate the checkout flow and gather checkout data from users.

<p class="slate-p" placeholder="Type / for widgets">Offers a collection of APIs designed to facilitate the bulk import of checkout data
</p><p class="slate-p" placeholder="Type / for widgets"></p>

Offers a collection of APIs designed to facilitate the bulk import of checkout data


Sections