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 or updated.

Data Schema

Example

Abandoned Cart Webhook Event Model

event

enum<string>

optional

Event Name

Allowed values:

abandoned.cartabandoned.cart.update

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

Timestamp of webhook creation

Example:

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

data

object (AbandonedCartWebhook)

optional

number

required

A unique identifier associated with a shopping cart.

total

object

required

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

subtotal

object

required

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

total_discount

object

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

object

required

updated_at

object

required

customer

object

required

coupon

object

required

items

array [object {3}]

required

Abandoned Cart Status Changed Webhook Event Model

This event is triggered when an abandoned cart's status has been changed.

Data Schema

Example

Abandoned Cart Status Changed Webhook Event Model

event

enum<string>

optional

Event Name

Allowed value:

abandoned.cart.status.changed

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

optional

number

optional

A unique identifier associated with a shopping cart.

status

enum<string>

optional

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

Allowed values:

activepurchased

Abandoned Cart Purchased Webhook Event Model

This event is triggered when an abandoned cart has been purchased, where the status is set to purchased.

Data Schema

Example

Abandoned Cart Purchased Webhook Event Model

event

enum<string>

optional

Event Name

Allowed value:

abandoned.cart.purchased

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

optional

number

optional

A unique identifier associated with a shopping cart.

total

number

optional

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

subtotal

number

optional

The sub-total cost of items in a cart.

total_discount

number

optional

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

status

enum<string>

optional

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

Allowed values:

activepurchased

currency

string

optional

Abandoned Cart Currency value

Example:

SAR

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#

Abandoned Cart Status Changed Webhook Event Model#

Abandoned Cart Purchased Webhook Event Model#

Coupon Applied Webhook Event Model#

Abandoned Cart Webhook Events Model

Abandoned Cart Status Changed Webhook Event Model

Abandoned Cart Purchased Webhook Event Model

Coupon Applied Webhook Event Model