Skip to main content
PATCH
Update Shipment

Authorizations

Authorization
string
header
required

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

Headers

X-Org-Id
string | null

Path Parameters

shipment_id
string
required

Body

application/json
documentId
string | null
direction
string | null
shipmentKind
string | null
scope
string | null
status
string | null
primaryPurchaseOrderId
string | null
productionOrderId
string | null
workOrderId
string | null
workOrderDocumentId
string | null
primarySalesOrderId
string | null
originLocationId
string | null
notes
string | null
incoterm
string | null
lineItems
ShipmentLineItemWrite · object[] | null

Response

Successful Response

id
string
required
documentId
string
required
direction
string
required
shipmentKind
string
required
scope
string
required
status
string
required
primaryPurchaseOrderId
string | null
primaryPurchaseOrderDocumentId
string | null
productionOrderId
string | null
productionOrderDocumentId
string | null
workOrderId
string | null
workOrderDocumentId
string | null
primarySalesOrderId
string | null
primarySalesOrderDocumentId
string | null
originLocationId
string | null
originLocationName
string | null
notes
string | null
incoterm
string | null
paymentTerms
string | null
createdAt
string | null
updatedAt
string | null
lineItemsCount
integer | null
packingListsCount
integer | null
lineItems
ShipmentLineItemResponse · object[] | null