Docs
Update Order
PATCH /orders/{orderId}
PATCH
/orders/{orderId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Updates all editable fields on an existing order, including status, notes, dates, and billing/delivery details.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| orderId | Guid | Required | The ID of the order to update. Replace `{{orderId}}` in the URL. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Order name. |
| status | string | Required | Order status (e.g. `"Draft"`, `"Submitted"`, `"Confirmed"`). |
| internalNotes | string | Optional | Internal-facing notes. |
| externalNotes | string | Optional | External/vendor-facing notes. |
| isDelivery | bool | Required | Whether this order requires delivery at the order level. |
| startDateTime | DateTime | Required | Order start date/time (ISO 8601). |
| endDateTime | DateTime | Required | Order end date/time (ISO 8601). |
| billingInformation | Billing | Optional | Billing contact and address. Pass `null` to clear. |
| billingInformation.name | string | Optional | Billing contact name. |
| billingInformation.company | string | Optional | Company name. |
| billingInformation.email | string | Optional | Email. |
| billingInformation.phone | string | Optional | Phone. |
| billingInformation.address | string | Optional | Street address. |
| billingInformation.city | string | Optional | City. |
| billingInformation.state | string | Optional | State/province. |
| billingInformation.country | string | Optional | Country. |
| billingInformation.postalCode | string | Optional | Postal/ZIP code. |
| deliveryInformation | Delivery | Optional | Delivery address. Same shape as `billingInformation`. Pass `null` if not applicable. |
Response
Returns 200 OK with an empty body on success.