{"items":[{"type":"link","label":"CargoSoft API","link":"/products/tms-api/2026.1/openapi","routeSlug":"/products/tms-api/2026.1/openapi","content":{"contentType":"overview","meta":{"name":"CargoSoft API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/products/tms-api/@2026.1/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/products/tms-api/@2026.1/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.cargosoft.de","url":"https://www.cargosoft.de"},{"kind":"email","title":"Uwe Droste","email":"support@cargosoft.de","label":"support@cargosoft.de","withCopyButton":true,"copyContent":"support@cargosoft.de"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"CargoSoft API (2026.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":1,"id":"section/about-the-cargosoft-api"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"About the CargoSoft API"},"children":[],"type":"text"}],"type":"heading"}]}],"sectionId":"/section/about-the-cargosoft-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/about-the-cargosoft-api/general"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"General"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Attention: Since our API is still under development, endpoints may well change, or object structures may change. Of course, we try to avoid this as much as possible, but we cannot guarantee it. So that you have the possibility to react in time, we will soon offer you a possibility to subscribe to a newsletter. We would then inform all subscribers when something will change in the API. We are currently still looking for an integrable solution for newsletters, which can be used to subscribe and unsubscribe at this place. Until then, we would like to ask you to send us an email to support@cargosoft.de with the request that we inform you when there are planned changes to the API."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please note: The API endpoints available to a customer depend on the installed CargoSoft version. New endpoints must"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"be enabled by CargoSoft before they can be used."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}]}],"sectionId":"/section/about-the-cargosoft-api/general"}],"sectionId":"/section/about-the-cargosoft-api/general"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/about-the-cargosoft-api/changelog"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Changelog"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This page documents all business-relevant changes to our API."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Endpoint / Area"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Change"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Impact and required action"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Version"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Added"},"children":[],"type":"text"}],"type":"strong"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" /cargosoft/shipment"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Added new shipment create endpoint."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"No changes to existing integrations are required."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026.1"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Added"},"children":[],"type":"text"}],"type":"strong"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use cases"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Added new use case to create a shipment - "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/use-cases/create-a-shipment"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"see"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"No changes to existing integrations are required."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026.1"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Added"},"children":[],"type":"text"}],"type":"strong"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"E-File"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Added support for E-File - "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/use-cases/attach-an-e-file-document-to-a-shipment"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"see"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"No changes to existing integrations are required."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026.1"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Added"},"children":[],"type":"text"}],"type":"strong"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Provider status"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Added "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to create a provider status - "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/use-cases/attach-a-status-to-a-shipment"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"see"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"No changes to existing integrations are required."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026.1"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Added"},"children":[],"type":"text"}],"type":"strong"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Basic data"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Added new edi code conversion endpoints."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"No changes to existing integrations are required."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026.1"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Deprecated"},"children":[],"type":"text"}],"type":"strong"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ShipmentEventQualifier"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The shipment event qualifer "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"TRANSSHIPMENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is now deprecated and will be removed in a future version."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"TRANSSHIPMENT_ARRIVAL"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" shipment event qualifer instead."},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"2026.1"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}]}],"sectionId":"/section/about-the-cargosoft-api/changelog"}],"sectionId":"/section/about-the-cargosoft-api/changelog"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"section/about-the-cargosoft-api/category-definitions"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category definitions"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Meaning"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Breaking change"},"children":[],"type":"text"}],"type":"strong"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A non-backward-compatible change that may require integration updates"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Added"},"children":[],"type":"text"}],"type":"strong"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A new feature, endpoint, field, or supported value"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Changed"},"children":[],"type":"text"}],"type":"strong"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A backward-compatible change to existing behavior"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Deprecated"},"children":[],"type":"text"}],"type":"strong"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A feature is still available but will be removed in the future"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Removed"},"children":[],"type":"text"}],"type":"strong"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A feature, endpoint, or field has been removed"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Fixed"},"children":[],"type":"text"}],"type":"strong"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A bug fix without an intended breaking interface change"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}]}],"sectionId":"/section/about-the-cargosoft-api/category-definitions"}],"sectionId":"/section/about-the-cargosoft-api/category-definitions"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/about-the-cargosoft-api/authorization"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{"name":"p","attrs":{"id":"CHAPTER_AUTHORIZATION"}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","attributes":{"content":"\nThe following chapter will explain the authorization prozess to access the CargoSoft API endpoints. The use case figure below shows a common example how to retrieve the JWT and how to use it.\n"},"children":[],"type":"text"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"alt":"Authorization","src":"/assets/seq_authentifizierung.1b5c3eaee40bae5bd2b1079171a9b2c57978719eff14a0c6274547ce9fb94e3c.b476403d.svg","title":"Use case Authorization!"},"children":[],"type":"image"}],"type":"paragraph"}]}],"sectionId":"/section/about-the-cargosoft-api/authorization"}],"sectionId":"/section/about-the-cargosoft-api/authorization"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"section/about-the-cargosoft-api/retrieve-a-token"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve a token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"First of all each client has to request a bearer Java Web Toke (JWT) from the CargoSoft API. To receive a JWT, username"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"and password are required. Username and password can only be created by CargoSoft."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"For more details "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/retrieveAuthToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"see"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please note: The JWT is valid for 24 hours. After that you have to request a new one."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}]}],"sectionId":"/section/about-the-cargosoft-api/retrieve-a-token"}],"sectionId":"/section/about-the-cargosoft-api/retrieve-a-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"section/about-the-cargosoft-api/access-api-endpoints"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Access API endpoints"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To access the CargoSoft API endpoint, a JWT is required. The JWT has to be sent in the HTTP authorization header."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": This example shows a minimal curl with a bearer authorization header. The token is not valid because we"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"only want to illustrate the structure."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl --location --request POST 'https://api-demo.cargosoft.de/cargosoft/shipment/lookup' \\\n--header 'Authorization: Bearer eyJ0eXAiOiJqd3QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJ1cGRhdGUiLCJjYXJnb3NvZnQtand0LNjc2NDQ1NTAzfQ.mK82rjSu0ltd0bf3mvXUqwpME05ck5OEuqnzsAQ8WPFPo' \\\n--data-raw '[]'\"\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl --location --request POST 'https://api-demo.cargosoft.de/cargosoft/shipment/lookup' \\\n--header 'Authorization: Bearer eyJ0eXAiOiJqd3QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJ1cGRhdGUiLCJjYXJnb3NvZnQtand0LNjc2NDQ1NTAzfQ.mK82rjSu0ltd0bf3mvXUqwpME05ck5OEuqnzsAQ8WPFPo' \\\n--data-raw '[]'\"\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Attention: Your user may be restricted. The CargoSoft API uses a permission system to grant access to the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CargoSoft API endpoint. If your user is restricted or it's not allowed to use an endpoint you need please contact our"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"support."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}]}],"sectionId":"/section/about-the-cargosoft-api/access-api-endpoints"}],"sectionId":"/section/about-the-cargosoft-api/access-api-endpoints"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"section/about-the-cargosoft-api/access-webhook"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Access webhook"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The webhook uses basic auth as its authorization type."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": This example shows a minimal curl request, to access the webhook. The basic auth is not valid."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl --location --request POST 'https://api-demo.cargosoft.de/external/webhook' \\\n--header 'Authorization: Basic cG9ydg53xcvgawawb3J0YmFzZWNj' \\\n--data-raw '{}'\"\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl --location --request POST 'https://api-demo.cargosoft.de/external/webhook' \\\n--header 'Authorization: Basic cG9ydg53xcvgawawb3J0YmFzZWNj' \\\n--data-raw '{}'\"\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please note: Your user needs a special role to access the webhook endpoint via basic auth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}]}],"sectionId":"/section/about-the-cargosoft-api/access-webhook"}],"sectionId":"/section/about-the-cargosoft-api/access-webhook"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/about-the-cargosoft-api/crud"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CRUD"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The CargoSoft API uses CRUD operations. We attempt to implement each CRUD operation for each functional"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"group of endpoints if it makes sense. The delete operation is one of the most sensitive function and will not"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"available to each function group."},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/section/about-the-cargosoft-api/crud"}],"sectionId":"/section/about-the-cargosoft-api/crud"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"section/about-the-cargosoft-api/lookup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lookup"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The CargoSoft API extends the CRUD retrieve operations with lookup operations. Each functional group of endpoints should"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"have a lookup method implemented."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lookups should be used to search functional objects with given criteria named identifiers. The identifiers may be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"different to each functional group. To find out which functional identifier are possible, please take a look at the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"corresponding functional group."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The identifier will be sent in the request body to the API lookup endpoint. An identifier contains the following"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"three information:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"match_mode"},"children":[],"type":"text"}],"type":"em"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The match mode can alter the behaviour, how the criteria is compared against the object in the database"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"are "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"[EQUALS, CONTAINS, IN, OR, GT, LT, GE, LE]"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"key"},"children":[],"type":"text"}],"type":"em"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The key of the criteria for the functional object to lookup. To find out which keys are possible, please check"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"corresponding implementation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"value"},"children":[],"type":"text"}],"type":"em"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The value of the criteria."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Lookup request body to search a shipment"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"[\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"MBL\",\n    \"value\": \"MASTER_12345\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"MODE_OF_TRANSPORT\",\n    \"value\": \"SEA\"\n  }\n]\n","language":"json"},"children":[{"$$mdtype":"Node","attributes":{"content":"[\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"MBL\",\n    \"value\": \"MASTER_12345\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"MODE_OF_TRANSPORT\",\n    \"value\": \"SEA\"\n  }\n]\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please note: When using one of any lookup methods, please define search criteria as precisely as possible to limit the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"result of objects."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The lookup may contain ordering by one or more criteria. The ordering will passed as a query parameter."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The result set of a lookup includes zero up to n functional objects depending on the search criteria."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Each functional object contains an ID. The ID can be used to retrieve additional information by passing the id as a path"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"parameter of the retrieve endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Lookup a shipment and retrieve all shipment events"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Looking up a shipment with given criteria, for instance with the BL number. For more details"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"please "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/lookup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"see"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Extract the ID of the shipment result object."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Call the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/%7Bid%7D/events"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Events"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint with the shipment ID as path parameter."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}],"sectionId":"/section/about-the-cargosoft-api/lookup"}],"sectionId":"/section/about-the-cargosoft-api/lookup"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"section/about-the-cargosoft-api/pagination"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Pagination"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Most endpoints of the CargoSoft API use pagination mechanics."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The pagination information will be sent as a request query parameter to the API endpoint. The pagination contains the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"following two query parameter:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"page_no"},"children":[],"type":"text"}],"type":"em"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The current number of the page"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"page_size"},"children":[],"type":"text"}],"type":"em"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The size of the page"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Lookup a shipment with pagination query parameter"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl --location --request POST 'https://api-demo.cargosoft.de/cargosoft/shipment/lookup?page_no=1&page_size=5' \\\n--header 'Authorization: Bearer eyJ0eXAiOiJqd3QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJ1cGRhdGUiLCJjYXJnb3NvZnQtand0LNjc2NDQ1NTAzfQ.mK82rjSu0ltd0bf3mvXUqwpME05ck5OEuqnzsAQ8WPFPo' \\\n--header 'Content-Type: application/json' \\\n--data '[\n    {\n        \"match_mode\": \"EQUALS\",\n        \"key\": \"MBL\",   \n        \"value\": \"MASTER_12345\"\n    },\n   {\n        \"match_mode\": \"EQUALS\",\n        \"key\": \"MODE_OF_TRANSPORT\",\n        \"value\": \"SEA\"\n    }\n]'\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl --location --request POST 'https://api-demo.cargosoft.de/cargosoft/shipment/lookup?page_no=1&page_size=5' \\\n--header 'Authorization: Bearer eyJ0eXAiOiJqd3QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJ1cGRhdGUiLCJjYXJnb3NvZnQtand0LNjc2NDQ1NTAzfQ.mK82rjSu0ltd0bf3mvXUqwpME05ck5OEuqnzsAQ8WPFPo' \\\n--header 'Content-Type: application/json' \\\n--data '[\n    {\n        \"match_mode\": \"EQUALS\",\n        \"key\": \"MBL\",   \n        \"value\": \"MASTER_12345\"\n    },\n   {\n        \"match_mode\": \"EQUALS\",\n        \"key\": \"MODE_OF_TRANSPORT\",\n        \"value\": \"SEA\"\n    }\n]'\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The response contains two additional headers:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"X-Page-Count"},"children":[],"type":"text"}],"type":"em"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The total number of pages."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"X-Row-Count"},"children":[],"type":"text"}],"type":"em"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The total number of found objects."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"With these both headers it is possible to scroll through a result set."},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/section/about-the-cargosoft-api/pagination"}],"sectionId":"/section/about-the-cargosoft-api/pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/about-the-cargosoft-api/testing"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Testing"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For testing purposes CargoSoft hosted a server with the last released CargoSoft API."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"URL"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": https://api-demo.cargosoft.de"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To use the test environment, please use the \"Try it\" console in this documentation. Login credentials are needed to use"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"the test API. The credentials have to be requested from the CargoSoft support. The received information grants access to"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"test account which should be able to use all endpoints. If any endpoint is restricted, please contact CargoSoft. Please"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"have in mind that the test environment will be reset every night!"},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/section/about-the-cargosoft-api/testing"}],"sectionId":"/section/about-the-cargosoft-api/testing"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":1,"id":"section/use-cases"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use cases"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The following use cases describe common integration workflows. Every request requires a JWT in the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" header. For details about retrieving and using a token, see"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#CHAPTER_AUTHORIZATION"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The sequence diagrams show token retrieval as a referenced flow."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Goal"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Primary endpoint"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Result"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create a shipment"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/shipment"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A new shipment with its unique ID and CargoSoft shipment number"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Look up an EDI code conversion"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/basicdata/codeconverter/lookup"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Matching conversion records for the supplied identifiers"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve a shipment"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/shipment/lookup"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Matching shipments and their IDs"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Attach an E-File document"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/efile"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A stored document linked to an existing shipment"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Attach a status"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/status"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A provider status associated with an existing shipment"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve shipment events"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /cargosoft/shipment/{id}/events"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The available CargoSoft events for a shipment"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"}]}],"sectionId":"/section/use-cases"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/use-cases/create-a-shipment"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create a shipment"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{"name":"p","attrs":{"id":"CHAPTER_SHIPMENT"}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Goal"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create a shipment together with any supplied nested data, such as goods, containers, addon field values, or memo lines."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Endpoint"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/createShipment"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/shipment"},"children":[],"type":"code"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Prerequisites"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The authenticated API username must match the matchcode of an EDI partner."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The shipment number definition, main department, and sub department must be resolvable from the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#CHAPTER_EDIPARTNER_SETTINGS"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"EDI partner settings"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or the request body."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{"name":"p","attrs":{"id":"CHAPTER_EDIPARTNER_SETTINGS"}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"EDI partner settings"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a shipment number requires three pieces of information: the shipment number definition (posdef), the main"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"department, and the sub department. Each value can be configured individually on the EDI partner determined from the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"authenticated API user. A configured EDI partner value takes precedence; an empty or blank value is treated as not"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"configured. Each key is resolved independently, and unrelated qualifiers on the EDI partner are ignored."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Key"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Meaning"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Fallback if not configured or blank on the EDI partner"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"SHIPMENT_NUMBER_DEFINITION_VERSION"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shipment number definition version to use"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"shipment_number_definition_version"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from the request body, if present; otherwise the CargoSoft client's default"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MAINDEPARTMENT"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Main department used for shipment numbering"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"maindepartment"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from the request body; if neither value is present, the request is rejected"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"SUBDEPARTMENT"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sub department used for shipment numbering"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"subdepartment"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from the request body; if neither value is present, the request is rejected"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ADDRESS_FORMAT"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Address format used for shipment addresses"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The CargoSoft client's default from the general company parameters"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please note: If a request does not need to rely on the EDI partner's settings, for example during testing,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"shipment_number_definition_version"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"maindepartment"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"subdepartment"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" can be supplied directly in the request"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"body."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sequence"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"alt":"CreateShipment","src":"/assets/seq_create_shipment.8b23570e48de927659f1a28ac89495067e893c77687e7e6e5eb534ebc558b0fc.b476403d.svg","title":"Use case to create a shipment"},"children":[],"type":"image"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Workflow"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Based on the authenticated API user, the CargoSoft API determines the EDI partner to associate with the new"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"shipment: the EDI partner's matchcode has to be identical to the API username. If no EDI partner exists for"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"the API user, the request is rejected and no shipment is created."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The determined EDI partner's settings are used, where configured, to fill in values that are required to generate"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"the shipment number. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#CHAPTER_EDIPARTNER_SETTINGS"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"EDI partner settings"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for the exact keys and fallback rules."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The shipment is created together with any nested data supplied in the same request body - goods, containers,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"addon field values, order memo lines, and so on. A memo text longer than the maximum line length is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"automatically wrapped across several consecutive memo lines. Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/shipment/memo/lookup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"retrieve memo lines independently afterwards."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If the request and all nested data pass validation, the CargoSoft API stores and returns the shipment."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Result"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The response contains the created shipment, including its unique shipment ID and CargoSoft shipment number."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Error handling"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If no EDI partner matches the API username, the request is rejected and no shipment is created."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If required shipment numbering values cannot be resolved, the request is rejected."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If nested data fails validation, the complete shipment creation is rejected and nothing is created."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}],"sectionId":"/section/use-cases/create-a-shipment"}],"sectionId":"/section/use-cases/create-a-shipment"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/use-cases/look-up-an-edi-code-conversion"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Look up an EDI code conversion"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Goal"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Translate an EDI partner's own code, for example a charge type or packaging code, into the corresponding CargoSoft"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"internal code or vice versa, depending on direction."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Endpoint"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/lookup"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/basicdata/codeconverter/lookup"},"children":[],"type":"code"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Prerequisites"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The EDI code conversion must be configured in the CargoSoft master data."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The EDI partner, direction, and code type must be known. The source code is additionally required when looking up one"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"specific conversion."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Workflow"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Build the lookup request from the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"EDIPARTNER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CODETYPE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" identifiers. The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" value must"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"be the raw single-character code stored in CargoSoft ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"E"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"S"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"), not the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"direction"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" value ("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RECEIVE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SEND"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"returned on the response object:"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{"content":"[\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"EDIPARTNER\",\n    \"value\": \"SAMPLEPARTNER\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"DIRECTION\",\n    \"value\": \"E\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"CODETYPE\",\n    \"value\": \"VERCO_T\"\n  }\n]\n","language":"json"},"children":[{"$$mdtype":"Node","attributes":{"content":"[\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"EDIPARTNER\",\n    \"value\": \"SAMPLEPARTNER\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"DIRECTION\",\n    \"value\": \"E\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"CODETYPE\",\n    \"value\": \"VERCO_T\"\n  }\n]\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{"ordered":true,"start":2,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Send the request without "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SOURCECODE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to retrieve every conversion configured for the EDI partner's code table and"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"direction. Add "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SOURCECODE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to look up one specific conversion."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" + "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CODETYPE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" + "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SOURCECODE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" can also be used without "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"EDIPARTNER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". This returns every matching"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"conversion across all EDI partners that share the source code."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Result"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The response contains the matching EDI code conversion records, including their source and target codes. The result is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"paginated and includes the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"X-Page-Count"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"X-Row-Count"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" response headers."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lookup behavior"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The following identifier combinations are served from a cache because this master data changes very rarely:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"EDIPARTNER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" + "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" + "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CODETYPE"},"children":[],"type":"code"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"EDIPARTNER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" + "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" + "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CODETYPE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" + "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SOURCECODE"},"children":[],"type":"code"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" + "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CODETYPE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" + "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SOURCECODE"},"children":[],"type":"code"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Any other identifier combination is looked up directly in the database."},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/section/use-cases/look-up-an-edi-code-conversion"}],"sectionId":"/section/use-cases/look-up-an-edi-code-conversion"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/use-cases/retrieve-a-shipment"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve a shipment"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Goal"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Find an existing shipment from business identifiers and obtain the unique shipment ID used by subsequent endpoints."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Endpoint"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/shipment/lookup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Prerequisites"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Select identifiers that narrow the result to the intended shipment."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use pagination when a lookup can return more results than fit on one page."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sequence"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"alt":"RetrieveShipment","src":"/assets/seq_retrieve_shipment.dc88e8ea28d483ed517a312fd92533d5b7613c1fff29301488778c598eb5693f.b476403d.svg","title":"Use case to retrieve a shipment"},"children":[],"type":"image"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Workflow"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Build the request body from supported shipment identifiers, such as client and shipment number."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Call "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/shipment/lookup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with the identifiers and, if necessary, pagination parameters."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Verify that the expected shipment was returned and extract its unique "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If full shipment details are required, call "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /cargosoft/shipment/{id}"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with the extracted ID."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Result"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The lookup returns zero or more base shipments. Each returned shipment contains the unique ID required for related data,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"such as shipment events or E-File lookups."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Error handling"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refine the identifiers when the lookup returns no result or more shipments than expected."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Do not select an arbitrary result when the criteria are not unique."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}],"sectionId":"/section/use-cases/retrieve-a-shipment"}],"sectionId":"/section/use-cases/retrieve-a-shipment"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/use-cases/attach-an-e-file-document-to-a-shipment"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Attach an E-File document to a shipment"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{"name":"p","attrs":{"id":"CHAPTER_EFILE_SHIPMENT"}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Development notice:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" The endpoint used in this workflow is still under development and may change."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Goal"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create an E-File document and link it to an existing shipment in the same request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Endpoints"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/shipment/lookup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to resolve the shipment number, client, and unique shipment ID."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/createEFileDocument"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/efile"},"children":[],"type":"code"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to create and link the document."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/efile/{id}/reference"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" only when linking an already existing document later."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Prerequisites"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The API user must be allowed to call the required shipment and E-File endpoints."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"E-File must be enabled and configured for the shipment's CargoSoft client."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The document content must be Base64 encoded without a data-URI prefix."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The document category must exist in the customer's CargoSoft basic data. It is mandatory when the configured"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"E-File system uses D3 mode."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sequence"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"alt":"AttachEFileToShipment","src":"/assets/seq_attach_efile_to_shipment.d32b61c902be1d8ad836fc8ac2d5897c9a6f2d4b28f2757d06719c5ff8b1ecba.b476403d.svg","title":"Use case to attach an E-File document to a shipment"},"children":[],"type":"image"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Workflow"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Look up the shipment with criteria that identify exactly one shipment. A CargoSoft shipment number is unique"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"only in combination with its client, so both identifiers should be supplied:"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{"content":"[\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"CLIENT\",\n    \"value\": \"001\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"SHIPMENT_NUMBER\",\n    \"value\": \"022120300004\"\n  }\n]\n","language":"json"},"children":[{"$$mdtype":"Node","attributes":{"content":"[\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"CLIENT\",\n    \"value\": \"001\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"SHIPMENT_NUMBER\",\n    \"value\": \"022120300004\"\n  }\n]\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{"ordered":true,"start":2,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Process the lookup response before uploading. Continue only when the expected shipment was returned, and read"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"its "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"shipment_number"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The numeric shipment "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" can later be used to"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/lookupEFileDocuments"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"look up E-File documents"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", but it is not the value of the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CSFILE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" reference."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Build the shipment reference and include it in the upload request:"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Situation"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Endpoint"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"reference_type"},"children":[],"type":"code"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"reference_value"},"children":[],"type":"code"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create and link a new document"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/efile"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CSFILE"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"<shipment_number>#<client>"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Link an existing document later"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/efile/{id}/reference"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CSFILE"},"children":[],"type":"code"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"<shipment_number>#<client>"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the lookup response above, the reference value is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"022120300004#001"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":true,"start":4,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Upload the document. The following example omits optional roles; when roles are supplied, use values configured"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"for the customer's E-File system. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"document_category"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is also customer-specific."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{"content":"{\n  \"client\": \"001\",\n  \"document_category\": 1601,\n  \"document_name\": \"shipping-instructions.pdf\",\n  \"description\": \"Shipping instructions received from the customer\",\n  \"document_date\": \"2026-11-02T10:15:00\",\n  \"bytes\": \"JVBERi0xLjQKJcTl8uXr...\",\n  \"references\": [\n    {\n      \"reference_type\": \"CSFILE\",\n      \"reference_value\": \"022120300004#001\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","attributes":{"content":"{\n  \"client\": \"001\",\n  \"document_category\": 1601,\n  \"document_name\": \"shipping-instructions.pdf\",\n  \"description\": \"Shipping instructions received from the customer\",\n  \"document_date\": \"2026-11-02T10:15:00\",\n  \"bytes\": \"JVBERi0xLjQKJcTl8uXr...\",\n  \"references\": [\n    {\n      \"reference_type\": \"CSFILE\",\n      \"reference_value\": \"022120300004#001\"\n    }\n  ]\n}\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{"ordered":true,"start":5,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keep the returned E-File document ID when references or roles need to be managed later."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Result"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The response contains the stored E-File document and its unique "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The included "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CSFILE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" reference links the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"document to the resolved shipment."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Error handling and retries"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A shipment lookup that returns no result or more than the expected shipment must be resolved before the upload."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refine the lookup identifiers instead of choosing an arbitrary result."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"401"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"403"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" indicates missing or insufficient API credentials. Do not retry until the credentials or endpoint"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"permissions have been corrected."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Invalid Base64 data, an unknown client, a missing mandatory document category, or an unavailable E-File system"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"causes the upload to fail. The error response must be handled before another upload is attempted."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The server-side connection from the CargoSoft API to the configured E-File system has a default timeout of"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"30 seconds; the deployment can override this value. API consumers should configure their HTTP timeout with enough"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"headroom for that downstream call."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The CargoSoft API does not automatically retry a failed upload. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/efile"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not idempotent, so a"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"blind retry after a client or downstream timeout can create a duplicate. First call the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/lookupEFileDocuments"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"E-File lookup"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with the shipment "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" as "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SHIPMENT_ID"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and verify whether the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"document was stored. Retry only when it is absent. If a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"503"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" response contains "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retry-After"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", wait for the stated"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"interval before retrying."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}],"sectionId":"/section/use-cases/attach-an-e-file-document-to-a-shipment"}],"sectionId":"/section/use-cases/attach-an-e-file-document-to-a-shipment"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/use-cases/attach-a-status-to-a-shipment"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Attach a status to a shipment"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{"name":"p","attrs":{"id":"CHAPTER_STATUS_SHIPMENT"}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Development notice:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" The endpoint used in this workflow is still under development and may change."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Goal"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create a provider status and associate it with an existing shipment through its CargoSoft client and shipment number."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Endpoints"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/shipment/lookup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to identify the shipment and confirm its client and shipment number."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/createProviderStatus"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/status"},"children":[],"type":"code"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to create the provider status."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Prerequisites"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The API user must be allowed to call both the shipment lookup and provider status endpoints."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The endpoints must be available for the installed CargoSoft version and enabled by CargoSoft."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The provider and provider status must be configured in the customer's CargoSoft master data."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The customer-specific client, provider, and provider status codes must be known."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sequence"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"alt":"AttachStatusToShipment","src":"/assets/seq_attach_status_to_shipment.1ce6312dc1a330a0e26575032ebd2e4c7b60b802f4f09f68a1ad2351f006a847.b476403d.svg","title":"Use case to attach a status to a shipment"},"children":[],"type":"image"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Workflow"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Look up the shipment with criteria that identify exactly one shipment. A CargoSoft shipment number is unique"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"only in combination with its client, so both identifiers should be supplied with exact matching:"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{"content":"[\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"CLIENT\",\n    \"value\": \"001\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"SHIPMENT_NUMBER\",\n    \"value\": \"022120300004\"\n  }\n]\n","language":"json"},"children":[{"$$mdtype":"Node","attributes":{"content":"[\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"CLIENT\",\n    \"value\": \"001\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"SHIPMENT_NUMBER\",\n    \"value\": \"022120300004\"\n  }\n]\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{"ordered":true,"start":2,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Continue only when the expected shipment was returned. Read its "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"client"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"shipment_number"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; the numeric"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"shipment "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not used by the provider status endpoint."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Build the provider status request. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLIENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PROVIDER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" are required for status processing, while"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SHIPMENT_NUMBER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" associates the status with the resolved shipment. The values below are examples and must be"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"replaced with codes configured for the customer:"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{"content":"{\n  \"provider_status\": \"EXPECTED_ARRIVAL\",\n  \"status_date_and_time\": {\n    \"date\": \"2026-11-02\",\n    \"time\": \"10:15:00\",\n    \"zone_offset\": \"+01:00\"\n  },\n  \"additional_information\": \"Estimated arrival updated by customer integration\",\n  \"unique_provider_message_number\": \"STATUS-2026-000123\",\n  \"status_events\": [\n    {\n      \"type\": \"STATUS\",\n      \"date_and_time\": {\n        \"date\": \"2026-11-04\",\n        \"time\": \"08:30:00\",\n        \"zone_offset\": \"+01:00\"\n      },\n      \"event_date_type\": \"ESTIMATED\"\n    }\n  ],\n  \"references\": [\n    {\n      \"type\": \"CLIENT\",\n      \"reference\": \"001\"\n    },\n    {\n      \"type\": \"SHIPMENT_NUMBER\",\n      \"reference\": \"022120300004\"\n    },\n    {\n      \"type\": \"PROVIDER\",\n      \"reference\": \"CUSTOMER_API\"\n    }\n  ],\n  \"identifiers\": []\n}\n","language":"json"},"children":[{"$$mdtype":"Node","attributes":{"content":"{\n  \"provider_status\": \"EXPECTED_ARRIVAL\",\n  \"status_date_and_time\": {\n    \"date\": \"2026-11-02\",\n    \"time\": \"10:15:00\",\n    \"zone_offset\": \"+01:00\"\n  },\n  \"additional_information\": \"Estimated arrival updated by customer integration\",\n  \"unique_provider_message_number\": \"STATUS-2026-000123\",\n  \"status_events\": [\n    {\n      \"type\": \"STATUS\",\n      \"date_and_time\": {\n        \"date\": \"2026-11-04\",\n        \"time\": \"08:30:00\",\n        \"zone_offset\": \"+01:00\"\n      },\n      \"event_date_type\": \"ESTIMATED\"\n    }\n  ],\n  \"references\": [\n    {\n      \"type\": \"CLIENT\",\n      \"reference\": \"001\"\n    },\n    {\n      \"type\": \"SHIPMENT_NUMBER\",\n      \"reference\": \"022120300004\"\n    },\n    {\n      \"type\": \"PROVIDER\",\n      \"reference\": \"CUSTOMER_API\"\n    }\n  ],\n  \"identifiers\": []\n}\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{"ordered":true,"start":4,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Send the request to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Copy the client and shipment number from the verified lookup"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"result without changing their formatting."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Result"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A successful request returns "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"200 OK"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" without a response body. CargoSoft creates the provider status and associates it"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"with the shipment when the supplied references resolve it. Depending on the configured master-data mapping, the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"provider status can also create a customer-defined shipment status or update shipment event data."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Error handling and retries"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Stop when the shipment lookup returns no result or more than the expected shipment. Refine the lookup criteria"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"instead of choosing an arbitrary result."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A missing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CLIENT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PROVIDER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" reference, an unknown client, or a provider status that is not configured for the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"provider causes status processing to fail. Correct the request or master data before retrying."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"401"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"403"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" indicates missing or insufficient API credentials. Do not retry until the credentials or endpoint"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"permissions have been corrected."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The endpoint has no automatic retry mechanism. Client, proxy, and deployment timeouts apply to the request."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not idempotent. A blind retry after an ambiguous timeout can create a duplicate"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"provider status. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"unique_provider_message_number"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is stored for traceability but is not an idempotency key. Because"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"no provider status retrieval endpoint is available, verify the result in CargoSoft before retrying."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{"name":"p","attrs":{"id":"CHAPTER_SHIPMENT_STATUS_MODEL"}},"children":[],"type":"tag","tag":"html"}]}],"sectionId":"/section/use-cases/attach-a-status-to-a-shipment"}],"sectionId":"/section/use-cases/attach-a-status-to-a-shipment"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":3,"id":"section/use-cases/shipment-status-model"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shipment status model"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CargoSoft stores status information in different pools. The following diagram shows how status messages can be mapped"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"and processed."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"alt":"ShipmentStatus","src":"/assets/use_case_shipment_status.e9b7dd1edbee2d7936570062ca33a9dfed6596e3b21ef52bdc2433ae35118a62.b476403d.svg","title":"CargoSoft shipment status model"},"children":[],"type":"image"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Type"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Origin and behavior"},"children":[],"type":"text"}],"type":"th"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"API availability"},"children":[],"type":"text"}],"type":"th"}],"type":"tr"}],"type":"thead"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shipment provider status"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Supplied by an external status or service provider; codes depend on the provider"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creation through "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; no retrieval endpoint yet"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shipment status"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Customer-defined and optionally mapped from provider status"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"No retrieval endpoint yet"},"children":[],"type":"text"}],"type":"td"}],"type":"tr"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shipment event"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CargoSoft-defined and optionally derived from shipment or provider status"},"children":[],"type":"text"}],"type":"td"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Available through "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /cargosoft/shipment/{id}/events"},"children":[],"type":"code"}],"type":"td"}],"type":"tr"}],"type":"tbody"}],"type":"table"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shipment provider status"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"These status messages come from external status providers and service providers. CargoSoft employees cannot enter or"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"change them manually. A provider status represents exactly one state, such as a planned, estimated, or actual date and"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"time. Its code is defined by the provider and can therefore vary between providers."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shipment status"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CargoSoft customers define these status codes themselves. Provider statuses can be mapped to shipment statuses through"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"the customer's basic data. For example, provider status "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ABC"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" can be mapped to the customer-defined shipment status"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ETA"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"; consequently, there is no universal list of valid shipment status codes."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A shipment status record can contain both planned and actual date information. Customers can add status information"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"manually, but an existing record can no longer be changed."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shipment events"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shipment events are fixed status events defined by CargoSoft. They can be retrieved when data is available for the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"shipment. An event can be created automatically from a shipment or provider status when the CargoSoft master data is"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"configured accordingly. It represents either a planned or an actual instance and can be changed manually or by"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"background processes. The complete list of event codes is documented by the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/retrieveEvents"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /cargosoft/shipment/{id}/events"},"children":[],"type":"code"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"}]}],"sectionId":"/section/use-cases/shipment-status-model"}],"sectionId":"/section/use-cases/shipment-status-model"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{"level":2,"id":"section/use-cases/retrieve-shipment-events"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve shipment events"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Goal"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve the CargoSoft-defined events currently available for an existing shipment."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Endpoint"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/retrieveEvents"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /cargosoft/shipment/{id}/events"},"children":[],"type":"code"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Prerequisites"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The unique shipment ID must be known. If only business identifiers are available, first follow the"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/use-cases/retrieve-a-shipment"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieve a shipment"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" workflow."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sequence"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"alt":"RetrieveShipmentEvents","src":"/assets/seq_retrieve_shipment_event.31ae83d1f570ac7a7ad02d38c3644693be9e1dd63bbfcadde63041b12f594937.b476403d.svg","title":"Use case to retrieve shipment events"},"children":[],"type":"image"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Workflow"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Resolve the shipment with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /cargosoft/shipment/lookup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when its unique ID is not yet known."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Extract the shipment "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"id"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from the lookup result."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Call "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /cargosoft/shipment/{id}/events"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with that ID."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Result"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The response contains the available CargoSoft shipment events. An event represents either a planned or an actual"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"instance. For the differences between provider status, customer-defined shipment status, and shipment events, see"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#CHAPTER_SHIPMENT_STATUS_MODEL"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shipment status model"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Error handling"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The response may not contain every possible event because some events may not have been recorded for the shipment yet."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Verify the shipment ID when no events are returned unexpectedly."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}]}],"sectionId":"/section/use-cases/retrieve-shipment-events"}],"sectionId":"/section/use-cases/retrieve-shipment-events"}]}]}},{"type":"group","label":"About the CargoSoft API","link":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api","routeSlug":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api","items":[{"type":"link","label":"General","link":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/general","routeSlug":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/general","content":null},{"type":"link","label":"Changelog","link":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/changelog","routeSlug":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/changelog","content":null},{"type":"link","label":"Category definitions","link":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/category-definitions","routeSlug":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/category-definitions","content":null},{"type":"link","label":"Authorization","link":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/authorization","routeSlug":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/authorization","content":null},{"type":"link","label":"Retrieve a token","link":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/retrieve-a-token","routeSlug":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/retrieve-a-token","content":null},{"type":"link","label":"Access API endpoints","link":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/access-api-endpoints","routeSlug":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/access-api-endpoints","content":null},{"type":"link","label":"Access webhook","link":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/access-webhook","routeSlug":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/access-webhook","content":null},{"type":"link","label":"CRUD","link":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/crud","routeSlug":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/crud","content":null},{"type":"link","label":"Lookup","link":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/lookup","routeSlug":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/lookup","content":null},{"type":"link","label":"Pagination","link":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/pagination","routeSlug":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/pagination","content":null},{"type":"link","label":"Testing","link":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/testing","routeSlug":"/products/tms-api/2026.1/openapi/section/about-the-cargosoft-api/testing","content":null}],"content":null},{"type":"group","label":"Use cases","link":"/products/tms-api/2026.1/openapi/section/use-cases","routeSlug":"/products/tms-api/2026.1/openapi/section/use-cases","items":[{"type":"link","label":"Create a shipment","link":"/products/tms-api/2026.1/openapi/section/use-cases/create-a-shipment","routeSlug":"/products/tms-api/2026.1/openapi/section/use-cases/create-a-shipment","content":null},{"type":"link","label":"Look up an EDI code conversion","link":"/products/tms-api/2026.1/openapi/section/use-cases/look-up-an-edi-code-conversion","routeSlug":"/products/tms-api/2026.1/openapi/section/use-cases/look-up-an-edi-code-conversion","content":null},{"type":"link","label":"Retrieve a shipment","link":"/products/tms-api/2026.1/openapi/section/use-cases/retrieve-a-shipment","routeSlug":"/products/tms-api/2026.1/openapi/section/use-cases/retrieve-a-shipment","content":null},{"type":"link","label":"Attach an E-File document to a shipment","link":"/products/tms-api/2026.1/openapi/section/use-cases/attach-an-e-file-document-to-a-shipment","routeSlug":"/products/tms-api/2026.1/openapi/section/use-cases/attach-an-e-file-document-to-a-shipment","content":null},{"type":"link","label":"Attach a status to a shipment","link":"/products/tms-api/2026.1/openapi/section/use-cases/attach-a-status-to-a-shipment","routeSlug":"/products/tms-api/2026.1/openapi/section/use-cases/attach-a-status-to-a-shipment","content":null},{"type":"link","label":"Shipment status model","link":"/products/tms-api/2026.1/openapi/section/use-cases/shipment-status-model","routeSlug":"/products/tms-api/2026.1/openapi/section/use-cases/shipment-status-model","content":null},{"type":"link","label":"Retrieve shipment events","link":"/products/tms-api/2026.1/openapi/section/use-cases/retrieve-shipment-events","routeSlug":"/products/tms-api/2026.1/openapi/section/use-cases/retrieve-shipment-events","content":null}],"content":null},{"type":"group","label":"Basic data","link":"/products/tms-api/2026.1/openapi/basic-data","routeSlug":"/products/tms-api/2026.1/openapi/basic-data","items":[{"label":"Lookup EDI code conversion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/basic-data/lookup","routeSlug":"/products/tms-api/2026.1/openapi/basic-data/lookup","metadata":{"seo":{"title":"Lookup EDI code conversion","description":"Looks up EDI code conversions (edicodes_t) by EDI partner, direction, code table/type and/or source code. The DIRECTION identifier value must be the raw single-character edicodes_t.richtung code (\"E\" or \"S\"), not the EdiCodeDirectionEnum enum name used on the response. Two identifier combinations are served from a cache (see CodeConverterServiceBean) since this master data changes very rarely: EDIPARTNER+DIRECTION+CODETYPE (all code conversions for a partner's table/direction), and EDIPARTNER+DIRECTION+CODETYPE+SOURCECODE (a single, specific conversion). Omitting EDIPARTNER for a DIRECTION+CODETYPE+SOURCECODE lookup returns every matching conversion across all EDI partners that share the same source code, also served from a cache. Any other identifier combination runs directly against the database."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lookup","name":"Lookup EDI code conversion","isWebhook":false,"pointer":"/paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup EDI code conversion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Looks up EDI code conversions (edicodes_t) by EDI partner, direction, code table/type and/or source code. The DIRECTION identifier value must be the raw single-character edicodes_t.richtung code (\"E\" or \"S\"), not the EdiCodeDirectionEnum enum name used on the response. Two identifier combinations are served from a cache (see CodeConverterServiceBean) since this master data changes very rarely: EDIPARTNER+DIRECTION+CODETYPE (all code conversions for a partner's table/direction), and EDIPARTNER+DIRECTION+CODETYPE+SOURCECODE (a single, specific conversion). Omitting EDIPARTNER for a DIRECTION+CODETYPE+SOURCECODE lookup returns every matching conversion across all EDI partners that share the same source code, also served from a cache. Any other identifier combination runs directly against the database."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_no","in":"query","schemaId":"schema_0","description":"The page number for pagination."},{"name":"page_size","in":"query","schemaId":"schema_1","description":"The page size for pagination."},{"name":"order_by","in":"query","schemaId":"schema_2","description":"The order by for ordering API results sending back as response."},{"name":"order_mode","in":"query","schemaId":"schema_3","description":"The order mode for ordering API results sending back as response."}],"pointer":"/paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/requestBody/content/application~1json/examples/LookupCodeConverterIdentifierExample"]}},"schemaId":"schema_4","exampleIds":["paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/requestBody/content/application~1json/examples/LookupCodeConverterIdentifierExample"],"pointer":"/paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cargosoft/basicdata/codeconverter/lookup","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[],"query":[{"name":"page_no","in":"query","schemaId":"schema_0"},{"name":"page_size","in":"query","schemaId":"schema_1"},{"name":"order_by","in":"query","schemaId":"schema_2"},{"name":"order_mode","in":"query","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/requestBody/content/application~1json/examples/LookupCodeConverterIdentifierExample"]}},"responseCodes":["200"],"pointer":"/cargosoft/basicdata/codeconverter/lookup","href":"basic-data/lookup","openApiOperationId":"lookup","summary":"Lookup EDI code conversion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"schema_4","exampleIds":["paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/requestBody/content/application~1json/examples/LookupCodeConverterIdentifierExample"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/requestBody/content/application~1json/examples/LookupCodeConverterIdentifierExample"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Records found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/responses/200/content/application~1json/examples/CodeConvertionExample"]}},"schemaId":"schema_5","exampleIds":["paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/responses/200/content/application~1json/examples/CodeConvertionExample"],"headers":{"X-Page-Count":{"description":"The total number of pages for pagination.","required":true,"style":"simple","schema":{}},"X-Row-Count":{"description":"The total number of found objects for pagination.","required":true,"style":"simple","schema":{}}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_5","exampleIds":["paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/responses/200/content/application~1json/examples/CodeConvertionExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/responses/200/content/application~1json/examples/CodeConvertionExample"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/basic-data/lookup"}],"panels":[]}]},"httpPath":"/cargosoft/basicdata/codeconverter/lookup"},{"label":"Retrieve all EDI code conversions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/basic-data/retrieveall","routeSlug":"/products/tms-api/2026.1/openapi/basic-data/retrieveall","metadata":{"seo":{"title":"Retrieve all EDI code conversions","description":"Scroll through all existing EDI code conversion records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveAll","name":"Retrieve all EDI code conversions","isWebhook":false,"pointer":"/paths/~1cargosoft~1basicdata~1codeconverter/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all EDI code conversions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Scroll through all existing EDI code conversion records."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_no","in":"query","schemaId":"schema_0"},{"name":"page_size","in":"query","schemaId":"schema_1"},{"name":"cascade","in":"query","schemaId":"schema_7"}],"pointer":"/paths/~1cargosoft~1basicdata~1codeconverter/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cargosoft/basicdata/codeconverter","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[],"query":[{"name":"page_no","in":"query","schemaId":"schema_0"},{"name":"page_size","in":"query","schemaId":"schema_1"},{"name":"cascade","in":"query","schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cargosoft/basicdata/codeconverter","href":"basic-data/retrieveall","openApiOperationId":"retrieveAll","summary":"Retrieve all EDI code conversions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Records retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5"}],"pointer":"/paths/~1cargosoft~1basicdata~1codeconverter/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/basic-data/retrieveall"}],"panels":[]}]},"httpPath":"/cargosoft/basicdata/codeconverter"},{"label":"Retrieve EDI code conversion","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/basic-data/retrievebyid","routeSlug":"/products/tms-api/2026.1/openapi/basic-data/retrievebyid","metadata":{"seo":{"title":"Retrieve EDI code conversion","description":"Retrieve a specific EDI code conversion record with the CargoSoft database id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveById","name":"Retrieve EDI code conversion","isWebhook":false,"pointer":"/paths/~1cargosoft~1basicdata~1codeconverter~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve EDI code conversion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific EDI code conversion record with the CargoSoft database id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_8","description":"Database id of the record you want to retrieve","required":true}],"pointer":"/paths/~1cargosoft~1basicdata~1codeconverter~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cascade","in":"query","schemaId":"schema_7"}],"pointer":"/paths/~1cargosoft~1basicdata~1codeconverter~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cargosoft/basicdata/codeconverter/{id}","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_8"}],"query":[{"name":"cascade","in":"query","schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cargosoft/basicdata/codeconverter/{id}","href":"basic-data/retrievebyid","openApiOperationId":"retrieveById","summary":"Retrieve EDI code conversion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Record retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CodeConvertion"}},"schemaId":"components/schemas/CodeConvertion"}],"pointer":"/paths/~1cargosoft~1basicdata~1codeconverter~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CodeConvertion","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CodeConvertion"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/basic-data/retrievebyid"}],"panels":[]}]},"httpPath":"/cargosoft/basicdata/codeconverter/{id}"}],"content":{"contentType":"group","meta":{"name":"Basic data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Basic data","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lookup of EDI code conversions (edicodes_t): translates an EDI partner's own code into the corresponding CargoSoft internal code, or vice versa."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cargosoft/basicdata/codeconverter/lookup","summary":"Lookup EDI code conversion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/basic-data/lookup","deprecated":false},{"title":"/cargosoft/basicdata/codeconverter","summary":"Retrieve all EDI code conversions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/basic-data/retrieveall","deprecated":false},{"title":"/cargosoft/basicdata/codeconverter/{id}","summary":"Retrieve EDI code conversion","prefix":{"name":"get","color":"get"},"badges":[],"link":"/basic-data/retrievebyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Shipment","link":"/products/tms-api/2026.1/openapi/shipment","routeSlug":"/products/tms-api/2026.1/openapi/shipment","items":[{"label":"Create shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/shipment/createshipment","routeSlug":"/products/tms-api/2026.1/openapi/shipment/createshipment","metadata":{"seo":{"title":"Create shipment","description":"Create a new shipment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createShipment","name":"Create shipment","isWebhook":false,"pointer":"/paths/~1cargosoft~1shipment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new shipment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Shipment","exampleIds":["paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleCollis","paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleContainer"]}},"schemaId":"components/schemas/Shipment","exampleIds":["paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleCollis","paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleContainer"],"pointer":"/paths/~1cargosoft~1shipment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cargosoft/shipment","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Shipment","exampleIds":["paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleCollis","paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleContainer"]}},"responseCodes":["200"],"pointer":"/cargosoft/shipment","href":"shipment/createshipment","openApiOperationId":"createShipment","summary":"Create shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"components/schemas/Shipment","exampleIds":["paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleCollis","paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleContainer"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Shipment","exampleIds":["paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleCollis","paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleContainer"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Record created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Shipment","exampleIds":["paths/~1cargosoft~1shipment/post/responses/200/content/application~1json/examples/CreateShipmentResponseExample"]}},"schemaId":"components/schemas/Shipment","exampleIds":["paths/~1cargosoft~1shipment/post/responses/200/content/application~1json/examples/CreateShipmentResponseExample"]}],"pointer":"/paths/~1cargosoft~1shipment/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Shipment","exampleIds":["paths/~1cargosoft~1shipment/post/responses/200/content/application~1json/examples/CreateShipmentResponseExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Shipment","exampleIds":["paths/~1cargosoft~1shipment/post/responses/200/content/application~1json/examples/CreateShipmentResponseExample"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/createshipment"}],"panels":[]}]},"httpPath":"/cargosoft/shipment"},{"label":"Lookup for shipments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/shipment/lookup_1","routeSlug":"/products/tms-api/2026.1/openapi/shipment/lookup_1","metadata":{"seo":{"title":"Lookup for shipments","description":"This endpoint looks up shipments. The result should be limit by using search criterias in the request body. For a complete list of search criteria see the ShipmentIdentifier enumeration below. Depending on the search criteria you will receive zero up to n shipments. This endpoint only returns the base shipment. If you need the full shipment details, use the shipment id to retrieve them separately."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lookup_1","name":"Lookup for shipments","isWebhook":false,"pointer":"/paths/~1cargosoft~1shipment~1lookup/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup for shipments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint looks up shipments. The result should be limit by using search criterias in the request body. For a complete list of search criteria see the ShipmentIdentifier enumeration below. Depending on the search criteria you will receive zero up to n shipments. This endpoint only returns the base shipment. If you need the full shipment details, use the shipment id to retrieve them separately."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_no","in":"query","schemaId":"schema_0","description":"The page number for pagination."},{"name":"page_size","in":"query","schemaId":"schema_1","description":"The page size for pagination."},{"name":"order_by","in":"query","schemaId":"schema_9","description":"The order by for ordering API results sending back as response."},{"name":"order_mode","in":"query","schemaId":"schema_3","description":"The order mode for ordering API results sending back as response."}],"pointer":"/paths/~1cargosoft~1shipment~1lookup/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_10","exampleIds":["paths/~1cargosoft~1shipment~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentIdentifierExample"]}},"schemaId":"schema_10","exampleIds":["paths/~1cargosoft~1shipment~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentIdentifierExample"],"pointer":"/paths/~1cargosoft~1shipment~1lookup/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cargosoft/shipment/lookup","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[],"query":[{"name":"page_no","in":"query","schemaId":"schema_0"},{"name":"page_size","in":"query","schemaId":"schema_1"},{"name":"order_by","in":"query","schemaId":"schema_9"},{"name":"order_mode","in":"query","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_10","exampleIds":["paths/~1cargosoft~1shipment~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentIdentifierExample"]}},"responseCodes":["200"],"pointer":"/cargosoft/shipment/lookup","href":"shipment/lookup_1","openApiOperationId":"lookup_1","summary":"Lookup for shipments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"schema_10","exampleIds":["paths/~1cargosoft~1shipment~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentIdentifierExample"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_10","exampleIds":["paths/~1cargosoft~1shipment~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentIdentifierExample"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Records found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1cargosoft~1shipment~1lookup/post/responses/200/content/application~1json/examples/ShipmentExample"]}},"schemaId":"schema_11","exampleIds":["paths/~1cargosoft~1shipment~1lookup/post/responses/200/content/application~1json/examples/ShipmentExample"],"headers":{"X-Page-Count":{"description":"The total number of pages for pagination.","required":true,"style":"simple","schema":{}},"X-Row-Count":{"description":"The total number of found objects for pagination.","required":true,"style":"simple","schema":{}}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1cargosoft~1shipment~1lookup/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_11","exampleIds":["paths/~1cargosoft~1shipment~1lookup/post/responses/200/content/application~1json/examples/ShipmentExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1cargosoft~1shipment~1lookup/post/responses/200/content/application~1json/examples/ShipmentExample"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/lookup_1"}],"panels":[]}]},"httpPath":"/cargosoft/shipment/lookup"},{"label":"Retrieve airfreight shipment main carriage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/shipment/retrieveairmaincarriage","routeSlug":"/products/tms-api/2026.1/openapi/shipment/retrieveairmaincarriage","metadata":{"seo":{"title":"Retrieve airfreight shipment main carriage","description":"Retrieve the airfreight main carriage of the shipment with additional details. The CargoSoft Shipment ID is needed to retrieve the main carriage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveAirMainCarriage","name":"Retrieve airfreight shipment main carriage","isWebhook":false,"pointer":"/paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve airfreight shipment main carriage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the airfreight main carriage of the shipment with additional details. The CargoSoft Shipment ID is needed to retrieve the main carriage. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_8","required":true}],"pointer":"/paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cargosoft/shipment/{id}/airmaincarriage","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","500"],"pointer":"/cargosoft/shipment/{id}/airmaincarriage","href":"shipment/retrieveairmaincarriage","openApiOperationId":"retrieveAirMainCarriage","summary":"Retrieve airfreight shipment main carriage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Record retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses/200/content/application~1json/examples/ShipmentAirfreightCarriageExportExample","paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses/200/content/application~1json/examples/ShipmentAirfreightCarriageImportExample"]}},"schemaId":"schema_12","exampleIds":["paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses/200/content/application~1json/examples/ShipmentAirfreightCarriageExportExample","paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses/200/content/application~1json/examples/ShipmentAirfreightCarriageImportExample"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses/200/content/application~1json/examples/ShipmentAirfreightCarriageExportExample","paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses/200/content/application~1json/examples/ShipmentAirfreightCarriageImportExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses/200/content/application~1json/examples/ShipmentAirfreightCarriageExportExample","paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses/200/content/application~1json/examples/ShipmentAirfreightCarriageImportExample"]}}},{"code":"500","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/retrieveairmaincarriage"}],"panels":[]}]},"httpPath":"/cargosoft/shipment/{id}/airmaincarriage"},{"label":"Retrieve shipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/shipment/retrievebyid_1","routeSlug":"/products/tms-api/2026.1/openapi/shipment/retrievebyid_1","metadata":{"seo":{"title":"Retrieve shipment","description":"Retrieve a specific shipment with the CargoSoft database id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveById_1","name":"Retrieve shipment","isWebhook":false,"pointer":"/paths/~1cargosoft~1shipment~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific shipment with the CargoSoft database id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_8","description":"Database id of the record you want to retrieve","required":true}],"pointer":"/paths/~1cargosoft~1shipment~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cascade","in":"query","schemaId":"schema_7"}],"pointer":"/paths/~1cargosoft~1shipment~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cargosoft/shipment/{id}","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_8"}],"query":[{"name":"cascade","in":"query","schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cargosoft/shipment/{id}","href":"shipment/retrievebyid_1","openApiOperationId":"retrieveById_1","summary":"Retrieve shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Record retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Shipment"}},"schemaId":"components/schemas/Shipment"}],"pointer":"/paths/~1cargosoft~1shipment~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Shipment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Shipment"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/retrievebyid_1"}],"panels":[]}]},"httpPath":"/cargosoft/shipment/{id}"},{"label":"Retrieve shipment events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/shipment/retrieveevents","routeSlug":"/products/tms-api/2026.1/openapi/shipment/retrieveevents","metadata":{"seo":{"title":"Retrieve shipment events","description":"This endpoint retrieves all events of the shipment. To retrieve the events, the shipment id is needed. It is possible that not all events are included in the response because they are not entered or know in the shipment unitil now. To retrive the shipment id, use the lookup endpoint of this chapter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveEvents","name":"Retrieve shipment events","isWebhook":false,"pointer":"/paths/~1cargosoft~1shipment~1{id}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve shipment events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint retrieves all events of the shipment. To retrieve the events, the shipment id is needed. It is possible that not all events are included in the response because they are not entered or know in the shipment unitil now. To retrive the shipment id, use the lookup endpoint of this chapter."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_8","description":"The shipment id.","required":true}],"pointer":"/paths/~1cargosoft~1shipment~1{id}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cargosoft/shipment/{id}/events","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cargosoft/shipment/{id}/events","href":"shipment/retrieveevents","openApiOperationId":"retrieveEvents","summary":"Retrieve shipment events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Records found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1cargosoft~1shipment~1{id}~1events/get/responses/200/content/application~1json/examples/ShipmentEventExample"]}},"schemaId":"schema_13","exampleIds":["paths/~1cargosoft~1shipment~1{id}~1events/get/responses/200/content/application~1json/examples/ShipmentEventExample"]}],"pointer":"/paths/~1cargosoft~1shipment~1{id}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_13","exampleIds":["paths/~1cargosoft~1shipment~1{id}~1events/get/responses/200/content/application~1json/examples/ShipmentEventExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1cargosoft~1shipment~1{id}~1events/get/responses/200/content/application~1json/examples/ShipmentEventExample"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/retrieveevents"}],"panels":[]}]},"httpPath":"/cargosoft/shipment/{id}/events"},{"label":"Retrieve seafreight shipment main carriage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/shipment/retrieveseamaincarriage","routeSlug":"/products/tms-api/2026.1/openapi/shipment/retrieveseamaincarriage","metadata":{"seo":{"title":"Retrieve seafreight shipment main carriage","description":"Retrieve the main carriage of the shipment with additional details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveSeaMainCarriage","name":"Retrieve seafreight shipment main carriage","isWebhook":false,"pointer":"/paths/~1cargosoft~1shipment~1{id}~1seamaincarriage/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve seafreight shipment main carriage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the main carriage of the shipment with additional details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_8","required":true}],"pointer":"/paths/~1cargosoft~1shipment~1{id}~1seamaincarriage/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cargosoft/shipment/{id}/seamaincarriage","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","500"],"pointer":"/cargosoft/shipment/{id}/seamaincarriage","href":"shipment/retrieveseamaincarriage","openApiOperationId":"retrieveSeaMainCarriage","summary":"Retrieve seafreight shipment main carriage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Record retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}},"schemaId":"schema_14"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}},"schemaId":"components/schemas/APIErrorResponse"}],"pointer":"/paths/~1cargosoft~1shipment~1{id}~1seamaincarriage/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_14","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}}},{"code":"500","schemaId":"components/schemas/APIErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/retrieveseamaincarriage"}],"panels":[]}]},"httpPath":"/cargosoft/shipment/{id}/seamaincarriage"},{"label":"Create a shipment event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/shipment/create","routeSlug":"/products/tms-api/2026.1/openapi/shipment/create","metadata":{"seo":{"title":"Create a shipment event","description":"Create a shipment event of the given event type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create","name":"Create a shipment event","isWebhook":false,"pointer":"/paths/~1cargosoft~1shipment~1{shipmentId}~1event/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a shipment event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a shipment event of the given event type. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shipmentId","in":"path","schemaId":"schema_8","required":true}],"pointer":"/paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_15"}],"pointer":"/paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/requestBody/content/application~1json/examples/ShipmentEventExample"]}},"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/requestBody/content/application~1json/examples/ShipmentEventExample"],"pointer":"/paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cargosoft/shipment/{shipmentId}/event","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"shipmentId","in":"path","required":true,"schemaId":"schema_8"}],"query":[{"name":"type","in":"query","schemaId":"components/schemas/EventType"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/requestBody/content/application~1json/examples/ShipmentEventExample"]}},"responseCodes":["200"],"pointer":"/cargosoft/shipment/{shipmentId}/event","href":"shipment/create","openApiOperationId":"create","summary":"Create a shipment event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/requestBody/content/application~1json/examples/ShipmentEventExample"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/requestBody/content/application~1json/examples/ShipmentEventExample"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The event has been created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/responses/200/content/application~1json/examples/ShipmentEventExample"]}},"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/responses/200/content/application~1json/examples/ShipmentEventExample"]}],"pointer":"/paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/responses/200/content/application~1json/examples/ShipmentEventExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/responses/200/content/application~1json/examples/ShipmentEventExample"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/create"}],"panels":[]}]},"httpPath":"/cargosoft/shipment/{shipmentId}/event"},{"label":"Update a shipment event","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/shipment/update","routeSlug":"/products/tms-api/2026.1/openapi/shipment/update","metadata":{"seo":{"title":"Update a shipment event","description":"Update the event of the given event type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update","name":"Update a shipment event","isWebhook":false,"pointer":"/paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a shipment event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the event of the given event type. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shipmentId","in":"path","schemaId":"schema_8","required":true},{"name":"id","in":"path","schemaId":"schema_16","description":"Database id of the record you want to update.","required":true}],"pointer":"/paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_15"}],"pointer":"/paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventUpdateExample","paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventMinimalUpdateExample"]}},"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventUpdateExample","paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventMinimalUpdateExample"],"pointer":"/paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/cargosoft/shipment/{shipmentId}/event/{id}","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"shipmentId","in":"path","required":true,"schemaId":"schema_8"},{"name":"id","in":"path","required":true,"schemaId":"components/schemas/ShipmentEventQualifier"}],"query":[{"name":"type","in":"query","schemaId":"components/schemas/EventType"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventUpdateExample","paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventMinimalUpdateExample"]}},"responseCodes":["200"],"pointer":"/cargosoft/shipment/{shipmentId}/event/{id}","href":"shipment/update","openApiOperationId":"update","summary":"Update a shipment event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventUpdateExample","paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventMinimalUpdateExample"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventUpdateExample","paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventMinimalUpdateExample"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The event has been updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/responses/200/content/application~1json/examples/ShipmentEventExample"]}},"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/responses/200/content/application~1json/examples/ShipmentEventExample"]}],"pointer":"/paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/responses/200/content/application~1json/examples/ShipmentEventExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentEvent","exampleIds":["paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/responses/200/content/application~1json/examples/ShipmentEventExample"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/update"}],"panels":[]}]},"httpPath":"/cargosoft/shipment/{shipmentId}/event/{id}"}],"content":{"contentType":"group","meta":{"name":"Shipment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipment","showPageActions":true},{"nodeType":"markdoc","content":"The following chapter will give you an overview about the shipment endpoints and their function."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cargosoft/shipment","summary":"Create shipment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/createshipment","deprecated":false},{"title":"/cargosoft/shipment/lookup","summary":"Lookup for shipments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/lookup_1","deprecated":false},{"title":"/cargosoft/shipment/{id}/airmaincarriage","summary":"Retrieve airfreight shipment main carriage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/retrieveairmaincarriage","deprecated":false},{"title":"/cargosoft/shipment/{id}","summary":"Retrieve shipment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/retrievebyid_1","deprecated":false},{"title":"/cargosoft/shipment/{id}/events","summary":"Retrieve shipment events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/retrieveevents","deprecated":false},{"title":"/cargosoft/shipment/{id}/seamaincarriage","summary":"Retrieve seafreight shipment main carriage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/retrieveseamaincarriage","deprecated":false},{"title":"/cargosoft/shipment/{shipmentId}/event","summary":"Create a shipment event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/create","deprecated":false},{"title":"/cargosoft/shipment/{shipmentId}/event/{id}","summary":"Update a shipment event","prefix":{"name":"put","color":"put"},"badges":[],"link":"/shipment/update","deprecated":false}]}]}]}]}},{"type":"group","label":"ShipmentMemo","link":"/products/tms-api/2026.1/openapi/shipmentmemo","routeSlug":"/products/tms-api/2026.1/openapi/shipmentmemo","items":[{"label":"Lookup shipment memo lines","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/shipmentmemo/lookup_2","routeSlug":"/products/tms-api/2026.1/openapi/shipmentmemo/lookup_2","metadata":{"seo":{"title":"Lookup shipment memo lines","description":"Looks up order memo lines (eamemo_t) attached to a shipment, typically by client and shipment_number together (the shipment they were created for)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lookup_2","name":"Lookup shipment memo lines","isWebhook":false,"pointer":"/paths/~1cargosoft~1shipment~1memo~1lookup/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup shipment memo lines","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Looks up order memo lines (eamemo_t) attached to a shipment, typically by client and shipment_number together (the shipment they were created for)."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_no","in":"query","schemaId":"schema_0","description":"The page number for pagination."},{"name":"page_size","in":"query","schemaId":"schema_1","description":"The page size for pagination."},{"name":"order_by","in":"query","schemaId":"schema_17","description":"The order by for ordering API results sending back as response."},{"name":"order_mode","in":"query","schemaId":"schema_3","description":"The order mode for ordering API results sending back as response."}],"pointer":"/paths/~1cargosoft~1shipment~1memo~1lookup/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1cargosoft~1shipment~1memo~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentMemoIdentifierExample"]}},"schemaId":"schema_4","exampleIds":["paths/~1cargosoft~1shipment~1memo~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentMemoIdentifierExample"],"pointer":"/paths/~1cargosoft~1shipment~1memo~1lookup/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cargosoft/shipment/memo/lookup","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[],"query":[{"name":"page_no","in":"query","schemaId":"schema_0"},{"name":"page_size","in":"query","schemaId":"schema_1"},{"name":"order_by","in":"query","schemaId":"schema_17"},{"name":"order_mode","in":"query","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1cargosoft~1shipment~1memo~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentMemoIdentifierExample"]}},"responseCodes":["200"],"pointer":"/cargosoft/shipment/memo/lookup","href":"shipmentmemo/lookup_2","openApiOperationId":"lookup_2","summary":"Lookup shipment memo lines"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"schema_4","exampleIds":["paths/~1cargosoft~1shipment~1memo~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentMemoIdentifierExample"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1cargosoft~1shipment~1memo~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentMemoIdentifierExample"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Records found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1cargosoft~1shipment~1memo~1lookup/post/responses/200/content/application~1json/examples/ShipmentMemoExample"]}},"schemaId":"schema_18","exampleIds":["paths/~1cargosoft~1shipment~1memo~1lookup/post/responses/200/content/application~1json/examples/ShipmentMemoExample"],"headers":{"X-Page-Count":{"description":"The total number of pages for pagination.","required":true,"style":"simple","schema":{}},"X-Row-Count":{"description":"The total number of found objects for pagination.","required":true,"style":"simple","schema":{}}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1cargosoft~1shipment~1memo~1lookup/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_18","exampleIds":["paths/~1cargosoft~1shipment~1memo~1lookup/post/responses/200/content/application~1json/examples/ShipmentMemoExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1cargosoft~1shipment~1memo~1lookup/post/responses/200/content/application~1json/examples/ShipmentMemoExample"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipmentmemo/lookup_2"}],"panels":[]}]},"httpPath":"/cargosoft/shipment/memo/lookup"},{"label":"Retrieve all shipment memo lines","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/shipmentmemo/retrieveall_1","routeSlug":"/products/tms-api/2026.1/openapi/shipmentmemo/retrieveall_1","metadata":{"seo":{"title":"Retrieve all shipment memo lines","description":"Scroll through all existing shipment memo line records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveAll_1","name":"Retrieve all shipment memo lines","isWebhook":false,"pointer":"/paths/~1cargosoft~1shipment~1memo/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all shipment memo lines","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Scroll through all existing shipment memo line records."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_no","in":"query","schemaId":"schema_0"},{"name":"page_size","in":"query","schemaId":"schema_1"},{"name":"cascade","in":"query","schemaId":"schema_7"}],"pointer":"/paths/~1cargosoft~1shipment~1memo/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cargosoft/shipment/memo","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[],"query":[{"name":"page_no","in":"query","schemaId":"schema_0"},{"name":"page_size","in":"query","schemaId":"schema_1"},{"name":"cascade","in":"query","schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cargosoft/shipment/memo","href":"shipmentmemo/retrieveall_1","openApiOperationId":"retrieveAll_1","summary":"Retrieve all shipment memo lines"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Records retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"}},"schemaId":"schema_18"}],"pointer":"/paths/~1cargosoft~1shipment~1memo/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_18","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipmentmemo/retrieveall_1"}],"panels":[]}]},"httpPath":"/cargosoft/shipment/memo"},{"label":"Retrieve shipment memo line","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/shipmentmemo/retrievebyid_2","routeSlug":"/products/tms-api/2026.1/openapi/shipmentmemo/retrievebyid_2","metadata":{"seo":{"title":"Retrieve shipment memo line","description":"Retrieve a specific shipment memo line record with the CargoSoft database id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveById_2","name":"Retrieve shipment memo line","isWebhook":false,"pointer":"/paths/~1cargosoft~1shipment~1memo~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve shipment memo line","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific shipment memo line record with the CargoSoft database id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_8","description":"Database id of the record you want to retrieve","required":true}],"pointer":"/paths/~1cargosoft~1shipment~1memo~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cascade","in":"query","schemaId":"schema_7"}],"pointer":"/paths/~1cargosoft~1shipment~1memo~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cargosoft/shipment/memo/{id}","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_8"}],"query":[{"name":"cascade","in":"query","schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cargosoft/shipment/memo/{id}","href":"shipmentmemo/retrievebyid_2","openApiOperationId":"retrieveById_2","summary":"Retrieve shipment memo line"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Record retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentMemo"}},"schemaId":"components/schemas/ShipmentMemo"}],"pointer":"/paths/~1cargosoft~1shipment~1memo~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShipmentMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentMemo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipmentmemo/retrievebyid_2"}],"panels":[]}]},"httpPath":"/cargosoft/shipment/memo/{id}"}],"content":{"contentType":"group","meta":{"name":"ShipmentMemo"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ShipmentMemo","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lookup of order memo lines (eamemo_t) attached to a shipment."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cargosoft/shipment/memo/lookup","summary":"Lookup shipment memo lines","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipmentmemo/lookup_2","deprecated":false},{"title":"/cargosoft/shipment/memo","summary":"Retrieve all shipment memo lines","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipmentmemo/retrieveall_1","deprecated":false},{"title":"/cargosoft/shipment/memo/{id}","summary":"Retrieve shipment memo line","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipmentmemo/retrievebyid_2","deprecated":false}]}]}]}]}},{"type":"group","label":"Provider Status","link":"/products/tms-api/2026.1/openapi/provider-status","routeSlug":"/products/tms-api/2026.1/openapi/provider-status","items":[{"label":"Create a provider status.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/provider-status/createproviderstatus","routeSlug":"/products/tms-api/2026.1/openapi/provider-status/createproviderstatus","metadata":{"seo":{"title":"Create a provider status.","description":"Development notice: This endpoint is still under development and may change."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProviderStatus","name":"Create a provider status.","isWebhook":false,"pointer":"/paths/~1cargosoft~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a provider status.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Development notice:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" This endpoint is still under development and may change."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Creates a provider status and associates it with a shipment when the CLIENT and SHIPMENT_NUMBER references identify an existing shipment. Provider and status codes depend on the customer-specific CargoSoft master data."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProviderResponseStatus","exampleIds":["paths/~1cargosoft~1status/post/requestBody/content/application~1json/examples/CreateProviderStatusExample"]}},"schemaId":"components/schemas/ProviderResponseStatus","exampleIds":["paths/~1cargosoft~1status/post/requestBody/content/application~1json/examples/CreateProviderStatusExample"],"pointer":"/paths/~1cargosoft~1status/post/requestBody","description":"Provider status, event dates, and references used to resolve the customer, provider, and shipment."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cargosoft/status","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProviderResponseStatus","exampleIds":["paths/~1cargosoft~1status/post/requestBody/content/application~1json/examples/CreateProviderStatusExample"]}},"responseCodes":["200"],"pointer":"/cargosoft/status","href":"provider-status/createproviderstatus","openApiOperationId":"createProviderStatus","summary":"Create a provider status."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"components/schemas/ProviderResponseStatus","exampleIds":["paths/~1cargosoft~1status/post/requestBody/content/application~1json/examples/CreateProviderStatusExample"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProviderResponseStatus","exampleIds":["paths/~1cargosoft~1status/post/requestBody/content/application~1json/examples/CreateProviderStatusExample"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Provider status processed successfully. The response has no content."}],"pointer":"/paths/~1cargosoft~1status/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/provider-status/createproviderstatus"}],"panels":[]}]},"httpPath":"/cargosoft/status"}],"content":{"contentType":"group","meta":{"name":"Provider Status"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Provider Status","showPageActions":true},{"nodeType":"markdoc","content":"Create provider statuses and associate them with CargoSoft shipments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cargosoft/status","summary":"Create a provider status.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/provider-status/createproviderstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"E-File","link":"/products/tms-api/2026.1/openapi/e-file","routeSlug":"/products/tms-api/2026.1/openapi/e-file","items":[{"label":"Create an E-File document.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/e-file/createefiledocument","routeSlug":"/products/tms-api/2026.1/openapi/e-file/createefiledocument","metadata":{"seo":{"title":"Create an E-File document.","description":"Development notice: This endpoint is still under development and may change."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEFileDocument","name":"Create an E-File document.","isWebhook":false,"pointer":"/paths/~1cargosoft~1efile/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an E-File document.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Development notice:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" This endpoint is still under development and may change."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Stores a base64 encoded document in E-File and links it to the supplied references and roles."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EFile"}},"schemaId":"components/schemas/EFile","pointer":"/paths/~1cargosoft~1efile/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cargosoft/efile","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EFile"}},"responseCodes":["200"],"pointer":"/cargosoft/efile","href":"e-file/createefiledocument","openApiOperationId":"createEFileDocument","summary":"Create an E-File document."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"components/schemas/EFile","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EFile"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Record created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EFile"}},"schemaId":"components/schemas/EFile"}],"pointer":"/paths/~1cargosoft~1efile/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EFile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EFile"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-file/createefiledocument"}],"panels":[]}]},"httpPath":"/cargosoft/efile"},{"label":"Retrieve references from an E-File document.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/e-file/retrieveefilereferences","routeSlug":"/products/tms-api/2026.1/openapi/e-file/retrieveefilereferences","metadata":{"seo":{"title":"Retrieve references from an E-File document.","description":"Retrieves all references linked to an E-File document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveEFileReferences","name":"Retrieve references from an E-File document.","isWebhook":false,"pointer":"/paths/~1cargosoft~1efile~1{id}~1reference/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve references from an E-File document.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all references linked to an E-File document."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_19","description":"E-File document ID.","required":true}],"pointer":"/paths/~1cargosoft~1efile~1{id}~1reference/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cargosoft/efile/{id}/reference","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cargosoft/efile/{id}/reference","href":"e-file/retrieveefilereferences","openApiOperationId":"retrieveEFileReferences","summary":"Retrieve references from an E-File document."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"References retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}},"schemaId":"schema_20"}],"pointer":"/paths/~1cargosoft~1efile~1{id}~1reference/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_20","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-file/retrieveefilereferences"}],"panels":[]}]},"httpPath":"/cargosoft/efile/{id}/reference"},{"label":"Add a reference to an E-File document.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/e-file/addefilereference","routeSlug":"/products/tms-api/2026.1/openapi/e-file/addefilereference","metadata":{"seo":{"title":"Add a reference to an E-File document.","description":"Adds a reference, such as a shipment or address reference, to an existing E-File document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addEFileReference","name":"Add a reference to an E-File document.","isWebhook":false,"pointer":"/paths/~1cargosoft~1efile~1{id}~1reference/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a reference to an E-File document.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a reference, such as a shipment or address reference, to an existing E-File document."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_19","description":"E-File document ID.","required":true}],"pointer":"/paths/~1cargosoft~1efile~1{id}~1reference/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EFileReference"}},"schemaId":"components/schemas/EFileReference","pointer":"/paths/~1cargosoft~1efile~1{id}~1reference/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cargosoft/efile/{id}/reference","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EFileReference"}},"responseCodes":["200"],"pointer":"/cargosoft/efile/{id}/reference","href":"e-file/addefilereference","openApiOperationId":"addEFileReference","summary":"Add a reference to an E-File document."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"components/schemas/EFileReference","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EFileReference"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Reference added."}],"pointer":"/paths/~1cargosoft~1efile~1{id}~1reference/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-file/addefilereference"}],"panels":[]}]},"httpPath":"/cargosoft/efile/{id}/reference"},{"label":"Remove a reference from an E-File document.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/e-file/removeefilereference","routeSlug":"/products/tms-api/2026.1/openapi/e-file/removeefilereference","metadata":{"seo":{"title":"Remove a reference from an E-File document.","description":"Removes a reference from an existing E-File document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeEFileReference","name":"Remove a reference from an E-File document.","isWebhook":false,"pointer":"/paths/~1cargosoft~1efile~1{id}~1reference/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a reference from an E-File document.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a reference from an existing E-File document."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_19","description":"E-File document ID.","required":true}],"pointer":"/paths/~1cargosoft~1efile~1{id}~1reference/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EFileReference"}},"schemaId":"components/schemas/EFileReference","pointer":"/paths/~1cargosoft~1efile~1{id}~1reference/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cargosoft/efile/{id}/reference","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EFileReference"}},"responseCodes":["200"],"pointer":"/cargosoft/efile/{id}/reference","href":"e-file/removeefilereference","openApiOperationId":"removeEFileReference","summary":"Remove a reference from an E-File document."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"components/schemas/EFileReference","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EFileReference"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Reference removed."}],"pointer":"/paths/~1cargosoft~1efile~1{id}~1reference/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-file/removeefilereference"}],"panels":[]}]},"httpPath":"/cargosoft/efile/{id}/reference"},{"label":"Retrieve roles from an E-File document.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/e-file/retrieveefileroles","routeSlug":"/products/tms-api/2026.1/openapi/e-file/retrieveefileroles","metadata":{"seo":{"title":"Retrieve roles from an E-File document.","description":"Retrieves all authorization roles linked to an E-File document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveEFileRoles","name":"Retrieve roles from an E-File document.","isWebhook":false,"pointer":"/paths/~1cargosoft~1efile~1{id}~1role/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve roles from an E-File document.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all authorization roles linked to an E-File document."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_19","description":"E-File document ID.","required":true}],"pointer":"/paths/~1cargosoft~1efile~1{id}~1role/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cargosoft/efile/{id}/role","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cargosoft/efile/{id}/role","href":"e-file/retrieveefileroles","openApiOperationId":"retrieveEFileRoles","summary":"Retrieve roles from an E-File document."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Roles retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21"}],"pointer":"/paths/~1cargosoft~1efile~1{id}~1role/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-file/retrieveefileroles"}],"panels":[]}]},"httpPath":"/cargosoft/efile/{id}/role"},{"label":"Add a role to an E-File document.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/e-file/addefilerole","routeSlug":"/products/tms-api/2026.1/openapi/e-file/addefilerole","metadata":{"seo":{"title":"Add a role to an E-File document.","description":"Adds an authorization role to an existing E-File document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addEFileRole","name":"Add a role to an E-File document.","isWebhook":false,"pointer":"/paths/~1cargosoft~1efile~1{id}~1role/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a role to an E-File document.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds an authorization role to an existing E-File document."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_19","description":"E-File document ID.","required":true}],"pointer":"/paths/~1cargosoft~1efile~1{id}~1role/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"schema_22"}},"schemaId":"schema_22","pointer":"/paths/~1cargosoft~1efile~1{id}~1role/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cargosoft/efile/{id}/role","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"text/plain":{"schemaId":"schema_22"}},"responseCodes":["200"],"pointer":"/cargosoft/efile/{id}/role","href":"e-file/addefilerole","openApiOperationId":"addEFileRole","summary":"Add a role to an E-File document."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"schema_22","mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"schema_22"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Role added."}],"pointer":"/paths/~1cargosoft~1efile~1{id}~1role/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-file/addefilerole"}],"panels":[]}]},"httpPath":"/cargosoft/efile/{id}/role"},{"label":"Remove a role from an E-File document.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/e-file/removeefilerole","routeSlug":"/products/tms-api/2026.1/openapi/e-file/removeefilerole","metadata":{"seo":{"title":"Remove a role from an E-File document.","description":"Removes an authorization role from an existing E-File document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeEFileRole","name":"Remove a role from an E-File document.","isWebhook":false,"pointer":"/paths/~1cargosoft~1efile~1{id}~1role/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a role from an E-File document.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes an authorization role from an existing E-File document."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_19","description":"E-File document ID.","required":true}],"pointer":"/paths/~1cargosoft~1efile~1{id}~1role/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EFileRole"}},"schemaId":"components/schemas/EFileRole","pointer":"/paths/~1cargosoft~1efile~1{id}~1role/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cargosoft/efile/{id}/role","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EFileRole"}},"responseCodes":["200"],"pointer":"/cargosoft/efile/{id}/role","href":"e-file/removeefilerole","openApiOperationId":"removeEFileRole","summary":"Remove a role from an E-File document."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"components/schemas/EFileRole","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EFileRole"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Role removed."}],"pointer":"/paths/~1cargosoft~1efile~1{id}~1role/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-file/removeefilerole"}],"panels":[]}]},"httpPath":"/cargosoft/efile/{id}/role"},{"label":"Retrieve an E-File document.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/e-file/retrieveefiledocument","routeSlug":"/products/tms-api/2026.1/openapi/e-file/retrieveefiledocument","metadata":{"seo":{"title":"Retrieve an E-File document.","description":"Retrieves a single E-File document by its document ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveEFileDocument","name":"Retrieve an E-File document.","isWebhook":false,"pointer":"/paths/~1cargosoft~1efile~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an E-File document.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single E-File document by its document ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_8","description":"E-File document ID.","required":true}],"pointer":"/paths/~1cargosoft~1efile~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cascade","in":"query","schemaId":"schema_7"}],"pointer":"/paths/~1cargosoft~1efile~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cargosoft/efile/{id}","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_8"}],"query":[{"name":"cascade","in":"query","schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cargosoft/efile/{id}","href":"e-file/retrieveefiledocument","openApiOperationId":"retrieveEFileDocument","summary":"Retrieve an E-File document."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Record retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EFile"}},"schemaId":"components/schemas/EFile"}],"pointer":"/paths/~1cargosoft~1efile~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EFile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EFile"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-file/retrieveefiledocument"}],"panels":[]}]},"httpPath":"/cargosoft/efile/{id}"},{"label":"Delete an E-File document.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/e-file/deleteefiledocument","routeSlug":"/products/tms-api/2026.1/openapi/e-file/deleteefiledocument","metadata":{"seo":{"title":"Delete an E-File document.","description":"Deletes an E-File document by its document ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEFileDocument","name":"Delete an E-File document.","isWebhook":false,"pointer":"/paths/~1cargosoft~1efile~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an E-File document.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an E-File document by its document ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_8","description":"E-File document ID.","required":true}],"pointer":"/paths/~1cargosoft~1efile~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cargosoft/efile/{id}","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cargosoft/efile/{id}","href":"e-file/deleteefiledocument","openApiOperationId":"deleteEFileDocument","summary":"Delete an E-File document."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Record deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EFile"}},"schemaId":"components/schemas/EFile"}],"pointer":"/paths/~1cargosoft~1efile~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EFile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EFile"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-file/deleteefiledocument"}],"panels":[]}]},"httpPath":"/cargosoft/efile/{id}"},{"label":"Lookup E-File documents.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/e-file/lookupefiledocuments","routeSlug":"/products/tms-api/2026.1/openapi/e-file/lookupefiledocuments","metadata":{"seo":{"title":"Lookup E-File documents.","description":"Looks up electronic documents such as PDF files by the supplied lookup identifiers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lookupEFileDocuments","name":"Lookup E-File documents.","isWebhook":false,"pointer":"/paths/~1cargosoft~1efile~1lookup/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup E-File documents.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Looks up electronic documents such as PDF files by the supplied lookup identifiers."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JavaWebToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_no","in":"query","schemaId":"schema_0","description":"The page number for pagination."},{"name":"page_size","in":"query","schemaId":"schema_1","description":"The page size for pagination."},{"name":"order_by","in":"query","schemaId":"schema_23","description":"The order by for ordering API results sending back as response."},{"name":"order_mode","in":"query","schemaId":"schema_3","description":"The order mode for ordering API results sending back as response."}],"pointer":"/paths/~1cargosoft~1efile~1lookup/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24","exampleIds":["paths/~1cargosoft~1efile~1lookup/post/requestBody/content/application~1json/examples/LookupEFileIdentifierExample"]}},"schemaId":"schema_24","exampleIds":["paths/~1cargosoft~1efile~1lookup/post/requestBody/content/application~1json/examples/LookupEFileIdentifierExample"],"pointer":"/paths/~1cargosoft~1efile~1lookup/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cargosoft/efile/lookup","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[],"query":[{"name":"page_no","in":"query","schemaId":"schema_0"},{"name":"page_size","in":"query","schemaId":"schema_1"},{"name":"order_by","in":"query","schemaId":"schema_23"},{"name":"order_mode","in":"query","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_24","exampleIds":["paths/~1cargosoft~1efile~1lookup/post/requestBody/content/application~1json/examples/LookupEFileIdentifierExample"]}},"responseCodes":["200"],"pointer":"/cargosoft/efile/lookup","href":"e-file/lookupefiledocuments","openApiOperationId":"lookupEFileDocuments","summary":"Lookup E-File documents."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"schema_24","exampleIds":["paths/~1cargosoft~1efile~1lookup/post/requestBody/content/application~1json/examples/LookupEFileIdentifierExample"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24","exampleIds":["paths/~1cargosoft~1efile~1lookup/post/requestBody/content/application~1json/examples/LookupEFileIdentifierExample"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Records found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1cargosoft~1efile~1lookup/post/responses/200/content/application~1json/examples/ShipmentEFileExample"]}},"schemaId":"schema_25","exampleIds":["paths/~1cargosoft~1efile~1lookup/post/responses/200/content/application~1json/examples/ShipmentEFileExample"],"headers":{"X-Page-Count":{"description":"The total number of pages for pagination.","required":true,"style":"simple","schema":{}},"X-Row-Count":{"description":"The total number of found objects for pagination.","required":true,"style":"simple","schema":{}}},"headerSchemaId":"schema_6"}],"pointer":"/paths/~1cargosoft~1efile~1lookup/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_25","exampleIds":["paths/~1cargosoft~1efile~1lookup/post/responses/200/content/application~1json/examples/ShipmentEFileExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1cargosoft~1efile~1lookup/post/responses/200/content/application~1json/examples/ShipmentEFileExample"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-file/lookupefiledocuments"}],"panels":[]}]},"httpPath":"/cargosoft/efile/lookup"}],"content":{"contentType":"group","meta":{"name":"E-File"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"E-File","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cargosoft/efile","summary":"Create an E-File document.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-file/createefiledocument","deprecated":false},{"title":"/cargosoft/efile/{id}/reference","summary":"Retrieve references from an E-File document.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-file/retrieveefilereferences","deprecated":false},{"title":"/cargosoft/efile/{id}/reference","summary":"Add a reference to an E-File document.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-file/addefilereference","deprecated":false},{"title":"/cargosoft/efile/{id}/reference","summary":"Remove a reference from an E-File document.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/e-file/removeefilereference","deprecated":false},{"title":"/cargosoft/efile/{id}/role","summary":"Retrieve roles from an E-File document.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-file/retrieveefileroles","deprecated":false},{"title":"/cargosoft/efile/{id}/role","summary":"Add a role to an E-File document.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-file/addefilerole","deprecated":false},{"title":"/cargosoft/efile/{id}/role","summary":"Remove a role from an E-File document.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/e-file/removeefilerole","deprecated":false},{"title":"/cargosoft/efile/{id}","summary":"Retrieve an E-File document.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-file/retrieveefiledocument","deprecated":false},{"title":"/cargosoft/efile/{id}","summary":"Delete an E-File document.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/e-file/deleteefiledocument","deprecated":false},{"title":"/cargosoft/efile/lookup","summary":"Lookup E-File documents.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-file/lookupefiledocuments","deprecated":false}]}]}]}]}},{"type":"group","label":"Authorization","link":"/products/tms-api/2026.1/openapi/authorization","routeSlug":"/products/tms-api/2026.1/openapi/authorization","items":[{"label":"Retrieve JWT","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/tms-api/2026.1/openapi/authorization/retrieveauthtoken","routeSlug":"/products/tms-api/2026.1/openapi/authorization/retrieveauthtoken","metadata":{"seo":{"title":"Retrieve JWT","description":"Retrieve a Java Web Token to authenticate against the API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveAuthToken","name":"Retrieve JWT","isWebhook":false,"pointer":"/paths/~1auth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve JWT","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a Java Web Token to authenticate against the API"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_26"}},"schemaId":"schema_26","pointer":"/paths/~1auth~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/token","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_26"}},"responseCodes":["200","401"],"pointer":"/auth/token","href":"authorization/retrieveauthtoken","openApiOperationId":"retrieveAuthToken","summary":"Retrieve JWT"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"schemaId":"schema_26","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_26"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Java Web Token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Jwt"}},"schemaId":"components/schemas/Jwt"},{"code":"401","description":"Wrong username and/or password"}],"pointer":"/paths/~1auth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Jwt","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Jwt"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorization/retrieveauthtoken"}],"panels":[]}]},"httpPath":"/auth/token"}],"content":{"contentType":"group","meta":{"name":"Authorization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorization","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/token","summary":"Retrieve JWT","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorization/retrieveauthtoken","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CodeConvertion":{"id":"components/schemas/CodeConvertion","kind":"json-schema","title":"CodeConvertion","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An EDI code conversion (edicodes_t) translates an external partner's own code (e.g. for a charge type or packaging code) into the corresponding CargoSoft internal code, or vice versa, depending on direction."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"id":{"type":"integer","format":"int32","description":"The id of the EDI code conversion."},"client":{"type":"string","description":"The CargoSoft client this EDI code conversion belongs to."},"edipartner":{"type":"string","description":"The matchcode of the EDI partner this EDI code conversion applies to."},"direction":{"type":"string","description":"The direction the code conversion applies to.","enum":["RECEIVE","SEND"]},"code_type":{"type":"string","description":"The code table/type this conversion applies to (e.g. a charge type or packaging code table)."},"source_code":{"type":"string","description":"The source code to be converted."},"target_code":{"type":"string","description":"The CargoSoft internal (or, depending on direction, external) code the source code is converted to."}}}},"components/schemas/ContainsIdentifier":{"id":"components/schemas/ContainsIdentifier","kind":"json-schema","title":"ContainsIdentifier","data":{"allOf":[{"$ref":"#/components/schemas/IdentifierShipmentMemoIdentifier"}],"description":"This identifier should use when value have to contain.","title":"ContainsIdentifier"}},"components/schemas/EqualsIdentifier":{"id":"components/schemas/EqualsIdentifier","kind":"json-schema","title":"EqualsIdentifier","data":{"allOf":[{"$ref":"#/components/schemas/IdentifierShipmentMemoIdentifier"}],"description":"The equals identifier should use to match the value exactly.","title":"EqualsIdentifier"}},"components/schemas/GreaterEqualIdentifier":{"id":"components/schemas/GreaterEqualIdentifier","kind":"json-schema","title":"GreaterEqualIdentifier","data":{"allOf":[{"$ref":"#/components/schemas/IdentifierShipmentMemoIdentifier"}],"description":"This identifier should use when the value is greater or equals.","title":"GreaterEqualIdentifier"}},"components/schemas/GreaterThanIdentifier":{"id":"components/schemas/GreaterThanIdentifier","kind":"json-schema","title":"GreaterThanIdentifier","data":{"allOf":[{"$ref":"#/components/schemas/IdentifierShipmentMemoIdentifier"}],"description":"This identifier should use when the value is greater than.","title":"GreaterThanIdentifier"}},"components/schemas/Identifier":{"id":"components/schemas/Identifier","kind":"json-schema","title":"Identifier","data":{"type":"object","description":"Description of the Identifier DTO schema. This DTO contains the match mode and identifiers of a functional object for instance the shipment identifier.","discriminator":{"propertyName":"matchMode","mapping":{"EqualsIdentifierMapped":"#/components/schemas/EqualsIdentifier","ContainsIdentifierMapped":"#/components/schemas/ContainsIdentifier","InIdentifierMapped":"#/components/schemas/InIdentifier","OrIdentifierMapped":"#/components/schemas/OrIdentifier","GreaterThanIdentifierMapped":"#/components/schemas/GreaterThanIdentifier","LessThanIdentifierMapped":"#/components/schemas/LessThanIdentifier","GreaterEqualIdentifierMapped":"#/components/schemas/GreaterEqualIdentifier","LessEqualIdentifierMapped":"#/components/schemas/LessEqualIdentifier"}},"properties":{"key":{"description":"Identifier key. For instance a ShipmentIdentifier"},"match_mode":{"type":"string","default":"EQUALS","description":"The match mode.","enum":["EQUALS","CONTAINS","IN","OR","GT","LT","GE","LE"],"x-enumDescriptions":{"OR":"Or.","EQUALS":"Equals.","IN":"In.","LT":"Lower than.","LE":"Lower equals","CONTAINS":"Contains","GT":"Greater than.","GE":"Greater equals"}}}}},"components/schemas/IdentifierLookupIdentifier":{"id":"components/schemas/IdentifierLookupIdentifier","kind":"json-schema","title":"IdentifierLookupIdentifier","data":{"type":"object","description":"Description of the Identifier DTO schema. This DTO contains the match mode and identifiers of a functional object for instance the shipment identifier.","discriminator":{"propertyName":"matchMode","mapping":{"EqualsIdentifierMapped":"#/components/schemas/EqualsIdentifier","ContainsIdentifierMapped":"#/components/schemas/ContainsIdentifier","InIdentifierMapped":"#/components/schemas/InIdentifier","OrIdentifierMapped":"#/components/schemas/OrIdentifier","GreaterThanIdentifierMapped":"#/components/schemas/GreaterThanIdentifier","LessThanIdentifierMapped":"#/components/schemas/LessThanIdentifier","GreaterEqualIdentifierMapped":"#/components/schemas/GreaterEqualIdentifier","LessEqualIdentifierMapped":"#/components/schemas/LessEqualIdentifier"}},"properties":{"key":{"description":"Identifier key. For instance a ShipmentIdentifier"},"match_mode":{"type":"string","default":"EQUALS","description":"The match mode.","enum":["EQUALS","CONTAINS","IN","OR","GT","LT","GE","LE"],"x-enumDescriptions":{"OR":"Or.","EQUALS":"Equals.","IN":"In.","LT":"Lower than.","LE":"Lower equals","CONTAINS":"Contains","GT":"Greater than.","GE":"Greater equals"}}}}},"components/schemas/InIdentifier":{"id":"components/schemas/InIdentifier","kind":"json-schema","title":"InIdentifier","data":{"allOf":[{"$ref":"#/components/schemas/IdentifierShipmentMemoIdentifier"}],"description":"This identifier should use when more than one value can be match.","title":"InIdentifier"}},"components/schemas/LessEqualIdentifier":{"id":"components/schemas/LessEqualIdentifier","kind":"json-schema","title":"LessEqualsIdentifier","data":{"allOf":[{"$ref":"#/components/schemas/IdentifierShipmentMemoIdentifier"}],"description":"This identifier should use when the value is less or equals.","title":"LessEqualsIdentifier"}},"components/schemas/LessThanIdentifier":{"id":"components/schemas/LessThanIdentifier","kind":"json-schema","title":"LessThanIdentifier","data":{"allOf":[{"$ref":"#/components/schemas/IdentifierShipmentMemoIdentifier"}],"description":"This identifier should use when the value is less than.","title":"LessThanIdentifier"}},"components/schemas/LookupIdentifier":{"id":"components/schemas/LookupIdentifier","kind":"json-schema","title":"LookupIdentifier","data":{}},"components/schemas/OrIdentifier":{"id":"components/schemas/OrIdentifier","kind":"json-schema","title":"OrIdentifier","data":{"allOf":[{"$ref":"#/components/schemas/IdentifierShipmentMemoIdentifier"}],"description":"This identifier combines a list of identifier with the logical or.","title":"OrIdentifier"}},"components/schemas/IdentifierCodeConverterIdentifier":{"id":"components/schemas/IdentifierCodeConverterIdentifier","kind":"json-schema","title":"IdentifierCodeConverterIdentifier","data":{"type":"object","description":"Description of the Identifier DTO schema. This DTO contains the match mode and identifiers of a functional object for instance the shipment identifier.","discriminator":{"propertyName":"matchMode","mapping":{"EqualsIdentifierMapped":"#/components/schemas/EqualsIdentifier","ContainsIdentifierMapped":"#/components/schemas/ContainsIdentifier","InIdentifierMapped":"#/components/schemas/InIdentifier","OrIdentifierMapped":"#/components/schemas/OrIdentifier","GreaterThanIdentifierMapped":"#/components/schemas/GreaterThanIdentifier","LessThanIdentifierMapped":"#/components/schemas/LessThanIdentifier","GreaterEqualIdentifierMapped":"#/components/schemas/GreaterEqualIdentifier","LessEqualIdentifierMapped":"#/components/schemas/LessEqualIdentifier"}},"properties":{"key":{"type":"string","description":"Identifier key. For instance a ShipmentIdentifier","enum":["CLIENT","EDIPARTNER","DIRECTION","CODETYPE","SOURCECODE"]},"match_mode":{"type":"string","default":"EQUALS","description":"The match mode.","enum":["EQUALS","CONTAINS","IN","OR","GT","LT","GE","LE"],"x-enumDescriptions":{"OR":"Or.","EQUALS":"Equals.","IN":"In.","LT":"Lower than.","LE":"Lower equals","CONTAINS":"Contains","GT":"Greater than.","GE":"Greater equals"}}}}},"components/schemas/IdentifierListIdentifierCodeConverterIdentifier":{"id":"components/schemas/IdentifierListIdentifierCodeConverterIdentifier","kind":"json-schema","title":"IdentifierListIdentifierCodeConverterIdentifier","data":{"type":"object","items":{"$ref":"#/components/schemas/IdentifierCodeConverterIdentifier"},"properties":{"first":{"$ref":"#/components/schemas/IdentifierCodeConverterIdentifier"},"last":{"$ref":"#/components/schemas/IdentifierCodeConverterIdentifier"}}}},"components/schemas/EFile":{"id":"components/schemas/EFile","kind":"json-schema","title":"EFile","data":{"type":"object","description":"Description of the EFile DTO schema for electronic data like PDF's.","properties":{"id":{"type":"integer","format":"int64","description":"The unique ID of this document."},"client":{"type":"string","description":"The CargoSoft client."},"description":{"type":"string","description":"Description of this document."},"bytes":{"type":"string","format":"Base64 encoded String","description":"Base64 encoded content of this document."},"roles":{"type":"array","description":"The list of roles. The roles are a kind of authorization as to who may view the documents.","items":{"type":"string"}},"references":{"type":"array","description":"A list of references.","items":{"$ref":"#/components/schemas/EFileReference"}},"document_category":{"type":"integer","format":"int32","description":"The category of this document. The category is defined in the CargoSoft basic data and is individual for each customer."},"document_name":{"type":"string","description":"The file name of this document."},"document_date":{"type":"string","format":"date-time","description":"Date of creation of this document."}}}},"components/schemas/EFileReference":{"id":"components/schemas/EFileReference","kind":"json-schema","title":"EFileReference","data":{"type":"object","description":"Description of the EFileReference DTO schema for efile references.","properties":{"reference_type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Each reference is typified. The type describes the reference value. For example [CSFILE, ADRFILE]. CSFILE = The document is attached to a shipment, ADRFILE = The document is attached to an address."},"children":[],"type":"text"}],"type":"paragraph"}],"examples":["CSFILE","ADRFILE"]},"reference_value":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The reference value. For a CSFILE shipment reference, use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"<shipment_number>#<client>"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", for example "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"022120300004#001"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/EFileRole":{"id":"components/schemas/EFileRole","kind":"json-schema","title":"EFileRole","data":{"type":"object","properties":{"role":{"type":"string"}}}},"components/schemas/EFileLookupGenericClass":{"id":"components/schemas/EFileLookupGenericClass","kind":"json-schema","title":"EFileLookupGenericClass","data":{"type":"object","anyOf":[{"$ref":"#/components/schemas/EqualsIdentifier"}],"properties":{"key":{"type":"string","description":"Identifier key. For instance a ShipmentIdentifier","enum":["REFERENCE","SHIPMENT_ID","CLIENT"],"title":"EFileIdentifier","x-enumDescriptions":{"SHIPMENT_ID":"Unique database ID of the Shipment.","REFERENCE":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Reference of the efile as <REFERENCE_TYPE>:<REFERENCE_VALUE>, for example EDIMON:4711 for the JSON file belonging to the edimonitordatei_t row 4711. Must always be combined with a CLIENT identifier - several configured efile clients can share the same backend, so searching without a client would return the same document once per matching client. In most cases, this reference is not known by third party applications. For instance, use the SHIPMENT_ID identifier to search efile documents."},"children":[],"type":"text"}],"type":"paragraph"}],"CLIENT":"Mandant, required together with REFERENCE to scope the search to a single efile client."}},"match_mode":{"type":"string","default":"EQUALS","description":"The match mode.","enum":["EQUALS","CONTAINS","IN","OR","GT","LT","GE","LE"],"x-enumDescriptions":{"OR":"Or.","EQUALS":"Equals.","IN":"In.","LT":"Lower than.","LE":"Lower equals","CONTAINS":"Contains","GT":"Greater than.","GE":"Greater equals"}}}}},"components/schemas/IdentifierEFileIdentifier":{"id":"components/schemas/IdentifierEFileIdentifier","kind":"json-schema","title":"IdentifierEFileIdentifier","data":{"type":"object","description":"Description of the Identifier DTO schema. This DTO contains the match mode and identifiers of a functional object for instance the shipment identifier.","discriminator":{"propertyName":"matchMode","mapping":{"EqualsIdentifierMapped":"#/components/schemas/EqualsIdentifier","ContainsIdentifierMapped":"#/components/schemas/ContainsIdentifier","InIdentifierMapped":"#/components/schemas/InIdentifier","OrIdentifierMapped":"#/components/schemas/OrIdentifier","GreaterThanIdentifierMapped":"#/components/schemas/GreaterThanIdentifier","LessThanIdentifierMapped":"#/components/schemas/LessThanIdentifier","GreaterEqualIdentifierMapped":"#/components/schemas/GreaterEqualIdentifier","LessEqualIdentifierMapped":"#/components/schemas/LessEqualIdentifier"}},"properties":{"key":{"type":"string","description":"Identifier key. For instance a ShipmentIdentifier","enum":["REFERENCE","SHIPMENT_ID","CLIENT"],"title":"EFileIdentifier","x-enumDescriptions":{"SHIPMENT_ID":"Unique database ID of the Shipment.","REFERENCE":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Reference of the efile as <REFERENCE_TYPE>:<REFERENCE_VALUE>, for example EDIMON:4711 for the JSON file belonging to the edimonitordatei_t row 4711. Must always be combined with a CLIENT identifier - several configured efile clients can share the same backend, so searching without a client would return the same document once per matching client. In most cases, this reference is not known by third party applications. For instance, use the SHIPMENT_ID identifier to search efile documents."},"children":[],"type":"text"}],"type":"paragraph"}],"CLIENT":"Mandant, required together with REFERENCE to scope the search to a single efile client."}},"match_mode":{"type":"string","default":"EQUALS","description":"The match mode.","enum":["EQUALS","CONTAINS","IN","OR","GT","LT","GE","LE"],"x-enumDescriptions":{"OR":"Or.","EQUALS":"Equals.","IN":"In.","LT":"Lower than.","LE":"Lower equals","CONTAINS":"Contains","GT":"Greater than.","GE":"Greater equals"}}}}},"components/schemas/IdentifierListIdentifierEFileIdentifier":{"id":"components/schemas/IdentifierListIdentifierEFileIdentifier","kind":"json-schema","title":"IdentifierListIdentifierEFileIdentifier","data":{"type":"object","items":{"$ref":"#/components/schemas/IdentifierEFileIdentifier"},"properties":{"first":{"$ref":"#/components/schemas/IdentifierEFileIdentifier"},"last":{"$ref":"#/components/schemas/IdentifierEFileIdentifier"}}}},"components/schemas/AES":{"id":"components/schemas/AES","kind":"json-schema","title":"AES","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"The unique identifier of this AES proposal."},"client":{"type":"string","description":"The CargoSoft client."},"mrn":{"type":"string","description":"The Movement Reference Number assigned to this customs declaration."},"shipment_number":{"type":"string","description":"The CargoSoft shipment number of the shipment."},"running_number":{"type":"integer","format":"int32","description":"Proposal counter"}}}},"components/schemas/AddonFieldValue":{"id":"components/schemas/AddonFieldValue","kind":"json-schema","title":"AddonFieldValue","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The value of one addon field (eaaddonfield_t) on a specific record, identified by table_name/table_id. When submitted as part of a Shipment or Container, table_name and table_id are derived from that parent record and don't need to be set."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of this addon field value record."},"table_name":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The table the addon field value belongs to (e.g. eakopf_t, eawarecont_t) - derived automatically, not required on create."},"children":[],"type":"text"}],"type":"paragraph"}]},"table_id":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The database id of the record (in table_name) this addon field value belongs to - derived automatically, not required on create."},"children":[],"type":"text"}],"type":"paragraph"}]},"addonfield_matchcode":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The technical name (matchcode) of the addon field master data record (addonfield_t.fieldname) this value belongs to."},"children":[],"type":"text"}],"type":"paragraph"}],"minLength":1},"value":{"type":"string","description":"The addon field's value."}},"required":["addonfield_matchcode"]}},"components/schemas/AddressMatchcode":{"id":"components/schemas/AddressMatchcode","kind":"json-schema","title":"AddressMatchcode","data":{"type":"object","properties":{"address_type":{"type":"string","description":"The CargoSoft address type."},"address_number":{"type":"integer","format":"int32","description":"The CargoSoft address number."}}}},"components/schemas/AirfreightCarriageLeg":{"id":"components/schemas/AirfreightCarriageLeg","kind":"json-schema","title":"AirfreightCarriageLeg","data":{"allOf":[{"$ref":"#/components/schemas/CarriageLeg"}],"description":"Description of the airfreight carriage DTO schema with several airfreight attributes."}},"components/schemas/CarriageLeg":{"id":"components/schemas/CarriageLeg","kind":"json-schema","title":"CarriageLeg","data":{"type":"object","description":"Description of the Carriage DTO schema.","discriminator":{"propertyName":"mot","mapping":{"AirfreightCarriageMapped":"#/components/schemas/AirfreightCarriageLeg","SeafreightCarriageMapped":"#/components/schemas/SeafreightCarriageLeg","RailCarriageMapped":"#/components/schemas/RailCarriageLeg","RoadCarriageMapped":"#/components/schemas/RoadCarriageLeg","GenericCarriageMapped":"#/components/schemas/GenericCarriageLeg"}},"properties":{"origin":{"$ref":"#/components/schemas/LocationDateTime","description":"The origin of this leg. This object contains several information about the location and its dates and times."},"destination":{"$ref":"#/components/schemas/LocationDateTime","description":"The destination of this leg. This object contains several information about the location and its dates and times."},"leg_no":{"type":"integer","format":"int32","description":"The number for the correct order of the transport legs. Important if more than one leg is entered for the shipment."},"mot":{"type":"string"}},"required":["mot"]}},"components/schemas/Contact":{"id":"components/schemas/Contact","kind":"json-schema","title":"Contact","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the contact person."},"phone_number":{"type":"string","description":"The telephone number of the contact person."},"fax_number":{"type":"string","description":"The fax number of the contact person."},"email":{"type":"string","description":"The email address of the contact person."}}}},"components/schemas/Container":{"id":"components/schemas/Container","kind":"json-schema","title":"Container","data":{"type":"object","description":"Description of the Container DTO. Each container refers to a good element because a container is part of the CargoSoft goods description.","properties":{"counter":{"type":"integer","format":"int32","description":"The sequential number of this container within the shipment."},"containerAddresses":{"type":"array","description":"List of container addresses. This list contains the three fixed addresses on the container. In addition, further dynamic addresses can be defined and entered on the container.","items":{"$ref":"#/components/schemas/ContainerAddress"}},"id":{"type":"integer","format":"int32","description":"The unique identifier of this Container."},"good_id":{"type":"integer","format":"int32","description":"The goods id references the associated good element."},"client":{"type":"string","description":"The CargoSoft client"},"shipment_number":{"type":"string","description":"The CargoSoft shipment number, this container belongs to."},"container_number":{"type":"string","description":"The container number"},"seal_number1":{"type":"string","description":"The first seal number."},"seal_number2":{"type":"string","description":"The second seal number"},"seal_number3":{"type":"string","description":"The third seal number"},"container_iso_code":{"type":"string","description":"The ISO code representing the type and size of this container."},"reefer_temperature":{"type":"number","description":"The constant reefer temperature set for this container."},"reefer_temperature_lower_bound":{"type":"number","description":"The lower bound of the reefer temperature range set for this container."},"reefer_temperature_upper_bound":{"type":"number","description":"The upper bound of the reefer temperature range set for this container."},"reefer_temperature_unit":{"type":"string","description":"The physical unit of the reefer temperature."},"shippers_own":{"type":"boolean","description":"Indicates whether the container is owned by the shipper rather than the carrier."},"addon_fields":{"type":"array","description":"Addon field values (custom, TMS-configurable extra fields) attached to this container.","items":{"$ref":"#/components/schemas/AddonFieldValue"}}}}},"components/schemas/ContainerAddress":{"id":"components/schemas/ContainerAddress","kind":"json-schema","title":"ContainerAddress","data":{"type":"object","description":"Description of the ContainerAddress DTO.","properties":{"id":{"type":"integer","format":"int32","description":"The id of the dynamic container address. The three fixed container addresses have no id."},"qualifier":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The role of this address. For the three fixed addresses are the following roles dedined [DELIVERER, PICKUP, REDILIVERY]. The roles of the dynamic addresses do not have a fixed qualifier."},"children":[],"type":"text"}],"type":"paragraph"}]},"street":{"type":"string","description":"The street of this address."},"city":{"type":"string","description":"The city name of this address."},"order":{"type":"integer","format":"int32","description":"Sequential numbering of the addresses. This is important for the order of the addresses."},"references":{"type":"array","description":"References of this address.","items":{"$ref":"#/components/schemas/Reference"}},"address_type":{"type":"string","description":"The CargoSoft address type."},"address_number":{"type":"integer","format":"int32","description":"The CargoSoft address number."},"printed_address":{"$ref":"#/components/schemas/PrintedAddress","description":"The address exactly as entered in the shipment record."},"postal_code":{"type":"string","description":"The postal code of this address."},"country_matchcode":{"type":"string","description":"The country code of this address."},"un_location_code":{"type":"string","description":"The city un location code of this address."},"from_date_and_time":{"$ref":"#/components/schemas/DateAndTime","description":"From date and time for an appointment."},"to_date_and_time":{"$ref":"#/components/schemas/DateAndTime","description":"To date and time for an appointment."},"contact":{"$ref":"#/components/schemas/Contact","description":"Additional contact information."}}}},"components/schemas/CreditData":{"id":"components/schemas/CreditData","kind":"json-schema","title":"CreditData","data":{"type":"object","properties":{"lc_number":{"type":"string","description":"The reference number for a Letter of Credit."},"latest_shipment_date":{"type":"string","format":"date","description":"The latest date on which the shipment may take place under the letter of credit."},"lc_expiry":{"type":"string","format":"date","description":"The date when a Letter of Credit becomes invalid."}}}},"components/schemas/CustomField":{"id":"components/schemas/CustomField","kind":"json-schema","title":"CustomField","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier for this custom field."},"client":{"type":"string","description":"The CargoSoft client"},"value":{"type":"string","description":"The value for this custom field."},"shipment_number":{"type":"string","description":"The CargoSoft shipment number"},"running_number":{"type":"integer","format":"int32","description":"Internal counter."}}}},"components/schemas/Customs":{"id":"components/schemas/Customs","kind":"json-schema","title":"Customs","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"The unique identifier of this customs record."},"client":{"type":"string","description":"The CargoSoft client."},"goods_dto":{"type":"integer","format":"int32","description":"The identifier of the goods description this customs record belongs to."},"shipment_number":{"type":"string","description":"The CargoSoft shipment number of the shipment."},"invoice_number":{"type":"string","description":"The invoice number associated with the goods."},"invoice_date_time":{"type":"string","format":"ISO-8601","description":"The invoice date and time."},"amount":{"type":"number","description":"The invoice amount associated with the goods."},"currency_matchcode":{"type":"string","description":"The CargoSoft currency matchcode of the invoice amount."},"delivery_note":{"type":"string","description":"The delivery note number associated with the goods."},"delivery_date_time":{"type":"string","format":"ISO-8601","description":"The delivery date and time."}}}},"components/schemas/CustomsData":{"id":"components/schemas/CustomsData","kind":"json-schema","title":"CustomsData","data":{"type":"object","properties":{"custom_clearance_date":{"type":"string","format":"date","description":"The date when goods are officially cleared by customs"},"clearance":{"type":"string","description":"The customs clearance procedure or status assigned to the shipment."},"book":{"type":"string","description":"The customs ledger used to record the official clearance of goods"}}}},"components/schemas/DangerousGood":{"id":"components/schemas/DangerousGood","kind":"json-schema","title":"DangerousGood","data":{"type":"object","description":"Description of the DangerousGood DTO.","properties":{"id":{"type":"integer","format":"int32","description":"The id of this dangerous goods."},"counter":{"type":"integer","format":"int32","description":"The sequential number of this dangerous goods record within the goods description."},"goods_dto":{"type":"integer","format":"int32","description":"The identifier of the goods description this dangerous goods record belongs to."},"client":{"type":"string","description":"The CargoSoft client."},"shipment_number":{"type":"string","description":"The CargoSoft shipment number of the shipment."},"imdg_code":{"type":"string","description":"The IMDG code assigned to the dangerous goods."},"dangerous_good_legislation":{"type":"string","description":"The dangerous goods legislation. Possible values are IMDG, ADR, or RID."},"classification_code":{"type":"string","description":"Classification code of this dangerous goods."},"un_number":{"type":"string","description":"Dangerous goods UN-Number."},"release":{"type":"string","description":"Dangerous goods release."},"label_1":{"type":"string","description":"Dangerous goods label."},"label_2":{"type":"string","description":"Dangerous goods label."},"label_3":{"type":"string","description":"Dangerous goods label."},"label_4":{"type":"string","description":"Dangerous goods label."},"site":{"type":"string","description":"Dangerous goods site."},"flashpoint":{"type":"string","description":"Flashpoint of this dangerous goods."},"flashpoint_unit":{"type":"string","description":"The unit of the flashpoint. Possible values are C or F."},"ems_number_1":{"type":"string","description":"EMS number."},"ems_number_2":{"type":"string","description":"EMS number."},"mfag_number_1":{"type":"string","description":"MFAG number."},"mfag_number_2":{"type":"string","description":"MFAG number."},"remarks":{"type":"array","description":"Dangerous goods remarks.","items":{"type":"string"}},"authorisation_number":{"type":"string","description":"Dangerous goods authorisation number."},"packaging_group":{"type":"string","description":"Packaging group of this dangerous goods."},"technical_name_1":{"type":"string","description":"Technical name of this dangerous goods."},"technical_name_2":{"type":"string","description":"Technical name of this dangerous goods."},"causing_substance_1":{"type":"string","description":"Causing substance of this dangerous goods."},"causing_substance_2":{"type":"string","description":"Causing substance of this dangerous goods."},"issuer":{"type":"string","description":"Issuer of this dangerous goods."},"net_weight":{"type":"number","description":"Net weight of this dangerous goods."},"weight_unit":{"type":"string","description":"Weight unit of the net and gross weight."},"gross_weight":{"type":"number","description":"Gross weight of this dangerous goods."},"contact":{"$ref":"#/components/schemas/Contact","description":"Contact information of this dangerous goods."},"limited_quantities":{"type":"boolean","description":"Indicates whether the dangerous goods are transported as limited quantities."},"nag":{"type":"boolean","description":"Indicates whether the dangerous goods record is marked with the CargoSoft NAG flag."}}}},"components/schemas/DateAndTime":{"id":"components/schemas/DateAndTime","kind":"json-schema","title":"DateAndTime","data":{"type":"object","properties":{"date":{"type":"string","format":"ISO-8601","description":"The date."},"time":{"type":"string","format":"ISO-8601","description":"The time."},"zone_offset":{"type":"string","format":"ISO-8601","description":"The UTC time zone of this date and time."}}}},"components/schemas/EventDateAndTime":{"id":"components/schemas/EventDateAndTime","kind":"json-schema","title":"EventDateAndTime","data":{"type":"object","properties":{"date":{"type":"string","format":"ISO-8601","description":"The date."},"time":{"type":"string","format":"ISO-8601","description":"The time."},"zone_offset":{"type":"string","format":"ISO-8601","description":"The UTC time zone of this date and time."},"until":{"type":"string","format":"ISO-8601","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Optional time range. Only for Event types: PICKUP and FINAL_DESTINATION"},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/EventType":{"id":"components/schemas/EventType","kind":"json-schema","title":"EventType","data":{"type":"string","description":"The following list will give an overview about the event types and a short description.","enum":["ACTUAL","ESTIMATED"],"x-enumDescriptions":{"ESTIMATED":"Estimated date and time","ACTUAL":"Actual date and time."}}},"components/schemas/GenericCarriageLeg":{"id":"components/schemas/GenericCarriageLeg","kind":"json-schema","title":"GenericCarriageLeg","data":{"allOf":[{"$ref":"#/components/schemas/CarriageLeg"},{"type":"object","properties":{"haulage_type":{"type":"string","description":"The method of transporting goods."},"haulage_reference":{"type":"string","description":"The reference assigned to this haulage leg."}}}]}},"components/schemas/Good":{"id":"components/schemas/Good","kind":"json-schema","title":"Good","data":{"type":"object","description":"Description of the Good DTO. Each container refers to a good element because a container is part of the CargoSoft goods description.","properties":{"measurements":{"type":"array","description":"A list of measurements related to the goods, such as dimensions or additional weights.","items":{"$ref":"#/components/schemas/Measurement"}},"customs":{"type":"array","description":"Customs-related information for processing the goods.","items":{"$ref":"#/components/schemas/Customs"}},"mrns":{"type":"array","description":"Movement Reference Numbers (MRNs) associated with customs declarations for the goods.","items":{"$ref":"#/components/schemas/MRN"}},"subgoods":{"type":"array","description":"Sub-goods or components that form part of the overall goods in the shipment.","items":{"$ref":"#/components/schemas/Good"}},"dangerousGoods":{"type":"array","description":"Details of dangerous goods information of this good.","items":{"$ref":"#/components/schemas/DangerousGood"}},"id":{"type":"integer","format":"int32","description":"Unique identifier for the goods description in the shipment."},"client":{"type":"string","description":"The CargoSoft client."},"shipment_number":{"type":"string","description":"The CargoSoft shipment number of the shipment."},"identifier":{"type":"string","description":"The CargoSoft identifier of the goods description line."},"counter":{"type":"integer","format":"int32","description":"Counter used to track and number individual goods description lines."},"level":{"type":"integer","format":"int32","description":"The hierarchical level of the goods within the goods description."},"level_number":{"type":"integer","format":"int32","description":"Internal technical number, to order the goods description lines within the CargoSoft TMS."},"marks":{"type":"array","description":"Marks or labels associated with the goods for identification purposes.","items":{"type":"string"}},"quantity":{"type":"integer","format":"int32","description":"The quantity of goods described in this entry."},"packaging_matchcode":{"type":"string","description":"The matchcode representing the type of packaging used for this good."},"commodity_matchcode":{"type":"string","description":"The matchcode representing the type of commodity being shipped."},"description":{"type":"array","description":"A list providing detailed descriptions of the goods.","items":{"type":"string"}},"weight":{"type":"number","description":"The total weight of the goods in this shipment."},"colli":{"type":"boolean","description":"Indicates whether this goods description line is a colli line."},"colli_number":{"type":"integer","format":"int32","description":"The sequential number of the colli line within the goods description."},"volume":{"type":"number","description":"The total volume."},"volume_unit":{"type":"string","description":"The unit of measurement used for the volume of the goods."},"additional_mark":{"type":"boolean","description":"Indicates whether this goods description line contains an additional mark."},"net_weight":{"type":"number","description":"The net weight of the goods, excluding packaging."},"weight_unit":{"type":"string","description":"The unit of measurement for the weight of the goods."},"chargable_weight":{"type":"number","description":"The chargeable weight used for calculating shipping costs, either based on actual or volumetric weight."},"container_number":{"type":"string","description":"The container number in which the goods are stored for shipment."},"container":{"type":"boolean","description":"Indicates whether this goods description line represents a container."},"hs_codes":{"type":"array","description":"List of Harmonized System (HS) codes for the goods in the shipment.","items":{"$ref":"#/components/schemas/HSCode"}}},"required":["identifier"]}},"components/schemas/HSCode":{"id":"components/schemas/HSCode","kind":"json-schema","title":"HSCode","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"The unique identifier of this HS code record."},"client":{"type":"string","description":"The CargoSoft client."},"counter":{"type":"integer","format":"int32","description":"The sequential number of this HS code within the goods description."},"hsCode":{"type":"string","description":"The Harmonized System code assigned to the goods."},"goods_dto":{"type":"integer","format":"int32","description":"The identifier of the goods description this HS code belongs to."},"shipment_number":{"type":"string","description":"The CargoSoft shipment number of the shipment."}}}},"components/schemas/Insurance":{"id":"components/schemas/Insurance","kind":"json-schema","title":"Insurance","data":{"type":"object","properties":{"waiver_customer":{"type":"boolean","description":"Indicates whether the customer has waived transport insurance."},"insurable_value":{"type":"number","description":"The value to be insured for this shipment."},"insurable_value_currency_matchcode":{"type":"string","description":"The CargoSoft currency matchcode of the insurable value."},"value_of_goods":{"type":"number","description":"The declared value of the transported goods."},"value_of_goods_currency_matchcode":{"type":"string","description":"The CargoSoft currency matchcode of the value of goods."},"insurance_text":{"type":"string","description":"Additional text concerning the shipment insurance."},"transport_insurance":{"type":"boolean","description":"Indicates whether transport insurance is requested for the shipment."},"insurance_type":{"type":"string","description":"The CargoSoft insurance type code."},"insurer":{"$ref":"#/components/schemas/AddressMatchcode","description":"The address type and number identifying the insurer."}}}},"components/schemas/Location":{"id":"components/schemas/Location","kind":"json-schema","title":"Location","data":{"type":"object","description":"Description of the Location DTO schema.","properties":{"codes":{"type":"array","description":"A list of all location codes and their types of this location.","items":{"$ref":"#/components/schemas/LocationCode"}},"name":{"type":"string","description":"The written name of this location."},"latitude":{"type":"number","description":"The latitude of this location."},"longitude":{"type":"number","description":"The longitude of this location."}}}},"components/schemas/LocationCode":{"id":"components/schemas/LocationCode","kind":"json-schema","title":"LocationCode","data":{"type":"object","description":"Description of the LocationCode DTO schema. Each location in CargoSoft can be describe by serveral location types and codes.","properties":{"type":{"type":"string","description":"The type of this location code.","enum":["CARGOSOFT","UNLOC","IATA","FOREIGN","POSTAL_CODE","UN_COUNTRY","ROAD_STATION"],"x-enumDescriptions":{"ROAD_STATION":"The location code of a road station.","FOREIGN":"Foreign location code of a third party system.","UNLOC":"The location code is an UN location code.","IATA":"The location code is an IATA location code.","CARGOSOFT":"The location code is a CargoSoft internal defined location code.","UN_COUNTRY":"The location code is an UN country code."}},"code":{"type":"string","description":"The code of this location."}},"required":["code","type"]}},"components/schemas/LocationDateTime":{"id":"components/schemas/LocationDateTime","kind":"json-schema","title":"LocationDateTime","data":{"type":"object","description":"The carriage leg in detail.","properties":{"location":{"$ref":"#/components/schemas/Location","description":"The location of this leg."},"estimated_datetime":{"$ref":"#/components/schemas/DateAndTime","description":"The local estimated date and time related to the location."},"actual_datetime":{"$ref":"#/components/schemas/DateAndTime","description":"The local actual date and time related to the location."},"revised_datetime":{"$ref":"#/components/schemas/DateAndTime","description":"The local revised date and time related to the location."},"estimated_datetime_until":{"$ref":"#/components/schemas/DateAndTime","description":"The end of the estimated date and time range at this location."}}}},"components/schemas/MRN":{"id":"components/schemas/MRN","kind":"json-schema","title":"MRN","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"The unique identifier of this MRN record."},"client":{"type":"string","description":"The CargoSoft client."},"mrn":{"type":"string","description":"The Movement Reference Number assigned to the customs declaration."},"goods_dto":{"type":"integer","format":"int32","description":"The identifier of the goods description this MRN belongs to."},"shipment_number":{"type":"string","description":"The CargoSoft shipment number of the shipment."}}}},"components/schemas/Measurement":{"id":"components/schemas/Measurement","kind":"json-schema","title":"Measurement","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"The unique identifier of this measurement record."},"client":{"type":"string","description":"The CargoSoft client."},"counter":{"type":"integer","format":"int32","description":"The sequential number of this measurement within the goods description."},"weight":{"type":"number","description":"The weight recorded for this measurement."},"length":{"type":"integer","format":"int32","description":"The length of the measured item."},"width":{"type":"integer","format":"int32","description":"The width of the measured item."},"height":{"type":"integer","format":"int32","description":"The height of the measured item."},"quantity":{"type":"integer","format":"int32","description":"The number of items with these measurements."},"goods_dto":{"type":"integer","format":"int32","description":"The identifier of the goods description this measurement belongs to."},"shipment_number":{"type":"string","description":"The CargoSoft shipment number of the shipment. This number may unique in combination of the client property."},"weight_unit":{"type":"string","description":"The unit used for the measurement weight."},"volume":{"type":"number","description":"The volume recorded for this measurement."},"volume_unit":{"type":"string","description":"The unit used for the measurement volume."},"measurement_unit":{"type":"string","description":"The unit used for length, width, and height."}},"required":["height","length","quantity","width"]}},"components/schemas/PrintedAddress":{"id":"components/schemas/PrintedAddress","kind":"json-schema","title":"PrintedAddress","data":{"type":"object","properties":{"line_1":{"type":"string","description":"The first line of the printed address."},"line_2":{"type":"string","description":"The second line of the printed address."},"line_3":{"type":"string","description":"The third line of the printed address."},"line_4":{"type":"string","description":"The fourth line of the printed address."},"line_5":{"type":"string","description":"The fifth line of the printed address."},"line_6":{"type":"string","description":"The sixth line of the printed address."}}}},"components/schemas/RailCarriageLeg":{"id":"components/schemas/RailCarriageLeg","kind":"json-schema","title":"RailCarriageLeg","data":{"allOf":[{"$ref":"#/components/schemas/CarriageLeg"}]}},"components/schemas/Reference":{"id":"components/schemas/Reference","kind":"json-schema","title":"Reference","data":{"type":"object","properties":{"type":{"type":"string","enum":["SHIPMENT_NUMBER","REFERENCE_NUMBER","BL_NUMBER","HOUSE_BL_NUMBER","BOOKING_NUMBER","CONTAINER_NUMBER","CONTAINER_ISO_CODE","FLIGHT_NUMBER","CARRIER_CODE","TERMINAL","TERMINAL_FULL_NAME","GOODSID","VESSEL","IMO_NUMBER","VESSEL_CALL_SIGN","CURRENCY","CURRENCY_VALUE","VOYAGE_NUMBER","SEAL_NUMBER","CLIENT","PROVIDER","HANDLING_AGENT","DECLARATION_TYPE","PUBLIC_LINK","RECIPIENT_NAME","VESSEL_FLAG","OLD_VESSEL","NEW_VESSEL","OLD_VESSEL_IMO","NEW_VESSEL_IMO","TRANSPORT_MODE","OFFICE","SCO_ID"]},"reference":{"type":"string"}},"required":["reference","type"]}},"components/schemas/RoadCarriageLeg":{"id":"components/schemas/RoadCarriageLeg","kind":"json-schema","title":"RoadCarriageLeg","data":{"allOf":[{"$ref":"#/components/schemas/CarriageLeg"}]}},"components/schemas/SeafreightCarriageLeg":{"id":"components/schemas/SeafreightCarriageLeg","kind":"json-schema","title":"SeafreightCarriageLeg","data":{"allOf":[{"$ref":"#/components/schemas/CarriageLeg"},{"type":"object","properties":{"voyage_no":{"type":"string","description":"The voyage number of this seafreight carriage leg."},"imo_code":{"type":"string","description":"The IMO identification number of the vessel."},"vessel_name":{"type":"string","description":"The name of the vessel."},"vessel_flag":{"type":"string","description":"The flag state of the vessel."},"call_sign":{"type":"string","description":"The radio call sign of the vessel."}}}],"description":"Description of the seafreight carriage DTO schema with several seafreight attributes."}},"components/schemas/Shipment":{"id":"components/schemas/Shipment","kind":"json-schema","title":"Shipment","data":{"type":"object","description":"Description of the Shipment DTO schema.","properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of this shipment."},"client":{"type":"string","description":"The CargoSoft client."},"direction":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The shipment direction. Possible values are [I, E]. I = import shipments, E = export shipments."},"children":[],"type":"text"}],"type":"paragraph"}]},"office":{"type":"string","description":"The shipment office."},"employees":{"$ref":"#/components/schemas/ShipmentEmployees","description":"Employee login names, who are working on this shipment."},"memos":{"type":"array","description":"Memos associated with this shipment.","items":{"$ref":"#/components/schemas/ShipmentMemo"}},"aes":{"type":"array","description":"Automated Export System (AES) proposals.","items":{"$ref":"#/components/schemas/AES"}},"temperatureControlled":{"type":"boolean","description":"Indicates whether the shipment is temperature-controlled."},"requestUuid":{"type":"string"},"edipartner_matchcode":{"type":"string","description":"Matchcode of the partner, who is sending this shipment. Used to retrieve custom interface configurations."},"shipment_number":{"type":"string","description":"The CargoSoft shipment number of this shipment."},"master_reference":{"type":"string","description":"The shipment master bl number."},"house_reference":{"type":"string","description":"The shipment house bl number."},"order_type":{"type":"string","description":"The order type of the shipment."},"bl_type":{"type":"string","description":"Bl type of the shipment."},"mode_of_transport":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Transport mode of the shipment. Possible values are [SEA, AIR, RD, RL]"},"children":[],"type":"text"}],"type":"paragraph"}]},"month_of_service":{"type":"string","description":"The month in which freight services are provided, used for billing and reporting."},"total_packages":{"type":"integer","format":"int32","description":"The total number of packages of the shipment."},"total_gross_weight":{"type":"number","description":"The gross weight of the shipment."},"self_pickup":{"type":"string","description":"Indicates whether the recipient will pick up the goods directly from the warehouse or terminal."},"self_delivery":{"type":"string","description":"Indicates whether the sender will deliver the goods to the carrier or warehouse by themselves."},"goods":{"type":"array","description":"The description of the transported goods.","items":{"$ref":"#/components/schemas/Good"}},"addresses":{"type":"array","description":"The contact details of involved parties.","items":{"$ref":"#/components/schemas/ShipmentAddress"}},"pre_carriage":{"$ref":"#/components/schemas/Transport","description":"The transport of goods from the origin to the main carrier, preceding the main shipment."},"main_carriage":{"$ref":"#/components/schemas/Transport","description":"The primary transportation stage of the shipment"},"post_carriage":{"$ref":"#/components/schemas/Transport","description":"The transportation of goods from the main carrier to the final destination after the main shipment."},"events":{"type":"array","description":"Shipment events with location, date and time.","items":{"$ref":"#/components/schemas/ShipmentEvent"}},"terms_of_delivery_matchcode":{"type":"string","description":"The agreed conditions under which goods are delivered (matchcode)."},"terms_of_delivery_name":{"type":"string","description":"The agreed conditions under which goods are delivered (full condition)."},"total_volume":{"type":"number","description":"The combined physical space occupied by the goods, measured in cubic meters."},"chargeable_weight":{"type":"number","description":"The weight used to calculate shipping costs, based on either the actual weight or the volumetric weight, whichever is higher."},"original_shipment_number":{"type":"string","description":"The shipment number of the original or source shipment related to this shipment."},"foreign_id":{"type":"string","description":"Shipment number used by a foreign system."},"movement_matchcode":{"type":"string","description":"The CargoSoft movement matchcode assigned to the shipment."},"insurance":{"$ref":"#/components/schemas/Insurance","description":"Informations related to the shipment insurance"},"credit_data":{"$ref":"#/components/schemas/CreditData","description":"Information related to payment terms"},"customs_data":{"$ref":"#/components/schemas/CustomsData","description":"Informations related to customs processing"},"containers":{"type":"array","description":"Containers on this shipment.","items":{"$ref":"#/components/schemas/Container"}},"custom_fields":{"type":"array","description":"Various customer specific values.","items":{"$ref":"#/components/schemas/CustomField"}},"addon_fields":{"type":"array","description":"Addon field values (custom, TMS-configurable extra fields) attached to this shipment.","items":{"$ref":"#/components/schemas/AddonFieldValue"}},"last_modified_date_time":{"type":"string","format":"date-time","description":"Timestamp of the last modification of the shipment."},"created_date_time":{"type":"string","format":"date-time","description":"Timestamp of the creation of the shipment."},"order_date_time":{"type":"string","format":"date-time","description":"The order date."},"project_matchcode":{"type":"string","description":"Customizable field used to classify or categorize the order based on business-specific criteria."},"depot_matchcode":{"type":"string","description":"The CargoSoft depot matchcode assigned to the shipment."},"shipment_closed":{"type":"boolean","description":"Indicates whether the shipment is closed."},"booking_party_address_qualifier":{"type":"string","description":"The address qualifier of the booking party of the shipment."},"full_container_load":{"type":"boolean","description":"Indicates whether the shipment is handled as a full container load."},"dangerous_goods":{"type":"boolean","description":"Indicates whether the shipment contains dangerous goods."},"shipment_number_definition_version":{"type":"string","description":"The version of the CargoSoft shipment number definition used to generate the shipment number."},"maindepartment":{"type":"string","description":"The CargoSoft main department used for shipment assignment and shipment number generation."},"subdepartment":{"type":"string","description":"The CargoSoft subdepartment used for shipment assignment and shipment number generation."},"vehicle_temperature_code":{"type":"string","description":"The matchcode of the temperature specification assigned to the transport vehicle."},"calculations":{"type":"array","description":"Calculation lines associated with the shipment.","items":{"$ref":"#/components/schemas/ShipmentCalculation"}}}}},"components/schemas/ShipmentAddress":{"id":"components/schemas/ShipmentAddress","kind":"json-schema","title":"ShipmentAddress","data":{"type":"object","properties":{"qualifier":{"type":"string","description":"The qualifier describing the role of this address within the shipment.","enum":["AGT","CAR","CNE","CUS","DEL","DEP","DL1","DL2","INV","MIS","NFY","PUP","SHP","TRA","TML","CSTOP","FACILIATOR","AGENT","CARRIER","HDL","SVC","GWINV","CINF","VET","VGM","CNPUP","CNDRO"]},"address_type":{"type":"string","description":"The CargoSoft address type."},"address_number":{"type":"integer","format":"int32","description":"The CargoSoft address number."},"printed_address":{"$ref":"#/components/schemas/PrintedAddress","description":"The address exactly as entered in the shipment record."},"street":{"type":"string","description":"The street address of the party involved in the shipment."},"postal_code":{"type":"string","description":"The postal code of the address."},"city":{"type":"string","description":"The city of the address."},"state":{"type":"string","description":"The state or region of the address."},"country_matchcode":{"type":"string","description":"The CargoSoft matchcode for the country of the address."},"un_location_code":{"type":"string","description":"The UN location code for the address."},"contact":{"$ref":"#/components/schemas/Contact","description":"The contact details of the person or entity at the specified address."},"references":{"type":"array","description":"Optional references related to the address, such as additional identifiers or notes.","items":{"$ref":"#/components/schemas/Reference"}}},"required":["qualifier"]}},"components/schemas/ShipmentCalculation":{"id":"components/schemas/ShipmentCalculation","kind":"json-schema","title":"ShipmentCalculation","data":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"The unique identifier of this shipment calculation line."},"client":{"type":"string","description":"The CargoSoft client."},"shipment_number":{"type":"string","description":"The CargoSoft shipment number of the shipment."},"voucher_type":{"type":"string","description":"The CargoSoft voucher type of the calculation line.","minLength":1},"allocation":{"type":"string","description":"The calculated allocation of the calculation line.","readOnly":true},"income_expense_indicator":{"type":"string","description":"The calculated income or expense indicator of the calculation line.","readOnly":true},"invoice_party":{"$ref":"#/components/schemas/AddressMatchcode","description":"The address type and number of the party to be invoiced."},"billing_category_matchcode":{"type":"string","description":"The CargoSoft billing category matchcode.","minLength":1},"billing_text_line1":{"type":"string","description":"The first billing text line."},"billing_text_line2":{"type":"string","description":"The second billing text line."},"billing_text_line3":{"type":"string","description":"The third billing text line."},"billing_text_line4":{"type":"string","description":"The fourth billing text line."},"billing_text_line5":{"type":"string","description":"The fifth billing text line."},"total_amount":{"type":"number","description":"The total amount of the calculation line."},"quantity":{"type":"number","description":"The quantity used to calculate the total amount."},"single_amount":{"type":"number","description":"The amount per unit."},"measure_unit_matchcode":{"type":"string","description":"The CargoSoft matchcode of the unit of measure."},"currency_matchcode":{"type":"string","description":"The CargoSoft currency matchcode of the calculation line."},"exchange_rate":{"type":"number","format":"double","description":"The exchange rate applied to the calculation line."},"home_currency_matchcode":{"type":"string","description":"The CargoSoft currency matchcode of the company's home currency.","readOnly":true},"revenue_amount_in_home_currency":{"type":"number","description":"The calculated revenue amount in the company's home currency.","readOnly":true},"expense_amount_in_home_currency":{"type":"number","description":"The calculated expense amount in the company's home currency.","readOnly":true},"origin":{"$ref":"#/components/schemas/ShipmentCalculationLocation","description":"The origin used for route-related calculation information."},"destination":{"$ref":"#/components/schemas/ShipmentCalculationLocation","description":"The destination used for route-related calculation information."},"collect_prepaid":{"type":"string","description":"The collect or prepaid indicator of the calculation line."},"contract_number":{"type":"string","description":"The contract number associated with the calculation line."},"quotation_number":{"type":"string","description":"The quotation number associated with the calculation line."},"ecm_booking":{"type":"boolean","description":"Indicates whether this calculation line is booked manually in ECM."},"ordering":{"type":"integer","format":"int32","description":"The sequence number controlling the order of calculation lines."},"booked":{"type":"boolean","description":"Indicates whether this calculation line is booked."}},"required":["billing_category_matchcode","invoice_party","voucher_type"]}},"components/schemas/ShipmentCalculationLocation":{"id":"components/schemas/ShipmentCalculationLocation","kind":"json-schema","title":"ShipmentCalculationLocation","data":{"type":"object","properties":{"locationMatchcode":{"type":"string","writeOnly":true},"location_type":{"type":"string","description":"The type of the calculation location code."},"location_code":{"type":"string","description":"The code identifying the calculation location."},"location_name":{"type":"string","description":"The written name of the calculation location."},"location_country":{"type":"string","description":"The country code of the calculation location."}}}},"components/schemas/ShipmentEmployees":{"id":"components/schemas/ShipmentEmployees","kind":"json-schema","title":"ShipmentEmployees","data":{"type":"object","properties":{"closed_employee_matchcode":{"type":"string","description":"Employee login, who closed the shipment."},"last_modified_employee_matchcode":{"type":"string","description":"Employee login, who last modified the shipment."},"created_employee_matchcode":{"type":"string","description":"Employee login, who created the shipment."},"responsible_employee_matchcode":{"type":"string","description":"Employee login, who is responsible for the shipment"}}}},"components/schemas/ShipmentEvent":{"id":"components/schemas/ShipmentEvent","kind":"json-schema","title":"ShipmentEvent","data":{"type":"object","description":"Description of the ShipmentEvent DTO schema.","properties":{"event":{"$ref":"#/components/schemas/ShipmentEventQualifier","description":"The event code of this shipment event. The code describes the functional meaning of the event date and time."},"type":{"$ref":"#/components/schemas/EventType","description":"The event type of this shipment event. The event type describes if the event date and time is estimated or actual."},"shipment_id":{"type":"integer","format":"int32","description":"The id of the Shipment."},"date_time":{"$ref":"#/components/schemas/EventDateAndTime","description":"The date and time of this event."},"location":{"$ref":"#/components/schemas/Location","description":"The location of this event."}}}},"components/schemas/ShipmentEventQualifier":{"id":"components/schemas/ShipmentEventQualifier","kind":"json-schema","title":"ShipmentEventQualifier","data":{"type":"string","description":"The following list will give an overview about the shipment events and a short description.","enum":["DISPATCH","PICKUP","WAREHOUSE","POL_ARRIVAL","LOADING_START","LOADING_END","POL_DEPARTURE","POD_ARRIVAL","CLEARANCE_START","CLEARANCE_END","CUSTOMS_CLEARANCE","AVAILABLE","ACCEPTANCE","FINAL_DESTINATION","TRANSSHIPMENT","GATE_OUT","POD_DEPARTURE","CUSTOMS_RELEASE","DELIVERY_DATE","POL_DEPARTURE_REVISED","POD_ARRIVAL_REVISED","TRANSSHIPMENT_ARRIVAL","TRANSSHIPMENT_DEPARTURE","DIFF_BL_DATE","VGM_CLOSING"],"x-enumDescriptions":{"GATE_OUT":"TBD.","TRANSSHIPMENT":"The  goods  are  at  the  transshipment port (seafreight only).","LOADING_START":"The goods will be loaded into the vessel / airplane.","LOADING_END":"The goods are loaded into the vessel airplane.","POL_ARRIVAL":"The goods arrived the port of loading.","CUSTOMS_CLEARANCE":"The goods are cleared by customs.","POD_DEPARTURE":"TBD.","POL_DEPARTURE":"The  goods  are  departured  (ETD  and ATD).","POL_DEPARTURE_REVISED":"The  goods  are  departured  (revised Date).","POD_ARRIVAL_REVISED":"The goods arrived at the port of discharge (revised Date).","POD_ARRIVAL":"The goods arrived at the port of discharge (ETA and ATA).","ACCEPTANCE":"The goods can be picked up at the port.","PICKUP":"The  goods  are  picked  up  from  the starting location.","VGM_CLOSING":"VGM Closing Date and Time","DIFF_BL_DATE":"The  B/L  date  has  changed  from  theinitial value","TRANSSHIPMENT_DEPARTURE":"The  goods  have  departed  from  thetransshipment  port  and  are  on  theirway to the next destination.","WAREHOUSE":"The goods are within the warehouse.","CLEARANCE_END":"The goods are cleared.","FINAL_DESTINATION":"The goods are at the final destination.","DISPATCH":"The goods were dispatched.","CUSTOMS_RELEASE":"TBD.","AVAILABLE":"The goods are available at the port.","DELIVERY_DATE":"TBD.","CLEARANCE_START":"The goods will be cleared.","TRANSSHIPMENT_ARRIVAL":"The goods have arrived at the transshipment port and are ready for further transportation"}}},"components/schemas/ShipmentMemo":{"id":"components/schemas/ShipmentMemo","kind":"json-schema","title":"ShipmentMemo","data":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"One line of the order memo (eamemo_t) attached to a shipment. A memo text longer than the maximum line length is automatically wrapped across several consecutive lines (same client/shipment_number, running_number incrementing by one) when the shipment is created."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of this memo line."},"client":{"type":"string","description":"The CargoSoft client."},"memo":{"type":"string","description":"The memo text of this line."},"shipment_number":{"type":"string","description":"The CargoSoft shipment number this memo line belongs to."},"running_number":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The running number (eamemo_t.lfd_nr) of this line within the shipment's memo, starting at 1 - assigned automatically on create, not settable by the caller."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/Transport":{"id":"components/schemas/Transport","kind":"json-schema","title":"Transport","data":{"type":"object","properties":{"carriage_legs":{"type":"array","description":"A specific segment of the overall transport journey","items":{"$ref":"#/components/schemas/CarriageLeg"}}}}},"components/schemas/ShipmenLookupGenericClass":{"id":"components/schemas/ShipmenLookupGenericClass","kind":"json-schema","title":"ShipmenLookupGenericClass","data":{"type":"object","anyOf":[{"$ref":"#/components/schemas/EqualsIdentifier"},{"$ref":"#/components/schemas/InIdentifier"},{"$ref":"#/components/schemas/ContainsIdentifier"},{"$ref":"#/components/schemas/OrIdentifier"},{"$ref":"#/components/schemas/LessThanIdentifier"},{"$ref":"#/components/schemas/LessEqualIdentifier"},{"$ref":"#/components/schemas/GreaterThanIdentifier"},{"$ref":"#/components/schemas/GreaterEqualIdentifier"}],"properties":{"key":{"type":"string","description":"Identifier key. For instance a ShipmentIdentifier","enum":["ID","HBL","MBL","FILENUMBER","SHIPMENT_ID","ADDRESS_REFERENCE","DIRECTION","MODE_OF_TRANSPORT","MONTH_OF_SERVICE","CLIENT","CREATION_DATE","RUNNING_SEQUENCE_NUMBER","SHIPMENT_NUMBER","CUSTOMER_ADDRESS_TYPE","CUSTOMER_ADDRESS_NUMBER","SHIPMENT_CLOSED","LAST_MODIFIED_DATE","LAST_MODIFIED_TIME"],"title":"ShipmentIdentifier","x-enumDescriptions":{"SHIPMENT_ID":"A foreign shipment ID of a third party system. This ID should be unique.","LAST_MODIFIED_TIME":"The time, when the shipment was last modified.","DIRECTION":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Direction of the shipment. Possible values are [I, E]. I = import shipments, E = export shipments."},"children":[],"type":"text"}],"type":"paragraph"}],"CREATION_DATE":"System date when the shipment was created.","LAST_MODIFIED_DATE":"The date, when the shipment was last modified.","CUSTOMER_ADDRESS_NUMBER":"CargoSoft address number of the customer address.","FILENUMBER":"CargoSoft shipment number. The shipment number is unique in combination with the client.","CLIENT":"The CargoSoft client.","HBL":"House bl number of the Shipment.","MBL":"Master bL number of the Shipment.","ADDRESS_REFERENCE":"A address reference at any CargoSoft address of the shipment.","RUNNING_SEQUENCE_NUMBER":"TBD","MONTH_OF_SERVICE":"TBD","CUSTOMER_ADDRESS_TYPE":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CargoSoft address type of the customer address. Possible values are [D, K, G, P, A]"},"children":[],"type":"text"}],"type":"paragraph"}],"ID":"Unique database ID of the Shipment.","MODE_OF_TRANSPORT":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The mode of the shipment. Possible values are [SEA, AIR, RD, RL]."},"children":[],"type":"text"}],"type":"paragraph"}],"SHIPMENT_NUMBER":"CargoSoft shipment number. The shipment number is unique in combination with the client.","SHIPMENT_CLOSED":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Flag if the shipment is done. Possible values are [J, N]."},"children":[],"type":"text"}],"type":"paragraph"}]}},"match_mode":{"type":"string","default":"EQUALS","description":"The match mode.","enum":["EQUALS","CONTAINS","IN","OR","GT","LT","GE","LE"],"x-enumDescriptions":{"OR":"Or.","EQUALS":"Equals.","IN":"In.","LT":"Lower than.","LE":"Lower equals","CONTAINS":"Contains","GT":"Greater than.","GE":"Greater equals"}}}}},"components/schemas/IdentifierListIdentifierShipmentIdentifier":{"id":"components/schemas/IdentifierListIdentifierShipmentIdentifier","kind":"json-schema","title":"IdentifierListIdentifierShipmentIdentifier","data":{"type":"object","items":{"$ref":"#/components/schemas/IdentifierShipmentIdentifier"},"properties":{"first":{"$ref":"#/components/schemas/IdentifierShipmentIdentifier"},"last":{"$ref":"#/components/schemas/IdentifierShipmentIdentifier"}}}},"components/schemas/IdentifierShipmentIdentifier":{"id":"components/schemas/IdentifierShipmentIdentifier","kind":"json-schema","title":"IdentifierShipmentIdentifier","data":{"type":"object","description":"Description of the Identifier DTO schema. This DTO contains the match mode and identifiers of a functional object for instance the shipment identifier.","discriminator":{"propertyName":"matchMode","mapping":{"EqualsIdentifierMapped":"#/components/schemas/EqualsIdentifier","ContainsIdentifierMapped":"#/components/schemas/ContainsIdentifier","InIdentifierMapped":"#/components/schemas/InIdentifier","OrIdentifierMapped":"#/components/schemas/OrIdentifier","GreaterThanIdentifierMapped":"#/components/schemas/GreaterThanIdentifier","LessThanIdentifierMapped":"#/components/schemas/LessThanIdentifier","GreaterEqualIdentifierMapped":"#/components/schemas/GreaterEqualIdentifier","LessEqualIdentifierMapped":"#/components/schemas/LessEqualIdentifier"}},"properties":{"key":{"type":"string","description":"Identifier key. For instance a ShipmentIdentifier","enum":["ID","HBL","MBL","FILENUMBER","SHIPMENT_ID","ADDRESS_REFERENCE","DIRECTION","MODE_OF_TRANSPORT","MONTH_OF_SERVICE","CLIENT","CREATION_DATE","RUNNING_SEQUENCE_NUMBER","SHIPMENT_NUMBER","CUSTOMER_ADDRESS_TYPE","CUSTOMER_ADDRESS_NUMBER","SHIPMENT_CLOSED","LAST_MODIFIED_DATE","LAST_MODIFIED_TIME"],"title":"ShipmentIdentifier","x-enumDescriptions":{"SHIPMENT_ID":"A foreign shipment ID of a third party system. This ID should be unique.","LAST_MODIFIED_TIME":"The time, when the shipment was last modified.","DIRECTION":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Direction of the shipment. Possible values are [I, E]. I = import shipments, E = export shipments."},"children":[],"type":"text"}],"type":"paragraph"}],"CREATION_DATE":"System date when the shipment was created.","LAST_MODIFIED_DATE":"The date, when the shipment was last modified.","CUSTOMER_ADDRESS_NUMBER":"CargoSoft address number of the customer address.","FILENUMBER":"CargoSoft shipment number. The shipment number is unique in combination with the client.","CLIENT":"The CargoSoft client.","HBL":"House bl number of the Shipment.","MBL":"Master bL number of the Shipment.","ADDRESS_REFERENCE":"A address reference at any CargoSoft address of the shipment.","RUNNING_SEQUENCE_NUMBER":"TBD","MONTH_OF_SERVICE":"TBD","CUSTOMER_ADDRESS_TYPE":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CargoSoft address type of the customer address. Possible values are [D, K, G, P, A]"},"children":[],"type":"text"}],"type":"paragraph"}],"ID":"Unique database ID of the Shipment.","MODE_OF_TRANSPORT":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The mode of the shipment. Possible values are [SEA, AIR, RD, RL]."},"children":[],"type":"text"}],"type":"paragraph"}],"SHIPMENT_NUMBER":"CargoSoft shipment number. The shipment number is unique in combination with the client.","SHIPMENT_CLOSED":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Flag if the shipment is done. Possible values are [J, N]."},"children":[],"type":"text"}],"type":"paragraph"}]}},"match_mode":{"type":"string","default":"EQUALS","description":"The match mode.","enum":["EQUALS","CONTAINS","IN","OR","GT","LT","GE","LE"],"x-enumDescriptions":{"OR":"Or.","EQUALS":"Equals.","IN":"In.","LT":"Lower than.","LE":"Lower equals","CONTAINS":"Contains","GT":"Greater than.","GE":"Greater equals"}}}}},"components/schemas/APIErrorResponse":{"id":"components/schemas/APIErrorResponse","kind":"json-schema","title":"APIErrorResponse","data":{"type":"object","properties":{"error_code":{"$ref":"#/components/schemas/ApiError"},"error_message":{"type":"string"},"error_source":{"type":"string"},"monitor_id":{"type":"integer","format":"int32"}}}},"components/schemas/ApiError":{"id":"components/schemas/ApiError","kind":"json-schema","title":"ApiError","data":{"type":"object","properties":{"errorMessage":{"type":"string"}}}},"components/schemas/IdentifierListIdentifierShipmentMemoIdentifier":{"id":"components/schemas/IdentifierListIdentifierShipmentMemoIdentifier","kind":"json-schema","title":"IdentifierListIdentifierShipmentMemoIdentifier","data":{"type":"object","items":{"$ref":"#/components/schemas/IdentifierShipmentMemoIdentifier"},"properties":{"first":{"$ref":"#/components/schemas/IdentifierShipmentMemoIdentifier"},"last":{"$ref":"#/components/schemas/IdentifierShipmentMemoIdentifier"}}}},"components/schemas/IdentifierShipmentMemoIdentifier":{"id":"components/schemas/IdentifierShipmentMemoIdentifier","kind":"json-schema","title":"IdentifierShipmentMemoIdentifier","data":{"type":"object","description":"Description of the Identifier DTO schema. This DTO contains the match mode and identifiers of a functional object for instance the shipment identifier.","discriminator":{"propertyName":"matchMode","mapping":{"EqualsIdentifierMapped":"#/components/schemas/EqualsIdentifier","ContainsIdentifierMapped":"#/components/schemas/ContainsIdentifier","InIdentifierMapped":"#/components/schemas/InIdentifier","OrIdentifierMapped":"#/components/schemas/OrIdentifier","GreaterThanIdentifierMapped":"#/components/schemas/GreaterThanIdentifier","LessThanIdentifierMapped":"#/components/schemas/LessThanIdentifier","GreaterEqualIdentifierMapped":"#/components/schemas/GreaterEqualIdentifier","LessEqualIdentifierMapped":"#/components/schemas/LessEqualIdentifier"}},"properties":{"key":{"type":"string","description":"Identifier key. For instance a ShipmentIdentifier","enum":["ID","SHIPMENT_NUMBER","CLIENT"]},"match_mode":{"type":"string","default":"EQUALS","description":"The match mode.","enum":["EQUALS","CONTAINS","IN","OR","GT","LT","GE","LE"],"x-enumDescriptions":{"OR":"Or.","EQUALS":"Equals.","IN":"In.","LT":"Lower than.","LE":"Lower equals","CONTAINS":"Contains","GT":"Greater than.","GE":"Greater equals"}}}}},"components/schemas/ProviderResponseStatus":{"id":"components/schemas/ProviderResponseStatus","kind":"json-schema","title":"ProviderResponseStatus","data":{"type":"object","description":"A provider status with event dates and references used to associate it with CargoSoft data.","properties":{"id":{"type":"integer","format":"int32","description":"Internal provider response status ID.","readOnly":true},"references":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"References for status processing. CLIENT and PROVIDER are required; SHIPMENT_NUMBER associates the status with a shipment."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"$ref":"#/components/schemas/Reference"}},"identifiers":{"type":"array","description":"Additional key-value identifiers originating from provider subscriptions. They are optional for direct status creation.","items":{"$ref":"#/components/schemas/SubscriptionStatusAdditional"}},"cs_status":{"type":"string","description":"Optional CargoSoft status code. The status creation process uses the customer-specific provider status mapping.","example":"ETA"},"provider_status":{"type":"string","description":"Provider-specific status code configured in the customer's CargoSoft master data.","example":"EXPECTED_ARRIVAL"},"status_date_and_time":{"$ref":"#/components/schemas/DateAndTime","description":"Date and time assigned to the provider status message."},"status_location":{"$ref":"#/components/schemas/Location","description":"Location assigned to the provider status message."},"additional_information":{"type":"string","description":"Additional free-text information supplied with the provider status.","example":"Estimated arrival updated by customer integration"},"unique_provider_message_number":{"type":"string","description":"Provider message number for traceability. It is not an idempotency key.","example":"STATUS-2026-000123"},"status_events":{"type":"array","description":"Provider event dates and locations used by the configured status processing rules.","items":{"$ref":"#/components/schemas/ProviderResponseStatusEvent"}}},"required":["provider_status","references"]}},"components/schemas/ProviderResponseStatusEvent":{"id":"components/schemas/ProviderResponseStatusEvent","kind":"json-schema","title":"ProviderResponseStatusEvent","data":{"type":"object","description":"A dated provider event used by CargoSoft status processing.","properties":{"type":{"type":"string","description":"Role of the event date in the provider status.","enum":["FROM","TO","STATUS","EVENT"],"example":"STATUS"},"date_and_time":{"$ref":"#/components/schemas/DateAndTime","description":"Date and time of the provider event."},"event_date_type":{"type":"string","description":"Whether the event date is actual or estimated.","enum":["ACTUAL","ESTIMATED"],"example":"ESTIMATED"},"location":{"$ref":"#/components/schemas/Location","description":"Location of the provider event."}},"required":["date_and_time","type"]}},"components/schemas/SubscriptionStatusAdditional":{"id":"components/schemas/SubscriptionStatusAdditional","kind":"json-schema","title":"SubscriptionStatusAdditional","data":{"type":"object","description":"An additional provider-specific identifier attached to a status response.","properties":{"key":{"type":"string","description":"Provider-specific identifier key.","example":"CONTAINER"},"value":{"type":"string","description":"Provider-specific identifier value.","example":"CSQU3054383"}}}},"components/schemas/Jwt":{"id":"components/schemas/Jwt","kind":"json-schema","title":"Jwt","data":{"type":"object","properties":{"token":{"type":"string"}}}},"schema_0":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":50},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["CLIENT","EDIPARTNER","DIRECTION","CODETYPE","SOURCECODE"]}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","description":"Description of the order mode for ordering API results sending back as response","enum":["ASC","DESC"],"x-enumDescriptions":{"ASC":"ascending","DESC":"descending"}}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Identifier"}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CodeConvertion"}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"object","properties":{"X-Page-Count":{"description":"The total number of pages for pagination."},"X-Row-Count":{"description":"The total number of found objects for pagination."}},"required":["X-Page-Count","X-Row-Count"]},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","description":"The following list will give an overview about the implemented shipment identifier and a short description.","enum":["ID","HBL","MBL","FILENUMBER","SHIPMENT_ID","ADDRESS_REFERENCE","DIRECTION","MODE_OF_TRANSPORT","MONTH_OF_SERVICE","CLIENT","CREATION_DATE","RUNNING_SEQUENCE_NUMBER","SHIPMENT_NUMBER","CUSTOMER_ADDRESS_TYPE","CUSTOMER_ADDRESS_NUMBER","SHIPMENT_CLOSED","LAST_MODIFIED_DATE","LAST_MODIFIED_TIME"],"title":"ShipmentIdentifier","x-enumDescriptions":{"SHIPMENT_ID":"A foreign shipment ID of a third party system. This ID should be unique.","LAST_MODIFIED_TIME":"The time, when the shipment was last modified.","DIRECTION":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Direction of the shipment. Possible values are [I, E]. I = import shipments, E = export shipments."},"children":[],"type":"text"}],"type":"paragraph"}],"CREATION_DATE":"System date when the shipment was created.","LAST_MODIFIED_DATE":"The date, when the shipment was last modified.","CUSTOMER_ADDRESS_NUMBER":"CargoSoft address number of the customer address.","FILENUMBER":"CargoSoft shipment number. The shipment number is unique in combination with the client.","CLIENT":"The CargoSoft client.","HBL":"House bl number of the Shipment.","MBL":"Master bL number of the Shipment.","ADDRESS_REFERENCE":"A address reference at any CargoSoft address of the shipment.","RUNNING_SEQUENCE_NUMBER":"TBD","MONTH_OF_SERVICE":"TBD","CUSTOMER_ADDRESS_TYPE":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CargoSoft address type of the customer address. Possible values are [D, K, G, P, A]"},"children":[],"type":"text"}],"type":"paragraph"}],"ID":"Unique database ID of the Shipment.","MODE_OF_TRANSPORT":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The mode of the shipment. Possible values are [SEA, AIR, RD, RL]."},"children":[],"type":"text"}],"type":"paragraph"}],"SHIPMENT_NUMBER":"CargoSoft shipment number. The shipment number is unique in combination with the client.","SHIPMENT_CLOSED":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Flag if the shipment is done. Possible values are [J, N]."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ShipmenLookupGenericClass"}},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Shipment"}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AirfreightCarriageLeg"}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentEvent"}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SeafreightCarriageLeg"}},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EventType"},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ShipmentEventQualifier"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["ID","SHIPMENT_NUMBER","CLIENT"]}},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentMemo"}},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/EFileReference"}},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/EFileRole"}},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"string"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","description":"The following list will give an overview about the implemented efile identifier and a short description.","enum":["REFERENCE","SHIPMENT_ID","CLIENT"],"title":"EFileIdentifier","x-enumDescriptions":{"SHIPMENT_ID":"Unique database ID of the Shipment.","REFERENCE":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Reference of the efile as <REFERENCE_TYPE>:<REFERENCE_VALUE>, for example EDIMON:4711 for the JSON file belonging to the edimonitordatei_t row 4711. Must always be combined with a CLIENT identifier - several configured efile clients can share the same backend, so searching without a client would return the same document once per matching client. In most cases, this reference is not known by third party applications. For instance, use the SHIPMENT_ID identifier to search efile documents."},"children":[],"type":"text"}],"type":"paragraph"}],"CLIENT":"Mandant, required together with REFERENCE to scope the search to a single efile client."}}},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/EFileLookupGenericClass"}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/EFile"}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","properties":{"username":{"type":"string","description":"Your username"},"password":{"type":"string","description":"Your password"}},"required":["password","username"]},"id":"schema_26"}},"exampleStore":{"components/examples/Lookup_codeconverter_example":{"id":"components/examples/Lookup_codeconverter_example","value":[{"match_mode":"EQUALS","key":"EDIPARTNER","value":"SAMPLEPARTNER"},{"match_mode":"EQUALS","key":"DIRECTION","value":"E"},{"match_mode":"EQUALS","key":"CODETYPE","value":"VERCO_T"}]},"components/examples/CodeConvertion_lookup_example_object":{"id":"components/examples/CodeConvertion_lookup_example_object","value":[{"id":4711,"client":"001","edipartner":"SAMPLEPARTNER","direction":"RECEIVE","code_type":"VERCO_T","source_code":"BX","target_code":"10"}]},"components/examples/Lookup_efile_example":{"id":"components/examples/Lookup_efile_example","value":[{"match_mode":"EQUALS","key":"SHIPMENT_ID","value":"54842"}]},"components/examples/Efile_example_object":{"id":"components/examples/Efile_example_object","value":[{"id":117481,"client":"001","description":"A18 document","bytes":"iVBORw0KGgoAAAANSUhEUgAAAgoAAAKlCAYAAACqi8RuAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAABhaVRYdFNuaXBNZXRhZGF0YQAAAAAAeyJjbGlwUG9pbnRzIjpbeyJ4IjowLCJ5IjowfSx7IngiOjUyMiwieSI6MH0seyJ4Ijo1MjIsInkiOjY3N30seyJ4IjowLCJ5Ijo2Nzd9XX1rMyYmAAD/OElEQVR4XuT9B5xeV3XvD6/pvWtm1HuvtlzkirsxGGzTCb1DaAFCgHRCQuq9NzcJCUkooXcwGHds495k2bItS7J6HZXpvY/e33fts58582hGkgl53/f/+a9n1pxd1167rrXL2Sfnq49uPSGwiLm5uRkcGxuzqSAnJ0f/T+2feyKxJJCXk5tJBzghEqQDkFagOQ4xfdzBGC9COnz0w210dNSfkXaE7PgnYCAF2f6WF/gFTpwYtcK8fKdtOWOWl5cn5oM95tP5TJHIy8/xcMPDw5ZrOVZQUGAjIyNmoyH+CVPcpKxJhyc08INuYW7IS/QDYr4om/zcEA4zYaAP4OblcELldyLX8vMDnyPiDV4INzQ0ZIVFRW7Hn/h9fX1WVVXlT+dBHMIv4UmTsNCNaeQXlMh/KNAbHvC8V5SV2HB/nxXmF1jO8KgVFBbasNrJyJh4sjxPC5pFci8syrG248dsbkOjNVRX2g+//Q27/Zc329o1K+yv//qv7cRQn/PV3d0tfkL9Ex8YGRm2mtwiGxgZszG59Y8O2mjOkFVWliuVQivILbPOvk5ra26xTY89Yd/8ytfsfe94lz38wIPisdye3/ys1a+YbxdeeoV965vfs/WrV9ueHdtt+owGa+nuEb1cK8kZsRNjQ2q3Y1ZcWmGNc+bbpqeeseuuvsoO7NhmW1/pGgGLPjWsMYgfn6yXam47oHr2MpdtbTIjWCx/9iJ5kNjS3ZY3C2hC16e6DH8B16DsOn8Syf0nIN74CXBvbPHLF/j4Lr+98+A5/3ngzI5WY+c8Avug39RD9d4R+YR9wV10y7+DuoPyoE/8hvtoU4OeB99xuHaoq+OoF6en23r7PbJrDA/af8fqiSe3XAxiM0AAAAASUVORK5CYII=","roles":["cargosoft","SCM","C2C"],"references":[{"reference_type":"CSFILE","reference_value":"022120300004#001"},{"reference_type":"createdBy","reference_value":"CargoSoft User"}],"document_category":"1601,","document_name":"A18.pdf","document_date":"2024-01-17T10:51:48.001"},{"id":117482,"client":"001","description":"Description of this Screenshot","bytes":"iVBORw0KGgoAAAANSUhEUgAAAgpGgGLPjWsMYg+XH2YTHVX5pDD4IqP9TKZmfKgneoZWrePCP8C9QWIQlvEbBD11fwky2HApEzHmQOwoC9Ec1KDLYj0qBwl6qWTRhiAt6noQu7GXP5EmAO/GweV3JX/+cz0BfzIu/PPHAigGrDkERYDtA8ZN46acP5PApOwBNZltOW4C5WIoQ/IjtUF9qIydUfuQDxWnYmK2yZcFMVPb+fis4oTIaG7L1a1baD77yH7Zjy3P2r//4v+3iC86TYtOnQXlEwrVbNazZonitrq6xgYGBTLrMBOGJ+hmRYM4vLJI+kmfFSu/PP/c5y1U5Xn7J5XbpRS+zBx+5357YuNEGpdTs3LvHlq5aYQ8+9rAtWLLfn6yXam47oHr2MpdtbTIjWCx/9iJ5kNjS3ZY3C2hC16e6DH8B16DsOn8Syf0nIN74CXBvbPHLF/j4Lr+98+A5/3ngzI5WY+c8Avug39RD9d4R+YR9wV10y7+DuoPyoE/8hvtoU4OeB99xuHaoq+OoF6en23r7PbJrDA/af8fqiSe3XAxiM0AAAAASUVORK5CYII=","roles":["cargosoft","SCM","C2C"],"references":[{"reference_type":"CSFILE","reference_value":"022120300004#001"},{"reference_type":"createdBy","reference_value":"CargoSoft User"}],"document_category":"1601,","document_name":"Screenshot 2024-01-17 121503.png","document_date":"2024-01-17T12:15:24.877"}]},"components/examples/Create_Shipment_example_object_Addresses_2colli":{"id":"components/examples/Create_Shipment_example_object_Addresses_2colli","value":{"edipartner_matchcode":"EDIPARTNER","client":"DE4","direction":"E","office":"BRE","employees":{"created_employee_matchcode":"cargo"},"house_reference":"20260901102536","bl_type":"HBL","mode_of_transport":"SEA","month_of_service":"202609","goods":[{"measurements":[],"customs":[],"mrns":[],"subgoods":[],"dangerousGoods":[],"identifier":"M","counter":1,"level":1,"level_number":0,"marks":[],"quantity":5,"packaging_matchcode":"PL","commodity_matchcode":"0077","description":["BIER"],"weight":5500,"colli":true,"colli_number":1,"volume":null,"volume_unit":"cbm","additional_mark":false,"net_weight":4500,"weight_unit":"k","chargable_weight":null,"container_number":null,"container":false,"hs_codes":[]},{"measurements":[],"customs":[],"mrns":[],"subgoods":[],"dangerousGoods":[],"identifier":"M","counter":2,"level":1,"level_number":0,"marks":[],"quantity":5,"packaging_matchcode":"KT","commodity_matchcode":"0061","description":["BATTERIEN"],"weight":4800,"colli":true,"colli_number":2,"volume":null,"volume_unit":"cbm","additional_mark":false,"net_weight":4300,"weight_unit":"k","chargable_weight":null,"container_number":null,"container":false,"hs_codes":[]}],"addresses":[{"qualifier":"SHP","address_type":"G","address_number":1,"printed_address":{"line_1":"CargoSoft GmbH","line_2":"Buschhöhe 10","line_3":"28359 Bremen","line_4":"Deutschland","line_5":null},"street":"Buschhöhe 10","postal_code":"28359","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"matchcode":null,"value":"ShipperRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"CNE","address_type":"G","address_number":2,"printed_address":{"line_1":"AROY-D","line_2":"45/1-2 Phra Athit Rd, Chana Songkhram","line_3":"10200 Bangkok","line_4":"THAILAND","line_5":null},"street":"45/1-2 Phra Athit Rd, Chana Songkhram","postal_code":"10200","city":"Bangkok","state":null,"country_matchcode":"TH","un_location_code":"THBKK","contact":null,"references":[{"matchcode":null,"value":"ConsigneeRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"NFY","address_type":"G","address_number":3,"printed_address":{"line_1":"Thailand DES-Agent Bangkok","line_2":"Trad Road Km 15 Rachathewa","line_3":"10540 Bangkok","line_4":"THAILAND","line_5":null},"street":"Trad Road Km 15 Rachathewa","postal_code":"10540","city":"Bangkok","state":null,"country_matchcode":"TH","un_location_code":"THBKK","contact":null,"references":[{"matchcode":null,"value":"NotifyRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"AGT","address_type":"G","address_number":4,"printed_address":{"line_1":"Thailand DES-Agent Surat Thani","line_2":"Hua Toei, Amphoe Phunphin","line_3":"10545 Surat Thani","line_4":"THAILAND","line_5":null},"street":"Hua Toei, Amphoe Phunphin","postal_code":"10545","city":"Surat Thani","state":null,"country_matchcode":"TH","un_location_code":"THURT","contact":null,"references":[{"matchcode":null,"value":"AgentRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"CAR","address_type":"G","address_number":5,"printed_address":{"line_1":"Adresse für ADRESSVORSCHLAG","line_2":"Adresse für ADRESSVORSCHLAG","line_3":"Straßenname 123","line_4":"28359 Bremen","line_5":"Deutschland"},"street":"Straßenname 123","postal_code":"28359","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"matchcode":null,"value":"CarrierRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"TRA","address_type":"G","address_number":6,"printed_address":{"line_1":"EKB Container Logistik GmbH & Co. KG","line_2":"Container- und Frachtguttransporte","line_3":"Richard-Dunkel-Straße 120","line_4":"28819 Bremen","line_5":"Deutschland"},"street":"Richard-Dunkel-Straße 120","postal_code":"28819","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"matchcode":null,"value":"TerminalInRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"TML","address_type":"G","address_number":7,"printed_address":{"line_1":"Addicks & Kreye Container Service GmbH","line_2":"Windhukstraße 20-26","line_3":"28237 Bremen","line_4":"Deutschland","line_5":null},"street":"Windhukstraße 20-26","postal_code":"28237","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"matchcode":null,"value":"TruckerRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"PUP","address_type":"G","address_number":8,"printed_address":{"line_1":"AHS Bremen Aviation","line_2":"Handling Services GmbH","line_3":"Terminal 1, Flughafenallee 21","line_4":"28199 Bremen","line_5":"Deutschland"},"street":"Terminal 1, Flughafenallee 21","postal_code":"28199","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"matchcode":null,"value":"TerminalOutRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"CSTOP","address_type":"G","address_number":9,"printed_address":{"line_1":"Miscellaneous GmbH & Co KG","line_2":"Sonstige Güter","line_3":"Am Wall 207","line_4":"28195 Bremen","line_5":"Deutschland"},"street":"Am Wall 207","postal_code":"28195","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"matchcode":null,"value":"TerminalAdresse9Ref","date_and_time":{"date":null,"time":null,"zone_offset":null}}]}],"order_date_time":"2026-09-22T07:25:36","maindepartment":"HB","subdepartment":"EX"}},"components/examples/Create_Shipment_example_object_Addresses_Container":{"id":"components/examples/Create_Shipment_example_object_Addresses_Container","value":{"edipartner_matchcode":"COCACOLA","client":"DE4","direction":"E","office":"BRE","employees":{"created_employee_matchcode":"cargo"},"house_reference":"WARENBESCHREIBUNG","bl_type":"HBL","mode_of_transport":"SEA","month_of_service":"202609","goods":[{"measurements":[],"customs":[],"mrns":[],"subgoods":[{"measurements":[],"customs":[],"mrns":[],"subgoods":[],"dangerousGoods":[],"identifier":"M","counter":1,"level":2,"level_number":1000000,"marks":[],"quantity":5,"packaging_matchcode":"PL","commodity_matchcode":"0077","description":["BIER"],"weight":5800,"colli":true,"colli_number":1,"volume":null,"volume_unit":"cbm","additional_mark":false,"net_weight":5000,"weight_unit":"k","chargable_weight":null,"container_number":null,"container":false,"hs_codes":[]},{"measurements":[],"customs":[],"mrns":[],"subgoods":[],"dangerousGoods":[],"identifier":"M","counter":2,"level":2,"level_number":1000000,"marks":[],"quantity":5,"packaging_matchcode":"PL","commodity_matchcode":"0064","description":["BAUMWOLLE/-ABFAELLE"],"weight":4900,"colli":true,"colli_number":2,"volume":null,"volume_unit":"cbm","additional_mark":false,"net_weight":4450,"weight_unit":"k","chargable_weight":null,"container_number":null,"container":false,"hs_codes":[]}],"dangerousGoods":[],"identifier":"M","counter":1,"level":1,"level_number":0,"marks":["MSKU 235 125-2"],"quantity":1,"packaging_matchcode":"C2","commodity_matchcode":null,"description":["SAID TO CONTAIN"],"weight":12500,"colli":true,"colli_number":1,"volume":null,"volume_unit":"cbm","additional_mark":false,"net_weight":10500,"weight_unit":"k","chargable_weight":null,"container_number":"MSKU2351252","container":true,"hs_codes":[]}],"order_date_time":"2026-09-22T07:25:36","maindepartment":"HB","subdepartment":"EX"}},"components/examples/Shipment_example_object_response":{"id":"components/examples/Shipment_example_object_response","value":{"id":327410,"client":"001","direction":"E","office":"BRE","employees":{"closed_employee_matchcode":null,"last_modified_employee_matchcode":"cargo","created_employee_matchcode":"cargo","responsible_employee_matchcode":"cargo"},"edipartner_matchcode":"SAMPLEPARTNER","memos":[],"aes":[],"addon_fields":[{"addonfield_matchcode":"CUSTOMS_REFERENCE","value":"REF-4711"}],"dangerous_goods":true,"shipment_number":"0111230300003","master_reference":null,"house_reference":"0111230300003","order_type":null,"bl_type":"HBL","mode_of_transport":"SEA","month_of_service":"202402","total_packages":1,"total_gross_weight":1,"self_pickup":"N","self_delivery":"N","goods":[{"measurements":[],"customs":[],"mrns":[],"subgoods":[{"measurements":[{"id":8384,"client":"001","counter":1,"weight":null,"length":100,"width":100,"height":100,"quantity":1,"goods_dto":970652,"shipment_number":"0111230300003","weight_unit":"kg","volume":1,"volume_unit":"cbm","measurement_unit":"cm"}],"customs":[],"mrns":[],"subgoods":[],"dangerousGoods":[{"id":11030,"client":"001","goods_dto":970652,"dangerous_good_legislation":"IMDG","classification_code":null,"un_number":"0121","release":"","label_1":null,"label_2":null,"label_3":null,"label_4":null,"site":null,"flashpoint":null,"flashpoint_unit":null,"ems_number_1":"F-B","ems_number_2":"S-X","mfag_number_1":null,"mfag_number_2":null,"remarks":null,"authorisation_number":null,"packaging_group":null,"technical_name_1":"IGNITERS","technical_name_2":null,"causing_substance_1":"Fire","causing_substance_2":null,"issuer":"CargoSoft GmbH","net_weight":1,"weight_unit":"k","gross_weight":1.5,"contact":null}],"id":970652,"client":"001","shipment_number":"0111230300003","identifier":"M","counter":1,"level":2,"level_number":1000000,"marks":[],"quantity":100,"packaging_matchcode":"KT","commodity_matchcode":null,"description":["Playstation 5"],"weight":1,"colli":true,"colli_number":1,"volume":1,"volume_unit":"cbm","additional_mark":false,"net_weight":1,"weight_unit":"k","chargable_weight":null,"container_number":null,"container":false,"hs_codes":[{"id":6952,"client":"001","hsCode":"12345","goods_dto":970652}]}],"dangerousGoods":[],"id":970650,"client":"001","shipment_number":"0111230300003","identifier":"M","counter":1,"level":1,"level_number":0,"marks":["SUDU 222 222-2"],"quantity":1,"packaging_matchcode":"C4","commodity_matchcode":null,"description":[],"weight":null,"colli":true,"colli_number":1,"volume":null,"volume_unit":"cbm","additional_mark":false,"net_weight":null,"weight_unit":"k","chargable_weight":null,"container_number":"SUDU2222222","container":true,"hs_codes":[]}],"addresses":[{"qualifier":"AGT","address_type":"G","address_number":909524,"printed_address":{"line_1":"Daniel Turkoane","line_2":"Faktorsgatan 5","line_3":null,"line_4":"S 25246 Helsingborg","line_5":null,"line_6":null},"street":"Faktorsgatan 5","postal_code":"25246","city":"Helsingborg","state":null,"country_matchcode":"SE","un_location_code":null,"contact":{"name":null,"phone_number":null,"fax_number":"olaf test xxxxxxxxxx0111230300003","email":null},"references":[]},{"qualifier":"CAR","address_type":"G","address_number":8923,"printed_address":{"line_1":"Jumbo Transport A/S","line_2":"Lokesvej 8","line_3":null,"line_4":"DK 8230 ABYHOJ","line_5":null,"line_6":null},"street":"Lokesvej 8","postal_code":"8230","city":"ABYHOJ","state":null,"country_matchcode":"DK","un_location_code":null,"contact":{"name":null,"phone_number":null,"fax_number":"olaf test xxxxxxxxxx0111230300003","email":null},"references":[]},{"qualifier":"CNE","address_type":"D","address_number":1030,"printed_address":{"line_1":"Max Mustermann","line_2":"Hollywood Blvd.","line_3":"90245 Los Angeles","line_4":null,"line_5":null,"line_6":null},"street":"Hollywood Blvd.","postal_code":"90245","city":"Los Angeles","state":null,"country_matchcode":"US","un_location_code":"USLAX","contact":null,"references":[]},{"qualifier":"CUS","address_type":"K","address_number":111111,"printed_address":{"line_1":"MAERSK","line_2":null,"line_3":"HAMBURG","line_4":null,"line_5":null,"line_6":null},"street":null,"postal_code":null,"city":"HAMBURG","state":null,"country_matchcode":"DE","un_location_code":null,"contact":null,"references":[]},{"qualifier":"PUP","address_type":"D","address_number":1030,"printed_address":{"line_1":"Max Mustermann","line_2":"Hollywood Blvd.","line_3":"90245 Los Angeles","line_4":null,"line_5":null,"line_6":null},"street":"Hollywood Blvd.","postal_code":"90245","city":"Los Angeles","state":null,"country_matchcode":"US","un_location_code":"USLAX","contact":null,"references":[]},{"qualifier":"SHP","address_type":"D","address_number":1030,"printed_address":{"line_1":"CargoSoft GmbH1 e-logistic solutions inf","line_2":"Bremen 28199 28357 Postfach POST4711 HB","line_3":"D Buschhöhe 10a +49 (421) 122-225-444","line_4":"+49 (421) 122-225-288 etr j765j655ju u65","line_5":"DE DE987654321 nicht !1ss cscs","line_6":null},"street":"Buschhöhe 10a","postal_code":"28357","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"id":10182,"matchcode":"DEF","value":"Testreferenz 123","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"CARRIER","address_type":"K","address_number":111111,"printed_address":null,"street":null,"postal_code":null,"city":null,"state":null,"country_matchcode":null,"un_location_code":null,"contact":null,"references":[]}],"pre_carriage":{"carriage_legs":[{"mot":"ANY","origin":{"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-05","time":"10:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-10-01","time":"11:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"destination":{"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"10:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"11:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"leg_no":1,"haulage_type":null,"haulage_reference":null}]},"main_carriage":{"carriage_legs":[{"mot":"SEA","origin":{"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"10:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"11:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"destination":{"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"19:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"leg_no":1,"voyage_no":null,"imo_code":null,"vessel_name":null,"vessel_flag":null,"call_sign":null}]},"post_carriage":{"carriage_legs":[{"mot":"ANY","origin":{"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"19:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"destination":{"location":{"codes":[{"type":"UNLOC","code":"NLAMS"}],"name":"Amsterdam","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-07","time":"15:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-07","time":"16:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"leg_no":1,"haulage_type":null,"haulage_reference":null}]},"events":[{"event":"DISPATCH","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"DISPATCH","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"PICKUP","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-10-01","time":"11:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"PICKUP","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-05","time":"10:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"WAREHOUSE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"WAREHOUSE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"POL_ARRIVAL","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-05","time":"16:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POL_ARRIVAL","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-05","time":"15:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_START","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_START","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_END","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_END","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POL_DEPARTURE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"11:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POL_DEPARTURE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"10:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POD_ARRIVAL","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"POD_ARRIVAL","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"19:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_START","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"21:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_START","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_END","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"22:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_END","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"21:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CUSTOMS_CLEARANCE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CUSTOMS_CLEARANCE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"AVAILABLE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"09:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"AVAILABLE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"09:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"ACCEPTANCE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"ACCEPTANCE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"FINAL_DESTINATION","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"16:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLAMS"}],"name":"Amsterdam","latitude":null,"longitude":null}},{"event":"FINAL_DESTINATION","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"15:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLAMS"}],"name":"Amsterdam","latitude":null,"longitude":null}},{"event":"POL_DEPARTURE_REVISED","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POD_ARRIVAL_REVISED","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}}],"terms_of_delivery_matchcode":"FOB","terms_of_delivery_name":"FOB Bremerhaven","total_volume":1,"chargeableWeight":0,"original_shipment_number":"33030","foreign_id":null,"movement_matchcode":null,"insurance":{"waiver_customer":null,"insurable_value":null,"insurable_value_currency_matchcode":"EUR","value_of_goods":null,"value_of_goods_currency_matchcode":"EUR","insurance_text":null,"transport_insurance":false,"insurance_type":null,"insurer":null},"credit_data":null,"customs_data":null,"containers":[{"containerAddresses":[{"id":11423,"qualifier":"SHP","street":"Buschhöhe 10a","city":"Bremen","order":1,"references":[],"address_type":"D","address_number":1030,"printed_address":{"line_1":"CargoSoft GmbH1 e-logistic solutions inf","line_2":"Bremen 28199 28357 Postfach POST4711 HB","line_3":"D Buschhöhe 10a +49 (421) 122-225-444","line_4":null,"line_5":null,"line_6":null},"postal_code":"28357","country_matchcode":"DE","un_location_code":"DEBRE","from_date_and_time":null,"to_date_and_time":null,"contact":null},{"id":11424,"qualifier":"CNE","street":"Hollywood Blvd.","city":"Los Angeles","order":2,"references":[],"address_type":"D","address_number":100,"printed_address":{"line_1":"Max Mustermann","line_2":"Hollywood Blvd.","line_3":"90245 Los Angeles","line_4":null,"line_5":null,"line_6":null},"postal_code":"90245","country_matchcode":"US","un_location_code":"USLAX","from_date_and_time":null,"to_date_and_time":null,"contact":null},{"id":11425,"qualifier":"PUP","street":"Hollywood Blvd.","city":"Los Angeles","order":3,"references":[],"address_type":"D","address_number":100,"printed_address":{"line_1":"Max Mustermann","line_2":"Hollywood Blvd.","line_3":"90245 Los Angeles","line_4":null,"line_5":null,"line_6":null},"postal_code":"90245","country_matchcode":"US","un_location_code":"USLAX","from_date_and_time":null,"to_date_and_time":null,"contact":null}],"id":24720,"good_id":970650,"client":"001","shipment_number":"0111230300003","container_number":"SUDU2222222","seal_number1":null,"seal_number2":null,"seal_number3":null,"container_iso_code":"40G0","reefer_temperature":null,"reefer_temperature_lower_bound":null,"reefer_temperature_upper_bound":null,"reefer_temperature_unit":null,"shippers_own":false,"addon_fields":[{"addonfield_matchcode":"CUSTOMS_REFERENCE","value":"CONTAINER-REF-4711"}]}],"custom_fields":[{"id":197235,"client":"001","value":null,"shipment_number":"0111230300003","running_number":16}],"last_modified_date_time":"2026-09-07T15:27:58","created_date_time":"2026-09-07T15:27:58","order_date_time":"2023-03-06T00:00:00","project_matchcode":null,"depot_matchcode":null,"shipment_closed":false,"booking_party_address_qualifier":"SHP","full_container_load":true,"shipment_number_definition_version":null,"maindepartment":"01","subdepartment":"11","vehicle_temperature_code":"COOL","calculations":[{"voucher_type":"R","invoice_party":{"address_type":"D","address_number":1030},"billing_category_matchcode":"FRT","billing_text_line1":"Ocean freight","billing_text_line2":null,"billing_text_line3":null,"billing_text_line4":null,"billing_text_line5":null,"total_amount":250,"quantity":1,"single_amount":250,"measure_unit_matchcode":null,"currency_matchcode":"EUR","exchange_rate":1,"origin":{"location_type":"UNLOC","location_code":"DEBRV","location_name":"Bremerhaven","location_country":"DE"},"destination":{"location_type":"UNLOC","location_code":"NLRTM","location_name":"Rotterdam","location_country":"NL"},"collect_prepaid":"P","contract_number":null,"quotation_number":null,"ecm_booking":false,"ordering":1}]}},"components/examples/Lookup_shipment_example":{"id":"components/examples/Lookup_shipment_example","value":[{"match_mode":"EQUALS","key":"CLIENT","value":"001"},{"match_mode":"EQUALS","key":"MBL","value":"MASTER_12345"},{"match_mode":"EQUALS","key":"DIRECTION","value":"E"},{"match_mode":"EQUALS","key":"MODE_OF_TRANSPORT","value":"SEA"}]},"components/examples/Shipment_lookup_example_object":{"id":"components/examples/Shipment_lookup_example_object","value":{"id":327410,"client":"001","direction":"E","office":"BRE","employees":{"closed_employee_matchcode":null,"last_modified_employee_matchcode":"cargo","created_employee_matchcode":"cargo","responsible_employee_matchcode":"cargo"},"memos":[],"aes":[],"shipment_number":"0111230300003","master_reference":null,"house_reference":"0111230300003","bl_type":"HBL","mode_of_transport":"SEA","month_of_service":"202402","total_packages":1,"total_gross_weight":1,"self_pickup":"N","self_delivery":"N","goods":[],"addresses":[{"qualifier":"AGT","address_type":"G","address_number":909524,"printed_address":{"line_1":"Daniel Turkoane","line_2":"Faktorsgatan 5","line_3":null,"line_4":"S 25246 Helsingborg","line_5":null},"street":"Faktorsgatan 5","postal_code":"25246","city":"Helsingborg","state":null,"country_matchcode":"SE","un_location_code":null,"contact":null,"references":[]},{"qualifier":"CAR","address_type":"G","address_number":8923,"printed_address":{"line_1":"Jumbo Transport A/S","line_2":"Lokesvej 8","line_3":null,"line_4":"DK 8230 ABYHOJ","line_5":null},"street":"Lokesvej 8","postal_code":"8230","city":"ABYHOJ","state":null,"country_matchcode":"DK","un_location_code":null,"contact":null,"references":[]},{"qualifier":"CNE","address_type":"D","address_number":1030,"printed_address":{"line_1":"Max Mustermann","line_2":"Hollywood Blvd.","line_3":"90245 Los Angeles","line_4":null,"line_5":null},"street":"Hollywood Blvd.","postal_code":"90245","city":"Los Angeles","state":null,"country_matchcode":"US","un_location_code":"USLAX","contact":null,"references":[]},{"qualifier":"CUS","address_type":"K","address_number":111111,"printed_address":{"line_1":"MAERSK","line_2":null,"line_3":"HAMBURG","line_4":null,"line_5":null},"street":null,"postal_code":null,"city":"HAMBURG","state":null,"country_matchcode":"DE","un_location_code":null,"contact":null,"references":[]},{"qualifier":"PUP","address_type":"D","address_number":1030,"printed_address":{"line_1":"Max Mustermann","line_2":"Hollywood Blvd.","line_3":"90245 Los Angeles","line_4":null,"line_5":null},"street":"Hollywood Blvd.","postal_code":"90245","city":"Los Angeles","state":null,"country_matchcode":"US","un_location_code":"USLAX","contact":null,"references":[]},{"qualifier":"SHP","address_type":"D","address_number":1030,"printed_address":{"line_1":"CargoSoft GmbH1 e-logistic solutions inf","line_2":"Bremen 28199 28357 Postfach POST4711 HB","line_3":"D Buschhöhe 10a +49 (421) 122-225-444","line_4":"+49 (421) 122-225-288 etr j765j655ju u65","line_5":"DE DE987654321 nicht !1ss cscs"},"street":"Buschhöhe 10a","postal_code":"28357","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"id":10182,"matchcode":"DEF","value":"Testreferenz 123","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"CARRIER","address_type":"K","address_number":111111,"printed_address":null,"street":null,"postal_code":null,"city":null,"state":null,"country_matchcode":null,"un_location_code":null,"contact":null,"references":[]}],"pre_carriage":{"carriage_legs":[{"mot":"ANY","origin":{"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-05","time":"10:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2025-11-01","time":null,"zone_offset":null},"revised_datetime":null,"estimated_datetime_until":null},"destination":{"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"10:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"11:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"leg_no":1,"haulage_type":null,"haulage_reference":null}]},"main_carriage":{"carriage_legs":[{"mot":"SEA","origin":{"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"10:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"11:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"destination":{"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"19:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"leg_no":1,"voyage_no":null,"imo_code":null,"vessel_name":null,"vessel_flag":null,"call_sign":null}]},"post_carriage":{"carriage_legs":[{"mot":"ANY","origin":{"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"19:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"destination":{"location":{"codes":[{"type":"UNLOC","code":"NLAMS"}],"name":"Amsterdam","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-07","time":"15:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-07","time":"16:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"leg_no":1,"haulage_type":null,"haulage_reference":null}]},"events":[{"event":"PICKUP","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2025-11-01","time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"PICKUP","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-05","time":"10:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"POL_ARRIVAL","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-05","time":"16:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POL_ARRIVAL","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-05","time":"15:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_START","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_START","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_END","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_END","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POL_DEPARTURE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"11:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POL_DEPARTURE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"10:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POD_ARRIVAL","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"POD_ARRIVAL","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"19:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_START","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"21:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_START","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_END","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"22:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_END","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"21:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CUSTOMS_CLEARANCE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CUSTOMS_CLEARANCE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"AVAILABLE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"09:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"AVAILABLE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"09:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"ACCEPTANCE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"ACCEPTANCE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"FINAL_DESTINATION","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"16:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLAMS"}],"name":"Amsterdam","latitude":null,"longitude":null}},{"event":"FINAL_DESTINATION","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"15:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLAMS"}],"name":"Amsterdam","latitude":null,"longitude":null}},{"event":"POL_DEPARTURE_REVISED","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POD_ARRIVAL_REVISED","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}}],"terms_of_delivery_matchcode":"FOB","terms_of_delivery_name":"FOB Bremerhaven","total_volume":1,"chargeableWeight":0,"original_shipment_number":"33030","foreign_id":null,"movement_matchcode":null,"insurance":{"waiver_customer":null,"insurable_value":null,"insurable_value_currency_matchcode":"EUR","value_of_goods":null,"value_of_goods_currency_matchcode":"EUR","insurance_text":null,"transport_insurance":false,"insurance_type":null,"insurer":null},"credit_data":null,"customs_data":null,"containers":[],"custom_fields":[],"last_modified_date_time":"2023-03-06T16:00:12","created_date_time":"2023-03-06T16:00:12","order_date_time":"2023-03-06T00:00:00","project_matchcode":null}},"components/examples/Retrieve_shipment_airfright_carriage_export_example":{"id":"components/examples/Retrieve_shipment_airfright_carriage_export_example","value":[{"origin":{"location":{"codes":[{"type":"IATA","code":"BRE"}],"name":"Bremen","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-11-17","time":"13:00:00","zone_offset":"+01:00"},"actual_datetime":{"date":"2023-11-17","time":"13:30:00","zone_offset":"+01:00"}},"destination":{"location":{"codes":[{"type":"IATA","code":"FRA"}],"name":null,"latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-11-18","time":"05:00:00","zone_offset":"+01:00"},"actual_datetime":{"date":"2023-11-18","time":"05:15:00","zone_offset":"+01:00"}},"leg_no":1,"flight_no":"985472","airline_awb_code":"438577456345","airline_name":"AC"},{"origin":{"location":{"codes":[{"type":"IATA","code":"FRA"}],"name":null,"latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-11-22","time":"18:00:00","zone_offset":"+01:00"},"actual_datetime":{"date":"2023-11-18","time":"18:45:00","zone_offset":"+01:00"}},"destination":{"location":{"codes":[{"type":"IATA","code":"NYC"}],"name":null,"latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-11-19","time":null,"zone_offset":null},"actual_datetime":{"date":"2023-11-19","time":null,"zone_offset":null}},"leg_no":2,"flight_no":"837265437","airline_awb_code":"438577456345","airline_name":"AC"}]},"components/examples/Retrieve_shipment_airfright_carriage_import_example":{"id":"components/examples/Retrieve_shipment_airfright_carriage_import_example","value":[{"origin":{"location":{"codes":[{"type":"IATA","code":"NYC"}],"name":null,"latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-12-17","time":"10:00:00","zone_offset":null},"actual_datetime":{"date":"2023-12-17","time":"10:30:00","zone_offset":null}},"destination":{"location":{"codes":[{"type":"IATA","code":"FRA"}],"name":null,"latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-11-18","time":"03:00:00","zone_offset":"+01:00"},"actual_datetime":{"date":"2023-11-18","time":"03:15:00","zone_offset":"+01:00"}},"leg_no":1,"flight_no":"3456","airline_awb_code":"84576826534","airline_name":"LH"}]},"components/examples/Retrieve_shipment_events_example":{"id":"components/examples/Retrieve_shipment_events_example","value":[{"event":"PICKUP","type":"ACTUAL","shipment_id":318283,"date_time":{"date":"2023-01-21","time":"13:00:00","zone_offset":"+01:00"},"location":{"codes":[{"type":"UNLOC","code":"DEBRE"},{"type":"CARGOSOFT","code":"DEBRE"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"PICKUP","type":"ESTIMATED","shipment_id":318283,"date_time":{"date":"2023-01-21","time":"09:00:00","zone_offset":"+01:00"},"location":{"codes":[{"type":"UNLOC","code":"DEBRE"},{"type":"CARGOSOFT","code":"DEBRE"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"POL_ARRIVAL","type":"ACTUAL","shipment_id":318283,"date_time":{"date":"2023-01-23","time":"11:00:00","zone_offset":"+01:00"},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"HAMBURG","latitude":null,"longitude":null}},{"event":"POL_ARRIVAL","type":"ESTIMATED","shipment_id":318283,"date_time":{"date":"2023-01-23","time":"10:00:00","zone_offset":"+01:00"},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"HAMBURG","latitude":null,"longitude":null}}]},"components/examples/Shipment_event_example_object":{"id":"components/examples/Shipment_event_example_object","value":{"event":"PICKUP","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2025-10-01","time":"12:00:00","zone_offset":"+02:00"},"location":{"codes":[{"type":"UNLOC","code":"DEBRE"}],"name":"BREMEN","latitude":null,"longitude":null}}},"components/examples/Shipment_event_update_example":{"id":"components/examples/Shipment_event_update_example","value":{"event":"PICKUP","type":"ACTUAL","date_time":{"date":"2025-10-01"}}},"components/examples/Lookup_shipmentmemo_example":{"id":"components/examples/Lookup_shipmentmemo_example","value":[{"match_mode":"EQUALS","key":"CLIENT","value":"001"},{"match_mode":"EQUALS","key":"SHIPMENT_NUMBER","value":"BRUNOTEST0001"}]},"components/examples/ShipmentMemo_lookup_example_object":{"id":"components/examples/ShipmentMemo_lookup_example_object","value":[{"id":4711,"client":"001","shipment_number":"BRUNOTEST0001","running_number":1,"memo":"Handle with care - fragile goods, keep upright at all times."}]},"components/examples/Create_provider_status_example":{"id":"components/examples/Create_provider_status_example","value":{"provider_status":"EXPECTED_ARRIVAL","status_date_and_time":{"date":"2026-11-02","time":"10:15:00","zone_offset":"+01:00"},"additional_information":"Estimated arrival updated by customer integration","unique_provider_message_number":"STATUS-2026-000123","status_events":[{"type":"STATUS","date_and_time":{"date":"2026-11-04","time":"08:30:00","zone_offset":"+01:00"},"event_date_type":"ESTIMATED"}],"references":[{"type":"CLIENT","reference":"001"},{"type":"SHIPMENT_NUMBER","reference":"022120300004"},{"type":"PROVIDER","reference":"CUSTOMER_API"}],"identifiers":[]}},"paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/requestBody/content/application~1json/examples/LookupCodeConverterIdentifierExample":{"value":[{"match_mode":"EQUALS","key":"EDIPARTNER","value":"SAMPLEPARTNER"},{"match_mode":"EQUALS","key":"DIRECTION","value":"E"},{"match_mode":"EQUALS","key":"CODETYPE","value":"VERCO_T"}],"key":"LookupCodeConverterIdentifierExample","summary":"LookupCodeConverterIdentifierExample","id":"paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/requestBody/content/application~1json/examples/LookupCodeConverterIdentifierExample"},"paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/responses/200/content/application~1json/examples/CodeConvertionExample":{"value":[{"id":4711,"client":"001","edipartner":"SAMPLEPARTNER","direction":"RECEIVE","code_type":"VERCO_T","source_code":"BX","target_code":"10"}],"key":"CodeConvertionExample","summary":"CodeConvertionExample","id":"paths/~1cargosoft~1basicdata~1codeconverter~1lookup/post/responses/200/content/application~1json/examples/CodeConvertionExample"},"paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleCollis":{"value":{"edipartner_matchcode":"EDIPARTNER","client":"DE4","direction":"E","office":"BRE","employees":{"created_employee_matchcode":"cargo"},"house_reference":"20260901102536","bl_type":"HBL","mode_of_transport":"SEA","month_of_service":"202609","goods":[{"measurements":[],"customs":[],"mrns":[],"subgoods":[],"dangerousGoods":[],"identifier":"M","counter":1,"level":1,"level_number":0,"marks":[],"quantity":5,"packaging_matchcode":"PL","commodity_matchcode":"0077","description":["BIER"],"weight":5500,"colli":true,"colli_number":1,"volume":null,"volume_unit":"cbm","additional_mark":false,"net_weight":4500,"weight_unit":"k","chargable_weight":null,"container_number":null,"container":false,"hs_codes":[]},{"measurements":[],"customs":[],"mrns":[],"subgoods":[],"dangerousGoods":[],"identifier":"M","counter":2,"level":1,"level_number":0,"marks":[],"quantity":5,"packaging_matchcode":"KT","commodity_matchcode":"0061","description":["BATTERIEN"],"weight":4800,"colli":true,"colli_number":2,"volume":null,"volume_unit":"cbm","additional_mark":false,"net_weight":4300,"weight_unit":"k","chargable_weight":null,"container_number":null,"container":false,"hs_codes":[]}],"addresses":[{"qualifier":"SHP","address_type":"G","address_number":1,"printed_address":{"line_1":"CargoSoft GmbH","line_2":"Buschhöhe 10","line_3":"28359 Bremen","line_4":"Deutschland","line_5":null},"street":"Buschhöhe 10","postal_code":"28359","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"matchcode":null,"value":"ShipperRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"CNE","address_type":"G","address_number":2,"printed_address":{"line_1":"AROY-D","line_2":"45/1-2 Phra Athit Rd, Chana Songkhram","line_3":"10200 Bangkok","line_4":"THAILAND","line_5":null},"street":"45/1-2 Phra Athit Rd, Chana Songkhram","postal_code":"10200","city":"Bangkok","state":null,"country_matchcode":"TH","un_location_code":"THBKK","contact":null,"references":[{"matchcode":null,"value":"ConsigneeRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"NFY","address_type":"G","address_number":3,"printed_address":{"line_1":"Thailand DES-Agent Bangkok","line_2":"Trad Road Km 15 Rachathewa","line_3":"10540 Bangkok","line_4":"THAILAND","line_5":null},"street":"Trad Road Km 15 Rachathewa","postal_code":"10540","city":"Bangkok","state":null,"country_matchcode":"TH","un_location_code":"THBKK","contact":null,"references":[{"matchcode":null,"value":"NotifyRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"AGT","address_type":"G","address_number":4,"printed_address":{"line_1":"Thailand DES-Agent Surat Thani","line_2":"Hua Toei, Amphoe Phunphin","line_3":"10545 Surat Thani","line_4":"THAILAND","line_5":null},"street":"Hua Toei, Amphoe Phunphin","postal_code":"10545","city":"Surat Thani","state":null,"country_matchcode":"TH","un_location_code":"THURT","contact":null,"references":[{"matchcode":null,"value":"AgentRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"CAR","address_type":"G","address_number":5,"printed_address":{"line_1":"Adresse für ADRESSVORSCHLAG","line_2":"Adresse für ADRESSVORSCHLAG","line_3":"Straßenname 123","line_4":"28359 Bremen","line_5":"Deutschland"},"street":"Straßenname 123","postal_code":"28359","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"matchcode":null,"value":"CarrierRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"TRA","address_type":"G","address_number":6,"printed_address":{"line_1":"EKB Container Logistik GmbH & Co. KG","line_2":"Container- und Frachtguttransporte","line_3":"Richard-Dunkel-Straße 120","line_4":"28819 Bremen","line_5":"Deutschland"},"street":"Richard-Dunkel-Straße 120","postal_code":"28819","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"matchcode":null,"value":"TerminalInRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"TML","address_type":"G","address_number":7,"printed_address":{"line_1":"Addicks & Kreye Container Service GmbH","line_2":"Windhukstraße 20-26","line_3":"28237 Bremen","line_4":"Deutschland","line_5":null},"street":"Windhukstraße 20-26","postal_code":"28237","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"matchcode":null,"value":"TruckerRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"PUP","address_type":"G","address_number":8,"printed_address":{"line_1":"AHS Bremen Aviation","line_2":"Handling Services GmbH","line_3":"Terminal 1, Flughafenallee 21","line_4":"28199 Bremen","line_5":"Deutschland"},"street":"Terminal 1, Flughafenallee 21","postal_code":"28199","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"matchcode":null,"value":"TerminalOutRef","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"CSTOP","address_type":"G","address_number":9,"printed_address":{"line_1":"Miscellaneous GmbH & Co KG","line_2":"Sonstige Güter","line_3":"Am Wall 207","line_4":"28195 Bremen","line_5":"Deutschland"},"street":"Am Wall 207","postal_code":"28195","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"matchcode":null,"value":"TerminalAdresse9Ref","date_and_time":{"date":null,"time":null,"zone_offset":null}}]}],"order_date_time":"2026-09-22T07:25:36","maindepartment":"HB","subdepartment":"EX"},"key":"CreateShipmentRequestExampleCollis","summary":"CreateShipmentRequestExampleCollis","id":"paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleCollis"},"paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleContainer":{"value":{"edipartner_matchcode":"COCACOLA","client":"DE4","direction":"E","office":"BRE","employees":{"created_employee_matchcode":"cargo"},"house_reference":"WARENBESCHREIBUNG","bl_type":"HBL","mode_of_transport":"SEA","month_of_service":"202609","goods":[{"measurements":[],"customs":[],"mrns":[],"subgoods":[{"measurements":[],"customs":[],"mrns":[],"subgoods":[],"dangerousGoods":[],"identifier":"M","counter":1,"level":2,"level_number":1000000,"marks":[],"quantity":5,"packaging_matchcode":"PL","commodity_matchcode":"0077","description":["BIER"],"weight":5800,"colli":true,"colli_number":1,"volume":null,"volume_unit":"cbm","additional_mark":false,"net_weight":5000,"weight_unit":"k","chargable_weight":null,"container_number":null,"container":false,"hs_codes":[]},{"measurements":[],"customs":[],"mrns":[],"subgoods":[],"dangerousGoods":[],"identifier":"M","counter":2,"level":2,"level_number":1000000,"marks":[],"quantity":5,"packaging_matchcode":"PL","commodity_matchcode":"0064","description":["BAUMWOLLE/-ABFAELLE"],"weight":4900,"colli":true,"colli_number":2,"volume":null,"volume_unit":"cbm","additional_mark":false,"net_weight":4450,"weight_unit":"k","chargable_weight":null,"container_number":null,"container":false,"hs_codes":[]}],"dangerousGoods":[],"identifier":"M","counter":1,"level":1,"level_number":0,"marks":["MSKU 235 125-2"],"quantity":1,"packaging_matchcode":"C2","commodity_matchcode":null,"description":["SAID TO CONTAIN"],"weight":12500,"colli":true,"colli_number":1,"volume":null,"volume_unit":"cbm","additional_mark":false,"net_weight":10500,"weight_unit":"k","chargable_weight":null,"container_number":"MSKU2351252","container":true,"hs_codes":[]}],"order_date_time":"2026-09-22T07:25:36","maindepartment":"HB","subdepartment":"EX"},"key":"CreateShipmentRequestExampleContainer","summary":"CreateShipmentRequestExampleContainer","id":"paths/~1cargosoft~1shipment/post/requestBody/content/application~1json/examples/CreateShipmentRequestExampleContainer"},"paths/~1cargosoft~1shipment/post/responses/200/content/application~1json/examples/CreateShipmentResponseExample":{"value":{"id":327410,"client":"001","direction":"E","office":"BRE","employees":{"closed_employee_matchcode":null,"last_modified_employee_matchcode":"cargo","created_employee_matchcode":"cargo","responsible_employee_matchcode":"cargo"},"edipartner_matchcode":"SAMPLEPARTNER","memos":[],"aes":[],"addon_fields":[{"addonfield_matchcode":"CUSTOMS_REFERENCE","value":"REF-4711"}],"dangerous_goods":true,"shipment_number":"0111230300003","master_reference":null,"house_reference":"0111230300003","order_type":null,"bl_type":"HBL","mode_of_transport":"SEA","month_of_service":"202402","total_packages":1,"total_gross_weight":1,"self_pickup":"N","self_delivery":"N","goods":[{"measurements":[],"customs":[],"mrns":[],"subgoods":[{"measurements":[{"id":8384,"client":"001","counter":1,"weight":null,"length":100,"width":100,"height":100,"quantity":1,"goods_dto":970652,"shipment_number":"0111230300003","weight_unit":"kg","volume":1,"volume_unit":"cbm","measurement_unit":"cm"}],"customs":[],"mrns":[],"subgoods":[],"dangerousGoods":[{"id":11030,"client":"001","goods_dto":970652,"dangerous_good_legislation":"IMDG","classification_code":null,"un_number":"0121","release":"","label_1":null,"label_2":null,"label_3":null,"label_4":null,"site":null,"flashpoint":null,"flashpoint_unit":null,"ems_number_1":"F-B","ems_number_2":"S-X","mfag_number_1":null,"mfag_number_2":null,"remarks":null,"authorisation_number":null,"packaging_group":null,"technical_name_1":"IGNITERS","technical_name_2":null,"causing_substance_1":"Fire","causing_substance_2":null,"issuer":"CargoSoft GmbH","net_weight":1,"weight_unit":"k","gross_weight":1.5,"contact":null}],"id":970652,"client":"001","shipment_number":"0111230300003","identifier":"M","counter":1,"level":2,"level_number":1000000,"marks":[],"quantity":100,"packaging_matchcode":"KT","commodity_matchcode":null,"description":["Playstation 5"],"weight":1,"colli":true,"colli_number":1,"volume":1,"volume_unit":"cbm","additional_mark":false,"net_weight":1,"weight_unit":"k","chargable_weight":null,"container_number":null,"container":false,"hs_codes":[{"id":6952,"client":"001","hsCode":"12345","goods_dto":970652}]}],"dangerousGoods":[],"id":970650,"client":"001","shipment_number":"0111230300003","identifier":"M","counter":1,"level":1,"level_number":0,"marks":["SUDU 222 222-2"],"quantity":1,"packaging_matchcode":"C4","commodity_matchcode":null,"description":[],"weight":null,"colli":true,"colli_number":1,"volume":null,"volume_unit":"cbm","additional_mark":false,"net_weight":null,"weight_unit":"k","chargable_weight":null,"container_number":"SUDU2222222","container":true,"hs_codes":[]}],"addresses":[{"qualifier":"AGT","address_type":"G","address_number":909524,"printed_address":{"line_1":"Daniel Turkoane","line_2":"Faktorsgatan 5","line_3":null,"line_4":"S 25246 Helsingborg","line_5":null,"line_6":null},"street":"Faktorsgatan 5","postal_code":"25246","city":"Helsingborg","state":null,"country_matchcode":"SE","un_location_code":null,"contact":{"name":null,"phone_number":null,"fax_number":"olaf test xxxxxxxxxx0111230300003","email":null},"references":[]},{"qualifier":"CAR","address_type":"G","address_number":8923,"printed_address":{"line_1":"Jumbo Transport A/S","line_2":"Lokesvej 8","line_3":null,"line_4":"DK 8230 ABYHOJ","line_5":null,"line_6":null},"street":"Lokesvej 8","postal_code":"8230","city":"ABYHOJ","state":null,"country_matchcode":"DK","un_location_code":null,"contact":{"name":null,"phone_number":null,"fax_number":"olaf test xxxxxxxxxx0111230300003","email":null},"references":[]},{"qualifier":"CNE","address_type":"D","address_number":1030,"printed_address":{"line_1":"Max Mustermann","line_2":"Hollywood Blvd.","line_3":"90245 Los Angeles","line_4":null,"line_5":null,"line_6":null},"street":"Hollywood Blvd.","postal_code":"90245","city":"Los Angeles","state":null,"country_matchcode":"US","un_location_code":"USLAX","contact":null,"references":[]},{"qualifier":"CUS","address_type":"K","address_number":111111,"printed_address":{"line_1":"MAERSK","line_2":null,"line_3":"HAMBURG","line_4":null,"line_5":null,"line_6":null},"street":null,"postal_code":null,"city":"HAMBURG","state":null,"country_matchcode":"DE","un_location_code":null,"contact":null,"references":[]},{"qualifier":"PUP","address_type":"D","address_number":1030,"printed_address":{"line_1":"Max Mustermann","line_2":"Hollywood Blvd.","line_3":"90245 Los Angeles","line_4":null,"line_5":null,"line_6":null},"street":"Hollywood Blvd.","postal_code":"90245","city":"Los Angeles","state":null,"country_matchcode":"US","un_location_code":"USLAX","contact":null,"references":[]},{"qualifier":"SHP","address_type":"D","address_number":1030,"printed_address":{"line_1":"CargoSoft GmbH1 e-logistic solutions inf","line_2":"Bremen 28199 28357 Postfach POST4711 HB","line_3":"D Buschhöhe 10a +49 (421) 122-225-444","line_4":"+49 (421) 122-225-288 etr j765j655ju u65","line_5":"DE DE987654321 nicht !1ss cscs","line_6":null},"street":"Buschhöhe 10a","postal_code":"28357","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"id":10182,"matchcode":"DEF","value":"Testreferenz 123","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"CARRIER","address_type":"K","address_number":111111,"printed_address":null,"street":null,"postal_code":null,"city":null,"state":null,"country_matchcode":null,"un_location_code":null,"contact":null,"references":[]}],"pre_carriage":{"carriage_legs":[{"mot":"ANY","origin":{"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-05","time":"10:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-10-01","time":"11:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"destination":{"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"10:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"11:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"leg_no":1,"haulage_type":null,"haulage_reference":null}]},"main_carriage":{"carriage_legs":[{"mot":"SEA","origin":{"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"10:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"11:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"destination":{"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"19:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"leg_no":1,"voyage_no":null,"imo_code":null,"vessel_name":null,"vessel_flag":null,"call_sign":null}]},"post_carriage":{"carriage_legs":[{"mot":"ANY","origin":{"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"19:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"destination":{"location":{"codes":[{"type":"UNLOC","code":"NLAMS"}],"name":"Amsterdam","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-07","time":"15:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-07","time":"16:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"leg_no":1,"haulage_type":null,"haulage_reference":null}]},"events":[{"event":"DISPATCH","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"DISPATCH","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"PICKUP","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-10-01","time":"11:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"PICKUP","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-05","time":"10:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"WAREHOUSE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"WAREHOUSE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"POL_ARRIVAL","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-05","time":"16:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POL_ARRIVAL","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-05","time":"15:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_START","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_START","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_END","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_END","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POL_DEPARTURE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"11:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POL_DEPARTURE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"10:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POD_ARRIVAL","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"POD_ARRIVAL","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"19:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_START","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"21:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_START","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_END","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"22:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_END","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"21:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CUSTOMS_CLEARANCE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CUSTOMS_CLEARANCE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"AVAILABLE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"09:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"AVAILABLE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"09:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"ACCEPTANCE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"ACCEPTANCE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"FINAL_DESTINATION","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"16:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLAMS"}],"name":"Amsterdam","latitude":null,"longitude":null}},{"event":"FINAL_DESTINATION","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"15:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLAMS"}],"name":"Amsterdam","latitude":null,"longitude":null}},{"event":"POL_DEPARTURE_REVISED","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POD_ARRIVAL_REVISED","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}}],"terms_of_delivery_matchcode":"FOB","terms_of_delivery_name":"FOB Bremerhaven","total_volume":1,"chargeableWeight":0,"original_shipment_number":"33030","foreign_id":null,"movement_matchcode":null,"insurance":{"waiver_customer":null,"insurable_value":null,"insurable_value_currency_matchcode":"EUR","value_of_goods":null,"value_of_goods_currency_matchcode":"EUR","insurance_text":null,"transport_insurance":false,"insurance_type":null,"insurer":null},"credit_data":null,"customs_data":null,"containers":[{"containerAddresses":[{"id":11423,"qualifier":"SHP","street":"Buschhöhe 10a","city":"Bremen","order":1,"references":[],"address_type":"D","address_number":1030,"printed_address":{"line_1":"CargoSoft GmbH1 e-logistic solutions inf","line_2":"Bremen 28199 28357 Postfach POST4711 HB","line_3":"D Buschhöhe 10a +49 (421) 122-225-444","line_4":null,"line_5":null,"line_6":null},"postal_code":"28357","country_matchcode":"DE","un_location_code":"DEBRE","from_date_and_time":null,"to_date_and_time":null,"contact":null},{"id":11424,"qualifier":"CNE","street":"Hollywood Blvd.","city":"Los Angeles","order":2,"references":[],"address_type":"D","address_number":100,"printed_address":{"line_1":"Max Mustermann","line_2":"Hollywood Blvd.","line_3":"90245 Los Angeles","line_4":null,"line_5":null,"line_6":null},"postal_code":"90245","country_matchcode":"US","un_location_code":"USLAX","from_date_and_time":null,"to_date_and_time":null,"contact":null},{"id":11425,"qualifier":"PUP","street":"Hollywood Blvd.","city":"Los Angeles","order":3,"references":[],"address_type":"D","address_number":100,"printed_address":{"line_1":"Max Mustermann","line_2":"Hollywood Blvd.","line_3":"90245 Los Angeles","line_4":null,"line_5":null,"line_6":null},"postal_code":"90245","country_matchcode":"US","un_location_code":"USLAX","from_date_and_time":null,"to_date_and_time":null,"contact":null}],"id":24720,"good_id":970650,"client":"001","shipment_number":"0111230300003","container_number":"SUDU2222222","seal_number1":null,"seal_number2":null,"seal_number3":null,"container_iso_code":"40G0","reefer_temperature":null,"reefer_temperature_lower_bound":null,"reefer_temperature_upper_bound":null,"reefer_temperature_unit":null,"shippers_own":false,"addon_fields":[{"addonfield_matchcode":"CUSTOMS_REFERENCE","value":"CONTAINER-REF-4711"}]}],"custom_fields":[{"id":197235,"client":"001","value":null,"shipment_number":"0111230300003","running_number":16}],"last_modified_date_time":"2026-09-07T15:27:58","created_date_time":"2026-09-07T15:27:58","order_date_time":"2023-03-06T00:00:00","project_matchcode":null,"depot_matchcode":null,"shipment_closed":false,"booking_party_address_qualifier":"SHP","full_container_load":true,"shipment_number_definition_version":null,"maindepartment":"01","subdepartment":"11","vehicle_temperature_code":"COOL","calculations":[{"voucher_type":"R","invoice_party":{"address_type":"D","address_number":1030},"billing_category_matchcode":"FRT","billing_text_line1":"Ocean freight","billing_text_line2":null,"billing_text_line3":null,"billing_text_line4":null,"billing_text_line5":null,"total_amount":250,"quantity":1,"single_amount":250,"measure_unit_matchcode":null,"currency_matchcode":"EUR","exchange_rate":1,"origin":{"location_type":"UNLOC","location_code":"DEBRV","location_name":"Bremerhaven","location_country":"DE"},"destination":{"location_type":"UNLOC","location_code":"NLRTM","location_name":"Rotterdam","location_country":"NL"},"collect_prepaid":"P","contract_number":null,"quotation_number":null,"ecm_booking":false,"ordering":1}]},"key":"CreateShipmentResponseExample","summary":"CreateShipmentResponseExample","id":"paths/~1cargosoft~1shipment/post/responses/200/content/application~1json/examples/CreateShipmentResponseExample"},"paths/~1cargosoft~1shipment~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentIdentifierExample":{"value":[{"match_mode":"EQUALS","key":"CLIENT","value":"001"},{"match_mode":"EQUALS","key":"MBL","value":"MASTER_12345"},{"match_mode":"EQUALS","key":"DIRECTION","value":"E"},{"match_mode":"EQUALS","key":"MODE_OF_TRANSPORT","value":"SEA"}],"key":"LookupShipmentIdentifierExample","summary":"LookupShipmentIdentifierExample","id":"paths/~1cargosoft~1shipment~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentIdentifierExample"},"paths/~1cargosoft~1shipment~1lookup/post/responses/200/content/application~1json/examples/ShipmentExample":{"value":{"id":327410,"client":"001","direction":"E","office":"BRE","employees":{"closed_employee_matchcode":null,"last_modified_employee_matchcode":"cargo","created_employee_matchcode":"cargo","responsible_employee_matchcode":"cargo"},"memos":[],"aes":[],"shipment_number":"0111230300003","master_reference":null,"house_reference":"0111230300003","bl_type":"HBL","mode_of_transport":"SEA","month_of_service":"202402","total_packages":1,"total_gross_weight":1,"self_pickup":"N","self_delivery":"N","goods":[],"addresses":[{"qualifier":"AGT","address_type":"G","address_number":909524,"printed_address":{"line_1":"Daniel Turkoane","line_2":"Faktorsgatan 5","line_3":null,"line_4":"S 25246 Helsingborg","line_5":null},"street":"Faktorsgatan 5","postal_code":"25246","city":"Helsingborg","state":null,"country_matchcode":"SE","un_location_code":null,"contact":null,"references":[]},{"qualifier":"CAR","address_type":"G","address_number":8923,"printed_address":{"line_1":"Jumbo Transport A/S","line_2":"Lokesvej 8","line_3":null,"line_4":"DK 8230 ABYHOJ","line_5":null},"street":"Lokesvej 8","postal_code":"8230","city":"ABYHOJ","state":null,"country_matchcode":"DK","un_location_code":null,"contact":null,"references":[]},{"qualifier":"CNE","address_type":"D","address_number":1030,"printed_address":{"line_1":"Max Mustermann","line_2":"Hollywood Blvd.","line_3":"90245 Los Angeles","line_4":null,"line_5":null},"street":"Hollywood Blvd.","postal_code":"90245","city":"Los Angeles","state":null,"country_matchcode":"US","un_location_code":"USLAX","contact":null,"references":[]},{"qualifier":"CUS","address_type":"K","address_number":111111,"printed_address":{"line_1":"MAERSK","line_2":null,"line_3":"HAMBURG","line_4":null,"line_5":null},"street":null,"postal_code":null,"city":"HAMBURG","state":null,"country_matchcode":"DE","un_location_code":null,"contact":null,"references":[]},{"qualifier":"PUP","address_type":"D","address_number":1030,"printed_address":{"line_1":"Max Mustermann","line_2":"Hollywood Blvd.","line_3":"90245 Los Angeles","line_4":null,"line_5":null},"street":"Hollywood Blvd.","postal_code":"90245","city":"Los Angeles","state":null,"country_matchcode":"US","un_location_code":"USLAX","contact":null,"references":[]},{"qualifier":"SHP","address_type":"D","address_number":1030,"printed_address":{"line_1":"CargoSoft GmbH1 e-logistic solutions inf","line_2":"Bremen 28199 28357 Postfach POST4711 HB","line_3":"D Buschhöhe 10a +49 (421) 122-225-444","line_4":"+49 (421) 122-225-288 etr j765j655ju u65","line_5":"DE DE987654321 nicht !1ss cscs"},"street":"Buschhöhe 10a","postal_code":"28357","city":"Bremen","state":null,"country_matchcode":"DE","un_location_code":"DEBRE","contact":null,"references":[{"id":10182,"matchcode":"DEF","value":"Testreferenz 123","date_and_time":{"date":null,"time":null,"zone_offset":null}}]},{"qualifier":"CARRIER","address_type":"K","address_number":111111,"printed_address":null,"street":null,"postal_code":null,"city":null,"state":null,"country_matchcode":null,"un_location_code":null,"contact":null,"references":[]}],"pre_carriage":{"carriage_legs":[{"mot":"ANY","origin":{"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-05","time":"10:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2025-11-01","time":null,"zone_offset":null},"revised_datetime":null,"estimated_datetime_until":null},"destination":{"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"10:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"11:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"leg_no":1,"haulage_type":null,"haulage_reference":null}]},"main_carriage":{"carriage_legs":[{"mot":"SEA","origin":{"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"10:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"11:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"destination":{"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"19:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"leg_no":1,"voyage_no":null,"imo_code":null,"vessel_name":null,"vessel_flag":null,"call_sign":null}]},"post_carriage":{"carriage_legs":[{"mot":"ANY","origin":{"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-06","time":"19:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"destination":{"location":{"codes":[{"type":"UNLOC","code":"NLAMS"}],"name":"Amsterdam","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-03-07","time":"15:00:00","zone_offset":"+02:00"},"actual_datetime":{"date":"2023-03-07","time":"16:00:00","zone_offset":"+02:00"},"revised_datetime":null,"estimated_datetime_until":null},"leg_no":1,"haulage_type":null,"haulage_reference":null}]},"events":[{"event":"PICKUP","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2025-11-01","time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"PICKUP","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-05","time":"10:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"POL_ARRIVAL","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-05","time":"16:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POL_ARRIVAL","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-05","time":"15:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_START","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_START","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_END","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"LOADING_END","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POL_DEPARTURE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"11:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POL_DEPARTURE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"10:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POD_ARRIVAL","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"POD_ARRIVAL","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"19:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_START","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"21:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_START","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"20:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_END","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"22:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CLEARANCE_END","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-06","time":"21:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CUSTOMS_CLEARANCE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"CUSTOMS_CLEARANCE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"AVAILABLE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"09:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"AVAILABLE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"09:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"ACCEPTANCE","type":"ACTUAL","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"ACCEPTANCE","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}},{"event":"FINAL_DESTINATION","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"16:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLAMS"}],"name":"Amsterdam","latitude":null,"longitude":null}},{"event":"FINAL_DESTINATION","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":"2023-03-07","time":"15:00:00","zone_offset":"+02:00","until":null},"location":{"codes":[{"type":"UNLOC","code":"NLAMS"}],"name":"Amsterdam","latitude":null,"longitude":null}},{"event":"POL_DEPARTURE_REVISED","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"DEBRV"}],"name":"Bremerhaven","latitude":null,"longitude":null}},{"event":"POD_ARRIVAL_REVISED","type":"ESTIMATED","shipment_id":327410,"date_time":{"date":null,"time":null,"zone_offset":null,"until":null},"location":{"codes":[{"type":"UNLOC","code":"NLRTM"}],"name":"Rotterdam","latitude":null,"longitude":null}}],"terms_of_delivery_matchcode":"FOB","terms_of_delivery_name":"FOB Bremerhaven","total_volume":1,"chargeableWeight":0,"original_shipment_number":"33030","foreign_id":null,"movement_matchcode":null,"insurance":{"waiver_customer":null,"insurable_value":null,"insurable_value_currency_matchcode":"EUR","value_of_goods":null,"value_of_goods_currency_matchcode":"EUR","insurance_text":null,"transport_insurance":false,"insurance_type":null,"insurer":null},"credit_data":null,"customs_data":null,"containers":[],"custom_fields":[],"last_modified_date_time":"2023-03-06T16:00:12","created_date_time":"2023-03-06T16:00:12","order_date_time":"2023-03-06T00:00:00","project_matchcode":null},"key":"ShipmentExample","summary":"ShipmentExample","id":"paths/~1cargosoft~1shipment~1lookup/post/responses/200/content/application~1json/examples/ShipmentExample"},"paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses/200/content/application~1json/examples/ShipmentAirfreightCarriageExportExample":{"value":[{"origin":{"location":{"codes":[{"type":"IATA","code":"BRE"}],"name":"Bremen","latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-11-17","time":"13:00:00","zone_offset":"+01:00"},"actual_datetime":{"date":"2023-11-17","time":"13:30:00","zone_offset":"+01:00"}},"destination":{"location":{"codes":[{"type":"IATA","code":"FRA"}],"name":null,"latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-11-18","time":"05:00:00","zone_offset":"+01:00"},"actual_datetime":{"date":"2023-11-18","time":"05:15:00","zone_offset":"+01:00"}},"leg_no":1,"flight_no":"985472","airline_awb_code":"438577456345","airline_name":"AC"},{"origin":{"location":{"codes":[{"type":"IATA","code":"FRA"}],"name":null,"latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-11-22","time":"18:00:00","zone_offset":"+01:00"},"actual_datetime":{"date":"2023-11-18","time":"18:45:00","zone_offset":"+01:00"}},"destination":{"location":{"codes":[{"type":"IATA","code":"NYC"}],"name":null,"latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-11-19","time":null,"zone_offset":null},"actual_datetime":{"date":"2023-11-19","time":null,"zone_offset":null}},"leg_no":2,"flight_no":"837265437","airline_awb_code":"438577456345","airline_name":"AC"}],"key":"ShipmentAirfreightCarriageExportExample","summary":"ShipmentAirfreightCarriageExportExample","id":"paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses/200/content/application~1json/examples/ShipmentAirfreightCarriageExportExample"},"paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses/200/content/application~1json/examples/ShipmentAirfreightCarriageImportExample":{"value":[{"origin":{"location":{"codes":[{"type":"IATA","code":"NYC"}],"name":null,"latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-12-17","time":"10:00:00","zone_offset":null},"actual_datetime":{"date":"2023-12-17","time":"10:30:00","zone_offset":null}},"destination":{"location":{"codes":[{"type":"IATA","code":"FRA"}],"name":null,"latitude":null,"longitude":null},"estimated_datetime":{"date":"2023-11-18","time":"03:00:00","zone_offset":"+01:00"},"actual_datetime":{"date":"2023-11-18","time":"03:15:00","zone_offset":"+01:00"}},"leg_no":1,"flight_no":"3456","airline_awb_code":"84576826534","airline_name":"LH"}],"key":"ShipmentAirfreightCarriageImportExample","summary":"ShipmentAirfreightCarriageImportExample","id":"paths/~1cargosoft~1shipment~1{id}~1airmaincarriage/get/responses/200/content/application~1json/examples/ShipmentAirfreightCarriageImportExample"},"paths/~1cargosoft~1shipment~1{id}~1events/get/responses/200/content/application~1json/examples/ShipmentEventExample":{"value":[{"event":"PICKUP","type":"ACTUAL","shipment_id":318283,"date_time":{"date":"2023-01-21","time":"13:00:00","zone_offset":"+01:00"},"location":{"codes":[{"type":"UNLOC","code":"DEBRE"},{"type":"CARGOSOFT","code":"DEBRE"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"PICKUP","type":"ESTIMATED","shipment_id":318283,"date_time":{"date":"2023-01-21","time":"09:00:00","zone_offset":"+01:00"},"location":{"codes":[{"type":"UNLOC","code":"DEBRE"},{"type":"CARGOSOFT","code":"DEBRE"}],"name":"Bremen","latitude":null,"longitude":null}},{"event":"POL_ARRIVAL","type":"ACTUAL","shipment_id":318283,"date_time":{"date":"2023-01-23","time":"11:00:00","zone_offset":"+01:00"},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"HAMBURG","latitude":null,"longitude":null}},{"event":"POL_ARRIVAL","type":"ESTIMATED","shipment_id":318283,"date_time":{"date":"2023-01-23","time":"10:00:00","zone_offset":"+01:00"},"location":{"codes":[{"type":"UNLOC","code":"DEHAM"}],"name":"HAMBURG","latitude":null,"longitude":null}}],"key":"ShipmentEventExample","summary":"ShipmentEventExample","id":"paths/~1cargosoft~1shipment~1{id}~1events/get/responses/200/content/application~1json/examples/ShipmentEventExample"},"paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/requestBody/content/application~1json/examples/ShipmentEventExample":{"value":{"event":"PICKUP","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2025-10-01","time":"12:00:00","zone_offset":"+02:00"},"location":{"codes":[{"type":"UNLOC","code":"DEBRE"}],"name":"BREMEN","latitude":null,"longitude":null}},"key":"ShipmentEventExample","summary":"ShipmentEventExample","id":"paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/requestBody/content/application~1json/examples/ShipmentEventExample"},"paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/responses/200/content/application~1json/examples/ShipmentEventExample":{"value":{"event":"PICKUP","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2025-10-01","time":"12:00:00","zone_offset":"+02:00"},"location":{"codes":[{"type":"UNLOC","code":"DEBRE"}],"name":"BREMEN","latitude":null,"longitude":null}},"key":"ShipmentEventExample","summary":"ShipmentEventExample","id":"paths/~1cargosoft~1shipment~1{shipmentId}~1event/post/responses/200/content/application~1json/examples/ShipmentEventExample"},"paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventUpdateExample":{"value":{"event":"PICKUP","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2025-10-01","time":"12:00:00","zone_offset":"+02:00"},"location":{"codes":[{"type":"UNLOC","code":"DEBRE"}],"name":"BREMEN","latitude":null,"longitude":null}},"key":"ShipmentEventUpdateExample","summary":"ShipmentEventUpdateExample","id":"paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventUpdateExample"},"paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventMinimalUpdateExample":{"value":{"event":"PICKUP","type":"ACTUAL","date_time":{"date":"2025-10-01"}},"key":"ShipmentEventMinimalUpdateExample","summary":"ShipmentEventMinimalUpdateExample","id":"paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/requestBody/content/application~1json/examples/ShipmentEventMinimalUpdateExample"},"paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/responses/200/content/application~1json/examples/ShipmentEventExample":{"value":{"event":"PICKUP","type":"ACTUAL","shipment_id":327410,"date_time":{"date":"2025-10-01","time":"12:00:00","zone_offset":"+02:00"},"location":{"codes":[{"type":"UNLOC","code":"DEBRE"}],"name":"BREMEN","latitude":null,"longitude":null}},"key":"ShipmentEventExample","summary":"ShipmentEventExample","id":"paths/~1cargosoft~1shipment~1{shipmentId}~1event~1{id}/put/responses/200/content/application~1json/examples/ShipmentEventExample"},"paths/~1cargosoft~1shipment~1memo~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentMemoIdentifierExample":{"value":[{"match_mode":"EQUALS","key":"CLIENT","value":"001"},{"match_mode":"EQUALS","key":"SHIPMENT_NUMBER","value":"BRUNOTEST0001"}],"key":"LookupShipmentMemoIdentifierExample","summary":"LookupShipmentMemoIdentifierExample","id":"paths/~1cargosoft~1shipment~1memo~1lookup/post/requestBody/content/application~1json/examples/LookupShipmentMemoIdentifierExample"},"paths/~1cargosoft~1shipment~1memo~1lookup/post/responses/200/content/application~1json/examples/ShipmentMemoExample":{"value":[{"id":4711,"client":"001","shipment_number":"BRUNOTEST0001","running_number":1,"memo":"Handle with care - fragile goods, keep upright at all times."}],"key":"ShipmentMemoExample","summary":"ShipmentMemoExample","id":"paths/~1cargosoft~1shipment~1memo~1lookup/post/responses/200/content/application~1json/examples/ShipmentMemoExample"},"paths/~1cargosoft~1status/post/requestBody/content/application~1json/examples/CreateProviderStatusExample":{"value":{"provider_status":"EXPECTED_ARRIVAL","status_date_and_time":{"date":"2026-11-02","time":"10:15:00","zone_offset":"+01:00"},"additional_information":"Estimated arrival updated by customer integration","unique_provider_message_number":"STATUS-2026-000123","status_events":[{"type":"STATUS","date_and_time":{"date":"2026-11-04","time":"08:30:00","zone_offset":"+01:00"},"event_date_type":"ESTIMATED"}],"references":[{"type":"CLIENT","reference":"001"},{"type":"SHIPMENT_NUMBER","reference":"022120300004"},{"type":"PROVIDER","reference":"CUSTOMER_API"}],"identifiers":[]},"key":"CreateProviderStatusExample","summary":"CreateProviderStatusExample","id":"paths/~1cargosoft~1status/post/requestBody/content/application~1json/examples/CreateProviderStatusExample"},"paths/~1cargosoft~1efile~1lookup/post/requestBody/content/application~1json/examples/LookupEFileIdentifierExample":{"value":[{"match_mode":"EQUALS","key":"SHIPMENT_ID","value":"54842"}],"key":"LookupEFileIdentifierExample","summary":"LookupEFileIdentifierExample","id":"paths/~1cargosoft~1efile~1lookup/post/requestBody/content/application~1json/examples/LookupEFileIdentifierExample"},"paths/~1cargosoft~1efile~1lookup/post/responses/200/content/application~1json/examples/ShipmentEFileExample":{"value":[{"id":117481,"client":"001","description":"A18 document","bytes":"iVBORw0KGgoAAAANSUhEUgAAAgoAAAKlCAYAAACqi8RuAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAABhaVRYdFNuaXBNZXRhZGF0YQAAAAAAeyJjbGlwUG9pbnRzIjpbeyJ4IjowLCJ5IjowfSx7IngiOjUyMiwieSI6MH0seyJ4Ijo1MjIsInkiOjY3N30seyJ4IjowLCJ5Ijo2Nzd9XX1rMyYmAAD/OElEQVR4XuT9B5xeV3XvD6/pvWtm1HuvtlzkirsxGGzTCb1DaAFCgHRCQuq9NzcJCUkooXcwGHds495k2bItS7J6HZXpvY/e33fts58582hGkgl53/f/+a9n1pxd1167rrXL2Sfnq49uPSGwiLm5uRkcGxuzqSAnJ0f/T+2feyKxJJCXk5tJBzghEqQDkFagOQ4xfdzBGC9COnz0w210dNSfkXaE7PgnYCAF2f6WF/gFTpwYtcK8fKdtOWOWl5cn5oM95tP5TJHIy8/xcMPDw5ZrOVZQUGAjIyNmoyH+CVPcpKxJhyc08INuYW7IS/QDYr4om/zcEA4zYaAP4OblcELldyLX8vMDnyPiDV4INzQ0ZIVFRW7Hn/h9fX1WVVXlT+dBHMIv4UmTsNCNaeQXlMh/KNAbHvC8V5SV2HB/nxXmF1jO8KgVFBbasNrJyJh4sjxPC5pFci8syrG248dsbkOjNVRX2g+//Q27/Zc329o1K+yv//qv7cRQn/PV3d0tfkL9Ex8YGRm2mtwiGxgZszG59Y8O2mjOkFVWliuVQivILbPOvk5ra26xTY89Yd/8ytfsfe94lz38wIPisdye3/ys1a+YbxdeeoV965vfs/WrV9ueHdtt+owGa+nuEb1cK8kZsRNjQ2q3Y1ZcWmGNc+bbpqeeseuuvsoO7NhmW1/pGgGLPjWsMYgfn6yXam47oHr2MpdtbTIjWCx/9iJ5kNjS3ZY3C2hC16e6DH8B16DsOn8Syf0nIN74CXBvbPHLF/j4Lr+98+A5/3ngzI5WY+c8Avug39RD9d4R+YR9wV10y7+DuoPyoE/8hvtoU4OeB99xuHaoq+OoF6en23r7PbJrDA/af8fqiSe3XAxiM0AAAAASUVORK5CYII=","roles":["cargosoft","SCM","C2C"],"references":[{"reference_type":"CSFILE","reference_value":"022120300004#001"},{"reference_type":"createdBy","reference_value":"CargoSoft User"}],"document_category":"1601,","document_name":"A18.pdf","document_date":"2024-01-17T10:51:48.001"},{"id":117482,"client":"001","description":"Description of this Screenshot","bytes":"iVBORw0KGgoAAAANSUhEUgAAAgpGgGLPjWsMYg+XH2YTHVX5pDD4IqP9TKZmfKgneoZWrePCP8C9QWIQlvEbBD11fwky2HApEzHmQOwoC9Ec1KDLYj0qBwl6qWTRhiAt6noQu7GXP5EmAO/GweV3JX/+cz0BfzIu/PPHAigGrDkERYDtA8ZN46acP5PApOwBNZltOW4C5WIoQ/IjtUF9qIydUfuQDxWnYmK2yZcFMVPb+fis4oTIaG7L1a1baD77yH7Zjy3P2r//4v+3iC86TYtOnQXlEwrVbNazZonitrq6xgYGBTLrMBOGJ+hmRYM4vLJI+kmfFSu/PP/c5y1U5Xn7J5XbpRS+zBx+5357YuNEGpdTs3LvHlq5aYQ8+9rAtWLLfn6yXam47oHr2MpdtbTIjWCx/9iJ5kNjS3ZY3C2hC16e6DH8B16DsOn8Syf0nIN74CXBvbPHLF/j4Lr+98+A5/3ngzI5WY+c8Avug39RD9d4R+YR9wV10y7+DuoPyoE/8hvtoU4OeB99xuHaoq+OoF6en23r7PbJrDA/af8fqiSe3XAxiM0AAAAASUVORK5CYII=","roles":["cargosoft","SCM","C2C"],"references":[{"reference_type":"CSFILE","reference_value":"022120300004#001"},{"reference_type":"createdBy","reference_value":"CargoSoft User"}],"document_category":"1601,","document_name":"Screenshot 2024-01-17 121503.png","document_date":"2024-01-17T12:15:24.877"}],"key":"ShipmentEFileExample","summary":"ShipmentEFileExample","id":"paths/~1cargosoft~1efile~1lookup/post/responses/200/content/application~1json/examples/ShipmentEFileExample"}},"securitySchemeStore":{"JavaWebToken":{"id":"JavaWebToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"\n"}},"specVersion":"3.1.0","servers":[{"url":"/_mock/products/tms-api/2026.1/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://api-demo.cargosoft.de","description":"Test CargoSoft API server."}],"logo":{"imageUrl":"https://raw.githubusercontent.com/cargosoft-gmbh/cargosoft-api-docs/2026.1/resources/CargoSoftLogo.jpg","href":"https://www.cargosoft.de","altText":"CargoSoft GmbH","backgroundColor":"#FFFFF"},"specType":"openapi"},"options":{"showExtensions":false,"mockServer":{"url":"/_mock/products/tms-api/2026.1/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/tms-api/@2026.1/openapi.json?download"},{"url":"/_bundle/products/tms-api/@2026.1/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false,"asyncapi":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"CargoSoft API","description":"# About the CargoSoft API\n\n## General\n\n> Attention: Since our API is still under development, endpoints may well change, or object structures may change. Of course, we try to avoid this as much as possible, but we cannot guarantee it. So that you have the possibility to react in time, we will soon offer you a possibility to subscribe to a newsletter. We would then inform all subscribers when something will change in the API. We are currently still looking for an integrable solution for newsletters, which can be used to subscribe and unsubscribe at this place. Until then, we would like to ask you to send us an email to support@cargosoft.de with the request that we inform you when there are planned changes to the API.\n\n> Please note: The API endpoints available to a customer depend on the installed CargoSoft version. New endpoints must\n> be enabled by CargoSoft before they can be used.\n\n## Changelog\nThis page documents all business-relevant changes to our API.\n\n| Category       | Endpoint / Area            | Change                                                                                                 | Impact and required action                                       | Version |\n|----------------|----------------------------|--------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|---|\n| **Added**      | `POST` /cargosoft/shipment | Added new shipment create endpoint.                                                                    | No changes to existing integrations are required.                | 2026.1 |\n| **Added**      | Use cases                  | Added new use case to create a shipment - [see](#section/use-cases/create-a-shipment).                  | No changes to existing integrations are required.                | 2026.1 |\n| **Added**      | E-File                     | Added support for E-File - [see](#section/use-cases/attach-an-e-file-document-to-a-shipment).           | No changes to existing integrations are required.                | 2026.1 |\n| **Added**      | Provider status            | Added `POST /cargosoft/status` to create a provider status - [see](#section/use-cases/attach-a-status-to-a-shipment). | No changes to existing integrations are required. | 2026.1 |\n| **Added**      | Basic data                 | Added new edi code conversion endpoints.                                                               | No changes to existing integrations are required.                | 2026.1 |\n| **Deprecated** | ShipmentEventQualifier     | The shipment event qualifer `TRANSSHIPMENT` is now deprecated and will be removed in a future version. | Use the `TRANSSHIPMENT_ARRIVAL` shipment event qualifer instead. | 2026.1 |\n\n\n\n### Category definitions\n\n| Category | Meaning |\n|---|---|\n| **Breaking change** | A non-backward-compatible change that may require integration updates |\n| **Added** | A new feature, endpoint, field, or supported value |\n| **Changed** | A backward-compatible change to existing behavior |\n| **Deprecated** | A feature is still available but will be removed in the future |\n| **Removed** | A feature, endpoint, or field has been removed |\n| **Fixed** | A bug fix without an intended breaking interface change |\n\n## Authorization\n\n<p id='CHAPTER_AUTHORIZATION'></p>\nThe following chapter will explain the authorization prozess to access the CargoSoft API endpoints. The use case figure below shows a common example how to retrieve the JWT and how to use it.\n\n![Authorization][SeqAuthorization]\n\n[SeqAuthorization]: ./resources/Seq_authentifizierung.svg \"Use case Authorization!\"\n\n### Retrieve a token\n\nFirst of all each client has to request a bearer Java Web Toke (JWT) from the CargoSoft API. To receive a JWT, username\nand password are required. Username and password can only be created by CargoSoft.\nFor more details [see](#operation/retrieveAuthToken).\n\n> Please note: The JWT is valid for 24 hours. After that you have to request a new one.\n\n### Access API endpoints\n\nTo access the CargoSoft API endpoint, a JWT is required. The JWT has to be sent in the HTTP authorization header.\n\n**Example**: This example shows a minimal curl with a bearer authorization header. The token is not valid because we\nonly want to illustrate the structure.\n\n```\ncurl --location --request POST 'https://api-demo.cargosoft.de/cargosoft/shipment/lookup' \\\n--header 'Authorization: Bearer eyJ0eXAiOiJqd3QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJ1cGRhdGUiLCJjYXJnb3NvZnQtand0LNjc2NDQ1NTAzfQ.mK82rjSu0ltd0bf3mvXUqwpME05ck5OEuqnzsAQ8WPFPo' \\\n--data-raw '[]'\"\n```\n\n> Attention: Your user may be restricted. The CargoSoft API uses a permission system to grant access to the\n> CargoSoft API endpoint. If your user is restricted or it's not allowed to use an endpoint you need please contact our\n> support.\n\n### Access webhook\n\nThe webhook uses basic auth as its authorization type.\n\n**Example**: This example shows a minimal curl request, to access the webhook. The basic auth is not valid.\n\n```\ncurl --location --request POST 'https://api-demo.cargosoft.de/external/webhook' \\\n--header 'Authorization: Basic cG9ydg53xcvgawawb3J0YmFzZWNj' \\\n--data-raw '{}'\"\n```\n\n> Please note: Your user needs a special role to access the webhook endpoint via basic auth.\n\n## CRUD\n\nThe CargoSoft API uses CRUD operations. We attempt to implement each CRUD operation for each functional\ngroup of endpoints if it makes sense. The delete operation is one of the most sensitive function and will not\navailable to each function group.\n\n### Lookup\n\nThe CargoSoft API extends the CRUD retrieve operations with lookup operations. Each functional group of endpoints should\nhave a lookup method implemented.\nLookups should be used to search functional objects with given criteria named identifiers. The identifiers may be\ndifferent to each functional group. To find out which functional identifier are possible, please take a look at the\ncorresponding functional group.\n\nThe identifier will be sent in the request body to the API lookup endpoint. An identifier contains the following\nthree information:\n\n1. _match_mode_: The match mode can alter the behaviour, how the criteria is compared against the object in the database\n   are **[EQUALS, CONTAINS, IN, OR, GT, LT, GE, LE]**.\n2. _key_: The key of the criteria for the functional object to lookup. To find out which keys are possible, please check\n   the\n   corresponding implementation.\n3. _value_: The value of the criteria.\n\n**Example**: Lookup request body to search a shipment\n\n```json\n[\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"MBL\",\n    \"value\": \"MASTER_12345\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"MODE_OF_TRANSPORT\",\n    \"value\": \"SEA\"\n  }\n]\n```\n\n> Please note: When using one of any lookup methods, please define search criteria as precisely as possible to limit the\n> result of objects.\n\nThe lookup may contain ordering by one or more criteria. The ordering will passed as a query parameter.\n\nThe result set of a lookup includes zero up to n functional objects depending on the search criteria.\nEach functional object contains an ID. The ID can be used to retrieve additional information by passing the id as a path\nparameter of the retrieve endpoint.\n\n**Example**: Lookup a shipment and retrieve all shipment events\n\n1. Looking up a shipment with given criteria, for instance with the BL number. For more details\n   please [see](#operation/lookup).\n2. Extract the ID of the shipment result object.\n3. Call the [Events](#operation/{id}/events) endpoint with the shipment ID as path parameter.\n\n### Pagination\n\nMost endpoints of the CargoSoft API use pagination mechanics.\n\nThe pagination information will be sent as a request query parameter to the API endpoint. The pagination contains the\nfollowing two query parameter:\n1. _page_no_: The current number of the page\n2. _page_size_: The size of the page\n\n**Example**: Lookup a shipment with pagination query parameter\n```\ncurl --location --request POST 'https://api-demo.cargosoft.de/cargosoft/shipment/lookup?page_no=1&page_size=5' \\\n--header 'Authorization: Bearer eyJ0eXAiOiJqd3QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJ1cGRhdGUiLCJjYXJnb3NvZnQtand0LNjc2NDQ1NTAzfQ.mK82rjSu0ltd0bf3mvXUqwpME05ck5OEuqnzsAQ8WPFPo' \\\n--header 'Content-Type: application/json' \\\n--data '[\n    {\n        \"match_mode\": \"EQUALS\",\n        \"key\": \"MBL\",   \n        \"value\": \"MASTER_12345\"\n    },\n   {\n        \"match_mode\": \"EQUALS\",\n        \"key\": \"MODE_OF_TRANSPORT\",\n        \"value\": \"SEA\"\n    }\n]'\n```\n\nThe response contains two additional headers:\n1. _X-Page-Count_: The total number of pages.\n2. _X-Row-Count_: The total number of found objects.\n\nWith these both headers it is possible to scroll through a result set.\n\n## Testing\n\nFor testing purposes CargoSoft hosted a server with the last released CargoSoft API.\n\n**URL**: https://api-demo.cargosoft.de\n\nTo use the test environment, please use the \"Try it\" console in this documentation. Login credentials are needed to use\nthe test API. The credentials have to be requested from the CargoSoft support. The received information grants access to\na\ntest account which should be able to use all endpoints. If any endpoint is restricted, please contact CargoSoft. Please\nhave in mind that the test environment will be reset every night!\n\n# Use cases\n\nThe following use cases describe common integration workflows. Every request requires a JWT in the\n`Authorization: Bearer <token>` header. For details about retrieving and using a token, see\n[Authorization](#CHAPTER_AUTHORIZATION). The sequence diagrams show token retrieval as a referenced flow.\n\n| Goal | Primary endpoint | Result |\n|---|---|---|\n| Create a shipment | `POST /cargosoft/shipment` | A new shipment with its unique ID and CargoSoft shipment number |\n| Look up an EDI code conversion | `POST /cargosoft/basicdata/codeconverter/lookup` | Matching conversion records for the supplied identifiers |\n| Retrieve a shipment | `POST /cargosoft/shipment/lookup` | Matching shipments and their IDs |\n| Attach an E-File document | `POST /cargosoft/efile` | A stored document linked to an existing shipment |\n| Attach a status | `POST /cargosoft/status` | A provider status associated with an existing shipment |\n| Retrieve shipment events | `GET /cargosoft/shipment/{id}/events` | The available CargoSoft events for a shipment |\n\n## Create a shipment\n\n<p id='CHAPTER_SHIPMENT'></p>\n\n**Goal**\n\nCreate a shipment together with any supplied nested data, such as goods, containers, addon field values, or memo lines.\n\n**Endpoint**\n\nUse [`POST /cargosoft/shipment`](#operation/createShipment).\n\n**Prerequisites**\n\n- The authenticated API username must match the matchcode of an EDI partner.\n- The shipment number definition, main department, and sub department must be resolvable from the\n  [EDI partner settings](#CHAPTER_EDIPARTNER_SETTINGS) or the request body.\n\n<p id='CHAPTER_EDIPARTNER_SETTINGS'></p>\n\n**EDI partner settings**\n\nGenerating a shipment number requires three pieces of information: the shipment number definition (posdef), the main\ndepartment, and the sub department. Each value can be configured individually on the EDI partner determined from the\nauthenticated API user. A configured EDI partner value takes precedence; an empty or blank value is treated as not\nconfigured. Each key is resolved independently, and unrelated qualifiers on the EDI partner are ignored.\n\n| Key | Meaning | Fallback if not configured or blank on the EDI partner |\n|---|---|---|\n| `SHIPMENT_NUMBER_DEFINITION_VERSION` | Shipment number definition version to use | `shipment_number_definition_version` from the request body, if present; otherwise the CargoSoft client's default |\n| `MAINDEPARTMENT` | Main department used for shipment numbering | `maindepartment` from the request body; if neither value is present, the request is rejected |\n| `SUBDEPARTMENT` | Sub department used for shipment numbering | `subdepartment` from the request body; if neither value is present, the request is rejected |\n| `ADDRESS_FORMAT` | Address format used for shipment addresses | The CargoSoft client's default from the general company parameters |\n\n> Please note: If a request does not need to rely on the EDI partner's settings, for example during testing,\n> `shipment_number_definition_version`, `maindepartment`, and `subdepartment` can be supplied directly in the request\n> body.\n\n**Sequence**\n\n![CreateShipment][SeqCreateShipment]\n\n[SeqCreateShipment]: ./resources/Seq_create_shipment.svg \"Use case to create a shipment\"\n\n**Workflow**\n\n1. Based on the authenticated API user, the CargoSoft API determines the EDI partner to associate with the new\n   shipment: the EDI partner's matchcode has to be identical to the API username. If no EDI partner exists for\n   the API user, the request is rejected and no shipment is created.\n2. The determined EDI partner's settings are used, where configured, to fill in values that are required to generate\n   the shipment number. See [EDI partner settings](#CHAPTER_EDIPARTNER_SETTINGS) for the exact keys and fallback rules.\n3. The shipment is created together with any nested data supplied in the same request body - goods, containers,\n   addon field values, order memo lines, and so on. A memo text longer than the maximum line length is\n   automatically wrapped across several consecutive memo lines. Use `POST /cargosoft/shipment/memo/lookup` to\n   retrieve memo lines independently afterwards.\n4. If the request and all nested data pass validation, the CargoSoft API stores and returns the shipment.\n\n**Result**\n\nThe response contains the created shipment, including its unique shipment ID and CargoSoft shipment number.\n\n**Error handling**\n\n- If no EDI partner matches the API username, the request is rejected and no shipment is created.\n- If required shipment numbering values cannot be resolved, the request is rejected.\n- If nested data fails validation, the complete shipment creation is rejected and nothing is created.\n\n## Look up an EDI code conversion\n\n**Goal**\n\nTranslate an EDI partner's own code, for example a charge type or packaging code, into the corresponding CargoSoft\ninternal code or vice versa, depending on direction.\n\n**Endpoint**\n\nUse [`POST /cargosoft/basicdata/codeconverter/lookup`](#operation/lookup).\n\n**Prerequisites**\n\n- The EDI code conversion must be configured in the CargoSoft master data.\n- The EDI partner, direction, and code type must be known. The source code is additionally required when looking up one\n  specific conversion.\n\n**Workflow**\n\n1. Build the lookup request from the `EDIPARTNER`, `DIRECTION`, and `CODETYPE` identifiers. The `DIRECTION` value must\n   be the raw single-character code stored in CargoSoft (`E` or `S`), not the `direction` value (`RECEIVE` or `SEND`)\n   returned on the response object:\n\n```json\n[\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"EDIPARTNER\",\n    \"value\": \"SAMPLEPARTNER\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"DIRECTION\",\n    \"value\": \"E\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"CODETYPE\",\n    \"value\": \"VERCO_T\"\n  }\n]\n```\n\n2. Send the request without `SOURCECODE` to retrieve every conversion configured for the EDI partner's code table and\n   direction. Add `SOURCECODE` to look up one specific conversion.\n3. `DIRECTION` + `CODETYPE` + `SOURCECODE` can also be used without `EDIPARTNER`. This returns every matching\n   conversion across all EDI partners that share the source code.\n\n**Result**\n\nThe response contains the matching EDI code conversion records, including their source and target codes. The result is\npaginated and includes the `X-Page-Count` and `X-Row-Count` response headers.\n\n**Lookup behavior**\n\nThe following identifier combinations are served from a cache because this master data changes very rarely:\n\n- `EDIPARTNER` + `DIRECTION` + `CODETYPE`\n- `EDIPARTNER` + `DIRECTION` + `CODETYPE` + `SOURCECODE`\n- `DIRECTION` + `CODETYPE` + `SOURCECODE`\n\nAny other identifier combination is looked up directly in the database.\n\n## Retrieve a shipment\n\n**Goal**\n\nFind an existing shipment from business identifiers and obtain the unique shipment ID used by subsequent endpoints.\n\n**Endpoint**\n\nUse `POST /cargosoft/shipment/lookup`.\n\n**Prerequisites**\n\n- Select identifiers that narrow the result to the intended shipment.\n- Use pagination when a lookup can return more results than fit on one page.\n\n**Sequence**\n\n![RetrieveShipment][SeqRetrieveShipment]\n\n[SeqRetrieveShipment]: ./resources/Seq_retrieve_shipment.svg \"Use case to retrieve a shipment\"\n\n**Workflow**\n\n1. Build the request body from supported shipment identifiers, such as client and shipment number.\n2. Call `POST /cargosoft/shipment/lookup` with the identifiers and, if necessary, pagination parameters.\n3. Verify that the expected shipment was returned and extract its unique `id`.\n4. If full shipment details are required, call `GET /cargosoft/shipment/{id}` with the extracted ID.\n\n**Result**\n\nThe lookup returns zero or more base shipments. Each returned shipment contains the unique ID required for related data,\nsuch as shipment events or E-File lookups.\n\n**Error handling**\n\n- Refine the identifiers when the lookup returns no result or more shipments than expected.\n- Do not select an arbitrary result when the criteria are not unique.\n\n## Attach an E-File document to a shipment\n\n<p id='CHAPTER_EFILE_SHIPMENT'></p>\n\n> **Development notice:** The endpoint used in this workflow is still under development and may change.\n\n**Goal**\n\nCreate an E-File document and link it to an existing shipment in the same request.\n\n**Endpoints**\n\n- Use `POST /cargosoft/shipment/lookup` to resolve the shipment number, client, and unique shipment ID.\n- Use [`POST /cargosoft/efile`](#operation/createEFileDocument) to create and link the document.\n- Use `POST /cargosoft/efile/{id}/reference` only when linking an already existing document later.\n\n**Prerequisites**\n\n- The API user must be allowed to call the required shipment and E-File endpoints.\n- E-File must be enabled and configured for the shipment's CargoSoft client.\n- The document content must be Base64 encoded without a data-URI prefix.\n- The document category must exist in the customer's CargoSoft basic data. It is mandatory when the configured\n  E-File system uses D3 mode.\n\n**Sequence**\n\n![AttachEFileToShipment][SeqAttachEFileToShipment]\n\n[SeqAttachEFileToShipment]: ./resources/Seq_attach_efile_to_shipment.svg \"Use case to attach an E-File document to a shipment\"\n\n**Workflow**\n\n1. Look up the shipment with criteria that identify exactly one shipment. A CargoSoft shipment number is unique\n   only in combination with its client, so both identifiers should be supplied:\n\n```json\n[\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"CLIENT\",\n    \"value\": \"001\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"SHIPMENT_NUMBER\",\n    \"value\": \"022120300004\"\n  }\n]\n```\n\n2. Process the lookup response before uploading. Continue only when the expected shipment was returned, and read\n   its `id`, `shipment_number`, and `client`. The numeric shipment `id` can later be used to\n   [look up E-File documents](#operation/lookupEFileDocuments), but it is not the value of the `CSFILE` reference.\n3. Build the shipment reference and include it in the upload request:\n\n| Situation | Endpoint | `reference_type` | `reference_value` |\n|---|---|---|---|\n| Create and link a new document | `POST /cargosoft/efile` | `CSFILE` | `<shipment_number>#<client>` |\n| Link an existing document later | `POST /cargosoft/efile/{id}/reference` | `CSFILE` | `<shipment_number>#<client>` |\n\nFor the lookup response above, the reference value is `022120300004#001`.\n\n4. Upload the document. The following example omits optional roles; when roles are supplied, use values configured\n   for the customer's E-File system. `document_category` is also customer-specific.\n\n```json\n{\n  \"client\": \"001\",\n  \"document_category\": 1601,\n  \"document_name\": \"shipping-instructions.pdf\",\n  \"description\": \"Shipping instructions received from the customer\",\n  \"document_date\": \"2026-11-02T10:15:00\",\n  \"bytes\": \"JVBERi0xLjQKJcTl8uXr...\",\n  \"references\": [\n    {\n      \"reference_type\": \"CSFILE\",\n      \"reference_value\": \"022120300004#001\"\n    }\n  ]\n}\n```\n\n5. Keep the returned E-File document ID when references or roles need to be managed later.\n\n**Result**\n\nThe response contains the stored E-File document and its unique `id`. The included `CSFILE` reference links the\ndocument to the resolved shipment.\n\n**Error handling and retries**\n\n- A shipment lookup that returns no result or more than the expected shipment must be resolved before the upload.\n  Refine the lookup identifiers instead of choosing an arbitrary result.\n- `401` or `403` indicates missing or insufficient API credentials. Do not retry until the credentials or endpoint\n  permissions have been corrected.\n- Invalid Base64 data, an unknown client, a missing mandatory document category, or an unavailable E-File system\n  causes the upload to fail. The error response must be handled before another upload is attempted.\n- The server-side connection from the CargoSoft API to the configured E-File system has a default timeout of\n  30 seconds; the deployment can override this value. API consumers should configure their HTTP timeout with enough\n  headroom for that downstream call.\n- The CargoSoft API does not automatically retry a failed upload. `POST /cargosoft/efile` is not idempotent, so a\n  blind retry after a client or downstream timeout can create a duplicate. First call the\n  [E-File lookup](#operation/lookupEFileDocuments) with the shipment `id` as `SHIPMENT_ID` and verify whether the\n  document was stored. Retry only when it is absent. If a `503` response contains `Retry-After`, wait for the stated\n  interval before retrying.\n\n## Attach a status to a shipment\n\n<p id='CHAPTER_STATUS_SHIPMENT'></p>\n\n> **Development notice:** The endpoint used in this workflow is still under development and may change.\n\n**Goal**\n\nCreate a provider status and associate it with an existing shipment through its CargoSoft client and shipment number.\n\n**Endpoints**\n\n- Use `POST /cargosoft/shipment/lookup` to identify the shipment and confirm its client and shipment number.\n- Use [`POST /cargosoft/status`](#operation/createProviderStatus) to create the provider status.\n\n**Prerequisites**\n\n- The API user must be allowed to call both the shipment lookup and provider status endpoints.\n- The endpoints must be available for the installed CargoSoft version and enabled by CargoSoft.\n- The provider and provider status must be configured in the customer's CargoSoft master data.\n- The customer-specific client, provider, and provider status codes must be known.\n\n**Sequence**\n\n![AttachStatusToShipment][SeqAttachStatusToShipment]\n\n[SeqAttachStatusToShipment]: ./resources/Seq_attach_status_to_shipment.svg \"Use case to attach a status to a shipment\"\n\n**Workflow**\n\n1. Look up the shipment with criteria that identify exactly one shipment. A CargoSoft shipment number is unique\n   only in combination with its client, so both identifiers should be supplied with exact matching:\n\n```json\n[\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"CLIENT\",\n    \"value\": \"001\"\n  },\n  {\n    \"match_mode\": \"EQUALS\",\n    \"key\": \"SHIPMENT_NUMBER\",\n    \"value\": \"022120300004\"\n  }\n]\n```\n\n2. Continue only when the expected shipment was returned. Read its `client` and `shipment_number`; the numeric\n   shipment `id` is not used by the provider status endpoint.\n3. Build the provider status request. `CLIENT` and `PROVIDER` are required for status processing, while\n   `SHIPMENT_NUMBER` associates the status with the resolved shipment. The values below are examples and must be\n   replaced with codes configured for the customer:\n\n```json\n{\n  \"provider_status\": \"EXPECTED_ARRIVAL\",\n  \"status_date_and_time\": {\n    \"date\": \"2026-11-02\",\n    \"time\": \"10:15:00\",\n    \"zone_offset\": \"+01:00\"\n  },\n  \"additional_information\": \"Estimated arrival updated by customer integration\",\n  \"unique_provider_message_number\": \"STATUS-2026-000123\",\n  \"status_events\": [\n    {\n      \"type\": \"STATUS\",\n      \"date_and_time\": {\n        \"date\": \"2026-11-04\",\n        \"time\": \"08:30:00\",\n        \"zone_offset\": \"+01:00\"\n      },\n      \"event_date_type\": \"ESTIMATED\"\n    }\n  ],\n  \"references\": [\n    {\n      \"type\": \"CLIENT\",\n      \"reference\": \"001\"\n    },\n    {\n      \"type\": \"SHIPMENT_NUMBER\",\n      \"reference\": \"022120300004\"\n    },\n    {\n      \"type\": \"PROVIDER\",\n      \"reference\": \"CUSTOMER_API\"\n    }\n  ],\n  \"identifiers\": []\n}\n```\n\n4. Send the request to `POST /cargosoft/status`. Copy the client and shipment number from the verified lookup\n   result without changing their formatting.\n\n**Result**\n\nA successful request returns `200 OK` without a response body. CargoSoft creates the provider status and associates it\nwith the shipment when the supplied references resolve it. Depending on the configured master-data mapping, the\nprovider status can also create a customer-defined shipment status or update shipment event data.\n\n**Error handling and retries**\n\n- Stop when the shipment lookup returns no result or more than the expected shipment. Refine the lookup criteria\n  instead of choosing an arbitrary result.\n- A missing `CLIENT` or `PROVIDER` reference, an unknown client, or a provider status that is not configured for the\n  provider causes status processing to fail. Correct the request or master data before retrying.\n- `401` or `403` indicates missing or insufficient API credentials. Do not retry until the credentials or endpoint\n  permissions have been corrected.\n- The endpoint has no automatic retry mechanism. Client, proxy, and deployment timeouts apply to the request.\n- `POST /cargosoft/status` is not idempotent. A blind retry after an ambiguous timeout can create a duplicate\n  provider status. `unique_provider_message_number` is stored for traceability but is not an idempotency key. Because\n  no provider status retrieval endpoint is available, verify the result in CargoSoft before retrying.\n\n<p id='CHAPTER_SHIPMENT_STATUS_MODEL'></p>\n\n### Shipment status model\n\nCargoSoft stores status information in different pools. The following diagram shows how status messages can be mapped\nand processed.\n\n![ShipmentStatus][useCaseShipmentStatus]\n\n[useCaseShipmentStatus]: ./resources/Use_case_shipment_status.svg \"CargoSoft shipment status model\"\n\n| Type | Origin and behavior | API availability |\n|---|---|---|\n| Shipment provider status | Supplied by an external status or service provider; codes depend on the provider | Creation through `POST /cargosoft/status`; no retrieval endpoint yet |\n| Shipment status | Customer-defined and optionally mapped from provider status | No retrieval endpoint yet |\n| Shipment event | CargoSoft-defined and optionally derived from shipment or provider status | Available through `GET /cargosoft/shipment/{id}/events` |\n\n**Shipment provider status**\n\nThese status messages come from external status providers and service providers. CargoSoft employees cannot enter or\nchange them manually. A provider status represents exactly one state, such as a planned, estimated, or actual date and\ntime. Its code is defined by the provider and can therefore vary between providers.\n\n**Shipment status**\n\nCargoSoft customers define these status codes themselves. Provider statuses can be mapped to shipment statuses through\nthe customer's basic data. For example, provider status `ABC` can be mapped to the customer-defined shipment status\n`ETA`; consequently, there is no universal list of valid shipment status codes.\n\nA shipment status record can contain both planned and actual date information. Customers can add status information\nmanually, but an existing record can no longer be changed.\n\n**Shipment events**\n\nShipment events are fixed status events defined by CargoSoft. They can be retrieved when data is available for the\nshipment. An event can be created automatically from a shipment or provider status when the CargoSoft master data is\nconfigured accordingly. It represents either a planned or an actual instance and can be changed manually or by\nbackground processes. The complete list of event codes is documented by the\n[`GET /cargosoft/shipment/{id}/events`](#operation/retrieveEvents) endpoint.\n\n## Retrieve shipment events\n\n**Goal**\n\nRetrieve the CargoSoft-defined events currently available for an existing shipment.\n\n**Endpoint**\n\nUse [`GET /cargosoft/shipment/{id}/events`](#operation/retrieveEvents).\n\n**Prerequisites**\n\nThe unique shipment ID must be known. If only business identifiers are available, first follow the\n[Retrieve a shipment](#section/use-cases/retrieve-a-shipment) workflow.\n\n**Sequence**\n\n![RetrieveShipmentEvents][SeqRetrieveShipmentEvents]\n\n[SeqRetrieveShipmentEvents]: ./resources/Seq_retrieve_shipment_event.svg \"Use case to retrieve shipment events\"\n\n**Workflow**\n\n1. Resolve the shipment with `POST /cargosoft/shipment/lookup` when its unique ID is not yet known.\n2. Extract the shipment `id` from the lookup result.\n3. Call `GET /cargosoft/shipment/{id}/events` with that ID.\n\n**Result**\n\nThe response contains the available CargoSoft shipment events. An event represents either a planned or an actual\ninstance. For the differences between provider status, customer-defined shipment status, and shipment events, see\n[Shipment status model](#CHAPTER_SHIPMENT_STATUS_MODEL).\n\n**Error handling**\n\n- The response may not contain every possible event because some events may not have been recorded for the shipment yet.\n- Verify the shipment ID when no events are returned unexpectedly.\n"}},"baseSlug":"/products/tms-api/2026.1/openapi","routesMapping":{}}