Checkout
Update Checkout
- Community
- Showcase
- Github
- Blog
- Authentication
- Account
- Account / Address
- Account / Credit Cards
- Account / Orders
- Order Status
- Cart
- Cart / Line Items
- Cart / Other
- Cart / Coupons
- Checkout
- Checkout / State
- Checkout / Shipments
- Checkout / Payments
- Checkout / Store Credit
- Products
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
- Authentication
- Addresses
- Adjustments
- Classifications
- CMS Pages
- CMS Sections
- Countries
- Data Feeds
- Digital Links
- Digital Assets
- Line Items
- Menu Items
- Menus
- Option Types
- Option Values
- Orders
- Payment Methods
- Payments
- Products
- Promotion Actions
- Promotion Categories
- Promotion Rules
- Promotions
- Roles
- Shipments
- Shipping Categories
- Shipping Methods
- States
- Stock Items
- Stock Locations
- Store Credit Categories
- Store Credit Types
- Store Credits
- Tax Categories
- Tax Rates
- Taxonomies
- Taxons
- Users
- Variants
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Storefront API
Platform API
Checkout
Update Checkout
The Update Checkout endpoint allows you to manage the typical stages of an e-commerce checkout system.
PATCH
/
api
/
v2
/
storefront
/
checkout
X-Spree-Order-Token
string
*
X-Spree-Order-Token
Required
string
Order token to authorize Cart and Checkout requests.
include
string
include
string
Specify the related resources you would like to receive in the response body. More Information.
object
order
object
order
object
email
string
email
string
Add Example Value
bill_address_attributes
· object
bill_address_attributes
object
Add Example Value
firstname
string
*
firstname
Required
string
lastname
string
*
lastname
Required
string
address1
string
*
address1
Required
string
Street address
address2
string
address2
string
Additional address information, floor no etc
city
string
*
city
Required
string
City, town
phone
string
phone
string
zipcode
string
zipcode
string
Valid zipcode, will be validated against the selected Country
state_name
string
state_name
string
State/region/province 2 letter abbreviation
country_iso
string
*
country_iso
Required
string
Country ISO (2-chars) or ISO3 (3-chars) code. List of all codes
company
string
company
string
Company name
Add Example Value
label
string
label
string
The internal name for this address (Work, Home)
Add Example Value
ship_address_attributes
· object
ship_address_attributes
object
Add Example Value
firstname
string
*
firstname
Required
string
lastname
string
*
lastname
Required
string
address1
string
*
address1
Required
string
Street address
address2
string
address2
string
Additional address information, floor no etc
city
string
*
city
Required
string
City, town
phone
string
phone
string
zipcode
string
zipcode
string
Valid zipcode, will be validated against the selected Country
state_name
string
state_name
string
State/region/province 2 letter abbreviation
country_iso
string
*
country_iso
Required
string
Country ISO (2-chars) or ISO3 (3-chars) code. List of all codes
company
string
company
string
Company name
Add Example Value
label
string
label
string
The internal name for this address (Work, Home)
Add Example Value
shipments_attributes
array
shipments_attributes
array
payments_attributes
array
payments_attributes
array
curl --request PATCH \
--url https://demo.spreecommerce.org/api/v2/storefront/checkout \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Spree-Order-Token: <api-key>' \
--data '{
"order": {
"email": "john@snow.org",
"bill_address_attributes": {
"firstname": "John",
"lastname": "Snow",
"address1": "7735 Old Georgetown Road",
"city": "Bethesda",
"phone": "3014445002",
"zipcode": "20814",
"state_name": "MD",
"country_iso": "US"
},
"ship_address_attributes": {
"firstname": "John",
"lastname": "Snow",
"address1": "7735 Old Georgetown Road",
"city": "Bethesda",
"phone": "3014445002",
"zipcode": "20814",
"state_name": "MD",
"country_iso": "US"
}
}
}'{
"data": {
"id": "17",
"type": "cart",
"attributes": {
"number": "R233871560",
"item_total": "0.0",
"total": "0.0",
"ship_total": "0.0",
"adjustment_total": "0.0",
"created_at": "2021-09-28T22:15:07.471Z",
"updated_at": "2021-09-28T22:15:07.471Z",
"completed_at": null,
"included_tax_total": "0.0",
"additional_tax_total": "0.0",
"display_additional_tax_total": "$0.00",
"display_included_tax_total": "$0.00",
"tax_total": "0.0",
"currency": "USD",
"state": "cart",
"token": "zTEpsukRq_yEUcXVCSv0uw1632867307450",
"email": null,
"display_item_total": "$0.00",
"display_ship_total": "$0.00",
"display_adjustment_total": "$0.00",
"display_tax_total": "$0.00",
"promo_total": "0.0",
"display_promo_total": "$0.00",
"item_count": 0,
"special_instructions": null,
"display_total": "$0.00",
"pre_tax_item_amount": "0.0",
"display_pre_tax_item_amount": "$0.00",
"pre_tax_total": "0.0",
"display_pre_tax_total": "$0.00",
"shipment_state": null,
"payment_state": null
},
"relationships": {
"line_items": {
"data": []
},
"variants": {
"data": []
},
"promotions": {
"data": []
},
"payments": {
"data": []
},
"shipments": {
"data": []
},
"user": {
"data": null
},
"billing_address": {
"data": null
},
"shipping_address": {
"data": null
}
}
}
}Authorizations
X-Spree-Order-Token
string
headerrequiredOrder token to authorize Cart and Checkout requests.
Query Parameters
include
string
Specify the related resources you would like to receive in the response body. More Information.
Body
application/vnd.api+json
order
object
order.email
string
order.bill_address_attributes
object
order.bill_address_attributes.firstname
string
requiredorder.bill_address_attributes.lastname
string
requiredorder.bill_address_attributes.address1
string
requiredStreet address
order.bill_address_attributes.address2
string
Additional address information, floor no etc
order.bill_address_attributes.city
string
requiredCity, town
order.bill_address_attributes.phone
string
order.bill_address_attributes.zipcode
string
Valid zipcode, will be validated against the selected Country
order.bill_address_attributes.state_name
string
State/region/province 2 letter abbreviation
order.bill_address_attributes.country_iso
string
requiredCountry ISO (2-chars) or ISO3 (3-chars) code. List of all codes
order.bill_address_attributes.company
string
Company name
order.bill_address_attributes.label
string
The internal name for this address (Work, Home)
order.ship_address_attributes
object
order.ship_address_attributes.firstname
string
requiredorder.ship_address_attributes.lastname
string
requiredorder.ship_address_attributes.address1
string
requiredStreet address
order.ship_address_attributes.address2
string
Additional address information, floor no etc
order.ship_address_attributes.city
string
requiredCity, town
order.ship_address_attributes.phone
string
order.ship_address_attributes.zipcode
string
Valid zipcode, will be validated against the selected Country
order.ship_address_attributes.state_name
string
State/region/province 2 letter abbreviation
order.ship_address_attributes.country_iso
string
requiredCountry ISO (2-chars) or ISO3 (3-chars) code. List of all codes
order.ship_address_attributes.company
string
Company name
order.ship_address_attributes.label
string
The internal name for this address (Work, Home)
order.shipments_attributes
object[]
order.shipments_attributes.id
string
requiredThe Shipment id
order.shipments_attributes.selected_shipping_rate_id
string
requiredThe Shipping Rate id
order.payments_attributes
object[]
order.payments_attributes.payment_method_id
string
requiredThe id of the Payment Method
order.payments_attributes.source_attributes
object
requiredorder.payments_attributes.source_attributes.gateway_payment_profile_id
string
order.payments_attributes.source_attributes.month
number
order.payments_attributes.source_attributes.year
number
order.payments_attributes.source_attributes.cc_type
string
order.payments_attributes.source_attributes.name
string
Response
200 - application/vnd.api+json
data
object
requiredThe Cart provides a central place to collect information about an order, including line items, adjustments, payments, addresses, and shipments. Read more in Spree docs
data.id
string
requireddata.type
string
default: cartrequireddata.attributes
object
requireddata.attributes.number
string
Used as the {order_number} value in the URI to identify a completed order.
data.attributes.token
string
Used for authorizing actions through the X-Spree-Order-Token API Key.
data.attributes.item_total
string
data.attributes.total
string
data.attributes.ship_total
string
data.attributes.adjustment_total
string
data.attributes.created_at
string
data.attributes.updated_at
string
data.attributes.completed_at
string | null
data.attributes.included_tax_total
string
data.attributes.additional_tax_total
string
data.attributes.display_additional_tax_total
string
data.attributes.tax_total
string
data.attributes.currency
string
data.attributes.state
enum<string>
State of the Cart in the Checkout flow. Please see <a href="/developer/core-concepts/orders#the-order-state-machine"> The Order State machine </a> for a full list with description.
Available options:
cart, address, delivery, payment, confirm, complete data.attributes.email
string | null
data.attributes.display_item_total
string
data.attributes.display_ship_total
string
data.attributes.display_adjustment_total
string
data.attributes.display_included_tax_total
string
data.attributes.promo_total
string
data.attributes.display_promo_total
string
data.attributes.item_count
number
Total quantity number of all items added to the Cart
data.attributes.special_instructions
string | null
Message added by the Customer
data.attributes.display_total
string
data.attributes.pre_tax_item_amount
string
data.attributes.display_pre_tax_item_amount
string
data.attributes.pre_tax_total
string
data.attributes.display_tax_total
string
data.attributes.display_pre_tax_total
string
data.attributes.shipment_state
enum<string> | null
Overall state of the Shipments. Please see <a href="/developer/core-concepts/orders#order-shipment-states-1"> Order Shipments states </a> for a full list with description.
Available options:
pending, backorder, canceled, partial, ready, shipped data.attributes.payment_state
enum<string> | null
Overall state of the Payments. Please see <a href="/developer/core-concepts/orders#order-payment-states"> Order Payments states </a> for a full list with description.
Available options:
balance_due, credit_owed, failed, paid, void data.relationships
object
requireddata.relationships.line_items
object
data.relationships.line_items.data
array
data.relationships.line_items.data.id
string
requireddata.relationships.line_items.data.type
string
requireddata.relationships.variants
object
data.relationships.variants.data
array
data.relationships.variants.data.id
string
requireddata.relationships.variants.data.type
string
requireddata.relationships.promotions
object
data.relationships.promotions.data
array
data.relationships.promotions.data.id
string
requireddata.relationships.promotions.data.type
string
requireddata.relationships.payments
object
data.relationships.payments.data
array
data.relationships.payments.data.id
string
requireddata.relationships.payments.data.type
string
requireddata.relationships.shipments
object
data.relationships.shipments.data
array
data.relationships.shipments.data.id
string
requireddata.relationships.shipments.data.type
string
requireddata.relationships.user
object
data.relationships.user.data
object | null
data.relationships.user.data.id
string
requireddata.relationships.user.data.type
string
requireddata.relationships.billing_address
object
data.relationships.billing_address.data
object | null
data.relationships.billing_address.data.id
string
requireddata.relationships.billing_address.data.type
string
requireddata.relationships.shipping_address
object
data.relationships.shipping_address.data
object | null
data.relationships.shipping_address.data.id
string
requireddata.relationships.shipping_address.data.type
string
requiredincluded
object[]
included.id
string
requiredincluded.type
string
default: line_itemrequiredincluded.attributes
object
requiredincluded.attributes.name
string
included.attributes.quantity
integer
included.attributes.slug
string
included.attributes.options_text
string
included.attributes.price
string
Price of Product per quantity
included.attributes.currency
string
included.attributes.display_price
string
Price of Product per quantity
included.attributes.total
string
Total price of Line Item including adjastments, promotions and taxes
included.attributes.display_total
string
Total price of Line Item including adjastments, promotions and taxes
included.attributes.adjustment_total
string
TBD
included.attributes.display_adjustment_total
string
TBD
included.attributes.additional_tax_total
string
included.attributes.display_additional_tax_total
string
included.attributes.discounted_amount
string
included.attributes.display_discounted_amount
string
included.attributes.pre_tax_amount
string
included.attributes.display_pre_tax_amount
string
included.attributes.promo_total
string
included.attributes.display_promo_total
string
included.attributes.included_tax_total
string
Taxes included in the price, eg. VAT
included.attributes.display_inluded_tax_total
string
included.attributes.public_metadata
object
The public metadata for the Line Item.
included.relationships
object
requiredincluded.relationships.variant
object
included.relationships.variant.data
object | null
included.relationships.variant.data.id
string
requiredincluded.relationships.variant.data.type
string
requiredincluded.relationships.digital_links
object
included.relationships.digital_links.data
array
included.relationships.digital_links.data.id
string
requiredincluded.relationships.digital_links.data.type
string
requiredWas this page helpful?
curl --request PATCH \
--url https://demo.spreecommerce.org/api/v2/storefront/checkout \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Spree-Order-Token: <api-key>' \
--data '{
"order": {
"email": "john@snow.org",
"bill_address_attributes": {
"firstname": "John",
"lastname": "Snow",
"address1": "7735 Old Georgetown Road",
"city": "Bethesda",
"phone": "3014445002",
"zipcode": "20814",
"state_name": "MD",
"country_iso": "US"
},
"ship_address_attributes": {
"firstname": "John",
"lastname": "Snow",
"address1": "7735 Old Georgetown Road",
"city": "Bethesda",
"phone": "3014445002",
"zipcode": "20814",
"state_name": "MD",
"country_iso": "US"
}
}
}'{
"data": {
"id": "17",
"type": "cart",
"attributes": {
"number": "R233871560",
"item_total": "0.0",
"total": "0.0",
"ship_total": "0.0",
"adjustment_total": "0.0",
"created_at": "2021-09-28T22:15:07.471Z",
"updated_at": "2021-09-28T22:15:07.471Z",
"completed_at": null,
"included_tax_total": "0.0",
"additional_tax_total": "0.0",
"display_additional_tax_total": "$0.00",
"display_included_tax_total": "$0.00",
"tax_total": "0.0",
"currency": "USD",
"state": "cart",
"token": "zTEpsukRq_yEUcXVCSv0uw1632867307450",
"email": null,
"display_item_total": "$0.00",
"display_ship_total": "$0.00",
"display_adjustment_total": "$0.00",
"display_tax_total": "$0.00",
"promo_total": "0.0",
"display_promo_total": "$0.00",
"item_count": 0,
"special_instructions": null,
"display_total": "$0.00",
"pre_tax_item_amount": "0.0",
"display_pre_tax_item_amount": "$0.00",
"pre_tax_total": "0.0",
"display_pre_tax_total": "$0.00",
"shipment_state": null,
"payment_state": null
},
"relationships": {
"line_items": {
"data": []
},
"variants": {
"data": []
},
"promotions": {
"data": []
},
"payments": {
"data": []
},
"shipments": {
"data": []
},
"user": {
"data": null
},
"billing_address": {
"data": null
},
"shipping_address": {
"data": null
}
}
}
}