{"items":[{"type":"link","label":"CargoSoft API","link":"/2026.1/openapi","routeSlug":"/2026.1/openapi"},{"type":"group","label":"About the CargoSoft API","link":"/2026.1/openapi/section/about-the-cargosoft-api","routeSlug":"/2026.1/openapi/section/about-the-cargosoft-api","items":[{"type":"link","label":"General","link":"/2026.1/openapi/section/about-the-cargosoft-api/general","routeSlug":"/2026.1/openapi/section/about-the-cargosoft-api/general"},{"type":"link","label":"Authorization","link":"/2026.1/openapi/section/about-the-cargosoft-api/authorization","routeSlug":"/2026.1/openapi/section/about-the-cargosoft-api/authorization"},{"type":"link","label":"Retrieve a token","link":"/2026.1/openapi/section/about-the-cargosoft-api/retrieve-a-token","routeSlug":"/2026.1/openapi/section/about-the-cargosoft-api/retrieve-a-token"},{"type":"link","label":"Access API endpoints","link":"/2026.1/openapi/section/about-the-cargosoft-api/access-api-endpoints","routeSlug":"/2026.1/openapi/section/about-the-cargosoft-api/access-api-endpoints"},{"type":"link","label":"Access webhook","link":"/2026.1/openapi/section/about-the-cargosoft-api/access-webhook","routeSlug":"/2026.1/openapi/section/about-the-cargosoft-api/access-webhook"},{"type":"link","label":"CRUD","link":"/2026.1/openapi/section/about-the-cargosoft-api/crud","routeSlug":"/2026.1/openapi/section/about-the-cargosoft-api/crud"},{"type":"link","label":"Lookup","link":"/2026.1/openapi/section/about-the-cargosoft-api/lookup","routeSlug":"/2026.1/openapi/section/about-the-cargosoft-api/lookup"},{"type":"link","label":"Pagination","link":"/2026.1/openapi/section/about-the-cargosoft-api/pagination","routeSlug":"/2026.1/openapi/section/about-the-cargosoft-api/pagination"},{"type":"link","label":"Testing","link":"/2026.1/openapi/section/about-the-cargosoft-api/testing","routeSlug":"/2026.1/openapi/section/about-the-cargosoft-api/testing"}]},{"type":"group","label":"Use cases","link":"/2026.1/openapi/section/use-cases","routeSlug":"/2026.1/openapi/section/use-cases","items":[{"type":"link","label":"Retrieve a shipment","link":"/2026.1/openapi/section/use-cases/retrieve-a-shipment","routeSlug":"/2026.1/openapi/section/use-cases/retrieve-a-shipment"},{"type":"link","label":"Retrieve shipment status","link":"/2026.1/openapi/section/use-cases/retrieve-shipment-status","routeSlug":"/2026.1/openapi/section/use-cases/retrieve-shipment-status"},{"type":"link","label":"Shipment provider status","link":"/2026.1/openapi/section/use-cases/shipment-provider-status","routeSlug":"/2026.1/openapi/section/use-cases/shipment-provider-status"},{"type":"link","label":"Shipment status","link":"/2026.1/openapi/section/use-cases/shipment-status","routeSlug":"/2026.1/openapi/section/use-cases/shipment-status"},{"type":"link","label":"Shipment events","link":"/2026.1/openapi/section/use-cases/shipment-events","routeSlug":"/2026.1/openapi/section/use-cases/shipment-events"}]},{"type":"group","label":"Shipment","link":"/2026.1/openapi/shipment","routeSlug":"/2026.1/openapi/shipment","items":[{"label":"Lookup for shipments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/shipment/lookup_1","routeSlug":"/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."}},"httpPath":"/cargosoft/shipment/lookup"},{"label":"Retrieve airfreight shipment main carriage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/shipment/retrieveairmaincarriage","routeSlug":"/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."}},"httpPath":"/cargosoft/shipment/{id}/airmaincarriage"},{"label":"Retrieve shipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/shipment/retrievebyid_1","routeSlug":"/2026.1/openapi/shipment/retrievebyid_1","metadata":{"seo":{"title":"Retrieve shipment","description":"Retrieve a specific shipment with the CargoSoft database id."}},"httpPath":"/cargosoft/shipment/{id}"},{"label":"Retrieve shipment events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/shipment/retrieveevents","routeSlug":"/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."}},"httpPath":"/cargosoft/shipment/{id}/events"},{"label":"Retrieve seafreight shipment main carriage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/shipment/retrieveseamaincarriage","routeSlug":"/2026.1/openapi/shipment/retrieveseamaincarriage","metadata":{"seo":{"title":"Retrieve seafreight shipment main carriage","description":"Retrieve the main carriage of the shipment with additional details."}},"httpPath":"/cargosoft/shipment/{id}/seamaincarriage"},{"label":"Create a shipment event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/shipment/create_1","routeSlug":"/2026.1/openapi/shipment/create_1","metadata":{"seo":{"title":"Create a shipment event","description":"Create a shipment event of the given event type."}},"httpPath":"/cargosoft/shipment/{shipmentId}/event"},{"label":"Update a shipment event","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/shipment/update","routeSlug":"/2026.1/openapi/shipment/update","metadata":{"seo":{"title":"Update a shipment event","description":"Update the event of the given event type."}},"httpPath":"/cargosoft/shipment/{shipmentId}/event/{id}"}]},{"type":"group","label":"E-File","link":"/2026.1/openapi/e-file","routeSlug":"/2026.1/openapi/e-file","items":[{"label":"Create an E-File document.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/e-file/create","routeSlug":"/2026.1/openapi/e-file/create","metadata":{"seo":{"title":"Create an E-File document.","description":"Stores a base64 encoded document in E-File and links it to the supplied references and roles."}},"httpPath":"/cargosoft/efile"},{"label":"Retrieve references from an E-File document.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/e-file/retrievereferencesfromdocument","routeSlug":"/2026.1/openapi/e-file/retrievereferencesfromdocument","metadata":{"seo":{"title":"Retrieve references from an E-File document.","description":"Retrieves all references linked to an E-File document."}},"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":"/2026.1/openapi/e-file/createreferencefordocument","routeSlug":"/2026.1/openapi/e-file/createreferencefordocument","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."}},"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":"/2026.1/openapi/e-file/deletereferencefromdocument","routeSlug":"/2026.1/openapi/e-file/deletereferencefromdocument","metadata":{"seo":{"title":"Remove a reference from an E-File document.","description":"Removes a reference from an existing E-File document."}},"httpPath":"/cargosoft/efile/{id}/reference"},{"label":"Retrieve roles from an E-File document.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/e-file/retrieverolesfromdocument","routeSlug":"/2026.1/openapi/e-file/retrieverolesfromdocument","metadata":{"seo":{"title":"Retrieve roles from an E-File document.","description":"Retrieves all authorization roles linked to an E-File document."}},"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":"/2026.1/openapi/e-file/createrolefordocument","routeSlug":"/2026.1/openapi/e-file/createrolefordocument","metadata":{"seo":{"title":"Add a role to an E-File document.","description":"Adds an authorization role to an existing E-File document."}},"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":"/2026.1/openapi/e-file/deleterolefromdocument","routeSlug":"/2026.1/openapi/e-file/deleterolefromdocument","metadata":{"seo":{"title":"Remove a role from an E-File document.","description":"Removes an authorization role from an existing E-File document."}},"httpPath":"/cargosoft/efile/{id}/role"},{"label":"Retrieve an E-File document.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/e-file/retrievebyid","routeSlug":"/2026.1/openapi/e-file/retrievebyid","metadata":{"seo":{"title":"Retrieve an E-File document.","description":"Retrieves a single E-File document by its document ID."}},"httpPath":"/cargosoft/efile/{id}"},{"label":"Delete an E-File document.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/e-file/delete","routeSlug":"/2026.1/openapi/e-file/delete","metadata":{"seo":{"title":"Delete an E-File document.","description":"Deletes an E-File document by its document ID."}},"httpPath":"/cargosoft/efile/{id}"},{"label":"Lookup E-File documents.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/e-file/lookup","routeSlug":"/2026.1/openapi/e-file/lookup","metadata":{"seo":{"title":"Lookup E-File documents.","description":"Looks up electronic documents such as PDF files by the supplied lookup identifiers."}},"httpPath":"/cargosoft/efile/lookup"}]},{"type":"group","label":"Authorization","link":"/2026.1/openapi/authorization","routeSlug":"/2026.1/openapi/authorization","items":[{"label":"Retrieve JWT","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/2026.1/openapi/authorization/retrieveauthtoken","routeSlug":"/2026.1/openapi/authorization/retrieveauthtoken","metadata":{"seo":{"title":"Retrieve JWT","description":"Retrieve a Java Web Token to authenticate against the API"}},"httpPath":"/auth/token"}]},{"type":"group","label":"resources","items":[{"type":"link","fsPath":"@2026.1/resources/api_info_description.md","metadata":{"type":"markdown"},"label":"About the CargoSoft API","link":"/2026.1/resources/api_info_description","routeSlug":"/2026.1/resources/api_info_description","relativePathFromDirectory":"resources/api_info_description.md"},{"type":"link","fsPath":"@2026.1/resources/api_security_description.md","metadata":{"type":"markdown"},"label":"/2026.1/resources/api_security_description","link":"/2026.1/resources/api_security_description","routeSlug":"/2026.1/resources/api_security_description","relativePathFromDirectory":"resources/api_security_description.md"}]}]}