​

Order Data

Attributes on the order payload body for events with the topics order.created and order.updated.

• order.created is triggered when an order is created.
• order.updated is triggered when an order is updated, including when order exceptions are added.

​

id

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.

​

viewUrl

A URL to view the order in the Sibi Web UI.

​

createdAt

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

​

propertyAddress

The property address associated with this order. Broken down into separate string fields line1, line2, city, stateOrProvince, postalCode. If the address doesn’t have a line2, it will return a value of null.

​

fulfillmentMethod

How the order will be fulfilled. Will be one of PICKUP or DELIVERY.

​

requestedFulfillmentDate

The date when the order is requested to be fulfilled in ISO 8601 format.

​

estimatedFulfillmentDate

The estimated fulfillment date for the order in ISO 8601 format. Will return the fulfillment date from the distributor if available, falls back to the requestedFulfillmentDate.

​

status

The current status of the order.

​

taxCents

The tax amount for this order, represented in cents.

​

totalCents

The total cost of the order, represented in cents.

​

lineItems

A list of items included in the invoice.

​

lineItems.sku

The stock-keeping unit (SKU) identifier for the item.

​

lineItems.name

The human readable name of the product.

​

lineItems.quantity

The number of units purchased for this item.

​

lineItems.unitOfMeasure

The unit of measurement for this item (e.g., EA for each).

​

lineItems.unitPriceCents

The price per unit of the item, represented in cents.

​

lineItems.totalPriceCents

The total price for the line item, accounting for the quantity and unit price, represented in cents.

​

exceptions

A list of exceptions that occurred during order processing. May be empty if no exceptions occurred.

​

exceptions.createdAt

The timestamp when the exception occurred in ISO 8601 format.

​

exceptions.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.

​

exceptions.message

A description of the exception that occurred.

​

exceptions.category

The category of the exception. The only category we currently support is installation-failed. This is used to determine if the order exception is a result of a failed installation. Otherwise the category will be null.

​

deliveryContact

The delivery agent assigned to the order. Will be null when not available.

​

deliveryContact.name

The name of the delivery agent.

​

deliveryContact.phone

The phone number of the delivery agent. Will be null when not available.

​

deliveryContact.email

The email address of the delivery agent. Will be null when not available.

​

images

An array of installation images associated with the order.

​

images.url

The URL of the image.

​

Example payload

{  
  "topic": "order.created",
  "data": {
    "id": "ORD-12345XYZ",
    "poNumber": "123456",
    "viewUrl": "https://web.sibipro.com/orders/ORD-12345XYZ",
    "createdAt": "2025-03-18T15:30:45.123Z",
    "propertyAddress": {
      "line1": "12345 E Main St",
      "line2": "Unit 3",
      "city": "Anytown",
      "stateOrProvince": "AZ",
      "postalCode": "85233"
    },
    "fulfillmentMethod": "DELIVERY",
    "requestedFulfillmentDate": "2025-03-22T00:00:00.000Z",
    "estimatedFulfillmentDate": "2025-03-22T00:00:00.000Z",
    "status": "Processed",
    "taxCents": 4500,
    "totalCents": 90500,
    "lineItems": [
      {
        "name": "Ashton 2.0 - Benton Blonde",
        "sku": "VTRBENBLO7X48-4.4MM-12MIL",
        "quantity": 879,
        "unitOfMeasure": "Sq Ft",
        "unitPriceCents": 139,
        "totalPriceCents": 122181
      }
    ],
    "exceptions": [
      {
        "createdAt": "2025-03-18T15:35:22.456Z",
        "sku": "VTRBENBLO7X48-4.4MM-12MIL",
        "message": "Product temporarily out of stock at nearest distribution center",
        "category": "installation-failed"
      },
      {
        "createdAt": "2025-03-18T15:36:10.789Z",
        "sku": null,
        "message": "Delivery address outside of standard service area, additional fees may apply",
        "category": null
      }
    ],
    "deliveryContact": {
      "name": "Jay Doe",
      "phone": "123-456-7890",
      "email": "jay.doe@example.com"
    },
    "images": [
      { "url": "https://s3.us-east-2.amazonaws.com/sibi.images/fund/Sibi.png" }
      { "url": "https://s3.us-east-2.amazonaws.com/sibi.images/auth/logo.png" }
    ]
  }
}