Skip to main content
PATCH
Update Order

Authorizations

Authorization
string
header
required

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Path Parameters

id
string<uuid>
required

Body

application/json

Update order fields and/or replace order lines. When lines is provided, all existing lines are deleted and replaced. Any key other than the ones below is dropped silently.

orderNumber
string

New order number, unique per company.

orderDate
string<date-time>

Order date, ISO 8601.

deliveryDate
string<date-time>

Optional ISO 8601 delivery date. Applies only while no line of the order has its own date (lines[].deliveryDate, sent or stored): then it lands as sent. Once a line is dated, the order's deliveryDate is the earliest line date and this value is ignored (still 200, nothing changed).

supplierId
string<uuid>

UUID of an existing supplier of your company.

orderType
enum<string>

purchase = inbound order from a supplier, sale = outbound order to a customer

Available options:
purchase,
sale
lines
object[]

Replaces all existing order lines

Response

Updated successfully

success
boolean
required

Always true on success.