Orders
Update an Order
Storefront API
- 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
- Stripe
- Products
- Vendors
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
Platform API
- 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
- Vendors
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Orders
Update an Order
Updates an Order
PATCH
/
api
/
v2
/
platform
/
orders
/
{id}
curl --request PATCH \
--url http://{defaultHost}/api/v2/platform/orders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"order": {
"item_total": 170.9,
"total": 190.9,
"state": "complete",
"adjustment_total": 20,
"user_id": "1",
"completed_at": "2022-11-08 19:33:50 UTC",
"bill_address_id": "1",
"ship_address_id": "1",
"payment_total": 190.9,
"shipment_state": "shipped",
"payment_state": "paid",
"email": "[email protected]",
"special_instructions": "I need it ASAP!",
"currency": "USD",
"last_ip_address": "127.0.0.1",
"created_by_id": "1",
"shipment_total": 10,
"additional_tax_total": 10,
"promo_total": 0,
"channel": "online",
"included_tax_total": 0,
"item_count": 2,
"approver_id": "<string>",
"approved_at": "2022-11-08 19:33:50 UTC",
"confirmation_delivered": true,
"considered_risky": true,
"canceled_at": "<string>",
"canceler_id": "<string>",
"taxable_adjustment_total": 170.9,
"non_taxable_adjustment_total": 10,
"store_owner_notification_delivered": true,
"bill_address_attributes": {
"address": {
"country_id": "224",
"state_id": "516",
"state_name": "New York",
"address1": "5th ave",
"address2": "1st suite",
"city": "NY",
"zipcode": "10001",
"phone": "+1 123 456 789",
"alternative_phone": "<string>",
"firstname": "John",
"lastname": "Snow",
"label": "My home address",
"company": "Vendo Connect Inc",
"user_id": "<string>",
"public_metadata": {
"distance_from_city_in_km": 10,
"location_type": "building"
},
"private_metadata": {
"close_to_shop": true
}
}
},
"ship_address_attributes": {
"address": {
"country_id": "224",
"state_id": "516",
"state_name": "New York",
"address1": "5th ave",
"address2": "1st suite",
"city": "NY",
"zipcode": "10001",
"phone": "+1 123 456 789",
"alternative_phone": "<string>",
"firstname": "John",
"lastname": "Snow",
"label": "My home address",
"company": "Vendo Connect Inc",
"user_id": "<string>",
"public_metadata": {
"distance_from_city_in_km": 10,
"location_type": "building"
},
"private_metadata": {
"close_to_shop": true
}
}
},
"line_items_attributes": [
{
"line_item": {
"variant_id": "1",
"quantity": 2
}
}
],
"public_metadata": {},
"private_metadata": {}
}
}'
{
"data": {
"id": "47",
"type": "order",
"attributes": {
"number": "R484277352",
"item_total": "10.0",
"total": "110.0",
"state": "delivery",
"adjustment_total": "0.0",
"completed_at": null,
"payment_total": "0.0",
"shipment_state": null,
"payment_state": null,
"email": "[email protected]",
"special_instructions": null,
"created_at": "2022-11-08T19:34:38.200Z",
"updated_at": "2022-11-08T19:34:38.599Z",
"currency": "USD",
"last_ip_address": null,
"shipment_total": "100.0",
"additional_tax_total": "0.0",
"promo_total": "0.0",
"channel": "spree",
"included_tax_total": "0.0",
"item_count": 1,
"approved_at": null,
"confirmation_delivered": false,
"canceled_at": null,
"state_lock_version": 0,
"taxable_adjustment_total": "0.0",
"non_taxable_adjustment_total": "0.0",
"store_owner_notification_delivered": null,
"public_metadata": {},
"private_metadata": {},
"internal_note": null,
"display_ship_total": "$100.00",
"display_shipment_total": "$100.00",
"display_outstanding_balance": "$110.00",
"display_item_total": "$10.00",
"display_adjustment_total": "$0.00",
"display_included_tax_total": "$0.00",
"display_additional_tax_total": "$0.00",
"display_tax_total": "$0.00",
"display_promo_total": "$0.00",
"display_total": "$110.00",
"display_cart_promo_total": "$0.00",
"display_pre_tax_item_amount": "$10.00",
"display_pre_tax_total": "$10.00",
"display_total_applicable_store_credit": "$0.00",
"display_total_applied_store_credit": "$0.00",
"display_order_total_after_store_credit": "$110.00",
"display_total_available_store_credit": "$0.00",
"display_store_credit_remaining_after_capture": "$0.00"
},
"relationships": {
"user": {
"data": {
"id": "47",
"type": "user"
}
},
"created_by": {
"data": null
},
"approver": {
"data": null
},
"canceler": {
"data": null
},
"bill_address": {
"data": {
"id": "61",
"type": "address"
}
},
"ship_address": {
"data": {
"id": "62",
"type": "address"
}
},
"line_items": {
"data": [
{
"id": "38",
"type": "line_item"
}
]
},
"payments": {
"data": []
},
"shipments": {
"data": [
{
"id": "3",
"type": "shipment"
}
]
},
"state_changes": {
"data": []
},
"return_authorizations": {
"data": []
},
"reimbursements": {
"data": []
},
"adjustments": {
"data": []
},
"all_adjustments": {
"data": []
},
"order_promotions": {
"data": []
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Body
application/json
Example:
170.9
Example:
190.9
Available options:
cart
, address
, delivery
, payment
, confirm
, complete
, canceled
Example:
"complete"
Example:
20
Example:
"1"
Example:
"2022-11-08 19:33:50 UTC"
Example:
"1"
Example:
"1"
Example:
190.9
Available options:
backorder
, canceled
, partial
, pending
, ready
, shipped
Example:
"shipped"
Available options:
balance_due
, credit_owed
, failed
, paid
, void
Example:
"paid"
Example:
Example:
"I need it ASAP!"
Example:
"USD"
Example:
"127.0.0.1"
Example:
"1"
Example:
10
Example:
10
Example:
0
Example:
"online"
Example:
0
Example:
2
Example:
"2022-11-08 19:33:50 UTC"
Example:
true
Example:
true
Example:
170.9
Example:
10
Example:
true
Example:
"224"
Example:
"516"
Example:
"New York"
Example:
"5th ave"
Example:
"1st suite"
Example:
"NY"
Example:
"10001"
Example:
"+1 123 456 789"
Example:
"John"
Example:
"Snow"
Example:
"My home address"
Example:
"Vendo Connect Inc"
Example:
{
"distance_from_city_in_km": 10,
"location_type": "building"
}
Example:
{ "close_to_shop": true }
Example:
"224"
Example:
"516"
Example:
"New York"
Example:
"5th ave"
Example:
"1st suite"
Example:
"NY"
Example:
"10001"
Example:
"+1 123 456 789"
Example:
"John"
Example:
"Snow"
Example:
"My home address"
Example:
"Vendo Connect Inc"
Example:
{
"distance_from_city_in_km": 10,
"location_type": "building"
}
Example:
{ "close_to_shop": true }
Was this page helpful?
curl --request PATCH \
--url http://{defaultHost}/api/v2/platform/orders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"order": {
"item_total": 170.9,
"total": 190.9,
"state": "complete",
"adjustment_total": 20,
"user_id": "1",
"completed_at": "2022-11-08 19:33:50 UTC",
"bill_address_id": "1",
"ship_address_id": "1",
"payment_total": 190.9,
"shipment_state": "shipped",
"payment_state": "paid",
"email": "[email protected]",
"special_instructions": "I need it ASAP!",
"currency": "USD",
"last_ip_address": "127.0.0.1",
"created_by_id": "1",
"shipment_total": 10,
"additional_tax_total": 10,
"promo_total": 0,
"channel": "online",
"included_tax_total": 0,
"item_count": 2,
"approver_id": "<string>",
"approved_at": "2022-11-08 19:33:50 UTC",
"confirmation_delivered": true,
"considered_risky": true,
"canceled_at": "<string>",
"canceler_id": "<string>",
"taxable_adjustment_total": 170.9,
"non_taxable_adjustment_total": 10,
"store_owner_notification_delivered": true,
"bill_address_attributes": {
"address": {
"country_id": "224",
"state_id": "516",
"state_name": "New York",
"address1": "5th ave",
"address2": "1st suite",
"city": "NY",
"zipcode": "10001",
"phone": "+1 123 456 789",
"alternative_phone": "<string>",
"firstname": "John",
"lastname": "Snow",
"label": "My home address",
"company": "Vendo Connect Inc",
"user_id": "<string>",
"public_metadata": {
"distance_from_city_in_km": 10,
"location_type": "building"
},
"private_metadata": {
"close_to_shop": true
}
}
},
"ship_address_attributes": {
"address": {
"country_id": "224",
"state_id": "516",
"state_name": "New York",
"address1": "5th ave",
"address2": "1st suite",
"city": "NY",
"zipcode": "10001",
"phone": "+1 123 456 789",
"alternative_phone": "<string>",
"firstname": "John",
"lastname": "Snow",
"label": "My home address",
"company": "Vendo Connect Inc",
"user_id": "<string>",
"public_metadata": {
"distance_from_city_in_km": 10,
"location_type": "building"
},
"private_metadata": {
"close_to_shop": true
}
}
},
"line_items_attributes": [
{
"line_item": {
"variant_id": "1",
"quantity": 2
}
}
],
"public_metadata": {},
"private_metadata": {}
}
}'
{
"data": {
"id": "47",
"type": "order",
"attributes": {
"number": "R484277352",
"item_total": "10.0",
"total": "110.0",
"state": "delivery",
"adjustment_total": "0.0",
"completed_at": null,
"payment_total": "0.0",
"shipment_state": null,
"payment_state": null,
"email": "[email protected]",
"special_instructions": null,
"created_at": "2022-11-08T19:34:38.200Z",
"updated_at": "2022-11-08T19:34:38.599Z",
"currency": "USD",
"last_ip_address": null,
"shipment_total": "100.0",
"additional_tax_total": "0.0",
"promo_total": "0.0",
"channel": "spree",
"included_tax_total": "0.0",
"item_count": 1,
"approved_at": null,
"confirmation_delivered": false,
"canceled_at": null,
"state_lock_version": 0,
"taxable_adjustment_total": "0.0",
"non_taxable_adjustment_total": "0.0",
"store_owner_notification_delivered": null,
"public_metadata": {},
"private_metadata": {},
"internal_note": null,
"display_ship_total": "$100.00",
"display_shipment_total": "$100.00",
"display_outstanding_balance": "$110.00",
"display_item_total": "$10.00",
"display_adjustment_total": "$0.00",
"display_included_tax_total": "$0.00",
"display_additional_tax_total": "$0.00",
"display_tax_total": "$0.00",
"display_promo_total": "$0.00",
"display_total": "$110.00",
"display_cart_promo_total": "$0.00",
"display_pre_tax_item_amount": "$10.00",
"display_pre_tax_total": "$10.00",
"display_total_applicable_store_credit": "$0.00",
"display_total_applied_store_credit": "$0.00",
"display_order_total_after_store_credit": "$110.00",
"display_total_available_store_credit": "$0.00",
"display_store_credit_remaining_after_capture": "$0.00"
},
"relationships": {
"user": {
"data": {
"id": "47",
"type": "user"
}
},
"created_by": {
"data": null
},
"approver": {
"data": null
},
"canceler": {
"data": null
},
"bill_address": {
"data": {
"id": "61",
"type": "address"
}
},
"ship_address": {
"data": {
"id": "62",
"type": "address"
}
},
"line_items": {
"data": [
{
"id": "38",
"type": "line_item"
}
]
},
"payments": {
"data": []
},
"shipments": {
"data": [
{
"id": "3",
"type": "shipment"
}
]
},
"state_changes": {
"data": []
},
"return_authorizations": {
"data": []
},
"reimbursements": {
"data": []
},
"adjustments": {
"data": []
},
"all_adjustments": {
"data": []
},
"order_promotions": {
"data": []
}
}
}
}