Skip to content
SIBISIBI Developers
Esc
↑↓navigate↵open⌘Jpreview

Get order

Retrieve an order by its ID.

GET/orders/{id}
Authorization
AuthorizationBearer token · headerrequired

A Sibi Public API token or access token, sent as Authorization: Bearer <token>.

Scopes:read:orders
or
AuthorizationBearer token · headerrequired

A Sibi Public API token or access token, sent as Authorization: Bearer <token>.

Scopes:read:own:orders
Path parameters
idstringrequired

The ID of the order

Responses
200

The order was found.

idstringrequired

The unique identifier for the order

poNumberstring | nullrequired

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

viewUrlstringrequired

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

createdAtstringrequired

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

propertyAddressOrderPropertyAddressrequired

The property address associated with this order.

Show properties
line1stringrequired
line2string | nullrequired
citystringrequired
stateOrProvincestringrequired
postalCodestringrequired
countrystring | nullrequired
fulfillmentMethodstringrequired
Allowed:DELIVERYPICKUP
requestedFulfillmentDatestringrequired

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

estimatedFulfillmentDatestringrequired

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

fulfillmentTimeStartstring | nullrequired

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

fulfillmentTimeEndstring | nullrequired

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

actualFulfillmentDatestring | nullrequired

The timestamp when the order was fulfilled (transitioned to Delivered or Picked_Up) in ISO 8601 format in UTC. Null when the order has not been fulfilled yet.

statusstringrequired

The current status of the order

Allowed:ApprovedAt_DistributionCanceledConfirmedDelayedDeliveredIn_ProcessIn_TransitPendingPicked_UpProcessedReady_For_PickupReturned
statusDetailstring | nullrequired

The status detail of the order.

lineItemsOrderLineItem[]required

The line items associated with this order.

Show properties
Array of OrderLineItem
skustringrequired

The stock-keeping unit (SKU) identifier for the product ordered in this line item.

namestringrequired

The human readable name of the product ordered in this line item.

quantityintegerrequired

The number of units purchased for this item.

unitOfMeasurestringrequired

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

unitPriceCentsintegerrequired

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

totalPriceCentsintegerrequired

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

optionsOrderLineItemOption[]required

The option values (e.g. paint color) this line item was ordered with. Empty when the product has no selectable options.

Show properties
Array of OrderLineItemOption
keystringrequired

The option identifier.

valuestringrequired

The value identifier.

namestringrequired

The human readable name of the value.

hexstring | nullrequired

