Skip to content

Update an order​

PUT
/orders/{order_id}

Authorizations​

bearerToken|siteContext
bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)
+
siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)
or
siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Parameters​

Path Parameters

order_id*

Order identifier

Typestring
Required

Request Body​

application/json
JSON
{
"comments": "string",
"state": "string",
"customer": "string"
}

Responses​

order updated

application/json
JSON
{
"id": "string",
"state": "string",
"url": "string",
"created_at": "string",
"updated_at": "string",
"number": "string",
"customer": {
},
"totals": {
"items": 0,
"discounts": 0,
"credits": 0,
"coupons": 0,
"total": 0,
"tax": 0,
"deposit": 0,
"shipping": 0
},
"billing_address": {
},
"shipping_address": {
},
"items": [
{
}
]
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​