Skip to main content
PATCH
/
api
/
v3
/
admin
/
orders
/
{order_id}
/
items
/
{id}
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

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

const item = await client.orders.items.update('or_UkLWZg9DAJ', 'li_UkLWZg9DAJ', {
  quantity: 5,
})
{
  "id": "li_UkLWZg9DAJ",
  "variant_id": "variant_gbHJdmfrXB",
  "quantity": 5,
  "currency": "USD",
  "name": "Product 141563",
  "slug": "product-141563",
  "options_text": "Size: S",
  "price": "19.99",
  "display_price": "$19.99",
  "total": "99.95",
  "display_total": "$99.95",
  "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": "99.95",
  "display_pre_tax_amount": "$99.95",
  "discounted_amount": "99.95",
  "display_discounted_amount": "$99.95",
  "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-5",
      "label": "S",
      "position": 1,
      "color_code": null,
      "option_type_name": "foo-size-14",
      "option_type_label": "Size",
      "image_url": null,
      "metadata": {},
      "created_at": "2026-05-21T18:11:14.759Z",
      "updated_at": "2026-05-21T18:11:14.759Z"
    }
  ],
  "digital_links": [],
  "metadata": {},
  "created_at": "2026-05-21T18:11:15.044Z",
  "updated_at": "2026-05-21T18:11:15.352Z",
  "cost_price": "17.0",
  "tax_category_id": "taxcat_UkLWZg9DAJ"
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

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

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

Path Parameters

order_id
string
required

Order ID

id
string
required

Item ID

Body

application/json
quantity
integer

Response

200 - application/json

item updated