Skip to content
Stella ConnectDocs
Commerce

List completed orders

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

Authx-api-key

Field
Type
Required
Description
StartTimedate-time | nullNo

Return orders placed after 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

500

An unexpected error occurred on the server.

Field
Type
Required
Description
data[]object[] | nullNo
data[].orderIdstringNo

Unique identifier for the order in Stella

data[].quoteNumberstringNo

Quote/order number as it appears in Stella

data[].poNumberstringNo

Purchase order number as entered by the purchaser

data[].orderNumberstringNo

Order number entered by the supplier when the contract was signed

data[].quoteCreatedDatedate-timeNo

Date the original quote was created

data[].orderPlacedDatedate-timeNo

Date the purchaser placed the order

data[].orderAcceptedDatedate-timeNo

Date the supplier accepted the 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[].totalPricenumberNo

Total order price including all charges and taxes

data[].subTotalPricenumberNo

Subtotal before tax and miscellaneous charges

data[].salesTaxnumberNo

Sales tax amount applied to the order

data[].miscellaneousCharges[]object[]No

Collection of additional charges applied to the order (e.g., freight, setup fees)

data[].miscellaneousCharges[].namestringNo

Display name of the miscellaneous charge (e.g., "Freight", "Setup Fee")

data[].miscellaneousCharges[].amountnumberNo

Amount of the charge in the order currency

data[].shippingMethodstringNo

Freight/shipping method selected for the order

data[].estimatedDeliveryDatedate-timeNo

Estimated date the order will be delivered

data[].totalQuantitynumberNo

Total quantity of all line items combined

data[].supplierNotesstringNo

Notes added by the supplier on the order

data[].poNotesstringNo

Purchase order notes as entered by the purchaser

data[].lines[]object[]No

Collection of line items in the order

data[].lines[].lineItemKeyuuidNo

Unique identifier for the line item

data[].lines[].descriptionstringNo

Human-readable description of the line item

data[].lines[].quantityintegerNo

Quantity ordered

data[].lines[].lineTypestringNo

Type of line item (e.g., "part", "material", "service")

data[].lines[].notesstringNo

Additional notes or instructions for the line item

data[].lines[].unitPricenumberNo

Price per unit in the order currency

data[].lines[].totalPricenumberNo

Total price for the line item (unit price × quantity)

data[].lines[].unitWeightnumberNo

Weight of a single unit

data[].lines[].totalWeightnumberNo

Total weight for all units (unit weight × quantity)

data[].lines[].skustring | nullNo

Stock keeping unit identifier for the line item, if applicable

data[].supplierLocationNamestringNo

Name of the supplier location fulfilling the order

data[].acknowledgedBystringNo

Name or identifier of the person who acknowledged the order

data[].customerobjectNo

Customer contact and address information for this order

data[].customer.companystringNo

Name of the purchasing company

data[].customer.locationNamestringNo

Name of the purchasing location

data[].customer.purchasedBystringNo

Name of the person who placed the order

data[].customer.emailstringNo

Email address of the purchaser contact

data[].customer.phonestringNo

Phone number of the purchaser contact

data[].customer.locationobjectNo

Physical address of the purchasing location

data[].customer.location.externalIdstring | nullNo

External ERP identifier for this location, if set

data[].customer.location.addressLine1stringNo

Street address line 1

data[].customer.location.addressLine2string | nullNo

Street address line 2, if provided

data[].customer.location.localitystringNo

City or locality

data[].customer.location.stateOrProvincestringNo

State or province

data[].customer.location.postalCodestringNo

Postal or ZIP code

data[].customer.location.countrystringNo

Country code

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": [
    {
      "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
  }
}