Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'
const client = createAdminClient({
baseUrl: 'https://your-store.com',
secretKey: 'sk_xxx',
})
const { data: items } = await client.orders.items.list('or_UkLWZg9DAJ')spree api get /orders/{order_id}/items{
"data": [
{
"id": "li_UkLWZg9DAJ",
"variant_id": "variant_gbHJdmfrXB",
"seller_id": null,
"preorder": false,
"preorder_ships_at": null,
"quantity": 2,
"currency": "USD",
"name": "Product 479180",
"slug": "product-479180",
"options_text": "Size: S",
"price": "10.0",
"display_price": "$10.00",
"total": "20.0",
"display_total": "$20.00",
"adjustment_total": "0.0",
"display_adjustment_total": "$0.00",
"additional_tax_total": "0.0",
"display_additional_tax_total": "$0.00",
"included_tax_total": "0.0",
"display_included_tax_total": "$0.00",
"discount_total": "0.0",
"display_discount_total": "$0.00",
"pre_tax_amount": "20.0",
"display_pre_tax_amount": "$20.00",
"discounted_amount": "20.0",
"display_discounted_amount": "$20.00",
"display_compare_at_amount": "$0.00",
"compare_at_amount": null,
"thumbnail_url": null,
"option_values": [
{
"id": "optval_UkLWZg9DAJ",
"option_type_id": "opt_UkLWZg9DAJ",
"name": "size-1",
"label": "S",
"position": 1,
"color_code": null,
"option_type_name": "foo-size-10",
"option_type_label": "Size",
"image_url": null,
"metadata": {},
"created_at": "2026-01-15T12:00:00.000Z",
"updated_at": "2026-01-15T12:00:00.000Z"
}
],
"digital_links": [],
"metadata": {},
"price_source": null,
"created_at": "2026-01-15T12:00:00.000Z",
"updated_at": "2026-01-15T12:00:00.000Z",
"catalog_price": "19.99",
"cost_price": "17.0",
"tax_category_id": "taxcat_UkLWZg9DAJ"
}
],
"meta": {
"page": 1,
"limit": 25,
"count": 1,
"pages": 1,
"from": 1,
"to": 1,
"in": 1,
"previous": null,
"next": null
}
}Returns all line items for an order.
Required scope: read_orders (for API-key authentication).
GET
/
api
/
v3
/
admin
/
orders
/
{order_id}
/
items
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'
const client = createAdminClient({
baseUrl: 'https://your-store.com',
secretKey: 'sk_xxx',
})
const { data: items } = await client.orders.items.list('or_UkLWZg9DAJ')spree api get /orders/{order_id}/items{
"data": [
{
"id": "li_UkLWZg9DAJ",
"variant_id": "variant_gbHJdmfrXB",
"seller_id": null,
"preorder": false,
"preorder_ships_at": null,
"quantity": 2,
"currency": "USD",
"name": "Product 479180",
"slug": "product-479180",
"options_text": "Size: S",
"price": "10.0",
"display_price": "$10.00",
"total": "20.0",
"display_total": "$20.00",
"adjustment_total": "0.0",
"display_adjustment_total": "$0.00",
"additional_tax_total": "0.0",
"display_additional_tax_total": "$0.00",
"included_tax_total": "0.0",
"display_included_tax_total": "$0.00",
"discount_total": "0.0",
"display_discount_total": "$0.00",
"pre_tax_amount": "20.0",
"display_pre_tax_amount": "$20.00",
"discounted_amount": "20.0",
"display_discounted_amount": "$20.00",
"display_compare_at_amount": "$0.00",
"compare_at_amount": null,
"thumbnail_url": null,
"option_values": [
{
"id": "optval_UkLWZg9DAJ",
"option_type_id": "opt_UkLWZg9DAJ",
"name": "size-1",
"label": "S",
"position": 1,
"color_code": null,
"option_type_name": "foo-size-10",
"option_type_label": "Size",
"image_url": null,
"metadata": {},
"created_at": "2026-01-15T12:00:00.000Z",
"updated_at": "2026-01-15T12:00:00.000Z"
}
],
"digital_links": [],
"metadata": {},
"price_source": null,
"created_at": "2026-01-15T12:00:00.000Z",
"updated_at": "2026-01-15T12:00:00.000Z",
"catalog_price": "19.99",
"cost_price": "17.0",
"tax_category_id": "taxcat_UkLWZg9DAJ"
}
],
"meta": {
"page": 1,
"limit": 25,
"count": 1,
"pages": 1,
"from": 1,
"to": 1,
"in": 1,
"previous": null,
"next": null
}
}Authorizations
Secret API key for admin access
JWT token for admin user authentication
Headers
Bearer token for admin authentication
Path Parameters
Order ID
Query Parameters
Comma-separated associations to expand (e.g., variant, variant.product). Use dot notation for nested expand (max 4 levels).
Comma-separated list of fields to include (e.g., quantity,price,total). id is always included.
Response
200 - application/json
items found
Was this page helpful?
⌘I

