This event is triggered when an order exception is added to an order. The event will have a topic of order.exception.created.

​
createdAt

The timestamp when the order exception was created in ISO 8601 format.

​
orderId

The unique identifier for the order.

​
poNumber

Purchase order number associated with this order. Defined by the person that placed the order. Is null when not available.

​
sku

The SKU associated with the exception, if applicable. Note that this may be a distributor SKU that doesn’t exist in the SIBI system. Will be null when not available or not applicable.

​
message

A description of the exception that occurred.

​
category

The category of the exception. Will always be null at the moment.

We previously supported a category of installation-failed. However, we did not feel that it accurately identified when an installation has actually failed. We have temporarily adjusted the event to always have a category of null. Once we feel we can accurately identify when an installation has failed, we will re-introduce the installation-failed category.

​
Example payload

{
  "topic": "order.exception.created",
  "data": {
    "createdAt": "2025-03-18T15:30:45.123Z",
    "orderId": "ORD-12345XYZ",
    "poNumber": "customer-po-number",
    "sku": "1234567890",
    "message": "This is an exception message",
    "category": "installation-failed"
  }
}