Abandoned Checkout

An abandoned checkout occurs when a customer adds items to their cart, proceeds to the checkout process, but fails to complete the purchase. To assist the merchant in understanding the root cause of drop-offs and take appropriate action, we will send comprehensive details to the merchant’s API. This will allow them to analyze and handle the data as per their system’s requirements.

Request Metadata

Field	Description
url	Your server endpoint for handling the abandoned checkout data.
method	POST

Request Headers

Field	Description
Content-Type	application/json
X-Api-Key	Your API key

Request Payload

Step 1: Payload to be passed to merchant’s api

Parameter	Type	Mandatory	Description
cartDetails	CartDetails	Yes	Contain details about the item added to cart
customer	Customer Details	Yes	Contains the customer’s information
comments	Value	No	Any additional data to be passed
checkoutUrl	string	Yes	The checkout URL at the time the checkout was abandoned

CartDetails

Parameter	Type	Mandatory	Description
initialPrice	int	Yes	The initial price of the cart.
totalPrice	int	Yes	The total price of the cart.
totalDiscount	int	Yes	The total discount applied on the cart.
weight	int	No	The total weight of the cart.
itemCount	int	Yes	The total number of items in the cart.
items	array[AbandonedCartItem]	Yes	The list of items in the cart.
tax	double	Yes	Tax applied (in paisa)
shippingCharge	double	No	Shipping charges (in paisa)
surcharge	double	No	Surcharge amount (in paisa)
amountPaid	double	No	Amount paid if the user completed payment

AbandonedCartItem

Parameter	Type	Mandatory	Description
title	string	Yes	Title of the item
quantity	int	Yes	The quantity of the corresponding item
finalPrice	int	Yes	The final price of the item (in paisa)

Customer Details

Parameter	Type	Mandatory	Description
emailAddress	string	Yes	The customer’s email address
phoneNumber	string	Yes	The customer’s phone number
shippingAddress	array[Address]	No	The shipping address details of the user
billingAddress	array[Address]	No	The billing address details of the user
gst	object(GST)	No	GST details if applicable

GST

Parameter	Type	Mandatory	Description
gstIn	string	Yes	GST Number of the customer
companyName	string	Yes	Company name for GST Details
isActive	boolean	Yes	Is the GST Detail active or not
isVerified	boolean	No	Is the GST Detail verified or not

Address

Parameter	Type	Mandatory	Description
postalCode	string	Yes	postal code of the address
country	string	Yes	Country of the address
state	array[Address]	Yes	State of the address
district	array[Address]	Yes	District of the address
city	double	Yes	City of the address
_type	double	Yes	Defines the address in situated as home or office or any other
line1	string	Yes	Line 1 of address
line2	string	No	Line 2 of address
name	string	Yes	Name of the user address belongs to
nickname	string	Yes	Nickname of the user address belongs to
phoneNumber	array[Address]	Yes	Phone no of correspondence
landmark	array[Address]	Yes	Landmark of the address
countryPhoneCode	double	Yes	country code for phone no present in address
isDefault	double	Yes	To identify whether it is default address or not
sourceIdentifier	string	No	Identifier on source
source	string	No	From which platform user has come
validate	boolean	No	Address to be validated or not
addressValidationId	string	No	If validation is on then address validation id

Step 2: Identification when customer left the checkout process

Case	Interpretation
In Customer only phone number present	The user left before reaching the address page
In Customer phone number and email address present	The user left before reaching the address page
All details present, except amountPaid	The user left after reaching the payment page
All details present	The user completed the transaction successfully