Checkout API Features

The Checkout API offers additional features.

Sales Assisted Checkout Tracking

When checkouts are manually created by the sales assistants for the shoppers, ESW's Sales Assisted Checkout Tracking feature identifies which sales assistant assisted the shoppers. As a result, you have the ability to track such sales and the sales assistants who drove those sales.

There are some mandatory and optional parameters you need to send to ESW to leverage this capability.

Mandatory Parameters

Sales Assistant ID

When a sale has been assisted by a sales assistant, you will need to flag this to ESW by sending metadata with the following parameters:

  • SA_ID: It is an ID associated with a sales assistant.
  • Order_Channel: This allows you to track the channel where the assistance occurred.
Meta Data
{
  "name": "SA_ID",
  "value": "<string value>"
},
{
  "name": "Order_Channel",
  "value": "<string value>"
}

Optional Parameters

User Registration

You can also let us know if the shopper has not registered with you and if you expect them to be registered with you before proceeding to the checkout. This registration may have been skipped by the sales representative before the checkout loads.


Info

If you want to have the user registered with you, then you must let ESW know that you expect a registration.


To support this enablement, you are expected to send the metadata with:

  • Registration_Needed: A boolean value flag to show if the registration is required or not.
  • Registration_URL: The redirect URL that will redirect the shopper to a retailer-owned page that displays a registration form.

Info

The metadata parameters must be added to the shopperCheckoutExperience object in the preorder.

Meta Data
{
  "name": "Registration_Needed",
  "value": "<string value (true/false)>"
},
{
  "name": "Registration_URL",
  "value": "<string value (URL)>"
}

Extended Session Expiry

You can also extend the session length for the sales assistant tracked orders. It is possible to set the session timeout period in the preorder request anywhere between 5 to 90 minutes. The URLs that are manually sent to the shopper will have an extended session period.


To cater for the same, the pre-order must contain the SA_ID and Order_Channel with a specified session expiry time parameter sessionTimeout.


Info

If no specific value for sessionTimeout is provided, the default session timeout is set to 15 minutes.

All other sessions will remain valid for the default session time.

This is applicable for Checkout v2 and v3.

Checkout UI Metadata

Overview
The Checkout API allows for a seamless checkout experience for shoppers.
Upload a full catalog
Uploading a full catalog