Skip to main content
GET
Get Order

Authorizations

Authorization
string
header
required

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

Path Parameters

document_id
string
required

Query Parameters

version
integer | null

Optional sales order version number to view

Required range: x >= 1

Response

Successful Response

Full sales order detail for GET /orders/{id}

Includes version history so frontend gets everything in one call.

id
string
required
internalId
string
required
versionNumber
integer
required
currentVersion
integer
required
createdAt
string
required
createdBy
string
required
clientId
string
required
clientName
string
required
etd
string
required
shippingTerm
string
required
paymentTerm
string
required
status
string
required
budgetApproved
boolean
required
timelineApproved
boolean
required
totalQuantity
integer
required
finalVersion
integer | null
isFinal
boolean
default:false
clientPoNumber
string | null
styleId
string | null
styleCode
string | null
styles
SalesOrderStyleRef · object[]
deadline
string | null
shipmentPlan
string | null
shipmentSchedule
SalesOrderShipmentScheduleOutput · object[]
estimatedQuantity
integer | null
estimatedCost
number | null
sourceQuoteId
string | null
trueCostPrice
number | null
trueCostCurrency
string | null
budgetAllowableTolerance
number | null
default:0
budgetApprovedAt
string | null
budgetApprovedBy
string | null
timelineApprovedAt
string | null
timelineApprovedBy
string | null
requestedDeliveryDate
string | null
requestedBulkReadyDate
string | null
notes
string | null
duplicateOrders
string[]
lineItems
SalesOrderLineItemOutput · object[]
versionHistory
SalesOrderVersionSummary · object[]