Skip to main content
PATCH
Update Order

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-User-Id
string | null

Path Parameters

document_id
string
required

Body

application/json

Input schema for updating a sales order (PATCH /orders/{id}). All fields are optional - only provided fields will be updated.

Use 'action' to trigger state transitions.

action
enum<string> | null

Actions for sales order state transitions

Permissions:

  • draft, submit_for_review: Any authenticated user
  • confirm, reject: Manager or Admin only
  • mark_in_procurement, mark_in_production, mark_delivered: Manager or Admin only
Available options:
draft,
submit_for_review,
approve,
confirm,
reject,
mark_in_procurement,
mark_in_production,
mark_partially_delivered,
mark_delivered
clientId
string | null
clientPoNumber
string | null
Maximum string length: 50
styleId
string | null
etd
string<date-time> | null
shippingTerm
string | null
deadline
string<date-time> | null
shipmentPlan
string | null
shipmentSchedule
SalesOrderShipmentScheduleInput · object[] | null
paymentTerm
string | null
estimatedQuantity
integer | null
estimatedCost
number | null
sourceQuoteId
string | null
trueCostPrice
number | null
trueCostCurrency
string | null
budgetAllowableTolerance
number | null
requestedDeliveryDate
string<date-time> | null
requestedBulkReadyDate
string<date-time> | null
notes
string | null
lineItems
SalesOrderLineItemInput · object[] | null
changeDescription
string | null

Response

Successful Response

Response after updating a sales order

success
boolean
required
message
string
required
salesOrderId
string
required
documentId
string
required
versionNumber
integer
required
status
string
required