Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Path Parameters

shipmentNoticeId
string<uuid>
required

Body

application/json

Request body for partially updating a shipment notice. Omit a field to leave it unchanged. Explicit JSON null is rejected unless noted on each field. Editability follows the rules at /api/v1/shipment-notices/{id} GET response status fields: a shipment notice is editable when status is SUBMITTED or when status is PROCESSING and at least one shipment is PENDING.

warehouseId
string<uuid>
required

New warehouse ID for the shipment notice. Only editable when the shipment notice is editable.

condition
enum<string>
required

New condition. Only editable when shipment notice sourceType is OFFICE; rejected for any other source type.

Available options:
NEW,
USED
purchaseOrderNumber
string
required

New purchase order number.

shipmentNoticePackages
object[]
required

Per-package instructions. Omit to leave packages unchanged. Send {id, delete: true} to remove a package. Send {...without id...} to add a new package (only allowed when the shipment notice itself is editable). Send {id, ...fields...} to update a package (only allowed when that package is editable).

Response

Shipment notice updated

Shipment notice order (V1)

id
string<uuid>
required

Shipment notice order ID

status
enum<string>
required

Order status

Available options:
SUBMITTED,
PROCESSING,
COMPLETED,
PARTIALLY_COMPLETED,
NOT_COMPLETED,
CANCELLED
sourceType
enum<string>
required

Source type

Available options:
SUPPLIER,
OFFICE
createdAt
string<date-time>
required

Created timestamp

updatedAt
string<date-time>
required

Last updated timestamp

warehouse
object
required

Destination warehouse

shipmentNoticeOrderItems
object[]
required

Order line items

shipmentNoticePackages
object[]
required

Packages in this shipment notice

condition
enum<string>

Condition of items

Available options:
NEW,
USED
purchaseOrderNumber
string

Purchase order number

expectedShipDate
string<date>

Expected ship date

submittedBy
object

Person who submitted the shipment notice.