Skip to main content
PATCH
Partially update shipment definition
Send only the fields you want to change; fields you do not send keep their current values. Rules and examples: partial update.
  • A field that is not sent stays unchanged, a field sent as null is cleared.
  • Validation runs on the whole merged record; setting a required field to null is rejected.
  • The carrier company and driver rules are checked on the merged record: setting only one of the carrier fields to null is rejected.

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

shipmentDefinitionId
string<uuid>
required

Shipment definition ID.

Body

Code
null | string

Required. Shipment code, unique within the company. At most 50 characters.

Example:

"5469"

Description
null | string

Description. At most 255 characters.

Example:

"Istanbul road shipments"

TransportMode
integer<int32>

Required. 1: Road, 2: Rail, 3: Maritime, 4: Air. Decides what TransportInfo1 and TransportInfo2 mean.

Example:

1

TransportInfo1
null | string

Required. Vehicle identifier, by TransportMode: 1 license plate, 2 train number, 3 vessel name, 4 aircraft number. At most 50 characters.

Example:

"34ABC123"

TransportInfo2
null | string

Second transport information, used only when TransportMode is 2 (rail car number) or 3 (IMO number). Not stored for 1 (road) and 4 (air). At most 50 characters.

CarrierName
null | string

Carrier company name. Required together with the other Carrier* fields when the shipment is made by a carrier company; leave all of them empty for the company's own vehicle. At most 75 characters.

Example:

"Example Logistics Ltd."

CarrierTaxNumber
null | string

Carrier company tax number. At most 50 characters.

Example:

"1234567890"

CarrierCity
null | string

Carrier company city. At most 50 characters.

Example:

"ISTANBUL"

CarrierDistrict
null | string

Carrier company district. At most 50 characters.

Example:

"KADIKÖY"

CarrierCountry
null | string

Carrier company country. At most 50 characters.

Example:

"TÜRKİYE"

Driver1FirstName
null | string

First name of driver 1. Required when no carrier company is used. Not stored when a carrier company is used. At most 50 characters.

Example:

"Ahmet"

Driver1LastName
null | string

Last name of driver 1. Required when no carrier company is used. At most 20 characters.

Example:

"Kaya"

Driver1IdentityNumber
null | string

National ID number (TCKN) of driver 1. Required when no carrier company is used. At most 20 characters.

Example:

"12345678901"

Driver2FirstName
null | string

First name of driver 2. At most 50 characters.

Driver2LastName
null | string

Last name of driver 2. At most 20 characters.

Driver2IdentityNumber
null | string

National ID number (TCKN) of driver 2. At most 20 characters.

TrailerPlate1
null | string

Trailer license plate 1. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.

Example:

"34ABC123"

TrailerPlate2
null | string

Trailer license plate 2. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.

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
Message
null | string

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