Cart

Below are the webhook store events paired with their respective data schema related to the Store webhook events:

Abandoned Cart Webhook Events Model

This event is triggered when an abandoned cart has been created.

Data Schema

Example

Abandoned Cart Webhook Event Model

event

string

optional

Event Name

Example:

abandoned.cart

merchant

number

optional

Merchant ID who installed the application on their store. Get details on the Merchant via the ID using the endpoint here

Example:

1305146709

created_at

string

optional

Event Created at Timestamp

Example:

Tue Jan 25 2022 13:00:27 GMT+0300

data

object (AbandonedCartWebhook)

optional

number

required

A unique identifier associated with a shopping cart.

status

enum<string>

required

Abandoned Cart Status, which can be one of the allowed enum values

Allowed values:

expiredpendinginvalidforbiddenpurchasedactive

currency

string

required

Abandoned Cart Currency value

total

string

required

The sum of the prices of all the items in a cart.

subtotal

string

required

The sub-total cost of items in a shopping cart.

total_discount

string

required

Cumulative reduction in price applied to the items in a cart.

checkout_url

string

required

A web link or address that directs a user to a specific page or interface where they can proceed with the final steps of a purchase or transaction.

age_in_minutes

number

required

The age of cart, aka the time difference between cart's created_at and time now in minutes.

created_at

string <date-time>

required

Timestamp to indicate the created date of the cart.

updated_at

string <date-time>

required

Timestamp to indicate the updated date of the cart.

items_count

number

required

Number of items in the abandoned cart

customer

object

required

coupon

object

required

items

array [object {3}]

required

cart_history

array [object {4}]

required

Coupon Applied Webhook Event Model

This event is triggered when a coupon has been applied.

Data Schema

Example

Coupon Applied Webhook Event Model

event

string

optional

A label or title used to identify a specific event.

Example:

coupon.applied

merchant

number

optional

Merchant ID who installed the application on their store. Get details on the Merchant via the ID using the endpoint here

Example:

1029864349

created_at

string

optional

The date and time when a particular event was created or initiated.

Example:

Wed Jul 7 2021 14:50:48 GMT+0300

data

object

optional

cart

object

optional

Abandoned Cart Webhook Events Model#

Coupon Applied Webhook Event Model#

Abandoned Cart Webhook Events Model

Coupon Applied Webhook Event Model