List orders

GET

api

admin

orders

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: orders, meta } = await client.orders.list({
  status_eq: 'complete',
  completed_at_gt: '2026-01-01',
  sort: '-completed_at',
  limit: 25,
})

spree api get /orders -d '{"status_eq":"complete","completed_at_gt":"2026-01-01","sort":"-completed_at","limit":25}'

{
  "data": [
    {
      "id": "or_UkLWZg9DAJ",
      "market_id": null,
      "channel_id": "ch_UkLWZg9DAJ",
      "number": "R342068818",
      "email": "meda@little.ca",
      "customer_note": null,
      "currency": "USD",
      "locale": "en",
      "total_quantity": 0,
      "fulfillment_status": null,
      "payment_status": null,
      "completed_at": null,
      "item_total": "0.0",
      "display_item_total": "$0.00",
      "adjustment_total": "0.0",
      "display_adjustment_total": "$0.00",
      "discount_total": "0.0",
      "display_discount_total": "$0.00",
      "tax_total": "0.0",
      "display_tax_total": "$0.00",
      "included_tax_total": "0.0",
      "display_included_tax_total": "$0.00",
      "additional_tax_total": "0.0",
      "display_additional_tax_total": "$0.00",
      "total": "0.0",
      "display_total": "$0.00",
      "gift_card_total": "0.0",
      "display_gift_card_total": "$0.00",
      "amount_due": "0.0",
      "display_amount_due": "$0.00",
      "delivery_total": "0.0",
      "display_delivery_total": "$0.00",
      "store_credit_total": "0.0",
      "display_store_credit_total": "$0.00",
      "covered_by_store_credit": false,
      "gift_card": null,
      "market": null,
      "status": "draft",
      "last_ip_address": null,
      "considered_risky": false,
      "confirmation_delivered": false,
      "store_owner_notification_delivered": null,
      "payment_total": "0.0",
      "display_payment_total": "$0.00",
      "metadata": {},
      "canceled_at": null,
      "approved_at": null,
      "created_at": "2026-07-24T18:11:41.028Z",
      "updated_at": "2026-07-24T18:11:41.028Z",
      "preferred_stock_location_id": null,
      "tags": [],
      "internal_note": null,
      "approver_id": null,
      "canceler_id": null,
      "created_by_id": null,
      "customer_id": "cus_UkLWZg9DAJ"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

{
  "error": {
    "code": "authentication_required",
    "message": "Authentication required"
  }
}

Authorizations

x-spree-api-key

string

header

required

Secret API key for admin access

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Bearer token for admin authentication

Query Parameters

page

integer

Page number

limit

integer

Number of records per page

sort

string

Sort field (e.g., created_at, -created_at, completed_at)

q[state_eq]

string

Filter by state (cart, address, delivery, payment, confirm, complete, canceled)

q[email_cont]

string

Filter by email (contains)

q[number_eq]

string

Filter by order number

q[completed_at_gt]

string

Filter by completed after date

expand

string

Comma-separated associations to expand (e.g., items, fulfillments, payments, customer, discounts, billing_address, shipping_address). Use dot notation for nested expand (max 4 levels).

fields

string

Comma-separated list of fields to include (e.g., number,total,status,completed_at). id is always included.

Response

orders found

Remove store credit from an order

Create a draft order

⌘I

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: orders, meta } = await client.orders.list({
  status_eq: 'complete',
  completed_at_gt: '2026-01-01',
  sort: '-completed_at',
  limit: 25,
})

spree api get /orders -d '{"status_eq":"complete","completed_at_gt":"2026-01-01","sort":"-completed_at","limit":25}'

{
  "data": [
    {
      "id": "or_UkLWZg9DAJ",
      "market_id": null,
      "channel_id": "ch_UkLWZg9DAJ",
      "number": "R342068818",
      "email": "meda@little.ca",
      "customer_note": null,
      "currency": "USD",
      "locale": "en",
      "total_quantity": 0,
      "fulfillment_status": null,
      "payment_status": null,
      "completed_at": null,
      "item_total": "0.0",
      "display_item_total": "$0.00",
      "adjustment_total": "0.0",
      "display_adjustment_total": "$0.00",
      "discount_total": "0.0",
      "display_discount_total": "$0.00",
      "tax_total": "0.0",
      "display_tax_total": "$0.00",
      "included_tax_total": "0.0",
      "display_included_tax_total": "$0.00",
      "additional_tax_total": "0.0",
      "display_additional_tax_total": "$0.00",
      "total": "0.0",
      "display_total": "$0.00",
      "gift_card_total": "0.0",
      "display_gift_card_total": "$0.00",
      "amount_due": "0.0",
      "display_amount_due": "$0.00",
      "delivery_total": "0.0",
      "display_delivery_total": "$0.00",
      "store_credit_total": "0.0",
      "display_store_credit_total": "$0.00",
      "covered_by_store_credit": false,
      "gift_card": null,
      "market": null,
      "status": "draft",
      "last_ip_address": null,
      "considered_risky": false,
      "confirmation_delivered": false,
      "store_owner_notification_delivered": null,
      "payment_total": "0.0",
      "display_payment_total": "$0.00",
      "metadata": {},
      "canceled_at": null,
      "approved_at": null,
      "created_at": "2026-07-24T18:11:41.028Z",
      "updated_at": "2026-07-24T18:11:41.028Z",
      "preferred_stock_location_id": null,
      "tags": [],
      "internal_note": null,
      "approver_id": null,
      "canceler_id": null,
      "created_by_id": null,
      "customer_id": "cus_UkLWZg9DAJ"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

{
  "error": {
    "code": "authentication_required",
    "message": "Authentication required"
  }
}

API basics

Endpoints

Authorizations

Headers

Query Parameters

Response