The CSS hex color (#RRGGBB) of this value, for values that represent a color. Null when the value has no color representation.

feesOrderFee[]required

A list of fees associated with the order.

Show properties
Array of OrderFee
namestringrequired

Human readable name of the fee.

amountCentsintegerrequired

The amount of the fee, in cents.

exceptionsOrderException[]required

A list of exceptions that occurred during order processing. Empty if no exceptions occurred.

Show properties
Array of OrderException
createdAtstringrequired

The timestamp when the exception occurred in ISO 8601 format.

skustring | nullrequired

The SKU associated with the exception, if applicable. Note that this may be a distributor SKU that does not exist in the SIBI system. Null when not available or not applicable.

messagestringrequired

A description of the exception that occurred.

categorystring | nullrequired

The category of the exception. Null for now.

deliveryContactOrderDeliveryContact | nullrequired

The delivery agent assigned to the order. Null when not available.

Show properties
namestringrequired

The name of the delivery agent.

phonestring | nullrequired

The phone number of the delivery agent.

emailstring | nullrequired

The email address of the delivery agent.

orderingUserOrderingUserrequired

The user who placed the order.

Show properties
firstNamestringrequired
lastNamestringrequired
emailstringrequired
imagesOrderImage[]required

A list of images associated with the order.

Show properties
Array of OrderImage
urlstringrequired
confirmationNumbersOrderConfirmationNumber[]required

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

Show properties
Array of OrderConfirmationNumber
valuestringrequired

The value of the confirmation number. Confirmation numbers are a reference number from a fulfillment partner that enable you to track your order. They are issued when we submit the order to the partner.

cancellationRequestOrderCancellationRequest | nullrequired

The cancellation request associated with the order. Null when not available.

Show properties
statusstringrequired

The status of the cancellation request.

Allowed:PendingApprovedDenied
reasonstringrequired

The reason for the cancellation request.

createdAtstringrequired

The timestamp when the cancellation request was created in ISO 8601 format.

updatedAtstringrequired

The timestamp when the cancellation request was last updated in ISO 8601 format.

returnRequestsOrderReturnRequest[] | nullrequired

The return requests on this order, newest first. Empty when none have been opened; null when the return data could not be read (the order itself is still returned).

Show properties
Array of OrderReturnRequest
createdAtstringrequired

ISO 8601 timestamp of when the request was created.

updatedAtstringrequired

ISO 8601 timestamp of the most recent change.

itemsOrderReturnRequestItem[]required

The requested lines, each carrying its current status.

Show properties
Array of OrderReturnRequestItem
skustringrequired

The SKU of the product being returned, correlating to the order’s lineItems[].sku.

quantityintegerrequired

How many units of the order line this covers.

conditionstringrequired

Physical condition reported at intake.

requestReasonstringrequired

Why the line was requested for return.

statusstringrequired

Per-item status: Pending until Sibi staff decide, then Approved or Denied.

Allowed:PendingApprovedDenied
denialReasonstring | nullrequired

Why the line was denied. Set only when status is Denied; null otherwise.

400

Bad request - Invalid input data

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties
Array of object
fieldstringrequired
errorstringrequired
401

Unauthorized - Missing or invalid authentication

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties
Array of object
fieldstringrequired
errorstringrequired
403

Forbidden - The token is missing the scope this operation requires, or was minted for the other environment

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties
Array of object
fieldstringrequired
errorstringrequired
404

Not found - No order exists with the given id

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties
Array of object
fieldstringrequired
errorstringrequired
500

Internal server error

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties
Array of object
fieldstringrequired
errorstringrequired
Request
curl -X GET 'https://api.sibipro.com/orders/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "id": "SIBI-12345678",
  "poNumber": "PO-123456",
  "viewUrl": "https://web.sibipro.com/orders/SIBI-12345678",
  "createdAt": "2026-08-18T12:00:00Z",
  "propertyAddress": {
    "line1": "1630 W Guadalupe Rd",
    "line2": "Ste 101",
    "city": "Gilbert",
    "stateOrProvince": "AZ",
    "postalCode": "85233",
    "country": "USA"
  },
  "fulfillmentMethod": "DELIVERY",
  "requestedFulfillmentDate": "2026-08-20",
  "estimatedFulfillmentDate": "2026-08-20",
  "fulfillmentTimeStart": "string",
  "fulfillmentTimeEnd": "string",
  "actualFulfillmentDate": "string",
  "status": "Processed",
  "statusDetail": "string",
  "lineItems": [
    {
      "sku": "GDF510PSRSS",
      "name": "GE Dishwasher",
      "quantity": 1,
      "unitOfMeasure": "EA",
      "unitPriceCents": 54900,
      "totalPriceCents": 109800,
      "options": [
        {
          "key": "ppg-paint-color",
          "value": "PPG1105-3",
          "name": "Delicate White",
          "hex": "#F1EEE6"
        }
      ]
    }
  ],
  "fees": [
    {
      "name": "Delivery fee",
      "amountCents": 999
    }
  ],
  "exceptions": [
    {
      "createdAt": "2026-08-18T12:00:00Z",
      "sku": "string",
      "message": "string",
      "category": "string"
    }
  ],
  "deliveryContact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "orderingUser": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com"
  },
  "images": [
    {
      "url": "string"
    }
  ],
  "confirmationNumbers": [
    {
      "value": "string"
    }
  ],
  "cancellationRequest": {
    "status": "Pending",
    "reason": "string",
    "createdAt": "string",
    "updatedAt": "string"
  },
  "returnRequests": [
    {
      "createdAt": "string",
      "updatedAt": "string",
      "items": [
        {
          "sku": "GDF510PSRSS",
          "quantity": 0,
          "condition": "UNOPENED",
          "requestReason": "string",
          "status": "Pending",
          "denialReason": "string"
        }
      ]
    }
  ]
}

Was this page helpful?