Skip to main content
PATCH
Spree SDK

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Authorization
string
header
required

JWT token for authenticated customers

Headers

x-spree-api-key
string
required
Authorization
string
x-spree-token
string

Path Parameters

cart_id
string
required

Cart prefixed ID

id
string
required

Line item ID

Body

application/json
quantity
integer
Required range: x >= 1
Example:

5

metadata
object

Arbitrary key-value metadata (merged with existing)

Example:

Response

200 - application/json

metadata updated on line item

id
string
required
market_id
string | null
required
number
string
required
token
string
required
email
string | null
required
customer_note
string | null
required
currency
string
required
locale
string | null
required
total_quantity
number
required
warnings
object[]
required
item_total
string | null
required
display_item_total
string | null
required
adjustment_total
string | null
required
display_adjustment_total
string | null
required
discount_total
string | null
required
display_discount_total
string | null
required
tax_total
string | null
required
display_tax_total
string | null
required
included_tax_total
string | null
required
display_included_tax_total
string | null
required
additional_tax_total
string | null
required
display_additional_tax_total
string | null
required
total
string | null
required
display_total
string | null
required
gift_card_total
string | null
required
display_gift_card_total
string | null
required
amount_due
string | null
required
display_amount_due
string | null
required
delivery_total
string | null
required
display_delivery_total
string | null
required
store_credit_total
string | null
required
display_store_credit_total
string | null
required
covered_by_store_credit
boolean
required
current_step
string
required
completed_steps
string[]
required
requirements
object[]
required
shipping_eq_billing_address
boolean
required
discounts
object[]
required
items
object[]
required
fulfillments
object[]
required
payments
object[]
required
billing_address
object | null
required
shipping_address
object | null
required
payment_methods
object[]
required
gift_card
object | null
required
market
object | null
required