Skip to main content
GET
/
api
/
v1
/
orders
List Orders
curl --request GET \
  --url https://api.launchmystore.io/api/v1/orders \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data.items": [
    {
      "id": "<string>",
      "order_number": 123,
      "email": "<string>",
      "status": "<string>",
      "financial_status": "<string>",
      "fulfillment_status": "<string>",
      "currency": "<string>",
      "subtotal_price": 123,
      "total_tax": 123,
      "total_shipping": 123,
      "total_discounts": 123,
      "total_price": 123,
      "line_items": [
        {}
      ],
      "customer": {},
      "shipping_address": {},
      "billing_address": {},
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "data.pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "hasMore": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.launchmystore.io/llms.txt

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

​
List Orders

Returns a paginated list of orders for the store.

​
Request

curl -X GET "https://api.launchmystore.io/api/v1/orders" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Parameters

​
page
integer
default:"1"
Page number for pagination
​
limit
integer
default:"50"
Number of items per page (max 250)
​
status
string
Filter by order status: pending, confirmed, fulfilled, cancelled, refunded
​
financial_status
string
Filter by payment status: pending, paid, partially_paid, refunded, partially_refunded
​
fulfillment_status
string
Filter by fulfillment status: unfulfilled, partial, fulfilled
​
created_at_min
string
Filter orders created after this date (ISO 8601)
​
created_at_max
string
Filter orders created before this date (ISO 8601)
​
updated_at_min
string
Filter orders updated after this date (ISO 8601)
​
customer_id
string
Filter orders by customer ID

​
Response

​
success
boolean
Whether the request succeeded
​
data.items
array
Array of order objects
​
data.pagination
object
Pagination information

​
Example Response

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "ord_abc123",
        "order_number": 1001,
        "email": "customer@example.com",
        "status": "confirmed",
        "financial_status": "paid",
        "fulfillment_status": "unfulfilled",
        "currency": "USD",
        "subtotal_price": 5000,
        "total_tax": 450,
        "total_shipping": 500,
        "total_discounts": 0,
        "total_price": 5950,
        "line_items": [
          {
            "id": "li_xyz789",
            "product_id": "prod_abc123",
            "variant_id": "var_xyz789",
            "title": "Classic T-Shirt",
            "variant_title": "Small / Black",
            "quantity": 2,
            "price": 2500,
            "sku": "TSHIRT-S-BLK"
          }
        ],
        "customer": {
          "id": "cust_123",
          "email": "customer@example.com",
          "first_name": "John",
          "last_name": "Doe"
        },
        "shipping_address": {
          "first_name": "John",
          "last_name": "Doe",
          "address1": "123 Main St",
          "city": "New York",
          "province": "NY",
          "country": "US",
          "zip": "10001"
        },
        "created_at": "2024-01-20T14:30:00Z",
        "updated_at": "2024-01-20T14:35:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 250,
      "hasMore": true
    }
  }
}

​
Error Codes

CodeDescription
UNAUTHORIZEDInvalid or missing access token
FORBIDDENApp doesn’t have read_orders scope