Skip to main content
PATCH
Partially update despatch
In the body you send only the fields you want to change; fields that are not sent keep their current values. Rules and examples: partial update.
  • Only the descriptive fields listed in Update despatch can be changed; any other field (lines, customer, date, despatch number, amounts, …) is rejected (0002).
  • A field that is not sent does not change; a field sent as null is cleared.

Error codes

Codes this endpoint can return. The general errors that apply to every endpoint (authentication, permissions, request headers, request limits) are not repeated here.

Authorizations

Authorization
string
header
required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID
integer<int32>
required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1
X-CompanyID
integer<int32>
required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1
X-PeriodID
integer<int32>

ID of the accounting period. Optional; if sent, it is written to created records.

Required range: x >= 1

Path Parameters

despatchId
string<uuid>
required

Despatch ID.

Body

Description
null | string

Description. At most 1000 characters.

DocumentNumber
null | string

Document number (free text). At most 100 characters.

Example:

"2026-15"

ActualDispatchDate
null | string<date>

Actual dispatch date. Date only (yyyy-MM-dd), no time part.

Example:

"2026-10-15"

ShipmentDefinitionCode
null | string

Shipment definition code from GET /api/v1/definitions/shipment-definitions.

SharingCode
null | string

Sharing code that limits who can see the despatch. Empty means visible to everyone; otherwise it must be one of the user's sharing codes.

Response

OK

Success
boolean
required

Whether the operation succeeded.

Example:

true

ResultCode
string
required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data
object
required

Response data. Null when Success is false.

Message
null | string

Error message when Success is false. Messages of all errors are joined into a single text.