Partially update shipment definition

curl --request PATCH \
  --url https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-CompanyID: <x-companyid>' \
  --header 'X-UserID: <x-userid>' \
  --data '
{
  "Code": "5469",
  "Description": "Istanbul road shipments",
  "TransportMode": 1,
  "TransportInfo1": "34ABC123",
  "TransportInfo2": "<string>",
  "CarrierName": "Example Logistics Ltd.",
  "CarrierTaxNumber": "1234567890",
  "CarrierCity": "ISTANBUL",
  "CarrierDistrict": "KADIKÖY",
  "CarrierCountry": "TÜRKİYE",
  "Driver1FirstName": "Ahmet",
  "Driver1LastName": "Kaya",
  "Driver1IdentityNumber": "12345678901",
  "Driver2FirstName": "<string>",
  "Driver2LastName": "<string>",
  "Driver2IdentityNumber": "<string>",
  "TrailerPlate1": "34ABC123",
  "TrailerPlate2": "<string>"
}
'

using RestSharp;


var options = new RestClientOptions("https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"Code\": \"5469\",\n  \"Description\": \"Istanbul road shipments\",\n  \"TransportMode\": 1,\n  \"TransportInfo1\": \"34ABC123\",\n  \"TransportInfo2\": \"<string>\",\n  \"CarrierName\": \"Example Logistics Ltd.\",\n  \"CarrierTaxNumber\": \"1234567890\",\n  \"CarrierCity\": \"ISTANBUL\",\n  \"CarrierDistrict\": \"KADIKÖY\",\n  \"CarrierCountry\": \"TÜRKİYE\",\n  \"Driver1FirstName\": \"Ahmet\",\n  \"Driver1LastName\": \"Kaya\",\n  \"Driver1IdentityNumber\": \"12345678901\",\n  \"Driver2FirstName\": \"<string>\",\n  \"Driver2LastName\": \"<string>\",\n  \"Driver2IdentityNumber\": \"<string>\",\n  \"TrailerPlate1\": \"34ABC123\",\n  \"TrailerPlate2\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PATCH',
  headers: {
    'X-UserID': '<x-userid>',
    'X-CompanyID': '<x-companyid>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    Code: '5469',
    Description: 'Istanbul road shipments',
    TransportMode: 1,
    TransportInfo1: '34ABC123',
    TransportInfo2: '<string>',
    CarrierName: 'Example Logistics Ltd.',
    CarrierTaxNumber: '1234567890',
    CarrierCity: 'ISTANBUL',
    CarrierDistrict: 'KADIKÖY',
    CarrierCountry: 'TÜRKİYE',
    Driver1FirstName: 'Ahmet',
    Driver1LastName: 'Kaya',
    Driver1IdentityNumber: '12345678901',
    Driver2FirstName: '<string>',
    Driver2LastName: '<string>',
    Driver2IdentityNumber: '<string>',
    TrailerPlate1: '34ABC123',
    TrailerPlate2: '<string>'
  })
};

fetch('https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}"

payload = {
    "Code": "5469",
    "Description": "Istanbul road shipments",
    "TransportMode": 1,
    "TransportInfo1": "34ABC123",
    "TransportInfo2": "<string>",
    "CarrierName": "Example Logistics Ltd.",
    "CarrierTaxNumber": "1234567890",
    "CarrierCity": "ISTANBUL",
    "CarrierDistrict": "KADIKÖY",
    "CarrierCountry": "TÜRKİYE",
    "Driver1FirstName": "Ahmet",
    "Driver1LastName": "Kaya",
    "Driver1IdentityNumber": "12345678901",
    "Driver2FirstName": "<string>",
    "Driver2LastName": "<string>",
    "Driver2IdentityNumber": "<string>",
    "TrailerPlate1": "34ABC123",
    "TrailerPlate2": "<string>"
}
headers = {
    "X-UserID": "<x-userid>",
    "X-CompanyID": "<x-companyid>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "Success": true,
  "ResultCode": "0000",
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "Code": "5469",
    "Description": "Istanbul road shipments",
    "TransportMode": 1,
    "TransportInfo1": "34ABC123",
    "TransportInfo2": "<string>",
    "CarrierName": "Example Logistics Ltd.",
    "CarrierTaxNumber": "1234567890",
    "CarrierCity": "ISTANBUL",
    "CarrierDistrict": "KADIKÖY",
    "CarrierCountry": "TÜRKİYE",
    "Driver1FirstName": "Ahmet",
    "Driver1LastName": "Kaya",
    "Driver1IdentityNumber": "12345678901",
    "Driver2FirstName": "<string>",
    "Driver2LastName": "<string>",
    "Driver2IdentityNumber": "<string>",
    "TrailerPlate1": "34ABC123",
    "TrailerPlate2": "<string>"
  },
  "Message": "<string>"
}

