Special Offer

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

Special Offer Webhook Events Model

The following includes 2 special offer webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab

Data Schema

Example

Special Offer Webhook Event Model

event

enum<string>

optional

a label or title used to identify a specific event.

Allowed values:

specialoffer.createdspecialoffer.updated

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:

814202285

created_at

string

optional

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

Example:

Tue Aug 03 2021 09:30:16 GMT+0300

data

object

optional

number

optional

A unique identifier assigned to the special od.

Example:

525144736

name

string

optional

A label or title used to identify the special offer.

Example:

fixed amount specialoffer

message

string

optional

A promotional message or notification that communicates a specific deal, discount, promotion, or incentive to customers.

Example:

اشتري قطعة واحصل على خصم 10 ر.س من المنتجات التالية

expiry_date

string

optional

The date on which a promotional or discount offer is set to expire or become no longer valid.

Example:

2021-08-09

offer_type

enum<string>

optional

The category or classification of a specific promotion, discount, or incentive within a marketing or sales context.

Allowed values:

fixed_amountbuy_x_get_ypercentage

Example:

fixed_amount

status

string

optional

The current condition or state of a promotional offer.

Example:

active

applied_to

string

optional

The way a promotional or discount offer is implemented to or used.

Example:

order

buy

object

optional

get

object

optional

Special Offer Webhook Events Model#

Special Offer Webhook Events Model