Orders
Update order status
Updates the order status to one of: placed, refunded, compensated, released, delivered, or cancelled. Creates a history entry tracking the status transition. Publishes an order updated event.
PATCH
/
api
/
v1
/
{team_slug}
/
{app_slug}
/
orders
/
{order_id}
/
status
Error
A valid request URL is required to generate request examples{
"data": {
"billing_address": {
"address_type": "<string>",
"city": "<string>",
"country_code": "<string>",
"created_at": "<string>",
"email": "<string>",
"family_name": "<string>",
"given_name": "<string>",
"id": "<string>",
"postal_code": "<string>",
"state_or_province": "<string>",
"street_address": "<string>",
"street_address_2": "<string>",
"telephone_number": "<string>",
"updated_at": "<string>"
},
"bonus_total": 123,
"country_code": "<string>",
"created_at": "<string>",
"currency_code": "<string>",
"discount_total": 123,
"discounts": [
{
"created_at": "<string>",
"discount_id": "<string>",
"id": "<string>",
"name": "<string>",
"order_id": "<string>",
"updated_at": "<string>"
}
],
"gift_card_total": 123,
"grand_total": 123,
"id": "<string>",
"language_code": "<string>",
"merchant_user": {
"email": "<string>",
"id": "<string>",
"name": "<string>",
"surname": "<string>"
},
"order_lines": [
{
"base_price_amount": 123,
"created_at": "<string>",
"currency_code": "<string>",
"first_image_path": "<string>",
"id": "<string>",
"order_id": "<string>",
"product_id": "<string>",
"product_name": "<string>",
"product_number": "<string>",
"quantity": 123,
"short_description": "<string>",
"tax_group_id": "<string>",
"total_discount_amount": 123,
"total_price_amount": 123,
"total_sale_price": 123,
"total_tax_amount": 123,
"updated_at": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"variant_number": "<string>"
}
],
"payment_method": "<string>",
"payment_method_id": "<string>",
"payment_method_name": "<string>",
"reference": "<string>",
"session_id": "<string>",
"shipping_address": {
"address_type": "<string>",
"city": "<string>",
"country_code": "<string>",
"created_at": "<string>",
"email": "<string>",
"family_name": "<string>",
"given_name": "<string>",
"id": "<string>",
"postal_code": "<string>",
"state_or_province": "<string>",
"street_address": "<string>",
"street_address_2": "<string>",
"telephone_number": "<string>",
"updated_at": "<string>"
},
"shipping_methods": [
"<string>"
],
"shipping_total": 123,
"source": "<string>",
"sub_total": 123,
"tax_total": 123,
"updated_at": "<string>",
"user_content": [
{
"content_type": "<string>",
"filename": "<string>",
"id": "<string>",
"url": "<string>"
}
]
},
"details": [
"<string>"
],
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}Path Parameters
App slug
Team slug
Order ID (UUID)
Body
application/json
Status update data
Available options:
placed, refunded, compensated, released, delivered, cancelled ⌘I
Error
A valid request URL is required to generate request examples{
"data": {
"billing_address": {
"address_type": "<string>",
"city": "<string>",
"country_code": "<string>",
"created_at": "<string>",
"email": "<string>",
"family_name": "<string>",
"given_name": "<string>",
"id": "<string>",
"postal_code": "<string>",
"state_or_province": "<string>",
"street_address": "<string>",
"street_address_2": "<string>",
"telephone_number": "<string>",
"updated_at": "<string>"
},
"bonus_total": 123,
"country_code": "<string>",
"created_at": "<string>",
"currency_code": "<string>",
"discount_total": 123,
"discounts": [
{
"created_at": "<string>",
"discount_id": "<string>",
"id": "<string>",
"name": "<string>",
"order_id": "<string>",
"updated_at": "<string>"
}
],
"gift_card_total": 123,
"grand_total": 123,
"id": "<string>",
"language_code": "<string>",
"merchant_user": {
"email": "<string>",
"id": "<string>",
"name": "<string>",
"surname": "<string>"
},
"order_lines": [
{
"base_price_amount": 123,
"created_at": "<string>",
"currency_code": "<string>",
"first_image_path": "<string>",
"id": "<string>",
"order_id": "<string>",
"product_id": "<string>",
"product_name": "<string>",
"product_number": "<string>",
"quantity": 123,
"short_description": "<string>",
"tax_group_id": "<string>",
"total_discount_amount": 123,
"total_price_amount": 123,
"total_sale_price": 123,
"total_tax_amount": 123,
"updated_at": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"variant_number": "<string>"
}
],
"payment_method": "<string>",
"payment_method_id": "<string>",
"payment_method_name": "<string>",
"reference": "<string>",
"session_id": "<string>",
"shipping_address": {
"address_type": "<string>",
"city": "<string>",
"country_code": "<string>",
"created_at": "<string>",
"email": "<string>",
"family_name": "<string>",
"given_name": "<string>",
"id": "<string>",
"postal_code": "<string>",
"state_or_province": "<string>",
"street_address": "<string>",
"street_address_2": "<string>",
"telephone_number": "<string>",
"updated_at": "<string>"
},
"shipping_methods": [
"<string>"
],
"shipping_total": 123,
"source": "<string>",
"sub_total": 123,
"tax_total": 123,
"updated_at": "<string>",
"user_content": [
{
"content_type": "<string>",
"filename": "<string>",
"id": "<string>",
"url": "<string>"
}
]
},
"details": [
"<string>"
],
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}