Shippings

Below are the webhook store events paired with their respective data schema related to the Shipping Companies & Shipping Zones webhook events:

Shipping Zone Webhook Events Model

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

Data Schema

Example

Shipping Zone Webhook Model

event

enum<string>

optional

Event Name

Allowed values:

shipping.zone.createdshipping.zone.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

created_at

string

optional

Timestamp of webhook creation

data

object

optional

number

optional

Shipping Zone ID

zone_code

string

optional

Shipping Zone Code

company

object

optional

country

object

optional

city

object

optional

cities_excluded

array [object {3}]

optional

Cities Excluded from Shipping

fees

object

optional

cash_on_delivery

object

optional

duration

string

optional

Shipping Duration in Days

Shipping Company Webhook Events Model

The following includes 3 shipping company webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab

Data Schema

Example

Shipping Company Webhook Model

event

enum<string>

optional

Event Name

Allowed values:

shipping.company.createdshipping.company.updatedshipping.company.deleted

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:

Thu Apr 07 2022 13:48:22 GMT+0300

data

object

optional

number

optional

Shipping Company ID

Example:

488260393

name

string

optional

Shipping Company Name

Example:

شركة سريع

status

boolean

optional

Shipping Company Status

Default:

false

Shipping Zone Webhook Events Model#

Shipping Company Webhook Events Model#

Shipping Zone Webhook Events Model

Shipping Company Webhook Events Model