> ## 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.

# Update an item

> Updates an order item quantity or metadata.

**Required scope:** `write_orders` (for API-key authentication).



## OpenAPI

````yaml /api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/items/{id}
openapi: 3.0.3
info:
  title: Admin API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: >
    Spree Admin API v3 - Administrative API for managing products, orders, and
    store settings.


    ## Authentication


    The Admin API requires a secret API key passed in the `x-spree-api-key`
    header.

    Secret API keys can be generated in the Spree admin dashboard.


    ## Response Format


    All responses are JSON. List endpoints return paginated responses with
    `data` and `meta` keys.

    Single resource endpoints return a flat JSON object.


    ## Resource IDs


    Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,

    `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,

    request bodies, and Ransack filters all accept them directly.


    ## Error Handling


    Errors return a consistent format:

    ```json

    {
      "error": {
        "code": "validation_error",
        "message": "Validation failed",
        "details": { "name": ["can't be blank"] }
      }
    }

    ```
  version: v3
servers:
  - url: http://{defaultHost}
    variables:
      defaultHost:
        default: localhost:3000
security: []
tags:
  - name: Authentication
    description: Admin user authentication
  - name: Product Catalog
    description: Products, variants, and option types
  - name: Orders
    description: >-
      Order management — orders, items, payments, fulfillments, refunds, gift
      cards, store credits
  - name: Customers
    description: Customer management — profiles, addresses, store credits, credit cards
  - name: Configuration
    description: Store configuration — payment methods, tag autocomplete
paths:
  /api/v3/admin/orders/{order_id}/items/{id}:
    patch:
      tags:
        - Orders
      summary: Update an item
      description: |-
        Updates an order item quantity or metadata.

        **Required scope:** `write_orders` (for API-key authentication).
      parameters:
        - name: x-spree-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          description: Bearer token for admin authentication
          schema:
            type: string
        - name: order_id
          in: path
          required: true
          description: Order ID
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: Item ID
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                quantity:
                  type: integer
      responses:
        '200':
          description: item updated
          content:
            application/json:
              example:
                id: li_UkLWZg9DAJ
                variant_id: variant_gbHJdmfrXB
                quantity: 5
                currency: USD
                name: Product 14367
                slug: product-14367
                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-17T22:57:53.243Z'
                    updated_at: '2026-05-17T22:57:53.243Z'
                digital_links: []
                metadata: {}
                created_at: '2026-05-17T22:57:53.531Z'
                updated_at: '2026-05-17T22:57:53.828Z'
                cost_price: '17.0'
                tax_category_id: taxcat_UkLWZg9DAJ
      security:
        - api_key: []
          bearer_auth: []
      x-codeSamples:
        - lang: javascript
          label: Spree Admin SDK
          source: >-
            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,
            })
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: x-spree-api-key
      in: header
      description: Secret API key for admin access
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token for admin user authentication

````