Skip to main content
POST
/
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 item = await client.orders.items.create('or_UkLWZg9DAJ', {
  variant_id: 'variant_k5nR8xLq',
  quantity: 2,
})
{
  "id": "li_gbHJdmfrXB",
  "variant_id": "variant_VqXmZF31wY",
  "quantity": 3,
  "currency": "USD",
  "name": "Product 126547",
  "slug": "product-126547",
  "options_text": "Size: S",
  "price": "19.99",
  "display_price": "$19.99",
  "total": "59.97",
  "display_total": "$59.97",
  "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": "59.97",
  "display_pre_tax_amount": "$59.97",
  "discounted_amount": "59.97",
  "display_discounted_amount": "$59.97",
  "display_compare_at_amount": "$0.00",
  "compare_at_amount": null,
  "thumbnail_url": null,
  "option_values": [
    {
      "id": "optval_gbHJdmfrXB",
      "option_type_id": "opt_gbHJdmfrXB",
      "name": "size-3",
      "label": "S",
      "position": 1,
      "color_code": null,
      "option_type_name": "foo-size-12",
      "option_type_label": "Size",
      "image_url": null,
      "metadata": {},
      "created_at": "2026-05-21T18:11:14.028Z",
      "updated_at": "2026-05-21T18:11:14.028Z"
    }
  ],
  "digital_links": [],
  "metadata": {},
  "created_at": "2026-05-21T18:11:14.053Z",
  "updated_at": "2026-05-21T18:11:14.053Z",
  "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

Body

application/json
variant_id
string
required

Prefixed variant ID

quantity
integer
default:1

Response

201 - application/json

item added