Update one or more existing orders. Each request object must include the order_id of the order to update, plus any fields you want to change
Documentation Index
Fetch the complete documentation index at: https://quickbutik.dev/llms.txt
Use this file to discover all available pages before exploring further.
Basic Authentication with API Keys
The Quickbutik API uses Basic Authentication where you use your API key as both the username and password.
How it works:
api_key:api_key (using the SAME API key for both username and password)Authorization: Basic ENCODED_STRINGExample:
sk_live_abc123sk_live_abc123:sk_live_abc123c2tfbGl2ZV9hYmMxMjM6c2tfbGl2ZV9hYmMxMjM=Authorization: Basic c2tfbGl2ZV9hYmMxMjM6c2tfbGl2ZV9hYmMxMjM=cURL Example:
curl https://api.quickbutik.com/v1/orders -u your_api_key:your_api_keyAll API requests must be made over HTTPS. Requests made over HTTP will be rejected.
API keys can be generated in the Quickbutik Control Panel under Settings → API.
ID of the order to update. Required.
"948102"
Change the order state.
paid, done, cancelled, unpaid "paid"
Optional. Used together with status done to attach tracking information to the shipment.
Optional. Used together with status done — send shipping confirmation email to customer.
"true"
Optional. Used together with status paid — skip the order confirmation email.
"true"
Optional. Used together with status done. Default is true.
"false"
Optional. Used together with status paid — skip webhook notifications for this status change.
"true"
Optional. Used together with status paid. Two-letter language code (ISO 639-1) used for customer-facing emails.
"en"
Specify products in this order. When used, all other existing products in the order will be removed and be replaced with the ones specified here
Optional. If you would like to add products from the order. You can pass multiple objects/products into this parameter, to add multiple at once
Optional. If you would like to remove products from the order. You can pass multiple objects/products into this parameter, to remove multiple at once
Optional. Set only if you would like to add a discount for this order
Optional. Set only if you would like to add a discount for this order
Optional. Update customer details on the order.
Optional. Update payment details on the order.
Optional. Update the shipping method on the order.
Optional. Custom metadata to set on the order. Existing keys are overwritten, others are left in place.
Orders updated successfully