Completes an order in the confirm state, marking it as placed.
Set notify_customer: true to send the order confirmation email.
Required scope: write_orders (for API-key authentication).
PATCH
/
api
/
v3
/
admin
/
orders
/
{id}
/
complete
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'
const client = createAdminClient({
baseUrl: 'https://your-store.com',
secretKey: 'sk_xxx',
})
const order = await client.orders.complete('or_UkLWZg9DAJ', {
notify_customer: true,
})spree api patch /orders/{id}/complete -d '{"notify_customer":true}'{
"id": "or_UkLWZg9DAJ",
"market_id": null,
"channel_id": "ch_UkLWZg9DAJ",
"number": "R813647429",
"email": "renita@hanegoodwin.biz",
"customer_note": null,
"currency": "USD",
"locale": "en",
"total_quantity": 1,
"fulfillment_status": "ready",
"payment_status": "paid",
"completed_at": "2026-07-24T18:11:45.710Z",
"item_total": "10.0",
"display_item_total": "$10.00",
"adjustment_total": "0.0",
"display_adjustment_total": "$0.00",
"discount_total": "0.0",
"display_discount_total": "$0.00",
"tax_total": "0.0",
"display_tax_total": "$0.00",
"included_tax_total": "0.0",
"display_included_tax_total": "$0.00",
"additional_tax_total": "0.0",
"display_additional_tax_total": "$0.00",
"total": "110.0",
"display_total": "$110.00",
"gift_card_total": "0.0",
"display_gift_card_total": "$0.00",
"amount_due": "0.0",
"display_amount_due": "$0.00",
"delivery_total": "100.0",
"display_delivery_total": "$100.00",
"store_credit_total": "0.0",
"display_store_credit_total": "$0.00",
"covered_by_store_credit": false,
"gift_card": null,
"market": null,
"status": "draft",
"last_ip_address": null,
"considered_risky": false,
"confirmation_delivered": false,
"store_owner_notification_delivered": null,
"payment_total": "110.0",
"display_payment_total": "$110.00",
"metadata": {},
"canceled_at": null,
"approved_at": null,
"created_at": "2026-07-24T18:11:45.520Z",
"updated_at": "2026-07-24T18:11:45.765Z",
"preferred_stock_location_id": null,
"tags": [],
"internal_note": null,
"approver_id": null,
"canceler_id": null,
"created_by_id": null,
"customer_id": "cus_UkLWZg9DAJ"
}{
"error": {
"code": "order_cannot_complete",
"message": "No payment found",
"details": {
"base": [
"No payment found"
]
}
}
}Authorizations
Secret API key for admin access
JWT token for admin user authentication
Headers
Bearer token for admin authentication
Path Parameters
Order ID
Body
application/json
Send the order confirmation email after completion.
Response
order completed
Was this page helpful?
⌘I
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'
const client = createAdminClient({
baseUrl: 'https://your-store.com',
secretKey: 'sk_xxx',
})
const order = await client.orders.complete('or_UkLWZg9DAJ', {
notify_customer: true,
})spree api patch /orders/{id}/complete -d '{"notify_customer":true}'{
"id": "or_UkLWZg9DAJ",
"market_id": null,
"channel_id": "ch_UkLWZg9DAJ",
"number": "R813647429",
"email": "renita@hanegoodwin.biz",
"customer_note": null,
"currency": "USD",
"locale": "en",
"total_quantity": 1,
"fulfillment_status": "ready",
"payment_status": "paid",
"completed_at": "2026-07-24T18:11:45.710Z",
"item_total": "10.0",
"display_item_total": "$10.00",
"adjustment_total": "0.0",
"display_adjustment_total": "$0.00",
"discount_total": "0.0",
"display_discount_total": "$0.00",
"tax_total": "0.0",
"display_tax_total": "$0.00",
"included_tax_total": "0.0",
"display_included_tax_total": "$0.00",
"additional_tax_total": "0.0",
"display_additional_tax_total": "$0.00",
"total": "110.0",
"display_total": "$110.00",
"gift_card_total": "0.0",
"display_gift_card_total": "$0.00",
"amount_due": "0.0",
"display_amount_due": "$0.00",
"delivery_total": "100.0",
"display_delivery_total": "$100.00",
"store_credit_total": "0.0",
"display_store_credit_total": "$0.00",
"covered_by_store_credit": false,
"gift_card": null,
"market": null,
"status": "draft",
"last_ip_address": null,
"considered_risky": false,
"confirmation_delivered": false,
"store_owner_notification_delivered": null,
"payment_total": "110.0",
"display_payment_total": "$110.00",
"metadata": {},
"canceled_at": null,
"approved_at": null,
"created_at": "2026-07-24T18:11:45.520Z",
"updated_at": "2026-07-24T18:11:45.765Z",
"preferred_stock_location_id": null,
"tags": [],
"internal_note": null,
"approver_id": null,
"canceler_id": null,
"created_by_id": null,
"customer_id": "cus_UkLWZg9DAJ"
}{
"error": {
"code": "order_cannot_complete",
"message": "No payment found",
"details": {
"base": [
"No payment found"
]
}
}
}
