Store

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

Store Webhook Events Model

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

Data Schema

Example

Store Branch Webhook Event Model

event

enum<string>

optional

Event title or label to represent the event.

Allowed values:

store.branch.createdstore.branch.updatedstore.branch.setDefaultstore.branch.activatedstore.branch.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

created_at

string

optional

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

data

object

optional

number

optional

A unique identifier associated with a specific store.

name

string

optional

A title or label that represnts the store.

status

string

optional

Store status to indicate the current status of the store.

location

object

optional

contacts

object

optional

preparation_time

string

optional

Preparation Time

is_open

boolean

optional

The option to indidcate if the store is open.

closest_time

object

optional

working_hours

array [object {2}]

optional

Working Hours

is_cod_available

boolean

optional

The option to inidicate the availability of Cash On Delivery payamnet method.

Default:

true

is_default

boolean

optional

The option to indicate the store as the default store.

Default:

false

type

object

optional

cod_cost

string

optional

Cash On Delivery Cost

country

object

optional

city

object

optional

Store Tax Webhook Events Model

This event is triggered when a store tax has been created.

Data Schema

Example

Store Tax Webhook Event Model

event

enum<string>

optional

A label or title used to identify a specific event

Allowed value:

storetax.created

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

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

data

object

optional

number

optional

A unique identifier assigned to a specific store.

tax

string

optional

Tax amount value.

status

string

optional

The condition or classification of an entity or transaction with respect to taxation.

country

string

optional

The specific country or jurisdiction where taxes are levied, collected, and regulated in relation to a particular entity or transaction

Store Webhook Events Model#

Store Tax Webhook Events Model#

Store Webhook Events Model

Store Tax Webhook Events Model