List completed orders
Returns a paginated list of invoiced or confirmed orders. Includes header details, supplier and purchaser addresses, and line items with pricing and material information."
x-api-keyField | Type | Required | Description |
|---|---|---|---|
| StartTime | date-time | null | No | Return orders updated/created from 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 |
| 403 | Forbidden |
| 500 | An unexpected error occurred on the server. |
Field | Type | Required | Description |
|---|---|---|---|
| data[] | object[] | null | No | |
| data[]. | string | No | Quote/Order Number as it appears in Stella |
| data[]. | string | No | Unique identifier for the quote/order in Stella |
| data[]. | string | No | Order Number entered by the supplier when the contract was signed |
| data[]. | date-time | No | Date the Order was created |
| data[]. | date-time | No | Date the Order was last Updated |
| data[]. | string | No | Freight/shipping method selected for the order |
| data[]. | string | No | Supplier company location name associated with this 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[]. | string | No | Purchase Order Number as entered by the purchaser |
| data[]. | string | No | Purchase Order Notes as entered by the purchaser |
| data[]. | string | No | Integration identifier used to correlate this order with an external system |
| data[]. | object[] | No | Collection of line items in the order |
| data[]. | string | No | Unique identifier for the line item |
| data[]. | string | No | Customer-supplied part number for this line item |
| data[]. | integer | No | Quantity ordered |
| data[]. | string | No | Manufacturing process specified for the part |
| data[]. | string | No | Additional notes or instructions for the line item |
| data[]. | date-time | No | Date and time when the line item was created |
| data[]. | date-time | No | Date and time when the line item was last updated |
| data[]. | object[] | No | Collection of manufacturing operations applied to this line item |
| data[]. | string | No | Type of manufacturing operation (e.g., "cut", "bend") |
| data[]. | object | No | Key-value pairs of operation-specific parameters |
| data[]. | number | null | No | Price per unit in the order currency, or null if not yet priced |
| data[]. | number | null | No | Total price for the line item (unit price × quantity), or null if not yet priced |
| data[]. | string | null | No | SKU of the material associated with this line item |
| data[]. | string | null | No | Human-readable description of the material |
| data[]. | string | null | No | Category classification of the material |
| data[]. | string | null | No | Grade specification of the material |
| data[]. | string | null | No | Shape classification of the material (e.g., "sheet", "tube") |
| data[]. | object | null | No | Key-value pairs of dimension names and values for the material (e.g., "thickness": "0.25") |
| data[]. | number | No | Sales tax amount charged for the order |
| data[]. | object | No | Collection of miscellaneous costs associated with the order |
| data[]. | string | No | Name of the supplier company fulfilling the order |
| data[]. | string | No | Supplier street address line 1 |
| data[]. | string | No | Supplier street address line 2 |
| data[]. | string | No | Supplier city or locality |
| data[]. | string | No | Supplier state or province |
| data[]. | string | No | Supplier postal or ZIP code |
| data[]. | string | No | Supplier country code |
| data[]. | string | No | Name of the purchasing company |
| data[]. | string | No | Purchaser street address line 1 |
| data[]. | string | No | Purchaser street address line 2 |
| data[]. | string | No | Purchaser city or locality |
| data[]. | string | No | Purchaser state or province |
| data[]. | string | No | Purchaser postal or ZIP code |
| data[]. | string | No | Purchaser country code |
| data[]. | string | No | Email address of the purchaser contact |
| data[]. | string | No | First name of the purchaser contact |
| data[]. | string | No | Last name of the purchaser contact |
| data[]. | string | null | No | This is the external Id from the Suppliers ERP that should align to the purchasing location in that system. Same as the ExternalId from the ContactCompanyLocation in the List Contact Endpoint |
| 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": [
{
"quoteNumber": "string",
"orderId": "string",
"orderNumber": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"freight": "string",
"location": "string",
"status": "InProgress",
"poNumber": "string",
"notes": "string",
"connectIntegrationId": "string",
"lines": [
{
"id": "string",
"partNumber": "string",
"quantity": 0,
"process": "string",
"notes": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"operations": [
{
"operationType": "string",
"operationDetail": {
"property1": "string",
"property2": "string"
}
}
],
"unitPrice": 0,
"totalPrice": 0,
"materialSku": "string",
"materialDescription": "string",
"materialCategory": "string",
"materialGrade": "string",
"materialShape": "string",
"materialDimensions": {
"property1": "string",
"property2": "string"
}
}
],
"salesTaxAmount": 0,
"miscellaneousCosts": {
"property1": 0,
"property2": 0
},
"supplierCompanyName": "string",
"supplierAddressLine1": "string",
"supplierAddressLine2": "string",
"supplierLocality": "string",
"supplierStateOrProvince": "string",
"supplierPostalCode": "string",
"supplierCountry": "string",
"purchaserCompanyName": "string",
"purchaserAddressLine1": "string",
"purchaserAddressLine2": "string",
"purchaserLocality": "string",
"purchaserStateOrProvince": "string",
"purchaserPostalCode": "string",
"purchaserCountry": "string",
"purchaserEmailAddress": "string",
"purchaserFirstName": "string",
"purchaserLastName": "string",
"purchaserLocationExternalId": "string"
}
],
"errors": [
{
"description": "string",
"errorId": "string"
}
],
"paging": {
"limit": 0,
"start": 0,
"total": 0
}
}