Third Party Store

🚧
Documentation for the following webhooks is only applicable to the third party store.
Documentation for native store events will be coming soon. Contact your account manager if you are interested in utilizing native store data in your integration.

All webhooks related to store events are listed below.

Order Created

A notification is sent when a new order is created within the store. Event type: STORE_ORDER_CREATED

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "order.created",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": {
      "newPaymentStatus": "AWAITING_PAYMENT",
      "newFulfillmentStatus": "AWAITING_PROCESSING",
      "orderId": "1"
    }
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_ORDER_CREATED"
}

Name	Type	Description
data.siteAlias	string	A unique identifier of the site in which the storefront resides
data.eventType	string	Type of order event
data.eventId	string	A unique identifier for the event
data.storeId	string	A unique identifier for the store on which the order originated
data.eventCreated	int	A timestamp of when the event occurred
data.entityId	int	Id of the created entity. This field is deprecated and may be removed in the future. Migrate your applications to read the value from the `data.data.orderId` field. The `orderId` can be used when fetching order details via API.
data.data.newPaymentStatus	string	Payment status for the order
data.data.newFulfillmentStatus	string	Fulfillment status for the order
data.data.orderId	string	A unique identifier for the order

Order Updated

A notification is sent when an order is updated within the editor UI. For instance, when changing the fulfillment status of an order. Event type: STORE_ORDER_UPDATED

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "order.updated",
    "eventId": "49be7f69-05b0-4cd2-8e67-65af19811066",
    "storeId": 34313483,
    "eventCreated": 1597964890,
    "entityId": 1,
    "data": {
      "oldPaymentStatus": "AWAITING_PAYMENT",
      "newPaymentStatus": "PAID",
      "oldFulfillmentStatus": "AWAITING_PROCESSING",
      "newFulfillmentStatus": "DELIVERED",
      "orderId": "1"
    }
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964892412,
  "event_type": "STORE_ORDER_UPDATED"
}

Name	Type	Description
data.siteAlias	string	A unique identifier of the site in which the storefront resides
data.eventType	string	Type of order event
data.eventId	string	A unique identifier for the event
data.storeId	string	A unique identifier for the store on which the order originated
data.eventCreated	int	A timestamp of when the event occurred
data.entityId	int	Id of the updated entity. This field is deprecated and may be removed in the future. Migrate your applications to read the value from the `data.data.orderId` field. The `orderId` can be used when fetching order details via API.
data.data.newPaymentStatus	string	The updated payment status for the order
data.data.oldPaymentStatus	string	The previous payment status for the order
data.data.newFulfillmentStatus	string	The updated fulfillment status for the order
data.data.oldFulfillmentStatus	string	The previous fulfillment status for the order
data.data.orderId	string	A unique identifier for the order

Order Deleted

A notification is sent when an order is deleted. Event type: STORE_ORDER_DELETED

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "order.deleted",
    "eventId": "f821769b-8faa-4233-8e5c-a6426dcad42c",
    "storeId": 34313483,
    "eventCreated": 1597969480,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597969480789,
  "event_type": "STORE_ORDER_DELETED"
}

Name	Type	Description
data.siteAlias	string	A unique identifier of the site in which the storefront resides
data.eventType	string	Type of order event
data.eventId	string	Id of the deleted entity. This field is deprecated and may be removed in the future. Migrate your applications to read the value from the `data.data.orderId` field. The `orderId` can be used when fetching order details via API.
data.storeId	string	A unique identifier for the store on which the order originated
data.eventCreated	int	A timestamp of when the event occurred
data.entityId	int	Id of the updated entity. (order notifications will always have a value equal to orderId)

Product Created

A notification is sent when a new product is created within the store. Event type: STORE_PRODUCT_CREATED

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "product.created",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_PRODUCT_CREATED"
}


data.siteAlias	string	A unique identifier of the site in which the storefront resides
data.eventType	string	Type of product event
data.eventId	string	A unique identifier for the event
data.storeId	string	A unique identifier for the store on which the product was updated
data.eventCreated	int	A timestamp of when the event occurred
data.entityId	int	Id of the updated product

Product Updated

A notification is sent when a product is updated. Event type: STORE_PRODUCT_UPDATED

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "product.updated",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_PRODUCT_UPDATED"
}

Name	Type	Description
data.siteAlias	string	A unique identifier of the site in which the storefront resides
data.eventType	string	Type of product event
data.eventId	string	A unique identifier for the event
data.storeId	string	A unique identifier for the store on which the product was updated
data.eventCreated	int	A timestamp of when the event occurred
data.entityId	int	Id of the updated product

Product Deleted

A notification is sent when a product is deleted. Event type: STORE_PRODUCT_DELETED

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "product.deleted",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_PRODUCT_DELETED"
}


data.siteAlias	string	A unique identifier of the site in which the storefront resides
data.eventType	string	Type of product event
data.eventId	string	A unique identifier for the event
data.storeId	string	A unique identifier for the store on which the product was deleted
data.eventCreated	int	A timestamp of when the event occurred
data.entityId	int	Id of the deleted product

Category Created

A notification is sent when a product category is created. Event type: STORE_CATEGORY_CREATED

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "category.created",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_CATEGORY_CREATED"
}

Name	Type	Description
data.siteAlias	string	A unique identifier of the site in which the storefront resides
data.eventType	string	Type of product event
data.eventId	string	A unique identifier for the event
data.storeId	string	A unique identifier for the store on which category was created
data.eventCreated	int	A timestamp of when the event occurred
data.entityId	int	Id of the created category

Category Updated

A notification is sent when a product category is updated. Event type: STORE_CATEGORY_UPDATED

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "category.updated",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_CATEGORY_UPDATED"
}

Name	Type	Description
data.siteAlias	string	A unique identifier of the site in which the storefront resides
data.eventType	string	Type of product event
data.eventId	string	A unique identifier for the event
data.storeId	string	A unique identifier for the store on which category was updated
data.eventCreated	int	A timestamp of when the event occurred
data.entityId	int	Id of the updated category

Category Deleted

A notification is sent when a category is deleted. Event type: STORE_CATEGORY_DELETED

{
  "data": {
    "siteAlias": "ce73c59e",
    "eventType": "category.deleted",
    "eventId": "e6097159-ff2d-4b82-9e72-d58f2725e137",
    "storeId": 34313483,
    "eventCreated": 1597964765,
    "entityId": 1,
    "data": null
  },
  "source": null,
  "resource_data": {
    "site_name": "ce73c59e"
  },
  "event_timestamp": 1597964767312,
  "event_type": "STORE_CATEGORY_DELETED"
}

Name	Type	Description
data.siteAlias	string	A unique identifier of the site in which the storefront resides
data.eventType	string	Type of product event
data.eventId	string	A unique identifier for the event
data.storeId	string	A unique identifier for the store on which the category was deleted
data.eventCreated	int	A timestamp of when the event occurred
data.entityId	int	Id of the deleted category