Skip to main content
GET
/
api
/
dashboard
/
orders
List Orders
curl --request GET \
  --url https://api.example.com/api/dashboard/orders
{
  "orders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_number": "<string>",
      "email": "<string>",
      "line_items": [
        {
          "name": "<string>",
          "quantity": 123,
          "price": "<string>",
          "total": "<string>",
          "variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sku": "<string>",
          "option1": "<string>",
          "option2": "<string>",
          "option3": "<string>",
          "variant_name": "<string>",
          "image_url": "<string>"
        }
      ],
      "subtotal": "<string>",
      "tax": "<string>",
      "shipping_cost": "<string>",
      "discount": "<string>",
      "total": "<string>",
      "currency": "<string>",
      "status": "<string>",
      "payment_status": "<string>",
      "fulfillment_status": "<string>",
      "source": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phone": "<string>",
      "payment_method": "<string>",
      "billing_address": {
        "first_name": "<string>",
        "last_name": "<string>",
        "company": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>",
        "phone": "<string>"
      },
      "shipping_address": {
        "first_name": "<string>",
        "last_name": "<string>",
        "company": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>",
        "phone": "<string>"
      },
      "shipping_method": "<string>",
      "tracking_number": "<string>",
      "tracking_url": "<string>",
      "note": "<string>",
      "staff_note": "<string>",
      "shipped_at": "2023-11-07T05:31:56Z",
      "delivered_at": "2023-11-07T05:31:56Z",
      "cancelled_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "pages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.stella-commerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

authorization
string | null
X-API-Key
string | null
X-Stella-Merchant-Id
string | null

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100
status
string | null
payment_status
string | null
payment_method
string | null
fulfillment_status
string | null
search
string | null

Response

Successful Response

Schema for paginated order list.

orders
OrderResponse · object[]
required
total
integer
required
page
integer
required
limit
integer
required
pages
integer
required