Skip to main content
An object representing an order placed through the ordering API.

id

string - The unique identifier for the order.

poNumber

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

viewUrl

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

createdAt

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

propertyAddress

OrderingAddress - 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

OrderingFulfillmentMethodType - The fulfillment method for the order (e.g., delivery or pickup).

requestedFulfillmentDate

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

estimatedFulfillmentDate

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

fulfillmentTimeStart

string | null - The start of the time window when the order is requested to be fulfilled in ISO 8601 format in UTC.

fulfillmentTimeEnd

string | null - The end of the time window when the order is requested to be fulfilled in ISO 8601 format in UTC.

actualFulfillmentDate

string | null - The timestamp when the order was fulfilled (transitioned to Delivered or Picked_Up) in ISO 8601 format in UTC. Will be null when the order has not been fulfilled yet.

status

OrderingOrderStatus - The status of the order.

statusDetail

string | null - The status detail of the order. Provides additional context about the current status. Will be null when not available.

lineItems

OrderingOrderLineItem[] - The line items associated with this order.

fees

OrderingOrderFee[] - A list of fees associated with the order.

exceptions

OrderingOrderException[] - A list of exceptions that occurred during order processing. May be empty if no exceptions occurred.

deliveryContact

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

images

OrderingOrderImage[] - A list of images associated with the order.

confirmationNumbers

OrderingOrderConfirmationNumber[] - An array of confirmation numbers objects. Multiple confirmation numbers are usually an indication that the order has been split into multiple shipments.

cancellationRequest

OrderingOrderCancellationRequest | null - The cancellation request associated with the order. Will be null when not available.