List completed orders
Returns a paginated list of completed orders. Supersedes v1/commerce/orders with a richer schema including pricing totals, miscellaneous charges, shipping method, and a structured customer block.
x-api-keyField | Type | Required | Description |
|---|---|---|---|
| StartTime | date-time | null | No | Return orders placed after this UTC date/time. |
| Limit | integer | null | No | The page size of results to return. |
| Start | integer | null | No | The page number to start the results from. |
Status | When |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | An unexpected error occurred on the server. |
Field | Type | Required | Description |
|---|---|---|---|
| data[] | object[] | null | No | |
| data[]. | string | No | Unique identifier for the order in Stella |
| data[]. | string | No | Quote/order number as it appears in Stella |
| data[]. | string | No | Purchase order number as entered by the purchaser |
| data[]. | string | No | Order number entered by the supplier when the contract was signed |
| data[]. | date-time | No | Date the original quote was created |
| data[]. | date-time | No | Date the purchaser placed the order |
| data[]. | date-time | No | Date the supplier accepted the order |
| data[]. | enum | No | Current status of the order in the quoting/ordering workflow Show 13 values"InProgress""AwaitingResponse""Closed""Acknowledged""Applied""Awarded""Rejected""OrderPending""OrderAbandoned""OrderConfirmed""OrderDeclined""OrderInvoiced""Expired" |
| data[]. | number | No | Total order price including all charges and taxes |
| data[]. | number | No | Subtotal before tax and miscellaneous charges |
| data[]. | number | No | Sales tax amount applied to the order |
| data[]. | object[] | No | Collection of additional charges applied to the order (e.g., freight, setup fees) |
| data[]. | string | No | Display name of the miscellaneous charge (e.g., "Freight", "Setup Fee") |
| data[]. | number | No | Amount of the charge in the order currency |
| data[]. | string | No | Freight/shipping method selected for the order |
| data[]. | date-time | No | Estimated date the order will be delivered |
| data[]. | number | No | Total quantity of all line items combined |
| data[]. | string | No | Notes added by the supplier on the order |
| data[]. | string | No | Purchase order notes as entered by the purchaser |
| data[]. | object[] | No | Collection of line items in the order |
| data[]. | uuid | No | Unique identifier for the line item |
| data[]. | string | No | Human-readable description of the line item |
| data[]. | integer | No | Quantity ordered |
| data[]. | string | No | Type of line item (e.g., "part", "material", "service") |
| data[]. | string | No | Additional notes or instructions for the line item |
| data[]. | number | No | Price per unit in the order currency |
| data[]. | number | No | Total price for the line item (unit price × quantity) |
| data[]. | number | No | Weight of a single unit |
| data[]. | number | No | Total weight for all units (unit weight × quantity) |
| data[]. | string | null | No | Stock keeping unit identifier for the line item, if applicable |
| data[]. | string | No | Name of the supplier location fulfilling the order |
| data[]. | string | No | Name or identifier of the person who acknowledged the order |
| data[]. | object | No | Customer contact and address information for this order |
| data[]. | string | No | Name of the purchasing company |
| data[]. | string | No | Name of the purchasing location |
| data[]. | string | No | Name of the person who placed the order |
| data[]. | string | No | Email address of the purchaser contact |
| data[]. | string | No | Phone number of the purchaser contact |
| data[]. | object | No | Physical address of the purchasing location |
| data[]. | string | null | No | External ERP identifier for this location, if set |
| data[]. | string | No | Street address line 1 |
| data[]. | string | null | No | Street address line 2, if provided |
| data[]. | string | No | City or locality |
| data[]. | string | No | State or province |
| data[]. | string | No | Postal or ZIP code |
| data[]. | string | No | Country code |
| errors[] | object[] | null | No | One or more errors describing why the request failed. Absent ( |
| errors[]. | string | null | No | Human-readable explanation of the error. Intended for display to end users or logs. Wording is not stable and should not be branched on. |
| errors[]. | string | null | No | Machine-readable, stable error identifier. Consumers should branch on this value
rather than on Description. See |
| paging | object | null | No | Paging metadata for list endpoints. Absent on single-item responses. |
| paging. | integer | No | |
| paging. | integer | No | |
| paging. | integer | No |
{
"data": [
{
"orderId": "string",
"quoteNumber": "string",
"poNumber": "string",
"orderNumber": "string",
"quoteCreatedDate": "2019-08-24T14:15:22Z",
"orderPlacedDate": "2019-08-24T14:15:22Z",
"orderAcceptedDate": "2019-08-24T14:15:22Z",
"status": "InProgress",
"totalPrice": 0,
"subTotalPrice": 0,
"salesTax": 0,
"miscellaneousCharges": [
{
"name": "string",
"amount": 0
}
],
"shippingMethod": "string",
"estimatedDeliveryDate": "2019-08-24T14:15:22Z",
"totalQuantity": 0,
"supplierNotes": "string",
"poNotes": "string",
"lines": [
{
"lineItemKey": "be72f50d-bc07-45e9-b1c3-7db4f5f347b0",
"description": "string",
"quantity": 0,
"lineType": "string",
"notes": "string",
"unitPrice": 0,
"totalPrice": 0,
"unitWeight": 0,
"totalWeight": 0,
"sku": "string"
}
],
"supplierLocationName": "string",
"acknowledgedBy": "string",
"customer": {
"company": "string",
"locationName": "string",
"purchasedBy": "string",
"email": "string",
"phone": "string",
"location": {
"externalId": "string",
"addressLine1": "string",
"addressLine2": "string",
"locality": "string",
"stateOrProvince": "string",
"postalCode": "string",
"country": "string"
}
}
}
],
"errors": [
{
"description": "string",
"errorId": "string"
}
],
"paging": {
"limit": 0,
"start": 0,
"total": 0
}
}