ReferenceOrders
Update an order
AuthorizationBearer <token>
Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.
In: header
X-Nimbu-Site<token>
Identifier of the site context when authenticating with a personal access token.
In: header
Path Parameters
order_id*string
Order identifier
Request Body
application/json
Order update payload
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PUT "https://example.com/orders/string" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "string",
"state": "string",
"url": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"customer": {},
"currency": "string",
"totals": {},
"billing_address": {},
"shipping_address": {},
"shipping_method": "string",
"items": [
{
"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"product_id": "string",
"product_name": "string",
"variant_id": "string",
"variant_name": "string",
"sku": "string",
"quantity": 0,
"price": 0,
"price_excl_tax": 0,
"vendor": "string",
"type": "string",
"deposit_amount": 0,
"extras": [
{}
],
"group": "string"
}
],
"number": "string",
"paid": true,
"fulfilled": true,
"paid_at": "2019-08-24T14:15:22Z",
"payment": {},
"coupons": [
"string"
],
"expires_at": "2019-08-24T14:15:22Z",
"comments": "string",
"invoice_note": "string",
"metadata": {},
"cancel_reason": "string",
"shipment_tracking_code": "string",
"placed_at": "2019-08-24T14:15:22Z",
"invoice_number": "string",
"credit_note_number": "string",
"digital": true,
"attachment_status": "string",
"attachments_with_warnings": true,
"attachments": [
{}
]
}