Notifications
Introduction
A notification is received for any order event of API. Each notification contains detailed information about the event. Webhooks can be configured to receive these notifications. We follow the cloud events standard for notifications.
| Property Name | Description | Example |
|---|---|---|
| cloudEventsVersion | The version of the CloudEvents specification. | "cloudEventsVersion": "0.1" |
| eventType | This specifies the event name | "eventType": "com.example.orderItemShipped" |
| eventTypeVersion | The version of the event type. | "eventTypeVersion": "1.0" |
| source | The source of the event. | "source": "api/v1/order/STA-OrderNumber" |
| eventID | A unique id for each event. | "eventID": "9f7b1707-e35f-46eb-a4d8-6ca290781e54" |
| eventTime | The time at which the event occurred. | "eventTime": "2024-03-20T13:56:25.670Z" |
| contentType | The content type of the event data. | "contentType": "application/json" |
| data | The event data, it usually contains order data with the targeted line item |
List of notifications
The following notifications are supported by for order events:
| Event Name | Description | More Details |
|---|---|---|
| OrderConfirmed | Notification when an order is confirmed. | View details |
| OrderCancelled | Notification when an order is cancelled. | View details |
| OrderRejected | Notification when an order is rejected. | View details |
| OrderItemArtworkMissing | Notification when artwork for an order item is missing. | View details |
| OrderItemArtworkUploadFailed | Notification when artwork upload for an order item fails. | View details |
| OrderItemDeliveryDateUpdated | Notification when the delivery date for an order item is updated. | View details |
| OrderItemDocReviewRejected | Notification when document review for an order item is rejected. | View details |
| OrderItemFulfillmentError | Notification when there is an error in fulfilling an order item. | View details |
| OrderItemFulfillmentRejected | Notification when fulfillment of an order item is rejected. | View details |
| OrderItemPrintingInProgress | Notification when printing of an order item is in progress. | View details |
| OrderItemShipmentDelayed | Notification when shipment of an order item is delayed. | View details |
| OrderItemShipped | Notification when an order item is shipped. | View details |
| OrderItemReprintRequested | Notification when a reprint is requested for an order item. | View details |
| OrderItemReprintAccepted | Notification when a reprint is accepted for an order item. | View details |
| OrderItemCancelled | Notification when an order's item is cancelled. | View details |