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 \"TransportMode\": 1,\n \"TransportInfo1\": \"34ABC123\"\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
{
"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."
}
]
}
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 \"TransportMode\": 1,\n \"TransportInfo1\": \"34ABC123\"\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
{
"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."
}
]
}
To change individual fields, use a partial update: PATCH changes only the fields you send.
Update is a full replace: fields you do not send are cleared.
Code is required and must be unique within the company.
TransportMode and TransportInfo1 are required.
The carrier company / own vehicle rules are the same as on create (below).
What TransportInfo1 and TransportInfo2 mean depends on the transport mode; the Noyax screen changes the labels of these fields accordingly. The values are written to the e-despatch advice as transport information.
TransportMode
Transport mode
TransportInfo1 (required)
TransportInfo2
1
Road
License plate
—
2
Rail
Train number
Rail car number
3
Maritime
Vessel name
IMO number
4
Air
Aircraft number
—
The second field exists only for rail and maritime; for road and air TransportInfo2 is not stored even if sent.
Carrier company or your own vehicle?
A shipment is made either by a carrier company or with the company’s own vehicle. The API does not have a separate field for this; it decides by whether the carrier company fields are filled:
Own vehicle
Carrier company
Leave all carrier fields (CarrierName, CarrierTaxNumber, CarrierCity, CarrierDistrict, CarrierCountry) empty.
Driver1FirstName, Driver1LastName and Driver1IdentityNumber are required (0537).
Driver2* fields are optional.
Trailer plates are stored only for road transport (TransportMode: 1); for other transport modes they stay empty even if sent.
If any carrier field is filled, all five are required (0536).
Driver information is not needed; even if sent it is not stored and comes back empty.
Trailer plates are not stored.
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.
Code
HTTP
Meaning
0002
400
Request body could not be read (malformed JSON, wrong field type), or it contains a field the endpoint does not have
0003
400
A field exceeds its maximum length (the message names the field and the limit)
0530
404
Shipment definition not found
0531
400
Shipment definition Code is required
0532
400
The shipment code is already used in the company; the response carries the existing record’s ID as ExistingId
0533
400
TransportMode must be 1 (road), 2 (rail), 3 (maritime) or 4 (air)
0535
400
TransportInfo1 is required (plate, train, vessel or aircraft information)
0536
400
If any carrier field is filled, all five are required
0537
400
Driver 1 fields (first name, last name, national ID) are required when there is no carrier company
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
application/jsontext/jsonapplication/*+json
Code
null | string
required
Required. Shipment code, unique within the company. At most 50 characters.
Example:
"5469"
TransportMode
integer<int32>
required
Required. 1: Road, 2: Rail, 3: Maritime, 4: Air. Decides what TransportInfo1 and TransportInfo2 mean.
Example:
1
TransportInfo1
null | string
required
Required. Vehicle identifier, by TransportMode: 1 license plate, 2 train number, 3 vessel name, 4 aircraft number. At most 50 characters.
Example:
"34ABC123"
Description
null | string
Description. At most 255 characters.
Example:
"Istanbul road shipments"
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
Show child attributes
Message
null | string
Error message when Success is false. Messages of all errors are joined into a single text.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Noyax API","colors":{"primary":"#5B4AFF","light":"#8C80FF","dark":"#4A3AE0"},"logo":{"light":"https://mintcdn.com/noyax/K7LxoYHrQCdoQ4jy/logo/light.svg?fit=max\u0026auto=format\u0026n=K7LxoYHrQCdoQ4jy\u0026q=85\u0026s=78086fed969cddbbf46c4cd156eff780","dark":"https://mintcdn.com/noyax/K7LxoYHrQCdoQ4jy/logo/dark.svg?fit=max\u0026auto=format\u0026n=K7LxoYHrQCdoQ4jy\u0026q=85\u0026s=96614d322ed52bd768de7f3bfc057fb1","href":"/"},"favicon":"https://mintcdn.com/noyax/WZ1Gnfg0LydE9yNm/favicon.ico?fit=max\u0026auto=format\u0026n=WZ1Gnfg0LydE9yNm\u0026q=85\u0026s=b96b2569d70afdcc446a0d9785c6d34b","api":{"openapi":"api-reference/openapi.json","playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","csharp","javascript","python"]}},"footer":{"socials":{"website":"https://noyax.com"}},"seo":{"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"tr","default":true,"href":"tr/v1"},{"language":"en","href":"en/v1"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"noyax","hasAudioNarration":false,"actualSubdomain":"noyax","customDomains":["apidocs.noyax.com"],"gitSource":{"type":"github","owner":"ataakalin","repo":"noyaxapi","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6af70c2de766df7985e6260a","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"en","tag":"Modules","count":237},{"language":"tr","tag":"Modüller","count":237},{"language":"en","tag":"Customers","count":58},{"language":"tr","tag":"Cariler","count":56},{"language":"en","tag":"Finance","count":44},{"language":"tr","tag":"Finans","count":44},{"language":"en","tag":"Definitions","count":43},{"language":"tr","tag":"Tanımlar","count":43},{"language":"en","tag":"Bank","count":42},{"language":"tr","tag":"Banka","count":42},{"language":"en","tag":"Products","count":37},{"language":"tr","tag":"Ürünler","count":37},{"language":"en","tag":"Invoices","count":24},{"language":"tr","tag":"Faturalar","count":24},{"language":"en","tag":"Bank accounts","count":18},{"language":"tr","tag":"Banka hesapları","count":18},{"language":"en","tag":"Stock","count":14},{"language":"tr","tag":"Stok","count":14},{"language":"en","tag":"Parameter definitions","count":12},{"language":"tr","tag":"Parametre tanımları","count":12}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/v1/definitions/shipment-definitions/update","slug":"/en/v1/definitions/shipment-definitions/update","pageMetadata":{"title":"Update shipment definition","description":"Replaces all fields of a shipment definition.","openapi":"api-reference/openapi.json PUT /api/v1/definitions/shipment-definitions/{shipmentDefinitionId}","href":"/en/v1/definitions/shipment-definitions/update"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Replaces all fields of a shipment definition.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Tab,Table,Tabs}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`To change individual fields, use a `,_jsx(_components.a,{href:`/en/v1/guides/partial-update`,children:`partial update`}),`: `,_jsx(_components.code,{children:`PATCH`}),` changes only the fields you send.\nUpdate is a `,_jsx(_components.strong,{children:`full replace`}),`: fields you do not send are cleared.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`Code`}),` is required and must be unique within the company.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`TransportMode`}),` and `,_jsx(_components.code,{children:`TransportInfo1`}),` are required.`]}),`\n`,_jsx(_components.li,{children:`The carrier company / own vehicle rules are the same as on create (below).`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`What `,_jsx(_components.code,{children:`TransportInfo1`}),` and `,_jsx(_components.code,{children:`TransportInfo2`}),` mean depends on the transport mode; the Noyax screen changes the labels of these fields accordingly. The values are written to the e-despatch advice as transport information.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:_jsx(_components.code,{children:`TransportMode`})}),_jsx(_components.th,{children:`Transport mode`}),_jsxs(_components.th,{children:[_jsx(_components.code,{children:`TransportInfo1`}),` (required)`]}),_jsx(_components.th,{children:_jsx(_components.code,{children:`TransportInfo2`})})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`1`})}),_jsx(_components.td,{children:`Road`}),_jsx(_components.td,{children:`License plate`}),_jsx(_components.td,{children:`—`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`2`})}),_jsx(_components.td,{children:`Rail`}),_jsx(_components.td,{children:`Train number`}),_jsx(_components.td,{children:`Rail car number`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`3`})}),_jsx(_components.td,{children:`Maritime`}),_jsx(_components.td,{children:`Vessel name`}),_jsx(_components.td,{children:`IMO number`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`4`})}),_jsx(_components.td,{children:`Air`}),_jsx(_components.td,{children:`Aircraft number`}),_jsx(_components.td,{children:`—`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`The second field exists only for rail and maritime; for road and air `,_jsx(_components.code,{children:`TransportInfo2`}),` is not stored even if sent.`]}),`\n`,_jsx(Heading,{level:`2`,id:`carrier-company-or-your-own-vehicle`,children:`Carrier company or your own vehicle?`}),`\n`,_jsxs(_components.p,{children:[`A shipment is made either by a carrier company or with the company’s own vehicle. The API does not have a separate field for this; it decides by `,_jsx(_components.strong,{children:`whether the carrier company fields are filled`}),`:`]}),`\n`,_jsxs(Tabs,{children:[_jsxs(Tab,{title:`Own vehicle`,id:`own-vehicle`,children:[_jsxs(_components.p,{children:[`Leave all carrier fields (`,_jsx(_components.code,{children:`CarrierName`}),`, `,_jsx(_components.code,{children:`CarrierTaxNumber`}),`, `,_jsx(_components.code,{children:`CarrierCity`}),`, `,_jsx(_components.code,{children:`CarrierDistrict`}),`, `,_jsx(_components.code,{children:`CarrierCountry`}),`) empty.`]}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`Driver1FirstName`}),`, `,_jsx(_components.code,{children:`Driver1LastName`}),` and `,_jsx(_components.code,{children:`Driver1IdentityNumber`}),` are `,_jsx(_components.strong,{children:`required`}),` (`,_jsx(_components.code,{children:`0537`}),`).`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`Driver2*`}),` fields are optional.`]}),`\n`,_jsxs(_components.li,{children:[`Trailer plates are stored only for `,_jsx(_components.strong,{children:`road`}),` transport (`,_jsx(_components.code,{children:`TransportMode: 1`}),`); for other transport modes they stay empty even if sent.`]}),`\n`]})]}),_jsxs(Tab,{title:`Carrier company`,id:`carrier-company`,children:[_jsxs(_components.p,{children:[`If any carrier field is filled, `,_jsx(_components.strong,{children:`all five are required`}),` (`,_jsx(_components.code,{children:`0536`}),`).`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Driver information is not needed; even if sent it is not stored and comes back empty.`}),`\n`,_jsx(_components.li,{children:`Trailer plates are not stored.`}),`\n`]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`error-codes`,children:`Error codes`}),`\n`,_jsxs(_components.p,{children:[`Codes this endpoint can return. The `,_jsx(_components.a,{href:`/en/v1/guides/result-codes`,children:`general errors`}),` that apply to every endpoint (authentication, permissions, request headers, request limits) are not repeated here.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`HTTP`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0002`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:`Request body could not be read (malformed JSON, wrong field type), or it contains a field the endpoint does not have`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0003`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:`A field exceeds its maximum length (the message names the field and the limit)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0530`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:`Shipment definition not found`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0531`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsxs(_components.td,{children:[`Shipment definition `,_jsx(_components.code,{children:`Code`}),` is required`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0532`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsxs(_components.td,{children:[`The shipment code is already used in the company; the response carries the existing record’s ID as `,_jsx(_components.code,{children:`ExistingId`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0533`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`TransportMode`}),` must be 1 (road), 2 (rail), 3 (maritime) or 4 (air)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0535`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`TransportInfo1`}),` is required (plate, train, vessel or aircraft information)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0536`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:`If any carrier field is filled, all five are required`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0537`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:`Driver 1 fields (first name, last name, national ID) are required when there is no carrier company`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update shipment definition","description":"Replaces all fields of a shipment definition.","openapi":"api-reference/openapi.json PUT /api/v1/definitions/shipment-definitions/{shipmentDefinitionId}","href":"/en/v1/definitions/shipment-definitions/update"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Carrier company or your own vehicle?","slug":"carrier-company-or-your-own-vehicle","depth":2,"children":[]},{"title":"Error codes","slug":"error-codes","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Shipment Definitions"],"summary":"Update shipment definition","description":"Replaces all fields of a shipment definition.","parameters":["a9ab4543-f26f-445f-972d-aa19a5df360c","7d844b56-10bb-4b29-b0f2-a08691af4e4a","b87f9509-6cad-4a99-9242-0954d72c8369","78bae739-e190-4337-a489-b51aa03c8815"],"requestBody":"a4132dfb-7707-47d9-aefb-797f0c5f2504","responses":{"200":"8d33c1d7-d613-4024-b1ec-ab10845da362","400":"f258e97e-94d2-40da-8184-8a987b0295b7","401":"d949981a-7b41-420d-abe9-dbd90f3c65cf","403":"3debad33-2f03-42c5-9462-54d53015290f","404":"f4239c3f-ab41-4076-b7e3-4d13a993e6e8","429":"4659f992-82af-45ef-b3bc-2bf73435ec88"},"method":"put","type":"path","servers":["751ff55a-b28a-4823-93a0-54b137dafaf3"],"security":["2360e6fe-3f5d-4cb2-a410-60ae58b2515b"],"path":"/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}","baseUrlOptions":["https://api.noyax.com"],"title":"Update shipment definition","codeSamples":[],"requestExampleLanguages":["bash","csharp","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a9ab4543-f26f-445f-972d-aa19a5df360c":{"name":"shipmentDefinitionId","in":"path","description":"Shipment definition ID.","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Shipment definition ID.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"7d844b56-10bb-4b29-b0f2-a08691af4e4a":{"name":"X-UserID","in":"header","description":"ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32","isRequired":true,"description":"ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.","uniqueKey":"","typeLabel":"integer\u003cint32>"}},"b87f9509-6cad-4a99-9242-0954d72c8369":{"name":"X-CompanyID","in":"header","description":"ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32","isRequired":true,"description":"ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.","uniqueKey":"","typeLabel":"integer\u003cint32>"}},"78bae739-e190-4337-a489-b51aa03c8815":{"name":"X-PeriodID","in":"header","description":"ID of the accounting period. Optional; if sent, it is written to created records.","schema":{"minimum":1,"type":"integer","format":"int32","description":"ID of the accounting period. Optional; if sent, it is written to created records.","uniqueKey":"","typeLabel":"integer\u003cint32>"}}},"requestBody":{"content":{"application/json":{"schema":{"required":["Code","TransportMode","TransportInfo1"],"type":"object","properties":{"Code":{"oneOf":[{"type":"null","description":"Required. Shipment code, unique within the company. At most 50 characters.","example":"5469","isRequired":true,"uniqueKey":"Code.oneOf.0","typeLabel":"null"},{"type":"string","description":"Required. Shipment code, unique within the company. At most 50 characters.","example":"5469","isRequired":true,"uniqueKey":"Code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"Code","typeLabel":"null | string"},"TransportMode":{"type":"integer","description":"Required. 1: Road, 2: Rail, 3: Maritime, 4: Air. Decides what TransportInfo1 and TransportInfo2 mean.","format":"int32","example":1,"isRequired":true,"uniqueKey":"TransportMode","typeLabel":"integer\u003cint32>"},"TransportInfo1":{"oneOf":[{"type":"null","description":"Required. Vehicle identifier, by TransportMode: 1 license plate, 2 train number, 3 vessel name, 4 aircraft number. At most 50 characters.","example":"34ABC123","isRequired":true,"uniqueKey":"TransportInfo1.oneOf.0","typeLabel":"null"},{"type":"string","description":"Required. Vehicle identifier, by TransportMode: 1 license plate, 2 train number, 3 vessel name, 4 aircraft number. At most 50 characters.","example":"34ABC123","isRequired":true,"uniqueKey":"TransportInfo1.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"TransportInfo1","typeLabel":"null | string"},"Description":{"oneOf":[{"type":"null","description":"Description. At most 255 characters.","example":"Istanbul road shipments","uniqueKey":"Description.oneOf.0","typeLabel":"null"},{"type":"string","description":"Description. At most 255 characters.","example":"Istanbul road shipments","uniqueKey":"Description.oneOf.1","typeLabel":"string"}],"uniqueKey":"Description","typeLabel":"null | string"},"TransportInfo2":{"oneOf":[{"type":"null","description":"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.","uniqueKey":"TransportInfo2.oneOf.0","typeLabel":"null"},{"type":"string","description":"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.","uniqueKey":"TransportInfo2.oneOf.1","typeLabel":"string"}],"uniqueKey":"TransportInfo2","typeLabel":"null | string"},"CarrierName":{"oneOf":[{"type":"null","description":"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.","uniqueKey":"CarrierName.oneOf.0","typeLabel":"null"},{"type":"string","description":"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.","uniqueKey":"CarrierName.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierName","typeLabel":"null | string"},"CarrierTaxNumber":{"oneOf":[{"type":"null","description":"Carrier company tax number. At most 50 characters.","example":"1234567890","uniqueKey":"CarrierTaxNumber.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company tax number. At most 50 characters.","example":"1234567890","uniqueKey":"CarrierTaxNumber.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierTaxNumber","typeLabel":"null | string"},"CarrierCity":{"oneOf":[{"type":"null","description":"Carrier company city. At most 50 characters.","example":"ISTANBUL","uniqueKey":"CarrierCity.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company city. At most 50 characters.","example":"ISTANBUL","uniqueKey":"CarrierCity.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierCity","typeLabel":"null | string"},"CarrierDistrict":{"oneOf":[{"type":"null","description":"Carrier company district. At most 50 characters.","example":"KADIKÖY","uniqueKey":"CarrierDistrict.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company district. At most 50 characters.","example":"KADIKÖY","uniqueKey":"CarrierDistrict.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierDistrict","typeLabel":"null | string"},"CarrierCountry":{"oneOf":[{"type":"null","description":"Carrier company country. At most 50 characters.","example":"TÜRKİYE","uniqueKey":"CarrierCountry.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company country. At most 50 characters.","example":"TÜRKİYE","uniqueKey":"CarrierCountry.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierCountry","typeLabel":"null | string"},"Driver1FirstName":{"oneOf":[{"type":"null","description":"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","uniqueKey":"Driver1FirstName.oneOf.0","typeLabel":"null"},{"type":"string","description":"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","uniqueKey":"Driver1FirstName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver1FirstName","typeLabel":"null | string"},"Driver1LastName":{"oneOf":[{"type":"null","description":"Last name of driver 1. Required when no carrier company is used. At most 20 characters.","example":"Kaya","uniqueKey":"Driver1LastName.oneOf.0","typeLabel":"null"},{"type":"string","description":"Last name of driver 1. Required when no carrier company is used. At most 20 characters.","example":"Kaya","uniqueKey":"Driver1LastName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver1LastName","typeLabel":"null | string"},"Driver1IdentityNumber":{"oneOf":[{"type":"null","description":"National ID number (TCKN) of driver 1. Required when no carrier company is used. At most 20 characters.","example":"12345678901","uniqueKey":"Driver1IdentityNumber.oneOf.0","typeLabel":"null"},{"type":"string","description":"National ID number (TCKN) of driver 1. Required when no carrier company is used. At most 20 characters.","example":"12345678901","uniqueKey":"Driver1IdentityNumber.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver1IdentityNumber","typeLabel":"null | string"},"Driver2FirstName":{"oneOf":[{"type":"null","description":"First name of driver 2. At most 50 characters.","uniqueKey":"Driver2FirstName.oneOf.0","typeLabel":"null"},{"type":"string","description":"First name of driver 2. At most 50 characters.","uniqueKey":"Driver2FirstName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver2FirstName","typeLabel":"null | string"},"Driver2LastName":{"oneOf":[{"type":"null","description":"Last name of driver 2. At most 20 characters.","uniqueKey":"Driver2LastName.oneOf.0","typeLabel":"null"},{"type":"string","description":"Last name of driver 2. At most 20 characters.","uniqueKey":"Driver2LastName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver2LastName","typeLabel":"null | string"},"Driver2IdentityNumber":{"oneOf":[{"type":"null","description":"National ID number (TCKN) of driver 2. At most 20 characters.","uniqueKey":"Driver2IdentityNumber.oneOf.0","typeLabel":"null"},{"type":"string","description":"National ID number (TCKN) of driver 2. At most 20 characters.","uniqueKey":"Driver2IdentityNumber.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver2IdentityNumber","typeLabel":"null | string"},"TrailerPlate1":{"oneOf":[{"type":"null","description":"Trailer license plate 1. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","example":"34ABC123","uniqueKey":"TrailerPlate1.oneOf.0","typeLabel":"null"},{"type":"string","description":"Trailer license plate 1. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","example":"34ABC123","uniqueKey":"TrailerPlate1.oneOf.1","typeLabel":"string"}],"uniqueKey":"TrailerPlate1","typeLabel":"null | string"},"TrailerPlate2":{"oneOf":[{"type":"null","description":"Trailer license plate 2. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","uniqueKey":"TrailerPlate2.oneOf.0","typeLabel":"null"},{"type":"string","description":"Trailer license plate 2. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","uniqueKey":"TrailerPlate2.oneOf.1","typeLabel":"string"}],"uniqueKey":"TrailerPlate2","typeLabel":"null | string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"Code":"5469","TransportMode":1,"TransportInfo1":"34ABC123","Description":"Istanbul road shipments","TransportInfo2":"\u003cstring>","CarrierName":"Example Logistics Ltd.","CarrierTaxNumber":"1234567890","CarrierCity":"ISTANBUL","CarrierDistrict":"KADIKÖY","CarrierCountry":"TÜRKİYE","Driver1FirstName":"Ahmet","Driver1LastName":"Kaya","Driver1IdentityNumber":"12345678901","Driver2FirstName":"\u003cstring>","Driver2LastName":"\u003cstring>","Driver2IdentityNumber":"\u003cstring>","TrailerPlate1":"34ABC123","TrailerPlate2":"\u003cstring>"}}},"exampleType":"generated"},"text/json":{"schema":{"required":["Code","TransportMode","TransportInfo1"],"type":"object","properties":{"Code":{"oneOf":[{"type":"null","description":"Required. Shipment code, unique within the company. At most 50 characters.","example":"5469","isRequired":true,"uniqueKey":"Code.oneOf.0","typeLabel":"null"},{"type":"string","description":"Required. Shipment code, unique within the company. At most 50 characters.","example":"5469","isRequired":true,"uniqueKey":"Code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"Code","typeLabel":"null | string"},"TransportMode":{"type":"integer","description":"Required. 1: Road, 2: Rail, 3: Maritime, 4: Air. Decides what TransportInfo1 and TransportInfo2 mean.","format":"int32","example":1,"isRequired":true,"uniqueKey":"TransportMode","typeLabel":"integer\u003cint32>"},"TransportInfo1":{"oneOf":[{"type":"null","description":"Required. Vehicle identifier, by TransportMode: 1 license plate, 2 train number, 3 vessel name, 4 aircraft number. At most 50 characters.","example":"34ABC123","isRequired":true,"uniqueKey":"TransportInfo1.oneOf.0","typeLabel":"null"},{"type":"string","description":"Required. Vehicle identifier, by TransportMode: 1 license plate, 2 train number, 3 vessel name, 4 aircraft number. At most 50 characters.","example":"34ABC123","isRequired":true,"uniqueKey":"TransportInfo1.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"TransportInfo1","typeLabel":"null | string"},"Description":{"oneOf":[{"type":"null","description":"Description. At most 255 characters.","example":"Istanbul road shipments","uniqueKey":"Description.oneOf.0","typeLabel":"null"},{"type":"string","description":"Description. At most 255 characters.","example":"Istanbul road shipments","uniqueKey":"Description.oneOf.1","typeLabel":"string"}],"uniqueKey":"Description","typeLabel":"null | string"},"TransportInfo2":{"oneOf":[{"type":"null","description":"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.","uniqueKey":"TransportInfo2.oneOf.0","typeLabel":"null"},{"type":"string","description":"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.","uniqueKey":"TransportInfo2.oneOf.1","typeLabel":"string"}],"uniqueKey":"TransportInfo2","typeLabel":"null | string"},"CarrierName":{"oneOf":[{"type":"null","description":"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.","uniqueKey":"CarrierName.oneOf.0","typeLabel":"null"},{"type":"string","description":"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.","uniqueKey":"CarrierName.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierName","typeLabel":"null | string"},"CarrierTaxNumber":{"oneOf":[{"type":"null","description":"Carrier company tax number. At most 50 characters.","example":"1234567890","uniqueKey":"CarrierTaxNumber.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company tax number. At most 50 characters.","example":"1234567890","uniqueKey":"CarrierTaxNumber.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierTaxNumber","typeLabel":"null | string"},"CarrierCity":{"oneOf":[{"type":"null","description":"Carrier company city. At most 50 characters.","example":"ISTANBUL","uniqueKey":"CarrierCity.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company city. At most 50 characters.","example":"ISTANBUL","uniqueKey":"CarrierCity.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierCity","typeLabel":"null | string"},"CarrierDistrict":{"oneOf":[{"type":"null","description":"Carrier company district. At most 50 characters.","example":"KADIKÖY","uniqueKey":"CarrierDistrict.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company district. At most 50 characters.","example":"KADIKÖY","uniqueKey":"CarrierDistrict.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierDistrict","typeLabel":"null | string"},"CarrierCountry":{"oneOf":[{"type":"null","description":"Carrier company country. At most 50 characters.","example":"TÜRKİYE","uniqueKey":"CarrierCountry.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company country. At most 50 characters.","example":"TÜRKİYE","uniqueKey":"CarrierCountry.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierCountry","typeLabel":"null | string"},"Driver1FirstName":{"oneOf":[{"type":"null","description":"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","uniqueKey":"Driver1FirstName.oneOf.0","typeLabel":"null"},{"type":"string","description":"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","uniqueKey":"Driver1FirstName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver1FirstName","typeLabel":"null | string"},"Driver1LastName":{"oneOf":[{"type":"null","description":"Last name of driver 1. Required when no carrier company is used. At most 20 characters.","example":"Kaya","uniqueKey":"Driver1LastName.oneOf.0","typeLabel":"null"},{"type":"string","description":"Last name of driver 1. Required when no carrier company is used. At most 20 characters.","example":"Kaya","uniqueKey":"Driver1LastName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver1LastName","typeLabel":"null | string"},"Driver1IdentityNumber":{"oneOf":[{"type":"null","description":"National ID number (TCKN) of driver 1. Required when no carrier company is used. At most 20 characters.","example":"12345678901","uniqueKey":"Driver1IdentityNumber.oneOf.0","typeLabel":"null"},{"type":"string","description":"National ID number (TCKN) of driver 1. Required when no carrier company is used. At most 20 characters.","example":"12345678901","uniqueKey":"Driver1IdentityNumber.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver1IdentityNumber","typeLabel":"null | string"},"Driver2FirstName":{"oneOf":[{"type":"null","description":"First name of driver 2. At most 50 characters.","uniqueKey":"Driver2FirstName.oneOf.0","typeLabel":"null"},{"type":"string","description":"First name of driver 2. At most 50 characters.","uniqueKey":"Driver2FirstName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver2FirstName","typeLabel":"null | string"},"Driver2LastName":{"oneOf":[{"type":"null","description":"Last name of driver 2. At most 20 characters.","uniqueKey":"Driver2LastName.oneOf.0","typeLabel":"null"},{"type":"string","description":"Last name of driver 2. At most 20 characters.","uniqueKey":"Driver2LastName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver2LastName","typeLabel":"null | string"},"Driver2IdentityNumber":{"oneOf":[{"type":"null","description":"National ID number (TCKN) of driver 2. At most 20 characters.","uniqueKey":"Driver2IdentityNumber.oneOf.0","typeLabel":"null"},{"type":"string","description":"National ID number (TCKN) of driver 2. At most 20 characters.","uniqueKey":"Driver2IdentityNumber.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver2IdentityNumber","typeLabel":"null | string"},"TrailerPlate1":{"oneOf":[{"type":"null","description":"Trailer license plate 1. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","example":"34ABC123","uniqueKey":"TrailerPlate1.oneOf.0","typeLabel":"null"},{"type":"string","description":"Trailer license plate 1. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","example":"34ABC123","uniqueKey":"TrailerPlate1.oneOf.1","typeLabel":"string"}],"uniqueKey":"TrailerPlate1","typeLabel":"null | string"},"TrailerPlate2":{"oneOf":[{"type":"null","description":"Trailer license plate 2. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","uniqueKey":"TrailerPlate2.oneOf.0","typeLabel":"null"},{"type":"string","description":"Trailer license plate 2. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","uniqueKey":"TrailerPlate2.oneOf.1","typeLabel":"string"}],"uniqueKey":"TrailerPlate2","typeLabel":"null | string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"Code":"5469","TransportMode":1,"TransportInfo1":"34ABC123","Description":"Istanbul road shipments","TransportInfo2":"\u003cstring>","CarrierName":"Example Logistics Ltd.","CarrierTaxNumber":"1234567890","CarrierCity":"ISTANBUL","CarrierDistrict":"KADIKÖY","CarrierCountry":"TÜRKİYE","Driver1FirstName":"Ahmet","Driver1LastName":"Kaya","Driver1IdentityNumber":"12345678901","Driver2FirstName":"\u003cstring>","Driver2LastName":"\u003cstring>","Driver2IdentityNumber":"\u003cstring>","TrailerPlate1":"34ABC123","TrailerPlate2":"\u003cstring>"}}},"exampleType":"generated"},"application/*+json":{"schema":{"required":["Code","TransportMode","TransportInfo1"],"type":"object","properties":{"Code":{"oneOf":[{"type":"null","description":"Required. Shipment code, unique within the company. At most 50 characters.","example":"5469","isRequired":true,"uniqueKey":"Code.oneOf.0","typeLabel":"null"},{"type":"string","description":"Required. Shipment code, unique within the company. At most 50 characters.","example":"5469","isRequired":true,"uniqueKey":"Code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"Code","typeLabel":"null | string"},"TransportMode":{"type":"integer","description":"Required. 1: Road, 2: Rail, 3: Maritime, 4: Air. Decides what TransportInfo1 and TransportInfo2 mean.","format":"int32","example":1,"isRequired":true,"uniqueKey":"TransportMode","typeLabel":"integer\u003cint32>"},"TransportInfo1":{"oneOf":[{"type":"null","description":"Required. Vehicle identifier, by TransportMode: 1 license plate, 2 train number, 3 vessel name, 4 aircraft number. At most 50 characters.","example":"34ABC123","isRequired":true,"uniqueKey":"TransportInfo1.oneOf.0","typeLabel":"null"},{"type":"string","description":"Required. Vehicle identifier, by TransportMode: 1 license plate, 2 train number, 3 vessel name, 4 aircraft number. At most 50 characters.","example":"34ABC123","isRequired":true,"uniqueKey":"TransportInfo1.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"TransportInfo1","typeLabel":"null | string"},"Description":{"oneOf":[{"type":"null","description":"Description. At most 255 characters.","example":"Istanbul road shipments","uniqueKey":"Description.oneOf.0","typeLabel":"null"},{"type":"string","description":"Description. At most 255 characters.","example":"Istanbul road shipments","uniqueKey":"Description.oneOf.1","typeLabel":"string"}],"uniqueKey":"Description","typeLabel":"null | string"},"TransportInfo2":{"oneOf":[{"type":"null","description":"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.","uniqueKey":"TransportInfo2.oneOf.0","typeLabel":"null"},{"type":"string","description":"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.","uniqueKey":"TransportInfo2.oneOf.1","typeLabel":"string"}],"uniqueKey":"TransportInfo2","typeLabel":"null | string"},"CarrierName":{"oneOf":[{"type":"null","description":"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.","uniqueKey":"CarrierName.oneOf.0","typeLabel":"null"},{"type":"string","description":"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.","uniqueKey":"CarrierName.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierName","typeLabel":"null | string"},"CarrierTaxNumber":{"oneOf":[{"type":"null","description":"Carrier company tax number. At most 50 characters.","example":"1234567890","uniqueKey":"CarrierTaxNumber.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company tax number. At most 50 characters.","example":"1234567890","uniqueKey":"CarrierTaxNumber.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierTaxNumber","typeLabel":"null | string"},"CarrierCity":{"oneOf":[{"type":"null","description":"Carrier company city. At most 50 characters.","example":"ISTANBUL","uniqueKey":"CarrierCity.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company city. At most 50 characters.","example":"ISTANBUL","uniqueKey":"CarrierCity.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierCity","typeLabel":"null | string"},"CarrierDistrict":{"oneOf":[{"type":"null","description":"Carrier company district. At most 50 characters.","example":"KADIKÖY","uniqueKey":"CarrierDistrict.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company district. At most 50 characters.","example":"KADIKÖY","uniqueKey":"CarrierDistrict.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierDistrict","typeLabel":"null | string"},"CarrierCountry":{"oneOf":[{"type":"null","description":"Carrier company country. At most 50 characters.","example":"TÜRKİYE","uniqueKey":"CarrierCountry.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company country. At most 50 characters.","example":"TÜRKİYE","uniqueKey":"CarrierCountry.oneOf.1","typeLabel":"string"}],"uniqueKey":"CarrierCountry","typeLabel":"null | string"},"Driver1FirstName":{"oneOf":[{"type":"null","description":"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","uniqueKey":"Driver1FirstName.oneOf.0","typeLabel":"null"},{"type":"string","description":"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","uniqueKey":"Driver1FirstName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver1FirstName","typeLabel":"null | string"},"Driver1LastName":{"oneOf":[{"type":"null","description":"Last name of driver 1. Required when no carrier company is used. At most 20 characters.","example":"Kaya","uniqueKey":"Driver1LastName.oneOf.0","typeLabel":"null"},{"type":"string","description":"Last name of driver 1. Required when no carrier company is used. At most 20 characters.","example":"Kaya","uniqueKey":"Driver1LastName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver1LastName","typeLabel":"null | string"},"Driver1IdentityNumber":{"oneOf":[{"type":"null","description":"National ID number (TCKN) of driver 1. Required when no carrier company is used. At most 20 characters.","example":"12345678901","uniqueKey":"Driver1IdentityNumber.oneOf.0","typeLabel":"null"},{"type":"string","description":"National ID number (TCKN) of driver 1. Required when no carrier company is used. At most 20 characters.","example":"12345678901","uniqueKey":"Driver1IdentityNumber.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver1IdentityNumber","typeLabel":"null | string"},"Driver2FirstName":{"oneOf":[{"type":"null","description":"First name of driver 2. At most 50 characters.","uniqueKey":"Driver2FirstName.oneOf.0","typeLabel":"null"},{"type":"string","description":"First name of driver 2. At most 50 characters.","uniqueKey":"Driver2FirstName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver2FirstName","typeLabel":"null | string"},"Driver2LastName":{"oneOf":[{"type":"null","description":"Last name of driver 2. At most 20 characters.","uniqueKey":"Driver2LastName.oneOf.0","typeLabel":"null"},{"type":"string","description":"Last name of driver 2. At most 20 characters.","uniqueKey":"Driver2LastName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver2LastName","typeLabel":"null | string"},"Driver2IdentityNumber":{"oneOf":[{"type":"null","description":"National ID number (TCKN) of driver 2. At most 20 characters.","uniqueKey":"Driver2IdentityNumber.oneOf.0","typeLabel":"null"},{"type":"string","description":"National ID number (TCKN) of driver 2. At most 20 characters.","uniqueKey":"Driver2IdentityNumber.oneOf.1","typeLabel":"string"}],"uniqueKey":"Driver2IdentityNumber","typeLabel":"null | string"},"TrailerPlate1":{"oneOf":[{"type":"null","description":"Trailer license plate 1. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","example":"34ABC123","uniqueKey":"TrailerPlate1.oneOf.0","typeLabel":"null"},{"type":"string","description":"Trailer license plate 1. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","example":"34ABC123","uniqueKey":"TrailerPlate1.oneOf.1","typeLabel":"string"}],"uniqueKey":"TrailerPlate1","typeLabel":"null | string"},"TrailerPlate2":{"oneOf":[{"type":"null","description":"Trailer license plate 2. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","uniqueKey":"TrailerPlate2.oneOf.0","typeLabel":"null"},{"type":"string","description":"Trailer license plate 2. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","uniqueKey":"TrailerPlate2.oneOf.1","typeLabel":"string"}],"uniqueKey":"TrailerPlate2","typeLabel":"null | string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"Code":"5469","TransportMode":1,"TransportInfo1":"34ABC123","Description":"Istanbul road shipments","TransportInfo2":"\u003cstring>","CarrierName":"Example Logistics Ltd.","CarrierTaxNumber":"1234567890","CarrierCity":"ISTANBUL","CarrierDistrict":"KADIKÖY","CarrierCountry":"TÜRKİYE","Driver1FirstName":"Ahmet","Driver1LastName":"Kaya","Driver1IdentityNumber":"12345678901","Driver2FirstName":"\u003cstring>","Driver2LastName":"\u003cstring>","Driver2IdentityNumber":"\u003cstring>","TrailerPlate1":"34ABC123","TrailerPlate2":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"8d33c1d7-d613-4024-b1ec-ab10845da362":{"description":"OK","content":{"application/json":{"schema":{"required":["Success","ResultCode","Data"],"type":"object","properties":{"Success":{"type":"boolean","description":"Whether the operation succeeded.","example":true,"isRequired":true,"uniqueKey":"Success","typeLabel":"boolean"},"ResultCode":{"type":"string","description":"\"0000\" on success. On failure, the code of the first error; all errors are listed in Errors.","example":"0000","isRequired":true,"uniqueKey":"ResultCode","typeLabel":"string"},"Data":{"type":"object","properties":{"Id":{"type":"string","description":"Shipment definition ID. Use it as ShipmentDefinitionId in customers.","format":"uuid","uniqueKey":"Data.Id","typeLabel":"string\u003cuuid>"},"Code":{"oneOf":[{"type":"null","description":"Required. Shipment code, unique within the company. At most 50 characters.","example":"5469","uniqueKey":"Data.Code.oneOf.0","typeLabel":"null"},{"type":"string","description":"Required. Shipment code, unique within the company. At most 50 characters.","example":"5469","uniqueKey":"Data.Code.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.Code","typeLabel":"null | string"},"Description":{"oneOf":[{"type":"null","description":"Description. At most 255 characters.","example":"Istanbul road shipments","uniqueKey":"Data.Description.oneOf.0","typeLabel":"null"},{"type":"string","description":"Description. At most 255 characters.","example":"Istanbul road shipments","uniqueKey":"Data.Description.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.Description","typeLabel":"null | string"},"TransportMode":{"type":"integer","description":"Required. 1: Road, 2: Rail, 3: Maritime, 4: Air. Decides what TransportInfo1 and TransportInfo2 mean.","format":"int32","example":1,"uniqueKey":"Data.TransportMode","typeLabel":"integer\u003cint32>"},"TransportInfo1":{"oneOf":[{"type":"null","description":"Required. Vehicle identifier, by TransportMode: 1 license plate, 2 train number, 3 vessel name, 4 aircraft number. At most 50 characters.","example":"34ABC123","uniqueKey":"Data.TransportInfo1.oneOf.0","typeLabel":"null"},{"type":"string","description":"Required. Vehicle identifier, by TransportMode: 1 license plate, 2 train number, 3 vessel name, 4 aircraft number. At most 50 characters.","example":"34ABC123","uniqueKey":"Data.TransportInfo1.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.TransportInfo1","typeLabel":"null | string"},"TransportInfo2":{"oneOf":[{"type":"null","description":"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.","uniqueKey":"Data.TransportInfo2.oneOf.0","typeLabel":"null"},{"type":"string","description":"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.","uniqueKey":"Data.TransportInfo2.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.TransportInfo2","typeLabel":"null | string"},"CarrierName":{"oneOf":[{"type":"null","description":"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.","uniqueKey":"Data.CarrierName.oneOf.0","typeLabel":"null"},{"type":"string","description":"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.","uniqueKey":"Data.CarrierName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.CarrierName","typeLabel":"null | string"},"CarrierTaxNumber":{"oneOf":[{"type":"null","description":"Carrier company tax number. At most 50 characters.","example":"1234567890","uniqueKey":"Data.CarrierTaxNumber.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company tax number. At most 50 characters.","example":"1234567890","uniqueKey":"Data.CarrierTaxNumber.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.CarrierTaxNumber","typeLabel":"null | string"},"CarrierCity":{"oneOf":[{"type":"null","description":"Carrier company city. At most 50 characters.","example":"ISTANBUL","uniqueKey":"Data.CarrierCity.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company city. At most 50 characters.","example":"ISTANBUL","uniqueKey":"Data.CarrierCity.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.CarrierCity","typeLabel":"null | string"},"CarrierDistrict":{"oneOf":[{"type":"null","description":"Carrier company district. At most 50 characters.","example":"KADIKÖY","uniqueKey":"Data.CarrierDistrict.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company district. At most 50 characters.","example":"KADIKÖY","uniqueKey":"Data.CarrierDistrict.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.CarrierDistrict","typeLabel":"null | string"},"CarrierCountry":{"oneOf":[{"type":"null","description":"Carrier company country. At most 50 characters.","example":"TÜRKİYE","uniqueKey":"Data.CarrierCountry.oneOf.0","typeLabel":"null"},{"type":"string","description":"Carrier company country. At most 50 characters.","example":"TÜRKİYE","uniqueKey":"Data.CarrierCountry.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.CarrierCountry","typeLabel":"null | string"},"Driver1FirstName":{"oneOf":[{"type":"null","description":"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","uniqueKey":"Data.Driver1FirstName.oneOf.0","typeLabel":"null"},{"type":"string","description":"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","uniqueKey":"Data.Driver1FirstName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.Driver1FirstName","typeLabel":"null | string"},"Driver1LastName":{"oneOf":[{"type":"null","description":"Last name of driver 1. Required when no carrier company is used. At most 20 characters.","example":"Kaya","uniqueKey":"Data.Driver1LastName.oneOf.0","typeLabel":"null"},{"type":"string","description":"Last name of driver 1. Required when no carrier company is used. At most 20 characters.","example":"Kaya","uniqueKey":"Data.Driver1LastName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.Driver1LastName","typeLabel":"null | string"},"Driver1IdentityNumber":{"oneOf":[{"type":"null","description":"National ID number (TCKN) of driver 1. Required when no carrier company is used. At most 20 characters.","example":"12345678901","uniqueKey":"Data.Driver1IdentityNumber.oneOf.0","typeLabel":"null"},{"type":"string","description":"National ID number (TCKN) of driver 1. Required when no carrier company is used. At most 20 characters.","example":"12345678901","uniqueKey":"Data.Driver1IdentityNumber.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.Driver1IdentityNumber","typeLabel":"null | string"},"Driver2FirstName":{"oneOf":[{"type":"null","description":"First name of driver 2. At most 50 characters.","uniqueKey":"Data.Driver2FirstName.oneOf.0","typeLabel":"null"},{"type":"string","description":"First name of driver 2. At most 50 characters.","uniqueKey":"Data.Driver2FirstName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.Driver2FirstName","typeLabel":"null | string"},"Driver2LastName":{"oneOf":[{"type":"null","description":"Last name of driver 2. At most 20 characters.","uniqueKey":"Data.Driver2LastName.oneOf.0","typeLabel":"null"},{"type":"string","description":"Last name of driver 2. At most 20 characters.","uniqueKey":"Data.Driver2LastName.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.Driver2LastName","typeLabel":"null | string"},"Driver2IdentityNumber":{"oneOf":[{"type":"null","description":"National ID number (TCKN) of driver 2. At most 20 characters.","uniqueKey":"Data.Driver2IdentityNumber.oneOf.0","typeLabel":"null"},{"type":"string","description":"National ID number (TCKN) of driver 2. At most 20 characters.","uniqueKey":"Data.Driver2IdentityNumber.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.Driver2IdentityNumber","typeLabel":"null | string"},"TrailerPlate1":{"oneOf":[{"type":"null","description":"Trailer license plate 1. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","example":"34ABC123","uniqueKey":"Data.TrailerPlate1.oneOf.0","typeLabel":"null"},{"type":"string","description":"Trailer license plate 1. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","example":"34ABC123","uniqueKey":"Data.TrailerPlate1.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.TrailerPlate1","typeLabel":"null | string"},"TrailerPlate2":{"oneOf":[{"type":"null","description":"Trailer license plate 2. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","uniqueKey":"Data.TrailerPlate2.oneOf.0","typeLabel":"null"},{"type":"string","description":"Trailer license plate 2. Stored only when TransportMode is 1 (road) and no carrier company is used. At most 20 characters.","uniqueKey":"Data.TrailerPlate2.oneOf.1","typeLabel":"string"}],"uniqueKey":"Data.TrailerPlate2","typeLabel":"null | string"}},"isRequired":true,"uniqueKey":"Data","typeLabel":"object"},"Message":{"oneOf":[{"type":"null","description":"Error message when Success is false. Messages of all errors are joined into a single text.","uniqueKey":"Message.oneOf.0","typeLabel":"null"},{"type":"string","description":"Error message when Success is false. Messages of all errors are joined into a single text.","uniqueKey":"Message.oneOf.1","typeLabel":"string"}],"uniqueKey":"Message","typeLabel":"null | string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"Success":true,"ResultCode":"0000","Data":{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Code":"5469","Description":"Istanbul road shipments","TransportMode":1,"TransportInfo1":"34ABC123","TransportInfo2":"\u003cstring>","CarrierName":"Example Logistics Ltd.","CarrierTaxNumber":"1234567890","CarrierCity":"ISTANBUL","CarrierDistrict":"KADIKÖY","CarrierCountry":"TÜRKİYE","Driver1FirstName":"Ahmet","Driver1LastName":"Kaya","Driver1IdentityNumber":"12345678901","Driver2FirstName":"\u003cstring>","Driver2LastName":"\u003cstring>","Driver2IdentityNumber":"\u003cstring>","TrailerPlate1":"34ABC123","TrailerPlate2":"\u003cstring>"},"Message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f258e97e-94d2-40da-8184-8a987b0295b7":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"Whether the operation succeeded.","example":false,"uniqueKey":"Success","typeLabel":"boolean"},"ResultCode":{"oneOf":[{"type":"null","description":"\"0000\" on success. On failure, the code of the first error; all errors are listed in Errors.","uniqueKey":"ResultCode.oneOf.0","typeLabel":"null"},{"type":"string","description":"\"0000\" on success. On failure, the code of the first error; all errors are listed in Errors.","uniqueKey":"ResultCode.oneOf.1","typeLabel":"string"}],"uniqueKey":"ResultCode","typeLabel":"null | string"},"Message":{"oneOf":[{"type":"null","description":"Error message when Success is false. Messages of all errors are joined into a single text.","uniqueKey":"Message.oneOf.0","typeLabel":"null"},{"type":"string","description":"Error message when Success is false. Messages of all errors are joined into a single text.","uniqueKey":"Message.oneOf.1","typeLabel":"string"}],"uniqueKey":"Message","typeLabel":"null | string"},"TraceId":{"oneOf":[{"type":"null","description":"Support reference of an unexpected server error (ResultCode 0001). Share it with Noyax support so the error can be found. Only present on 500 responses.","uniqueKey":"TraceId.oneOf.0","typeLabel":"null"},{"type":"string","description":"Support reference of an unexpected server error (ResultCode 0001). Share it with Noyax support so the error can be found. Only present on 500 responses.","uniqueKey":"TraceId.oneOf.1","typeLabel":"string"}],"uniqueKey":"TraceId","typeLabel":"null | string"},"Errors":{"oneOf":[{"type":"null","items":{"required":["Code","Message"],"type":"object","properties":{"Code":{"type":"string","description":"Error code. See the result codes page for the full list."},"Message":{"type":"string","description":"Error description."}}},"description":"All errors with their codes. Only present when Success is false.","uniqueKey":"Errors.oneOf.0","typeLabel":"null"},{"type":"array","items":{"required":["Code","Message"],"type":"object","properties":{"Code":{"type":"string","description":"Error code. See the result codes page for the full list.","isRequired":true,"uniqueKey":"Errors.oneOf.1.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","description":"Error description.","isRequired":true,"uniqueKey":"Errors.oneOf.1.items.[INDEX].Message","typeLabel":"string"}},"uniqueKey":"Errors.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"All errors with their codes. Only present when Success is false.","uniqueKey":"Errors.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"Errors","typeLabel":"null | object[]"},"ExistingId":{"oneOf":[{"type":"null","description":"ID of the record that already exists, when the error is a duplicate (for example 1002: the customer that already uses the CustomerCode). Only present on such errors.","format":"uuid","uniqueKey":"ExistingId.oneOf.0","typeLabel":"null"},{"type":"string","description":"ID of the record that already exists, when the error is a duplicate (for example 1002: the customer that already uses the CustomerCode). Only present on such errors.","format":"uuid","uniqueKey":"ExistingId.oneOf.1","typeLabel":"string\u003cuuid>"}],"uniqueKey":"ExistingId","typeLabel":"null | string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"example":{"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)."}]},"examples":{"Example":{"title":"Example","value":{"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)."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d949981a-7b41-420d-abe9-dbd90f3c65cf":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"Whether the operation succeeded.","example":false,"uniqueKey":"Success","typeLabel":"boolean"},"ResultCode":{"oneOf":[{"type":"null","description":"\"0000\" on success. On failure, the code of the first error; all errors are listed in Errors.","uniqueKey":"ResultCode.oneOf.0","typeLabel":"null"},{"type":"string","description":"\"0000\" on success. On failure, the code of the first error; all errors are listed in Errors.","uniqueKey":"ResultCode.oneOf.1","typeLabel":"string"}],"uniqueKey":"ResultCode","typeLabel":"null | string"},"Message":{"oneOf":[{"type":"null","description":"Error message when Success is false. Messages of all errors are joined into a single text.","uniqueKey":"Message.oneOf.0","typeLabel":"null"},{"type":"string","description":"Error message when Success is false. Messages of all errors are joined into a single text.","uniqueKey":"Message.oneOf.1","typeLabel":"string"}],"uniqueKey":"Message","typeLabel":"null | string"},"TraceId":{"oneOf":[{"type":"null","description":"Support reference of an unexpected server error (ResultCode 0001). Share it with Noyax support so the error can be found. Only present on 500 responses.","uniqueKey":"TraceId.oneOf.0","typeLabel":"null"},{"type":"string","description":"Support reference of an unexpected server error (ResultCode 0001). Share it with Noyax support so the error can be found. Only present on 500 responses.","uniqueKey":"TraceId.oneOf.1","typeLabel":"string"}],"uniqueKey":"TraceId","typeLabel":"null | string"},"Errors":{"oneOf":[{"type":"null","items":{"required":["Code","Message"],"type":"object","properties":{"Code":{"type":"string","description":"Error code. See the result codes page for the full list."},"Message":{"type":"string","description":"Error description."}}},"description":"All errors with their codes. Only present when Success is false.","uniqueKey":"Errors.oneOf.0","typeLabel":"null"},{"type":"array","items":{"required":["Code","Message"],"type":"object","properties":{"Code":{"type":"string","description":"Error code. See the result codes page for the full list.","isRequired":true,"uniqueKey":"Errors.oneOf.1.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","description":"Error description.","isRequired":true,"uniqueKey":"Errors.oneOf.1.items.[INDEX].Message","typeLabel":"string"}},"uniqueKey":"Errors.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"All errors with their codes. Only present when Success is false.","uniqueKey":"Errors.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"Errors","typeLabel":"null | object[]"},"ExistingId":{"oneOf":[{"type":"null","description":"ID of the record that already exists, when the error is a duplicate (for example 1002: the customer that already uses the CustomerCode). Only present on such errors.","format":"uuid","uniqueKey":"ExistingId.oneOf.0","typeLabel":"null"},{"type":"string","description":"ID of the record that already exists, when the error is a duplicate (for example 1002: the customer that already uses the CustomerCode). Only present on such errors.","format":"uuid","uniqueKey":"ExistingId.oneOf.1","typeLabel":"string\u003cuuid>"}],"uniqueKey":"ExistingId","typeLabel":"null | string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"example":{"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."}]},"examples":{"Example":{"title":"Example","value":{"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."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"3debad33-2f03-42c5-9462-54d53015290f":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"Whether the operation succeeded.","example":false,"uniqueKey":"Success","typeLabel":"boolean"},"ResultCode":{"oneOf":[{"type":"null","description":"\"0000\" on success. On failure, the code of the first error; all errors are listed in Errors.","uniqueKey":"ResultCode.oneOf.0","typeLabel":"null"},{"type":"string","description":"\"0000\" on success. On failure, the code of the first error; all errors are listed in Errors.","uniqueKey":"ResultCode.oneOf.1","typeLabel":"string"}],"uniqueKey":"ResultCode","typeLabel":"null | string"},"Message":{"oneOf":[{"type":"null","description":"Error message when Success is false. Messages of all errors are joined into a single text.","uniqueKey":"Message.oneOf.0","typeLabel":"null"},{"type":"string","description":"Error message when Success is false. Messages of all errors are joined into a single text.","uniqueKey":"Message.oneOf.1","typeLabel":"string"}],"uniqueKey":"Message","typeLabel":"null | string"},"TraceId":{"oneOf":[{"type":"null","description":"Support reference of an unexpected server error (ResultCode 0001). Share it with Noyax support so the error can be found. Only present on 500 responses.","uniqueKey":"TraceId.oneOf.0","typeLabel":"null"},{"type":"string","description":"Support reference of an unexpected server error (ResultCode 0001). Share it with Noyax support so the error can be found. Only present on 500 responses.","uniqueKey":"TraceId.oneOf.1","typeLabel":"string"}],"uniqueKey":"TraceId","typeLabel":"null | string"},"Errors":{"oneOf":[{"type":"null","items":{"required":["Code","Message"],"type":"object","properties":{"Code":{"type":"string","description":"Error code. See the result codes page for the full list."},"Message":{"type":"string","description":"Error description."}}},"description":"All errors with their codes. Only present when Success is false.","uniqueKey":"Errors.oneOf.0","typeLabel":"null"},{"type":"array","items":{"required":["Code","Message"],"type":"object","properties":{"Code":{"type":"string","description":"Error code. See the result codes page for the full list.","isRequired":true,"uniqueKey":"Errors.oneOf.1.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","description":"Error description.","isRequired":true,"uniqueKey":"Errors.oneOf.1.items.[INDEX].Message","typeLabel":"string"}},"uniqueKey":"Errors.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"All errors with their codes. Only present when Success is false.","uniqueKey":"Errors.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"Errors","typeLabel":"null | object[]"},"ExistingId":{"oneOf":[{"type":"null","description":"ID of the record that already exists, when the error is a duplicate (for example 1002: the customer that already uses the CustomerCode). Only present on such errors.","format":"uuid","uniqueKey":"ExistingId.oneOf.0","typeLabel":"null"},{"type":"string","description":"ID of the record that already exists, when the error is a duplicate (for example 1002: the customer that already uses the CustomerCode). Only present on such errors.","format":"uuid","uniqueKey":"ExistingId.oneOf.1","typeLabel":"string\u003cuuid>"}],"uniqueKey":"ExistingId","typeLabel":"null | string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"example":{"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."}]},"examples":{"Example":{"title":"Example","value":{"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."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"f4239c3f-ab41-4076-b7e3-4d13a993e6e8":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"Whether the operation succeeded.","example":false,"uniqueKey":"Success","typeLabel":"boolean"},"ResultCode":{"oneOf":[{"type":"null","description":"\"0000\" on success. On failure, the code of the first error; all errors are listed in Errors.","uniqueKey":"ResultCode.oneOf.0","typeLabel":"null"},{"type":"string","description":"\"0000\" on success. On failure, the code of the first error; all errors are listed in Errors.","uniqueKey":"ResultCode.oneOf.1","typeLabel":"string"}],"uniqueKey":"ResultCode","typeLabel":"null | string"},"Message":{"oneOf":[{"type":"null","description":"Error message when Success is false. Messages of all errors are joined into a single text.","uniqueKey":"Message.oneOf.0","typeLabel":"null"},{"type":"string","description":"Error message when Success is false. Messages of all errors are joined into a single text.","uniqueKey":"Message.oneOf.1","typeLabel":"string"}],"uniqueKey":"Message","typeLabel":"null | string"},"TraceId":{"oneOf":[{"type":"null","description":"Support reference of an unexpected server error (ResultCode 0001). Share it with Noyax support so the error can be found. Only present on 500 responses.","uniqueKey":"TraceId.oneOf.0","typeLabel":"null"},{"type":"string","description":"Support reference of an unexpected server error (ResultCode 0001). Share it with Noyax support so the error can be found. Only present on 500 responses.","uniqueKey":"TraceId.oneOf.1","typeLabel":"string"}],"uniqueKey":"TraceId","typeLabel":"null | string"},"Errors":{"oneOf":[{"type":"null","items":{"required":["Code","Message"],"type":"object","properties":{"Code":{"type":"string","description":"Error code. See the result codes page for the full list."},"Message":{"type":"string","description":"Error description."}}},"description":"All errors with their codes. Only present when Success is false.","uniqueKey":"Errors.oneOf.0","typeLabel":"null"},{"type":"array","items":{"required":["Code","Message"],"type":"object","properties":{"Code":{"type":"string","description":"Error code. See the result codes page for the full list.","isRequired":true,"uniqueKey":"Errors.oneOf.1.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","description":"Error description.","isRequired":true,"uniqueKey":"Errors.oneOf.1.items.[INDEX].Message","typeLabel":"string"}},"uniqueKey":"Errors.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"All errors with their codes. Only present when Success is false.","uniqueKey":"Errors.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"Errors","typeLabel":"null | object[]"},"ExistingId":{"oneOf":[{"type":"null","description":"ID of the record that already exists, when the error is a duplicate (for example 1002: the customer that already uses the CustomerCode). Only present on such errors.","format":"uuid","uniqueKey":"ExistingId.oneOf.0","typeLabel":"null"},{"type":"string","description":"ID of the record that already exists, when the error is a duplicate (for example 1002: the customer that already uses the CustomerCode). Only present on such errors.","format":"uuid","uniqueKey":"ExistingId.oneOf.1","typeLabel":"string\u003cuuid>"}],"uniqueKey":"ExistingId","typeLabel":"null | string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"example":{"Success":false,"ResultCode":"0530","Message":"Shipment definition not found.","Errors":[{"Code":"0530","Message":"Shipment definition not found."}]},"examples":{"Example":{"title":"Example","value":{"Success":false,"ResultCode":"0530","Message":"Shipment definition not found.","Errors":[{"Code":"0530","Message":"Shipment definition not found."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"4659f992-82af-45ef-b3bc-2bf73435ec88":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"Whether the operation succeeded.","example":false,"uniqueKey":"Success","typeLabel":"boolean"},"ResultCode":{"oneOf":[{"type":"null","description":"\"0000\" on success. On failure, the code of the first error; all errors are listed in Errors.","uniqueKey":"ResultCode.oneOf.0","typeLabel":"null"},{"type":"string","description":"\"0000\" on success. On failure, the code of the first error; all errors are listed in Errors.","uniqueKey":"ResultCode.oneOf.1","typeLabel":"string"}],"uniqueKey":"ResultCode","typeLabel":"null | string"},"Message":{"oneOf":[{"type":"null","description":"Error message when Success is false. Messages of all errors are joined into a single text.","uniqueKey":"Message.oneOf.0","typeLabel":"null"},{"type":"string","description":"Error message when Success is false. Messages of all errors are joined into a single text.","uniqueKey":"Message.oneOf.1","typeLabel":"string"}],"uniqueKey":"Message","typeLabel":"null | string"},"TraceId":{"oneOf":[{"type":"null","description":"Support reference of an unexpected server error (ResultCode 0001). Share it with Noyax support so the error can be found. Only present on 500 responses.","uniqueKey":"TraceId.oneOf.0","typeLabel":"null"},{"type":"string","description":"Support reference of an unexpected server error (ResultCode 0001). Share it with Noyax support so the error can be found. Only present on 500 responses.","uniqueKey":"TraceId.oneOf.1","typeLabel":"string"}],"uniqueKey":"TraceId","typeLabel":"null | string"},"Errors":{"oneOf":[{"type":"null","items":{"required":["Code","Message"],"type":"object","properties":{"Code":{"type":"string","description":"Error code. See the result codes page for the full list."},"Message":{"type":"string","description":"Error description."}}},"description":"All errors with their codes. Only present when Success is false.","uniqueKey":"Errors.oneOf.0","typeLabel":"null"},{"type":"array","items":{"required":["Code","Message"],"type":"object","properties":{"Code":{"type":"string","description":"Error code. See the result codes page for the full list.","isRequired":true,"uniqueKey":"Errors.oneOf.1.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","description":"Error description.","isRequired":true,"uniqueKey":"Errors.oneOf.1.items.[INDEX].Message","typeLabel":"string"}},"uniqueKey":"Errors.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"All errors with their codes. Only present when Success is false.","uniqueKey":"Errors.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"Errors","typeLabel":"null | object[]"},"ExistingId":{"oneOf":[{"type":"null","description":"ID of the record that already exists, when the error is a duplicate (for example 1002: the customer that already uses the CustomerCode). Only present on such errors.","format":"uuid","uniqueKey":"ExistingId.oneOf.0","typeLabel":"null"},{"type":"string","description":"ID of the record that already exists, when the error is a duplicate (for example 1002: the customer that already uses the CustomerCode). Only present on such errors.","format":"uuid","uniqueKey":"ExistingId.oneOf.1","typeLabel":"string\u003cuuid>"}],"uniqueKey":"ExistingId","typeLabel":"null | string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"example":{"Success":false,"ResultCode":"0120","Message":"Daily request limit (10000) exceeded.","Errors":[{"Code":"0120","Message":"Daily request limit (10000) exceeded."}]},"examples":{"Example":{"title":"Example","value":{"Success":false,"ResultCode":"0120","Message":"Daily request limit (10000) exceeded.","Errors":[{"Code":"0120","Message":"Daily request limit (10000) exceeded."}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"2360e6fe-3f5d-4cb2-a410-60ae58b2515b":{"Bearer":{"type":"http","description":"Access token obtained from the Noyax auth service with your API key.","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"}}},"servers":{"751ff55a-b28a-4823-93a0-54b137dafaf3":{"url":"https://api.noyax.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Access token obtained from the Noyax auth service with your API key.","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Access token obtained from the Noyax auth service with your API key.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"noyax","siteName":"Noyax API","title":"Update shipment definition - Noyax API","navMaps":{"firstHrefInVersion":{"v1":{"href":"/en/v1/definitions/shipment-definitions/update","matchLevel":0}},"firstHrefInLanguage":{"tr":{"href":"/tr/v1/definitions/shipment-definitions/update","matchLevel":1},"en":{"href":"/en/v1/definitions/shipment-definitions/update","matchLevel":0}}},"lastModified":"2026-11-12T07:59:14.475Z","originalFileLocation":"en/v1/definitions/shipment-definitions/update.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Replaces all fields of a shipment definition.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Noyax API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/noyax/9sQuPgprl2ESyHgF/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/noyax/9sQuPgprl2ESyHgF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/noyax/9sQuPgprl2ESyHgF/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/noyax/9sQuPgprl2ESyHgF/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/noyax/9sQuPgprl2ESyHgF/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/noyax/9sQuPgprl2ESyHgF/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/noyax/9sQuPgprl2ESyHgF/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/noyax/9sQuPgprl2ESyHgF/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/noyax/9sQuPgprl2ESyHgF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update shipment definition - Noyax API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Replaces all fields of a shipment definition.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Noyax API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://apidocs.noyax.com/en/v1/definitions/shipment-definitions/update\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://noyax.mintlify.site/_mintlify/api/og/v2?division=Shipment+definitions\u0026amp;title=Update+shipment+definition\u0026amp;description=Replaces+all+fields+of+a+shipment+definition.\u0026amp;theme=ada594ee3d688db06027175d\u0026amp;signature=d1fd2a9a27c9bdd288d3989c125ed27c789694de288c72ad1f619735a77f39b5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update shipment definition - Noyax API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Replaces all fields of a shipment definition.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://noyax.mintlify.site/_mintlify/api/og/v2?division=Shipment+definitions\u0026amp;title=Update+shipment+definition\u0026amp;description=Replaces+all+fields+of+a+shipment+definition.\u0026amp;theme=ada594ee3d688db06027175d\u0026amp;signature=d1fd2a9a27c9bdd288d3989c125ed27c789694de288c72ad1f619735a77f39b5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/noyax/9sQuPgprl2ESyHgF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Noyax API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B4AFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://apidocs.noyax.com/en/v1/definitions/shipment-definitions/update\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/v1/definitions/shipment-definitions/update.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://apidocs.noyax.com/en/v1/definitions/shipment-definitions/update\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"tr\" href=\"https://apidocs.noyax.com/tr/v1/definitions/shipment-definitions/update\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://apidocs.noyax.com/tr/v1/definitions/shipment-definitions/update\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://apidocs.noyax.com/#organization\",\"name\":\"Noyax API\",\"url\":\"https://apidocs.noyax.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/noyax/K7LxoYHrQCdoQ4jy/logo/light.svg?fit=max\u0026auto=format\u0026n=K7LxoYHrQCdoQ4jy\u0026q=85\u0026s=78086fed969cddbbf46c4cd156eff780\"}},{\"@type\":\"WebSite\",\"@id\":\"https://apidocs.noyax.com#website\",\"name\":\"Noyax API\",\"url\":\"https://apidocs.noyax.com\",\"publisher\":{\"@id\":\"https://apidocs.noyax.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://apidocs.noyax.com/en/v1/definitions/shipment-definitions/update#webpage\",\"url\":\"https://apidocs.noyax.com/en/v1/definitions/shipment-definitions/update\",\"name\":\"Update shipment definition\",\"description\":\"Replaces all fields of a shipment definition.\",\"dateModified\":\"2026-11-12T07:59:14.475Z\",\"isPartOf\":{\"@id\":\"https://apidocs.noyax.com#website\"},\"breadcrumb\":{\"@id\":\"https://apidocs.noyax.com/en/v1/definitions/shipment-definitions/update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://apidocs.noyax.com/en/v1/definitions/shipment-definitions/update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Modules\",\"item\":\"https://apidocs.noyax.com/en/v1/definitions/countries/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Definitions\",\"item\":\"https://apidocs.noyax.com/en/v1/definitions/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Shipment definitions\",\"item\":\"https://apidocs.noyax.com/en/v1/definitions/shipment-definitions/list\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Update shipment definition\",\"item\":\"https://apidocs.noyax.com/en/v1/definitions/shipment-definitions/update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://apidocs.noyax.com/en/v1/definitions/shipment-definitions/update#apireference\",\"headline\":\"Update shipment definition\",\"name\":\"Update shipment definition\",\"description\":\"Replaces all fields of a shipment definition.\",\"url\":\"https://apidocs.noyax.com/en/v1/definitions/shipment-definitions/update\",\"mainEntityOfPage\":{\"@id\":\"https://apidocs.noyax.com/en/v1/definitions/shipment-definitions/update#webpage\"},\"dateModified\":\"2026-11-12T07:59:14.475Z\",\"publisher\":{\"@id\":\"https://apidocs.noyax.com/#organization\"},\"isPartOf\":{\"@id\":\"https://apidocs.noyax.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Noyax API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Noyax API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/en/v1/definitions/shipment-definitions/update.md","siteName":"Noyax API","nav":{"global":null,"languages":[{"language":"tr","default":true,"pages":[{"title":"tr","href":"/tr/v1/definitions/shipment-definitions/update"}]},{"language":"en","versions":[{"version":"v1","default":true,"groups":[{"group":"Getting started","pages":[{"title":"Noyax API","sidebarTitle":"Introduction","icon":"house","href":"/en/v1"},{"title":"Quickstart","icon":"rocket","href":"/en/v1/quickstart"},{"title":"Postman collection","icon":"download","href":"/en/v1/postman"}]},{"group":"Core concepts","pages":[{"title":"Authentication","icon":"key","href":"/en/v1/guides/authentication"},{"title":"Request headers","icon":"id-card","href":"/en/v1/guides/request-context"},{"title":"Permissions","icon":"shield-check","href":"/en/v1/guides/permissions"},{"title":"Rate limits","icon":"gauge","href":"/en/v1/guides/rate-limits"},{"title":"Partial update","icon":"pen-to-square","href":"/en/v1/guides/partial-update"},{"title":"Errors","icon":"triangle-exclamation","href":"/en/v1/guides/errors"},{"title":"Result codes","icon":"list-ol","href":"/en/v1/guides/result-codes"},{"title":"Pagination and search","icon":"list","href":"/en/v1/guides/pagination-search"},{"title":"Sharing codes","icon":"eye","href":"/en/v1/guides/sharing-codes"},{"title":"Versioning","icon":"code-branch","href":"/en/v1/guides/versioning"}]},{"group":"Modules","icon":"layer-group","pages":[{"group":"Definitions","icon":"book","root":{"title":"Definitions","icon":"book","href":"/en/v1/definitions/overview"},"expanded":false,"pages":[{"group":"Countries","icon":"earth-europe","pages":[{"title":"List countries","openapi":"api-reference/openapi.json GET /api/v1/definitions/countries","href":"/en/v1/definitions/countries/list"},{"title":"Get country","openapi":"api-reference/openapi.json GET /api/v1/definitions/countries/{countryId}","href":"/en/v1/definitions/countries/get"},{"title":"Create country","openapi":"api-reference/openapi.json POST /api/v1/definitions/countries","href":"/en/v1/definitions/countries/create"},{"title":"Update country","openapi":"api-reference/openapi.json PUT /api/v1/definitions/countries/{countryId}","href":"/en/v1/definitions/countries/update"},{"title":"Partially update country","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/countries/{countryId}","href":"/en/v1/definitions/countries/patch"},{"title":"Delete country","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/countries/{countryId}","href":"/en/v1/definitions/countries/delete"}]},{"group":"Cities","icon":"city","pages":[{"title":"List cities","openapi":"api-reference/openapi.json GET /api/v1/definitions/cities","href":"/en/v1/definitions/cities/list"},{"title":"Get city","openapi":"api-reference/openapi.json GET /api/v1/definitions/cities/{cityId}","href":"/en/v1/definitions/cities/get"},{"title":"Create city","openapi":"api-reference/openapi.json POST /api/v1/definitions/cities","href":"/en/v1/definitions/cities/create"},{"title":"Update city","openapi":"api-reference/openapi.json PUT /api/v1/definitions/cities/{cityId}","href":"/en/v1/definitions/cities/update"},{"title":"Partially update city","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/cities/{cityId}","href":"/en/v1/definitions/cities/patch"},{"title":"Delete city","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/cities/{cityId}","href":"/en/v1/definitions/cities/delete"}]},{"group":"Districts","icon":"map-pin","pages":[{"title":"List districts","openapi":"api-reference/openapi.json GET /api/v1/definitions/districts","href":"/en/v1/definitions/districts/list"},{"title":"Get district","openapi":"api-reference/openapi.json GET /api/v1/definitions/districts/{districtId}","href":"/en/v1/definitions/districts/get"},{"title":"Create district","openapi":"api-reference/openapi.json POST /api/v1/definitions/districts","href":"/en/v1/definitions/districts/create"},{"title":"Update district","openapi":"api-reference/openapi.json PUT /api/v1/definitions/districts/{districtId}","href":"/en/v1/definitions/districts/update"},{"title":"Partially update district","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/districts/{districtId}","href":"/en/v1/definitions/districts/patch"},{"title":"Delete district","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/districts/{districtId}","href":"/en/v1/definitions/districts/delete"}]},{"group":"Currencies","icon":"coins","pages":[{"title":"List currencies","openapi":"api-reference/openapi.json GET /api/v1/definitions/currencies","href":"/en/v1/definitions/currencies/list"},{"title":"Get currency","openapi":"api-reference/openapi.json GET /api/v1/definitions/currencies/{currencyId}","href":"/en/v1/definitions/currencies/get"},{"title":"Create currency","openapi":"api-reference/openapi.json POST /api/v1/definitions/currencies","href":"/en/v1/definitions/currencies/create"},{"title":"Update currency","openapi":"api-reference/openapi.json PUT /api/v1/definitions/currencies/{currencyId}","href":"/en/v1/definitions/currencies/update"},{"title":"Partially update currency","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/currencies/{currencyId}","href":"/en/v1/definitions/currencies/patch"},{"title":"Delete currency","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/currencies/{currencyId}","href":"/en/v1/definitions/currencies/delete"}]},{"group":"Units","icon":"ruler","pages":[{"title":"List units","openapi":"api-reference/openapi.json GET /api/v1/definitions/units","href":"/en/v1/definitions/units/list"},{"title":"Get unit","openapi":"api-reference/openapi.json GET /api/v1/definitions/units/{unitId}","href":"/en/v1/definitions/units/get"},{"title":"Create unit","openapi":"api-reference/openapi.json POST /api/v1/definitions/units","href":"/en/v1/definitions/units/create"},{"title":"Update unit","openapi":"api-reference/openapi.json PUT /api/v1/definitions/units/{unitId}","href":"/en/v1/definitions/units/update"},{"title":"Partially update unit","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/units/{unitId}","href":"/en/v1/definitions/units/patch"},{"title":"Delete unit","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/units/{unitId}","href":"/en/v1/definitions/units/delete"}]},{"group":"Line groups","icon":"layer-group","pages":[{"title":"List line groups","openapi":"api-reference/openapi.json GET /api/v1/definitions/line-groups","href":"/en/v1/definitions/line-groups/list"},{"title":"Get line group","openapi":"api-reference/openapi.json GET /api/v1/definitions/line-groups/{lineGroupId}","href":"/en/v1/definitions/line-groups/get"},{"title":"Create line group","openapi":"api-reference/openapi.json POST /api/v1/definitions/line-groups","href":"/en/v1/definitions/line-groups/create"},{"title":"Update line group","openapi":"api-reference/openapi.json PUT /api/v1/definitions/line-groups/{lineGroupId}","href":"/en/v1/definitions/line-groups/update"},{"title":"Partially update line group","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/line-groups/{lineGroupId}","href":"/en/v1/definitions/line-groups/patch"},{"title":"Delete line group","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/line-groups/{lineGroupId}","href":"/en/v1/definitions/line-groups/delete"}]},{"group":"VAT rates","icon":"percent","pages":[{"title":"List VAT rates","openapi":"api-reference/openapi.json GET /api/v1/definitions/vat-rates","href":"/en/v1/definitions/vat-rates/list"}]},{"group":"Shipment definitions","icon":"truck","pages":[{"title":"List shipment definitions","openapi":"api-reference/openapi.json GET /api/v1/definitions/shipment-definitions","href":"/en/v1/definitions/shipment-definitions/list"},{"title":"Get shipment definition","openapi":"api-reference/openapi.json GET /api/v1/definitions/shipment-definitions/{shipmentDefinitionId}","href":"/en/v1/definitions/shipment-definitions/get"},{"title":"Create shipment definition","description":"Adds a shipment definition.","openapi":"api-reference/openapi.json POST /api/v1/definitions/shipment-definitions","href":"/en/v1/definitions/shipment-definitions/create"},{"title":"Update shipment definition","openapi":"api-reference/openapi.json PUT /api/v1/definitions/shipment-definitions/{shipmentDefinitionId}","href":"/en/v1/definitions/shipment-definitions/update"},{"title":"Partially update shipment definition","description":"Changes only the sent fields of a shipment definition.","openapi":"api-reference/openapi.json PATCH /api/v1/definitions/shipment-definitions/{shipmentDefinitionId}","href":"/en/v1/definitions/shipment-definitions/patch"},{"title":"Delete shipment definition","openapi":"api-reference/openapi.json DELETE /api/v1/definitions/shipment-definitions/{shipmentDefinitionId}","href":"/en/v1/definitions/shipment-definitions/delete"}]}]},{"group":"Customers","icon":"users","root":{"title":"Customer record","icon":"user","href":"/en/v1/customers/overview"},"expanded":false,"pages":[{"title":"Customer code generation","icon":"hashtag","href":"/en/v1/customers/customer-code"},{"group":"Customer definitions","icon":"book-open","pages":[{"title":"List customer groups","openapi":"api-reference/openapi.json GET /api/v1/customers/groups","href":"/en/v1/customers/definitions/groups"},{"group":"Parameter definitions","pages":[{"title":"List customer parameter definitions","openapi":"api-reference/openapi.json GET /api/v1/customers/parameter-definitions","href":"/en/v1/customers/definitions/parameter-definitions/list"},{"title":"Get customer parameter definition","openapi":"api-reference/openapi.json GET /api/v1/customers/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/customers/definitions/parameter-definitions/get"},{"title":"Create customer parameter definition","openapi":"api-reference/openapi.json POST /api/v1/customers/parameter-definitions","href":"/en/v1/customers/definitions/parameter-definitions/create"},{"title":"Update customer parameter definition","openapi":"api-reference/openapi.json PUT /api/v1/customers/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/customers/definitions/parameter-definitions/update"},{"title":"Partially update customer parameter definition","openapi":"api-reference/openapi.json PATCH /api/v1/customers/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/customers/definitions/parameter-definitions/patch"},{"title":"Delete customer parameter definition","openapi":"api-reference/openapi.json DELETE /api/v1/customers/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/customers/definitions/parameter-definitions/delete"}]}]},{"group":"Customer endpoints","icon":"user","pages":[{"title":"List customers","openapi":"api-reference/openapi.json GET /api/v1/customers","href":"/en/v1/customers/list"},{"title":"Get customer","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}","href":"/en/v1/customers/get"},{"title":"Create customer","openapi":"api-reference/openapi.json POST /api/v1/customers","href":"/en/v1/customers/create"},{"title":"Update customer","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}","href":"/en/v1/customers/update"},{"title":"Partially update customer","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}","href":"/en/v1/customers/patch"},{"title":"Delete customer","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}","href":"/en/v1/customers/delete"}]},{"group":"Addresses","icon":"location-dot","pages":[{"title":"List addresses","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/addresses","href":"/en/v1/customers/addresses/list"},{"title":"Get address","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/addresses/{addressId}","href":"/en/v1/customers/addresses/get"},{"title":"Create address","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/addresses","href":"/en/v1/customers/addresses/create"},{"title":"Update address","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/addresses/{addressId}","href":"/en/v1/customers/addresses/update"},{"title":"Partially update address","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/addresses/{addressId}","href":"/en/v1/customers/addresses/patch"},{"title":"Delete address","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/addresses/{addressId}","href":"/en/v1/customers/addresses/delete"}]},{"group":"Telephones","icon":"phone","pages":[{"title":"List telephones","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/telephones","href":"/en/v1/customers/telephones/list"},{"title":"Get telephone","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/telephones/{telephoneId}","href":"/en/v1/customers/telephones/get"},{"title":"Create telephone","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/telephones","href":"/en/v1/customers/telephones/create"},{"title":"Update telephone","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/telephones/{telephoneId}","href":"/en/v1/customers/telephones/update"},{"title":"Partially update telephone","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/telephones/{telephoneId}","href":"/en/v1/customers/telephones/patch"},{"title":"Delete telephone","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/telephones/{telephoneId}","href":"/en/v1/customers/telephones/delete"}]},{"group":"Links","icon":"link","pages":[{"title":"List links","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/links","href":"/en/v1/customers/links/list"},{"title":"Get link","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/links/{linkId}","href":"/en/v1/customers/links/get"},{"title":"Create link","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/links","href":"/en/v1/customers/links/create"},{"title":"Update link","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/links/{linkId}","href":"/en/v1/customers/links/update"},{"title":"Partially update link","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/links/{linkId}","href":"/en/v1/customers/links/patch"},{"title":"Delete link","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/links/{linkId}","href":"/en/v1/customers/links/delete"}]},{"group":"Representatives","icon":"user-tie","pages":[{"title":"List representatives","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/representatives","href":"/en/v1/customers/representatives/list"},{"title":"Get representative","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/representatives/{representativeId}","href":"/en/v1/customers/representatives/get"},{"title":"Create representative","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/representatives","href":"/en/v1/customers/representatives/create"},{"title":"Update representative","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/representatives/{representativeId}","href":"/en/v1/customers/representatives/update"},{"title":"Partially update representative","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/representatives/{representativeId}","href":"/en/v1/customers/representatives/patch"},{"title":"Delete representative","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/representatives/{representativeId}","href":"/en/v1/customers/representatives/delete"}]},{"group":"Bank accounts","icon":"building-columns","pages":[{"title":"List bank accounts","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/bank-accounts","href":"/en/v1/customers/bank-accounts/list"},{"title":"Get bank account","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/bank-accounts/{bankAccountId}","href":"/en/v1/customers/bank-accounts/get"},{"title":"Create bank account","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/bank-accounts","href":"/en/v1/customers/bank-accounts/create"},{"title":"Update bank account","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/bank-accounts/{bankAccountId}","href":"/en/v1/customers/bank-accounts/update"},{"title":"Partially update bank account","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/bank-accounts/{bankAccountId}","href":"/en/v1/customers/bank-accounts/patch"},{"title":"Delete bank account","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/bank-accounts/{bankAccountId}","href":"/en/v1/customers/bank-accounts/delete"}]},{"group":"Group memberships","icon":"users-rectangle","pages":[{"title":"List group memberships","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/group-members","href":"/en/v1/customers/group-members/list"},{"title":"Get group membership","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/group-members/{groupMemberId}","href":"/en/v1/customers/group-members/get"},{"title":"Create group membership","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/group-members","href":"/en/v1/customers/group-members/create"},{"title":"Update group membership","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/group-members/{groupMemberId}","href":"/en/v1/customers/group-members/update"},{"title":"Partially update group membership","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/group-members/{groupMemberId}","href":"/en/v1/customers/group-members/patch"},{"title":"Delete group membership","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/group-members/{groupMemberId}","href":"/en/v1/customers/group-members/delete"}]},{"group":"Parameters","icon":"sliders","pages":[{"title":"List parameters","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/parameters","href":"/en/v1/customers/parameters/list"},{"title":"Get parameter","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}/parameters/{parameterId}","href":"/en/v1/customers/parameters/get"},{"title":"Create parameter","openapi":"api-reference/openapi.json POST /api/v1/customers/{customerId}/parameters","href":"/en/v1/customers/parameters/create"},{"title":"Update parameter","openapi":"api-reference/openapi.json PUT /api/v1/customers/{customerId}/parameters/{parameterId}","href":"/en/v1/customers/parameters/update"},{"title":"Partially update parameter value","openapi":"api-reference/openapi.json PATCH /api/v1/customers/{customerId}/parameters/{parameterId}","href":"/en/v1/customers/parameters/patch"},{"title":"Delete parameter","openapi":"api-reference/openapi.json DELETE /api/v1/customers/{customerId}/parameters/{parameterId}","href":"/en/v1/customers/parameters/delete"}]}]},{"group":"Products","icon":"box","root":{"title":"Product card","icon":"box","href":"/en/v1/products/overview"},"expanded":false,"pages":[{"title":"List products","openapi":"api-reference/openapi.json GET /api/v1/products","href":"/en/v1/products/list"},{"title":"List changed products","openapi":"api-reference/openapi.json GET /api/v1/products/changes","href":"/en/v1/products/changes"},{"title":"Get product","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}","href":"/en/v1/products/get"},{"title":"Create product","openapi":"api-reference/openapi.json POST /api/v1/products","href":"/en/v1/products/create"},{"title":"Update product","openapi":"api-reference/openapi.json PUT /api/v1/products/{productId}","href":"/en/v1/products/update"},{"title":"Partially update product","openapi":"api-reference/openapi.json PATCH /api/v1/products/{productId}","href":"/en/v1/products/patch"},{"title":"Delete product","openapi":"api-reference/openapi.json DELETE /api/v1/products/{productId}","href":"/en/v1/products/delete"},{"group":"Product definitions","icon":"book-open","pages":[{"group":"Parameter definitions","pages":[{"title":"List product parameter definitions","openapi":"api-reference/openapi.json GET /api/v1/products/parameter-definitions","href":"/en/v1/products/definitions/parameter-definitions/list"},{"title":"Get product parameter definition","openapi":"api-reference/openapi.json GET /api/v1/products/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/products/definitions/parameter-definitions/get"},{"title":"Create product parameter definition","openapi":"api-reference/openapi.json POST /api/v1/products/parameter-definitions","href":"/en/v1/products/definitions/parameter-definitions/create"},{"title":"Update product parameter definition","openapi":"api-reference/openapi.json PUT /api/v1/products/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/products/definitions/parameter-definitions/update"},{"title":"Partially update product parameter definition","openapi":"api-reference/openapi.json PATCH /api/v1/products/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/products/definitions/parameter-definitions/patch"},{"title":"Delete product parameter definition","openapi":"api-reference/openapi.json DELETE /api/v1/products/parameter-definitions/{parameterDefinitionId}","href":"/en/v1/products/definitions/parameter-definitions/delete"}]}]},{"group":"Groups","icon":"sitemap","pages":[{"title":"List product group details","openapi":"api-reference/openapi.json GET /api/v1/products/groups","href":"/en/v1/products/groups/list"},{"title":"Get product group detail","openapi":"api-reference/openapi.json GET /api/v1/products/groups/{groupDetailId}","href":"/en/v1/products/groups/get"},{"title":"Create product group detail","openapi":"api-reference/openapi.json POST /api/v1/products/groups","href":"/en/v1/products/groups/create"},{"title":"Update product group detail","openapi":"api-reference/openapi.json PUT /api/v1/products/groups/{groupDetailId}","href":"/en/v1/products/groups/update"},{"title":"Partially update product group detail","openapi":"api-reference/openapi.json PATCH /api/v1/products/groups/{groupDetailId}","href":"/en/v1/products/groups/patch"},{"title":"Delete product group detail","openapi":"api-reference/openapi.json DELETE /api/v1/products/groups/{groupDetailId}","href":"/en/v1/products/groups/delete"}]},{"group":"Parameters","icon":"sliders","pages":[{"title":"List product parameter values","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}/parameters","href":"/en/v1/products/parameters/list"},{"title":"Get product parameter value","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}/parameters/{parameterId}","href":"/en/v1/products/parameters/get"},{"title":"Create product parameter value","openapi":"api-reference/openapi.json POST /api/v1/products/{productId}/parameters","href":"/en/v1/products/parameters/create"},{"title":"Update product parameter value","openapi":"api-reference/openapi.json PUT /api/v1/products/{productId}/parameters/{parameterId}","href":"/en/v1/products/parameters/update"},{"title":"Partially update product parameter value","openapi":"api-reference/openapi.json PATCH /api/v1/products/{productId}/parameters/{parameterId}","href":"/en/v1/products/parameters/patch"},{"title":"Delete product parameter value","openapi":"api-reference/openapi.json DELETE /api/v1/products/{productId}/parameters/{parameterId}","href":"/en/v1/products/parameters/delete"}]},{"group":"Prices","icon":"tag","pages":[{"title":"List product prices","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}/prices","href":"/en/v1/products/prices/list"},{"title":"Get product price","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}/prices/{priceId}","href":"/en/v1/products/prices/get"},{"title":"Create product price","openapi":"api-reference/openapi.json POST /api/v1/products/{productId}/prices","href":"/en/v1/products/prices/create"},{"title":"Update product price","openapi":"api-reference/openapi.json PUT /api/v1/products/{productId}/prices/{priceId}","href":"/en/v1/products/prices/update"},{"title":"Partially update product price","openapi":"api-reference/openapi.json PATCH /api/v1/products/{productId}/prices/{priceId}","href":"/en/v1/products/prices/patch"},{"title":"Delete product price","openapi":"api-reference/openapi.json DELETE /api/v1/products/{productId}/prices/{priceId}","href":"/en/v1/products/prices/delete"}]},{"group":"Critical stock","icon":"triangle-exclamation","pages":[{"title":"List critical stock definitions","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}/critical-stock","href":"/en/v1/products/critical-stock/list"},{"title":"Get critical stock definition","openapi":"api-reference/openapi.json GET /api/v1/products/{productId}/critical-stock/{criticalStockId}","href":"/en/v1/products/critical-stock/get"},{"title":"Create critical stock definition","openapi":"api-reference/openapi.json POST /api/v1/products/{productId}/critical-stock","href":"/en/v1/products/critical-stock/create"},{"title":"Update critical stock definition","openapi":"api-reference/openapi.json PUT /api/v1/products/{productId}/critical-stock/{criticalStockId}","href":"/en/v1/products/critical-stock/update"},{"title":"Partially update critical stock definition","openapi":"api-reference/openapi.json PATCH /api/v1/products/{productId}/critical-stock/{criticalStockId}","href":"/en/v1/products/critical-stock/patch"},{"title":"Delete critical stock definition","openapi":"api-reference/openapi.json DELETE /api/v1/products/{productId}/critical-stock/{criticalStockId}","href":"/en/v1/products/critical-stock/delete"}]}]},{"group":"Stock","icon":"boxes-stacked","expanded":false,"pages":[{"group":"Warehouses","icon":"warehouse","pages":[{"title":"List warehouses","openapi":"api-reference/openapi.json GET /api/v1/stock/warehouses","href":"/en/v1/stock/warehouses/list"},{"title":"Get warehouse","openapi":"api-reference/openapi.json GET /api/v1/stock/warehouses/{warehouseId}","href":"/en/v1/stock/warehouses/get"},{"title":"Create warehouse","openapi":"api-reference/openapi.json POST /api/v1/stock/warehouses","href":"/en/v1/stock/warehouses/create"},{"title":"Update warehouse","openapi":"api-reference/openapi.json PUT /api/v1/stock/warehouses/{warehouseId}","href":"/en/v1/stock/warehouses/update"},{"title":"Partially update warehouse","openapi":"api-reference/openapi.json PATCH /api/v1/stock/warehouses/{warehouseId}","href":"/en/v1/stock/warehouses/patch"},{"title":"Delete warehouse","openapi":"api-reference/openapi.json DELETE /api/v1/stock/warehouses/{warehouseId}","href":"/en/v1/stock/warehouses/delete"},{"group":"Sections","icon":"map-pin","pages":[{"title":"List sections","openapi":"api-reference/openapi.json GET /api/v1/stock/warehouses/{warehouseId}/sections","href":"/en/v1/stock/warehouses/sections/list"},{"title":"Get section","openapi":"api-reference/openapi.json GET /api/v1/stock/warehouses/{warehouseId}/sections/{sectionId}","href":"/en/v1/stock/warehouses/sections/get"},{"title":"Create section","openapi":"api-reference/openapi.json POST /api/v1/stock/warehouses/{warehouseId}/sections","href":"/en/v1/stock/warehouses/sections/create"},{"title":"Update section","openapi":"api-reference/openapi.json PUT /api/v1/stock/warehouses/{warehouseId}/sections/{sectionId}","href":"/en/v1/stock/warehouses/sections/update"},{"title":"Partially update section","openapi":"api-reference/openapi.json PATCH /api/v1/stock/warehouses/{warehouseId}/sections/{sectionId}","href":"/en/v1/stock/warehouses/sections/patch"},{"title":"Delete section","openapi":"api-reference/openapi.json DELETE /api/v1/stock/warehouses/{warehouseId}/sections/{sectionId}","href":"/en/v1/stock/warehouses/sections/delete"}]}]},{"group":"Product Stock Status","icon":"boxes-packing","pages":[{"title":"Product stock status","openapi":"api-reference/openapi.json GET /api/v1/stock/products/{productId}/status","href":"/en/v1/stock/products/status"},{"title":"Product stock status by code","openapi":"api-reference/openapi.json GET /api/v1/stock/products/status","href":"/en/v1/stock/products/status-by-code"}]}]},{"group":"Quotes","icon":"file-signature","root":{"title":"Quotes","icon":"file-signature","href":"/en/v1/quotes/overview"},"expanded":false,"pages":[{"title":"Calculating quote amounts","href":"/en/v1/quotes/calculations"},{"title":"List quotes","openapi":"api-reference/openapi.json GET /api/v1/quotes","href":"/en/v1/quotes/list"},{"title":"Get quote","openapi":"api-reference/openapi.json GET /api/v1/quotes/{quoteId}","href":"/en/v1/quotes/get"},{"title":"Create quote","openapi":"api-reference/openapi.json POST /api/v1/quotes","href":"/en/v1/quotes/create"},{"title":"Update quote","openapi":"api-reference/openapi.json PUT /api/v1/quotes/{quoteId}","href":"/en/v1/quotes/update"},{"title":"Partially update quote","openapi":"api-reference/openapi.json PATCH /api/v1/quotes/{quoteId}","href":"/en/v1/quotes/patch"},{"title":"Delete quote","openapi":"api-reference/openapi.json DELETE /api/v1/quotes/{quoteId}","href":"/en/v1/quotes/delete"}]},{"group":"Orders","icon":"cart-shopping","root":{"title":"Orders","icon":"cart-shopping","href":"/en/v1/orders/overview"},"expanded":false,"pages":[{"title":"List orders","openapi":"api-reference/openapi.json GET /api/v1/orders","href":"/en/v1/orders/list"},{"title":"Get order","openapi":"api-reference/openapi.json GET /api/v1/orders/{orderId}","href":"/en/v1/orders/get"},{"title":"Create order","openapi":"api-reference/openapi.json POST /api/v1/orders","href":"/en/v1/orders/create"},{"title":"Update order","openapi":"api-reference/openapi.json PUT /api/v1/orders/{orderId}","href":"/en/v1/orders/update"},{"title":"Partially update order","openapi":"api-reference/openapi.json PATCH /api/v1/orders/{orderId}","href":"/en/v1/orders/patch"},{"title":"Delete order","openapi":"api-reference/openapi.json DELETE /api/v1/orders/{orderId}","href":"/en/v1/orders/delete"}]},{"group":"Despatches","icon":"truck","root":{"title":"Despatches","icon":"truck","href":"/en/v1/despatches/overview"},"expanded":false,"pages":[{"title":"List despatches","openapi":"api-reference/openapi.json GET /api/v1/despatches","href":"/en/v1/despatches/list"},{"title":"Get despatch","openapi":"api-reference/openapi.json GET /api/v1/despatches/{despatchId}","href":"/en/v1/despatches/get"},{"title":"Create despatch","openapi":"api-reference/openapi.json POST /api/v1/despatches","href":"/en/v1/despatches/create"},{"title":"Update despatch","openapi":"api-reference/openapi.json PUT /api/v1/despatches/{despatchId}","href":"/en/v1/despatches/update"},{"title":"Partially update despatch","openapi":"api-reference/openapi.json PATCH /api/v1/despatches/{despatchId}","href":"/en/v1/despatches/patch"},{"title":"Delete despatch","openapi":"api-reference/openapi.json DELETE /api/v1/despatches/{despatchId}","href":"/en/v1/despatches/delete"}]},{"group":"Invoices","icon":"file-invoice","expanded":false,"pages":[{"group":"Purchase Invoices","root":{"title":"Purchase Invoices","icon":"file-invoice","href":"/en/v1/purchase-invoices/overview"},"pages":[{"title":"List purchase invoices","openapi":"api-reference/openapi.json GET /api/v1/purchase-invoices","href":"/en/v1/purchase-invoices/list"},{"title":"Get purchase invoice","openapi":"api-reference/openapi.json GET /api/v1/purchase-invoices/{invoiceId}","href":"/en/v1/purchase-invoices/get"},{"title":"Create purchase invoice","openapi":"api-reference/openapi.json POST /api/v1/purchase-invoices","href":"/en/v1/purchase-invoices/create"},{"title":"Update purchase invoice","openapi":"api-reference/openapi.json PUT /api/v1/purchase-invoices/{invoiceId}","href":"/en/v1/purchase-invoices/update"},{"title":"Partially update purchase invoice","openapi":"api-reference/openapi.json PATCH /api/v1/purchase-invoices/{invoiceId}","href":"/en/v1/purchase-invoices/patch"},{"title":"Delete purchase invoice","openapi":"api-reference/openapi.json DELETE /api/v1/purchase-invoices/{invoiceId}","href":"/en/v1/purchase-invoices/delete"}]},{"group":"Sales Invoices","root":{"title":"Sales Invoices","icon":"file-invoice","href":"/en/v1/sales-invoices/overview"},"pages":[{"title":"List sales invoices","openapi":"api-reference/openapi.json GET /api/v1/sales-invoices","href":"/en/v1/sales-invoices/list"},{"title":"Get sales invoice","openapi":"api-reference/openapi.json GET /api/v1/sales-invoices/{invoiceId}","href":"/en/v1/sales-invoices/get"},{"title":"Create sales invoice","openapi":"api-reference/openapi.json POST /api/v1/sales-invoices","href":"/en/v1/sales-invoices/create"},{"title":"Update sales invoice","openapi":"api-reference/openapi.json PUT /api/v1/sales-invoices/{invoiceId}","href":"/en/v1/sales-invoices/update"},{"title":"Partially update sales invoice","openapi":"api-reference/openapi.json PATCH /api/v1/sales-invoices/{invoiceId}","href":"/en/v1/sales-invoices/patch"},{"title":"Delete sales invoice","openapi":"api-reference/openapi.json DELETE /api/v1/sales-invoices/{invoiceId}","href":"/en/v1/sales-invoices/delete"}]},{"group":"Purchase Return Invoices","root":{"title":"Purchase Return Invoices","icon":"file-invoice","href":"/en/v1/purchase-return-invoices/overview"},"pages":[{"title":"List purchase return invoices","openapi":"api-reference/openapi.json GET /api/v1/purchase-return-invoices","href":"/en/v1/purchase-return-invoices/list"},{"title":"Get purchase return invoice","openapi":"api-reference/openapi.json GET /api/v1/purchase-return-invoices/{invoiceId}","href":"/en/v1/purchase-return-invoices/get"},{"title":"Create purchase return invoice","openapi":"api-reference/openapi.json POST /api/v1/purchase-return-invoices","href":"/en/v1/purchase-return-invoices/create"},{"title":"Update purchase return invoice","openapi":"api-reference/openapi.json PUT /api/v1/purchase-return-invoices/{invoiceId}","href":"/en/v1/purchase-return-invoices/update"},{"title":"Partially update purchase return invoice","openapi":"api-reference/openapi.json PATCH /api/v1/purchase-return-invoices/{invoiceId}","href":"/en/v1/purchase-return-invoices/patch"},{"title":"Delete purchase return invoice","openapi":"api-reference/openapi.json DELETE /api/v1/purchase-return-invoices/{invoiceId}","href":"/en/v1/purchase-return-invoices/delete"}]},{"group":"Sales Return Invoices","root":{"title":"Sales Return Invoices","icon":"file-invoice","href":"/en/v1/sales-return-invoices/overview"},"pages":[{"title":"List sales return invoices","openapi":"api-reference/openapi.json GET /api/v1/sales-return-invoices","href":"/en/v1/sales-return-invoices/list"},{"title":"Get sales return invoice","openapi":"api-reference/openapi.json GET /api/v1/sales-return-invoices/{invoiceId}","href":"/en/v1/sales-return-invoices/get"},{"title":"Create sales return invoice","openapi":"api-reference/openapi.json POST /api/v1/sales-return-invoices","href":"/en/v1/sales-return-invoices/create"},{"title":"Update sales return invoice","openapi":"api-reference/openapi.json PUT /api/v1/sales-return-invoices/{invoiceId}","href":"/en/v1/sales-return-invoices/update"},{"title":"Partially update sales return invoice","openapi":"api-reference/openapi.json PATCH /api/v1/sales-return-invoices/{invoiceId}","href":"/en/v1/sales-return-invoices/patch"},{"title":"Delete sales return invoice","openapi":"api-reference/openapi.json DELETE /api/v1/sales-return-invoices/{invoiceId}","href":"/en/v1/sales-return-invoices/delete"}]}]},{"group":"Finance","icon":"building-columns","root":{"title":"Finance","icon":"building-columns","href":"/en/v1/finance/overview"},"expanded":false,"pages":[{"group":"Customers","icon":"address-card","pages":[{"title":"Customer balances","openapi":"api-reference/openapi.json GET /api/v1/finance/customers/balances","href":"/en/v1/finance/customers/balances"},{"title":"Customer transactions","openapi":"api-reference/openapi.json GET /api/v1/finance/customers/{customerId}/transactions","href":"/en/v1/finance/customers/transactions"}]},{"group":"Bank","icon":"landmark","pages":[{"group":"Bank transfers","icon":"money-bill-transfer","root":{"title":"Bank Transfer Vouchers","icon":"money-bill-transfer","href":"/en/v1/finance/bank-transfers/overview"},"pages":[{"title":"List bank transfers","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-transfers","href":"/en/v1/finance/bank-transfers/list"},{"title":"Get bank transfer","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-transfers/{bankTransferId}","href":"/en/v1/finance/bank-transfers/get"},{"title":"Create bank transfer","openapi":"api-reference/openapi.json POST /api/v1/finance/bank-transfers","href":"/en/v1/finance/bank-transfers/create"},{"title":"Update bank transfer","openapi":"api-reference/openapi.json PUT /api/v1/finance/bank-transfers/{bankTransferId}","href":"/en/v1/finance/bank-transfers/update"},{"title":"Partially update bank transfer","openapi":"api-reference/openapi.json PATCH /api/v1/finance/bank-transfers/{bankTransferId}","href":"/en/v1/finance/bank-transfers/patch"},{"title":"Delete bank transfer","openapi":"api-reference/openapi.json DELETE /api/v1/finance/bank-transfers/{bankTransferId}","href":"/en/v1/finance/bank-transfers/delete"}]},{"group":"Bank openings","icon":"door-open","root":{"title":"Bank Opening Vouchers","icon":"door-open","href":"/en/v1/finance/bank-openings/overview"},"pages":[{"title":"List bank openings","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-openings","href":"/en/v1/finance/bank-openings/list"},{"title":"Get bank opening","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-openings/{bankOpeningId}","href":"/en/v1/finance/bank-openings/get"},{"title":"Create bank opening","openapi":"api-reference/openapi.json POST /api/v1/finance/bank-openings","href":"/en/v1/finance/bank-openings/create"},{"title":"Update bank opening","openapi":"api-reference/openapi.json PUT /api/v1/finance/bank-openings/{bankOpeningId}","href":"/en/v1/finance/bank-openings/update"},{"title":"Partially update bank opening","openapi":"api-reference/openapi.json PATCH /api/v1/finance/bank-openings/{bankOpeningId}","href":"/en/v1/finance/bank-openings/patch"},{"title":"Delete bank opening","openapi":"api-reference/openapi.json DELETE /api/v1/finance/bank-openings/{bankOpeningId}","href":"/en/v1/finance/bank-openings/delete"}]},{"group":"Bank internal transfers","icon":"right-left","root":{"title":"Bank Internal Transfer Vouchers","icon":"right-left","href":"/en/v1/finance/bank-internal-transfers/overview"},"pages":[{"title":"List bank internal transfers","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-internal-transfers","href":"/en/v1/finance/bank-internal-transfers/list"},{"title":"Get bank internal transfer","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-internal-transfers/{bankInternalTransferId}","href":"/en/v1/finance/bank-internal-transfers/get"},{"title":"Create bank internal transfer","openapi":"api-reference/openapi.json POST /api/v1/finance/bank-internal-transfers","href":"/en/v1/finance/bank-internal-transfers/create"},{"title":"Update bank internal transfer","openapi":"api-reference/openapi.json PUT /api/v1/finance/bank-internal-transfers/{bankInternalTransferId}","href":"/en/v1/finance/bank-internal-transfers/update"},{"title":"Partially update bank internal transfer","openapi":"api-reference/openapi.json PATCH /api/v1/finance/bank-internal-transfers/{bankInternalTransferId}","href":"/en/v1/finance/bank-internal-transfers/patch"},{"title":"Delete bank internal transfer","openapi":"api-reference/openapi.json DELETE /api/v1/finance/bank-internal-transfers/{bankInternalTransferId}","href":"/en/v1/finance/bank-internal-transfers/delete"}]},{"group":"Credit card collections","icon":"credit-card","root":{"title":"Credit Card Collection Vouchers","icon":"credit-card","href":"/en/v1/finance/credit-card-collections/overview"},"pages":[{"title":"List credit card collections","openapi":"api-reference/openapi.json GET /api/v1/finance/credit-card-collections","href":"/en/v1/finance/credit-card-collections/list"},{"title":"Get credit card collection","openapi":"api-reference/openapi.json GET /api/v1/finance/credit-card-collections/{creditCardCollectionId}","href":"/en/v1/finance/credit-card-collections/get"},{"title":"Create credit card collection","openapi":"api-reference/openapi.json POST /api/v1/finance/credit-card-collections","href":"/en/v1/finance/credit-card-collections/create"},{"title":"Update credit card collection","openapi":"api-reference/openapi.json PUT /api/v1/finance/credit-card-collections/{creditCardCollectionId}","href":"/en/v1/finance/credit-card-collections/update"},{"title":"Partially update credit card collection","openapi":"api-reference/openapi.json PATCH /api/v1/finance/credit-card-collections/{creditCardCollectionId}","href":"/en/v1/finance/credit-card-collections/patch"},{"title":"Delete credit card collection","openapi":"api-reference/openapi.json DELETE /api/v1/finance/credit-card-collections/{creditCardCollectionId}","href":"/en/v1/finance/credit-card-collections/delete"}]},{"group":"Bank definitions","icon":"building-columns","pages":[{"title":"List banks","openapi":"api-reference/openapi.json GET /api/v1/finance/banks","href":"/en/v1/finance/banks/list"},{"title":"Get bank","openapi":"api-reference/openapi.json GET /api/v1/finance/banks/{bankId}","href":"/en/v1/finance/banks/get"},{"title":"Create bank","openapi":"api-reference/openapi.json POST /api/v1/finance/banks","href":"/en/v1/finance/banks/create"},{"title":"Update bank","openapi":"api-reference/openapi.json PUT /api/v1/finance/banks/{bankId}","href":"/en/v1/finance/banks/update"},{"title":"Partially update bank","openapi":"api-reference/openapi.json PATCH /api/v1/finance/banks/{bankId}","href":"/en/v1/finance/banks/patch"},{"title":"Delete bank","openapi":"api-reference/openapi.json DELETE /api/v1/finance/banks/{bankId}","href":"/en/v1/finance/banks/delete"}]},{"group":"Bank accounts","icon":"credit-card","pages":[{"title":"List bank accounts","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-accounts","href":"/en/v1/finance/bank-accounts/list"},{"title":"Get bank account","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-accounts/{bankAccountId}","href":"/en/v1/finance/bank-accounts/get"},{"title":"Create bank account","openapi":"api-reference/openapi.json POST /api/v1/finance/bank-accounts","href":"/en/v1/finance/bank-accounts/create"},{"title":"Update bank account","openapi":"api-reference/openapi.json PUT /api/v1/finance/bank-accounts/{bankAccountId}","href":"/en/v1/finance/bank-accounts/update"},{"title":"Partially update bank account","openapi":"api-reference/openapi.json PATCH /api/v1/finance/bank-accounts/{bankAccountId}","href":"/en/v1/finance/bank-accounts/patch"},{"title":"Delete bank account","openapi":"api-reference/openapi.json DELETE /api/v1/finance/bank-accounts/{bankAccountId}","href":"/en/v1/finance/bank-accounts/delete"},{"group":"Repayment plans","icon":"calendar-days","pages":[{"title":"List repayment plans","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans","href":"/en/v1/finance/bank-accounts/repayment-plans/list"},{"title":"Get repayment plan","openapi":"api-reference/openapi.json GET /api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}","href":"/en/v1/finance/bank-accounts/repayment-plans/get"},{"title":"Create repayment plan","openapi":"api-reference/openapi.json POST /api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans","href":"/en/v1/finance/bank-accounts/repayment-plans/create"},{"title":"Update repayment plan","openapi":"api-reference/openapi.json PUT /api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}","href":"/en/v1/finance/bank-accounts/repayment-plans/update"},{"title":"Partially update repayment plan","openapi":"api-reference/openapi.json PATCH /api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}","href":"/en/v1/finance/bank-accounts/repayment-plans/patch"},{"title":"Delete repayment plan","openapi":"api-reference/openapi.json DELETE /api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}","href":"/en/v1/finance/bank-accounts/repayment-plans/delete"}]}]}]}]}]},{"group":"Release notes","pages":[{"title":"Release notes","icon":"clock-rotate-left","href":"/en/v1/changelog"}]}]}]}]},"basePath":"","title":"Update shipment definition - Noyax API","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}