Skip to content
Stella ConnectDocs
Commerce

List completed orders

GET{baseUrl}/v1.0/commerce/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."

Authx-api-key

Field
Type
Required
Description
StartTimedate-time | nullNo

Return orders updated/created from this UTC date/time.

Limitinteger | nullNo

The page size of results to return.

Startinteger | nullNo

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[] | nullNo
data[].quoteNumberstringNo

Quote/Order Number as it appears in Stella

data[].orderIdstringNo

Unique identifier for the quote/order in Stella

data[].orderNumberstringNo

Order Number entered by the supplier when the contract was signed

data[].createdAtdate-timeNo

Date the Order was created

data[].updatedAtdate-timeNo

Date the Order was last Updated

data[].freightstringNo

Freight/shipping method selected for the order

data[].locationstringNo

Supplier company location name associated with this order

data[].statusenumNo

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[].poNumberstringNo

Purchase Order Number as entered by the purchaser

data[].notesstringNo

Purchase Order Notes as entered by the purchaser

data[].connectIntegrationIdstringNo

Integration identifier used to correlate this order with an external system

data[].lines[]object[]No

Collection of line items in the order

data[].lines[].idstringNo

Unique identifier for the line item

data[].lines[].partNumberstringNo

Customer-supplied part number for this line item

data[].lines[].quantityintegerNo

Quantity ordered

data[].lines[].processstringNo

Manufacturing process specified for the part

data[].lines[].notesstringNo

Additional notes or instructions for the line item

data[].lines[].createdAtdate-timeNo

Date and time when the line item was created

data[].lines[].updatedAtdate-timeNo

Date and time when the line item was last updated

data[].lines[].operations[]object[]No

Collection of manufacturing operations applied to this line item

data[].lines[].operations[].operationTypestringNo

Type of manufacturing operation (e.g., "cut", "bend")

data[].lines[].operations[].operationDetailobjectNo

Key-value pairs of operation-specific parameters

data[].lines[].unitPricenumber | nullNo

Price per unit in the order currency, or null if not yet priced

data[].lines[].totalPricenumber | nullNo

Total price for the line item (unit price × quantity), or null if not yet priced

data[].lines[].materialSkustring | nullNo

SKU of the material associated with this line item

data[].lines[].materialDescriptionstring | nullNo

Human-readable description of the material

data[].lines[].materialCategorystring | nullNo

Category classification of the material

data[].lines[].materialGradestring | nullNo

Grade specification of the material

data[].lines[].materialShapestring | nullNo

Shape classification of the material (e.g., "sheet", "tube")

data[].lines[].materialDimensionsobject | nullNo

Key-value pairs of dimension names and values for the material (e.g., "thickness": "0.25")

data[].salesTaxAmountnumberNo

Sales tax amount charged for the order

data[].miscellaneousCostsobjectNo

Collection of miscellaneous costs associated with the order

data[].supplierCompanyNamestringNo

Name of the supplier company fulfilling the order

data[].supplierAddressLine1stringNo

Supplier street address line 1

data[].supplierAddressLine2stringNo

Supplier street address line 2

data[].supplierLocalitystringNo

Supplier city or locality

data[].supplierStateOrProvincestringNo

Supplier state or province

data[].supplierPostalCodestringNo

Supplier postal or ZIP code

data[].supplierCountrystringNo

Supplier country code

data[].purchaserCompanyNamestringNo

Name of the purchasing company

data[].purchaserAddressLine1stringNo

Purchaser street address line 1

data[].purchaserAddressLine2stringNo

Purchaser street address line 2

data[].purchaserLocalitystringNo

Purchaser city or locality

data[].purchaserStateOrProvincestringNo

Purchaser state or province

data[].purchaserPostalCodestringNo

Purchaser postal or ZIP code

data[].purchaserCountrystringNo

Purchaser country code

data[].purchaserEmailAddressstringNo

Email address of the purchaser contact

data[].purchaserFirstNamestringNo

First name of the purchaser contact

data[].purchaserLastNamestringNo

Last name of the purchaser contact

data[].purchaserLocationExternalIdstring | nullNo

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[] | nullNo

One or more errors describing why the request failed. Absent (null) on success.

errors[].descriptionstring | nullNo

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[].errorIdstring | nullNo

Machine-readable, stable error identifier. Consumers should branch on this value rather than on Description. See ConnectErrorIds for the catalog.

pagingobject | nullNo

Paging metadata for list endpoints. Absent on single-item responses.

paging.limitintegerNo
paging.startintegerNo
paging.totalintegerNo

Example 200 response
{
  "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
  }
}