Company

Events categorised under company level will be triggered when any action performed on company. e.g. If new brand is created.

Article

This event will be generated where there is any action done on article

Events

company/article/create/v1

# this event is triggered when article is created

company/article/delete/v1

# this event is triggered when article is deleted

company/article/update/v1

# this event is triggered when article is updated

company/article/create/v1

this event is triggered when article is created

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/article/delete/v1

this event is triggered when article is deleted

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/article/update/v1

this event is triggered when article is updated

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Brand

This event will be generated where there is any action done on brand

Events

company/brand/create/v1

# this event is triggered when brand is created

company/brand/update/v1

# this event is triggered when brand is updated

company/brand/create/v1

this event is triggered when brand is created

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/brand/update/v1

this event is triggered when brand is updated

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Company

This event will be generated where there is any action done on company

Events

company/company/create/v1

# this event is triggered when company is created

company/company/update/v1

# this event is triggered when company is updated

company/company/create/v1

this event is triggered when company is created

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/company/update/v1

this event is triggered when company is updated

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Courier partner

This event will be generated where there is any action done on courier-partner

Events

company/courier-partner/account-status/v1

# this event is triggered when courier-partner is account-statused

company/courier-partner/account-status/v1

this event is triggered when courier-partner is account-statused

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Integration

This event will be generated where there is any action done on integration

Events

company/integration/update/v1

# this event is triggered when integration is updated

company/integration/update/v1

this event is triggered when integration is updated

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Location

This event will be generated where there is any action done on location

Events

company/location/create/v1

# this event is triggered when location is created

company/location/update/v1

# this event is triggered when location is updated

company/location/create/v1

this event is triggered when location is created

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/location/update/v1

this event is triggered when location is updated

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Logistics configuration

This event will be generated where there is any logistics as per actual change in billing plan

Events

company/logistics-configuration/update/v1

# this event is triggered when logistics-configuration is updated

company/logistics-configuration/update/v1

this event is triggered when logistics-configuration is updated

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Product size

This event will be generated where there is any action done on product-size

Events

company/product-size/create/v1

# this event is triggered when product-size is created

company/product-size/update/v1

# this event is triggered when product-size is updated

company/product-size/create/v2

# this event is triggered when product-size is created

company/product-size/delete/v2

# this event is triggered when product-size is deleted

company/product-size/update/v2

# this event is triggered when product-size is updated

company/product-size/create/v1

this event is triggered when product-size is created

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/product-size/update/v1

this event is triggered when product-size is updated

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/product-size/create/v2

this event is triggered when product-size is created

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/product-size/delete/v2

this event is triggered when product-size is deleted

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/product-size/update/v2

this event is triggered when product-size is updated

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Product

This event will be generated where there is any action done on product

Events

company/product/delete/v1

# this event is triggered when product is deleted

company/product/create/v2

# this event is triggered when product is created

company/product/delete/v2

# this event is triggered when product is deleted

company/product/update/v2

# this event is triggered when product is updated

company/product/create/v3

# this event is triggered when product is created

company/product/delete/v3

# this event is triggered when product is deleted

company/product/update/v3

# this event is triggered when product is updated

company/product/delete/v1

this event is triggered when product is deleted

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/product/create/v2

this event is triggered when product is created

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/product/delete/v2

this event is triggered when product is deleted

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/product/update/v2

this event is triggered when product is updated

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/product/create/v3

this event is triggered when product is created

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/product/delete/v3

this event is triggered when product is deleted

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/product/update/v3

this event is triggered when product is updated

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Support ticket

This event will be generated where there is any action done on support-ticket

Events

company/support-ticket/create/v1

# this event is triggered when support-ticket is created

company/support-ticket/update/v1

# this event is triggered when support-ticket is updated

company/support-ticket/create/v1

this event is triggered when support-ticket is created

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/support-ticket/update/v1

this event is triggered when support-ticket is updated

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

Zone

This event will be generated where there is any action done on zone

Events

company/zone/create/v1

# this event is triggered when zone is created

company/zone/update/v1

# this event is triggered when zone is updated

company/zone/create/v1

this event is triggered when zone is created

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example

company/zone/update/v1

this event is triggered when zone is updated

Payload

company_id

integer

company ID for which this event is triggered

contains

array of string

This array will have all the keys present at root level of 'payload' object

event

object

Properties

payload

object

Properties

Payload Schema JSON

Payload Example