{
  "Success": false,
  "ResultCode": "0533",
  "Message": "TransportMode must be 1 (road), 2 (rail), 3 (maritime) or 4 (air).",
  "Errors": [
    {
      "Code": "0533",
      "Message": "TransportMode must be 1 (road), 2 (rail), 3 (maritime) or 4 (air)."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0102",
  "Message": "Token has expired. Obtain a new token using the refresh token.",
  "Errors": [
    {
      "Code": "0102",
      "Message": "Token has expired. Obtain a new token using the refresh token."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0110",
  "Message": "You do not have permission for this operation.",
  "Errors": [
    {
      "Code": "0110",
      "Message": "You do not have permission for this operation."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0530",
  "Message": "Shipment definition not found.",
  "Errors": [
    {
      "Code": "0530",
      "Message": "Shipment definition not found."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0120",
  "Message": "Daily request limit (10000) exceeded.",
  "Errors": [
    {
      "Code": "0120",
      "Message": "Daily request limit (10000) exceeded."
    }
  ]
}

PATCH

api

definitions

shipment-definitions

{shipmentDefinitionId}

Partially update shipment definition

curl --request PATCH \
  --url https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-CompanyID: <x-companyid>' \
  --header 'X-UserID: <x-userid>' \
  --data '
{
  "Code": "5469",
  "Description": "Istanbul road shipments",
  "TransportMode": 1,
  "TransportInfo1": "34ABC123",
  "TransportInfo2": "<string>",
  "CarrierName": "Example Logistics Ltd.",
  "CarrierTaxNumber": "1234567890",
  "CarrierCity": "ISTANBUL",
  "CarrierDistrict": "KADIKÖY",
  "CarrierCountry": "TÜRKİYE",
  "Driver1FirstName": "Ahmet",
  "Driver1LastName": "Kaya",
  "Driver1IdentityNumber": "12345678901",
  "Driver2FirstName": "<string>",
  "Driver2LastName": "<string>",
  "Driver2IdentityNumber": "<string>",
  "TrailerPlate1": "34ABC123",
  "TrailerPlate2": "<string>"
}
'

using RestSharp;


var options = new RestClientOptions("https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"Code\": \"5469\",\n  \"Description\": \"Istanbul road shipments\",\n  \"TransportMode\": 1,\n  \"TransportInfo1\": \"34ABC123\",\n  \"TransportInfo2\": \"<string>\",\n  \"CarrierName\": \"Example Logistics Ltd.\",\n  \"CarrierTaxNumber\": \"1234567890\",\n  \"CarrierCity\": \"ISTANBUL\",\n  \"CarrierDistrict\": \"KADIKÖY\",\n  \"CarrierCountry\": \"TÜRKİYE\",\n  \"Driver1FirstName\": \"Ahmet\",\n  \"Driver1LastName\": \"Kaya\",\n  \"Driver1IdentityNumber\": \"12345678901\",\n  \"Driver2FirstName\": \"<string>\",\n  \"Driver2LastName\": \"<string>\",\n  \"Driver2IdentityNumber\": \"<string>\",\n  \"TrailerPlate1\": \"34ABC123\",\n  \"TrailerPlate2\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PATCH',
  headers: {
    'X-UserID': '<x-userid>',
    'X-CompanyID': '<x-companyid>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    Code: '5469',
    Description: 'Istanbul road shipments',
    TransportMode: 1,
    TransportInfo1: '34ABC123',
    TransportInfo2: '<string>',
    CarrierName: 'Example Logistics Ltd.',
    CarrierTaxNumber: '1234567890',
    CarrierCity: 'ISTANBUL',
    CarrierDistrict: 'KADIKÖY',
    CarrierCountry: 'TÜRKİYE',
    Driver1FirstName: 'Ahmet',
    Driver1LastName: 'Kaya',
    Driver1IdentityNumber: '12345678901',
    Driver2FirstName: '<string>',
    Driver2LastName: '<string>',
    Driver2IdentityNumber: '<string>',
    TrailerPlate1: '34ABC123',
    TrailerPlate2: '<string>'
  })
};

fetch('https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}"

payload = {
    "Code": "5469",
    "Description": "Istanbul road shipments",
    "TransportMode": 1,
    "TransportInfo1": "34ABC123",
    "TransportInfo2": "<string>",
    "CarrierName": "Example Logistics Ltd.",
    "CarrierTaxNumber": "1234567890",
    "CarrierCity": "ISTANBUL",
    "CarrierDistrict": "KADIKÖY",
    "CarrierCountry": "TÜRKİYE",
    "Driver1FirstName": "Ahmet",
    "Driver1LastName": "Kaya",
    "Driver1IdentityNumber": "12345678901",
    "Driver2FirstName": "<string>",
    "Driver2LastName": "<string>",
    "Driver2IdentityNumber": "<string>",
    "TrailerPlate1": "34ABC123",
    "TrailerPlate2": "<string>"
}
headers = {
    "X-UserID": "<x-userid>",
    "X-CompanyID": "<x-companyid>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "Success": true,
  "ResultCode": "0000",
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "Code": "5469",
    "Description": "Istanbul road shipments",
    "TransportMode": 1,
    "TransportInfo1": "34ABC123",
    "TransportInfo2": "<string>",
    "CarrierName": "Example Logistics Ltd.",
    "CarrierTaxNumber": "1234567890",
    "CarrierCity": "ISTANBUL",
    "CarrierDistrict": "KADIKÖY",
    "CarrierCountry": "TÜRKİYE",
    "Driver1FirstName": "Ahmet",
    "Driver1LastName": "Kaya",
    "Driver1IdentityNumber": "12345678901",
    "Driver2FirstName": "<string>",
    "Driver2LastName": "<string>",
    "Driver2IdentityNumber": "<string>",
    "TrailerPlate1": "34ABC123",
    "TrailerPlate2": "<string>"
  },
  "Message": "<string>"
}

{
  "Success": false,
  "ResultCode": "0533",
  "Message": "TransportMode must be 1 (road), 2 (rail), 3 (maritime) or 4 (air).",
  "Errors": [
    {
      "Code": "0533",
      "Message": "TransportMode must be 1 (road), 2 (rail), 3 (maritime) or 4 (air)."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0102",
  "Message": "Token has expired. Obtain a new token using the refresh token.",
  "Errors": [
    {
      "Code": "0102",
      "Message": "Token has expired. Obtain a new token using the refresh token."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0110",
  "Message": "You do not have permission for this operation.",
  "Errors": [
    {
      "Code": "0110",
      "Message": "You do not have permission for this operation."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0530",
  "Message": "Shipment definition not found.",
  "Errors": [
    {
      "Code": "0530",
      "Message": "Shipment definition not found."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0120",
  "Message": "Daily request limit (10000) exceeded.",
  "Errors": [
    {
      "Code": "0120",
      "Message": "Daily request limit (10000) exceeded."
    }
  ]
}

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.

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 for customer endpoints; 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

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

Show child attributes

Message

null | string

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

Getting started

Core concepts

Modules

Release notes

Partially update shipment definition

Authorizations

Headers

Path Parameters

Body

Response