{ "openapi": "3.1.0", "info": { "title": "Qargo TMS Customer API", "description": "Customer Portal API documentation\n
\n What's new — see the Changelog for recent additions and changes to the API.\n
\n\n# Authentication\n\nThe api requires oauth2 authentication with client id/secret. This should only be used for service to service communication.\n\n## Creating application credentials\n\nApplication client credentials can be created by users with the `Super admin` role in the Qargo application.\nUsers can create and remove application clients by navigating to Configuration -> Organisation Settings (API clients sections).\n\nApplications need to be linked to a valid integration id, identifying the Qargo approved integrator.\nPlease contact [us](mailto:integrations@qargo.com) if you don't have an id yet.\n\n## Obtaining an access token\n\nTo interact with the API, you need a valid access token in JWT (JSON Web Token) format. This token authenticates your requests and authorizes access to protected endpoints. The process involves using Basic Authentication to request the token via the `/auth/token` endpoint.\n\nThe [/auth/token endpoint](/customer/docs/section/authentication/the-api-call-to-request-tokens) can be used to generate an access token (JWT):\n\nThis token will need to be refreshed after expiration (we provide the 'expires_in' in the token response to check validity).\n\n### Understanding Basic Authentication\n\nBasic Authentication is a simple HTTP authentication scheme that allows clients to provide credentials (such as a client ID and secret) directly in the request header. It works by encoding the credentials in Base64 and including them in the `Authorization` header of the HTTP request. For example:\n\n- **Format**: `Authorization: Basic `\n- **Credentials Encoding**: The client ID and secret are concatenated with a colon (e.g., `client_id:secret_id`) and then Base64-encoded.\n\n### The API Call to Request Tokens\n\nThe `/auth/token` endpoint is a POST request used to generate a JWT access token. You authenticate this request using Basic Auth with your provided `client_id` and `secret_id`.\n\n#### Request Details\n\n- **Method**: POST\n- **URL**: `https://api.qargo.com/v1/auth/token`\n- **Headers**:\n - `Content-Type: application/json`\n - `Authorization: Basic `\n- **Body**: Empty.\n- **Parameters**: None.\n\nExample using `curl`:\n\n```\ncurl -XPOST https://api.qargo.com/v1/auth/token -H 'Content-type: application/json' -u ''\n```\n\n## Webhook authentication\n\n> **Important:** Webhook endpoints use a **different authentication method** than regular API endpoints. Do not use OAuth tokens for webhooks.\n\nQargo webhooks, such as those for order import and status updates, use **Basic Authentication** instead of OAuth. See [Understanding Basic Authentication](#understanding-basic-authentication) for details on the Basic Auth scheme.\n\nWebhook credentials (client id and secret id) are **provisioned by Qargo** when your webhook integration is configured — contact [integrations@qargo.com](mailto:integrations@qargo.com) to obtain them. They are **separate from your API credentials** and must be used exclusively for webhook endpoints.\n\n### API vs Webhook authentication summary\n\n| | **API endpoints** | **Webhook endpoints** |\n|---|---|---|\n| **Auth method** | OAuth2 (Client Credentials) | Basic Authentication |\n| **Credentials** | API client_id + secret_id → Bearer JWT token | Webhook client_id + secret_id (directly in header) |\n| **Header format** | `Authorization: Bearer ` | `Authorization: Basic ` |\n| **Where to find credentials** | Configuration → Organisation Settings → API clients | Provisioned by Qargo — contact [integrations@qargo.com](mailto:integrations@qargo.com) |\n| **Token refresh needed?** | Yes (JWT expires) | No (credentials sent with each request) |\n\n### Common mistake\n\nWebhook credentials can technically be used to obtain an OAuth token via the `/auth/token` endpoint, but this token **will not work** for authenticating webhook requests. Always use Basic Authentication with your webhook credentials directly in the `Authorization` header.\n\n### Example webhook request\n\n```\ncurl -XPOST https://api.qargo.com/v1/webhook/order-import \\\n -H 'Content-Type: application/json' \\\n -u ':' \\\n -d '{ ... }'\n```\n\n# Rate Limits\n\nTo maintain API stability and prevent abuse, we enforce rate limits on a per-tenant basis.\n\n### Limits\n\nThe limits below are estimates based on normal operating conditions. Under increased system load, these limits may be tightened without prior notice to protect API stability.\n\n| **Category** | **Scope** | **Limit** |\n| --- | --- | --- |\n| Authentication | `/auth/token` | 5 requests per hour |\n| General API Usage | All endpoints *except* authentication and webhooks | 2 requests per second (sustained); up to 3 per second (bursts) |\n\n### Enforcement\n\nRate limits are enforced by tracking requests over several sliding time windows-per second, per 10 minutes, and per hour. Exceeding any of these limits will result in an HTTP `429 Too Many Requests` response. The response includes a `Retry-After` header specifying the number of seconds your application should wait before making a new request.\n\n![Timeline showing how to pace API requests, wait with jitter after a 429 response, and retry successfully](https://api.qargo.com/docs/static/rate_limit_timeline.svg)\n\nExample response:\n```http\nHTTP/1.1 429 Too Many Requests\nContent-Type: application/json\nRetry-After: 58\n\n{\"error\":\"Rate limit exceeded\"}\n```\n\nApplications must handle this response correctly by treating `Retry-After` as the minimum delay, regardless of whether the request appeared to be within the estimated limits. If multiple workers or processes can make requests for the same tenant, add a small positive random delay (jitter) after `Retry-After` before retrying. Never subtract jitter or retry earlier than indicated. If another `429` response is returned, repeat this process using the latest `Retry-After` value.\n\nFor any concerns about these limits, please contact us at [integrations@qargo.com](mailto:integrations@qargo.com).\n\n# API Best Practices\n\nThis section outlines recommended practices for efficiently working with the Qargo API.\n\n## Pagination\n\nSome list endpoints support cursor-based pagination. Paginated responses contain `items` and `next_cursor`. When `next_cursor` is not `null`, pass its value unchanged as the `cursor` query parameter in the next request. Do not combine `cursor` with other query parameters.\n\n
\n\n### How pagination works\n\n1. **Initial request**: Make a request to a paginated endpoint without a `cursor` parameter.\n2. **Process the response**: Read the current page from `items`.\n3. **Subsequent requests**: If `next_cursor` is not `null`, pass its value as the `cursor` parameter in the next request.\n4. **Stop**: Repeat until `next_cursor` is `null`.\n\n
\n\n### Example usage\n\n```http\nGET /v1/resources/resource\n```\n\nResponse:\n```json\n{\n \"items\": [\n {\n \"name\": \"Truck 142\",\n \"row_id\": \"3f9e6b1c-3333-4d2e-b1a4-7c8f9e0a1b03\"\n }\n ],\n \"next_cursor\": \"eyJwYXJhbWV0ZXJzIjp7fSwic3RhdGUiOiJhYmMxMjM0NSIsImN1cnNvcl9zb3J0IjoiMjAyNi0wOC0xMlQxMDowMDowMFoiLCJjdXJzb3JfaWQiOiIzZjllNmIxYy0zMzMzLTRkMmUtYjFhNC03YzhmOWUwYTFiMDMifQ==\"\n}\n```\n\nNext request:\n```http\nGET /v1/resources/resource?cursor=eyJwYXJhbWV0ZXJzIjp7fSwic3RhdGUiOiJhYmMxMjM0NSIsImN1cnNvcl9zb3J0IjoiMjAyNi0wOC0xMlQxMDowMDowMFoiLCJjdXJzb3JfaWQiOiIzZjllNmIxYy0zMzMzLTRkMmUtYjFhNC03YzhmOWUwYTFiMDMifQ==\n```\n\nThe next page can be empty. Continue until the response returns `next_cursor` as `null`.\n\n### Recommendations\n\n- Check that `next_cursor` is not `null` before making another request.\n- Treat cursors as opaque. Do not parse, modify, or construct them.\n- Do not combine `cursor` with other query parameters.\n\n## Backward compatibility\n\nThe Qargo API follows these backward compatibility principles:\n\n- **New fields may be added** to response payloads at any time. Adding new fields is **not** considered a breaking change.\n- **Integrators should ignore unknown fields** when parsing responses. Do not fail on unexpected properties.\n- **Deprecated fields and endpoints** are marked as `deprecated` in this specification. They continue to work but may be removed in a future version. Migrate to the recommended replacement as soon as possible.\n- **Existing fields will not be renamed or removed** without prior notice and a deprecation period.\n\n## Date and time formats\n\nAll date and time fields in the API follow ISO 8601:\n\n| Type | Format | Example | Description |\n|------|--------|---------|-------------|\n| Date | `YYYY-MM-DD` | `2024-12-31` | Calendar date without time component |\n| Datetime | `YYYY-MM-DDTHH:mm:ssZ` | `2024-12-31T14:30:00Z` | Timestamp in UTC (indicated by `Z` suffix) |\n| Time | `HH:mm` | `09:30` | Time of day in 24-hour format |\n\n- **Datetime fields are always in UTC.** Convert to local time on the client side.\n- **Date fields have no timezone.** They represent a calendar date (e.g. a planned delivery date).\n- **Time fields** are used for time windows (e.g. delivery windows) and are in 24-hour format without seconds.\n\n# Concepts\n\n## Company\n\nA company in Qargo can be both a customer as well as a subcontractor (supplier).\nThe entity will have a single id within Qargo. The api client can link companies by this id,\nor by the accounting code, which is a user defined code field.\n\n## Order\n\nTransport order to execute. Also called job in other TMS systems. It contains all transport details:\n\n- Order references\n- Customer [company](/customer/docs/section/concepts/company)\n- Consigments, with their [stop](/customer/docs/section/concepts/stop) locations, time windows, references\n- Definition of the goods to transport\n\n## Stop\n\n- A stop is a part of a transport, at a certain date, optional timeslot and location.\n In addition to the planned times, it also tracks the actual times for a completed stop.\n Stops can be linked to [orders](/customer/docs/section/concepts/order), or can be defined standalone (for example a cleaning stop).\n All stops are linked to a Trip.\n\n### Stop group\n\nStops can be grouped together according to their activity and location. This is called a stop group.\n\n## Trip\n\nA trip contains [stops](/customer/docs/section/concepts/stop) from various [orders](/customer/docs/section/concepts/order), or standalone [stops](/customer/docs/section/concepts/stop). It tracks how a certain\ntransport is planned, and who will execute that transport.\n\n## Task\n\nA task is the primary workflow concept in Qargo. Users can define their own flow,\nusing both built-in tasks as well a custom defined ones. For the current accounting use case,\nwe only expose the `post invoice/credit note` task, that allows users to send invoices to an accounting system.\n\n## Resource\n\nA resource in Qargo is a vehicle, driver, trailer or other entity that can be assigned to a [trip](/customer/docs/section/concepts/trip).\n\n## Unavailability\n\nAn unavailability indicates that a specific [resource](/customer/docs/section/concepts/resource) is not available for use for a given time range. An unavailability has a reason to indicate why the resource is not available.\n\n## Status update\n\nA status update reflects a status change in an entity.\n\n## Document\n\nA document in Qargo can be identified by a unique id. It has a type and is linked to a certain entity (for example an order).\n\n# Transport order creation & status\n\nThis sections details how to construct payloads to create transport orders using the order upload endpoint([/orders/order/upload](/customer/docs/api-order/import_order_v1_orders_order_upload_post)).\n\n## Order creation metadata\n\nOrders are not created synchronously via the API. When creating orders via the `POST /orders/order/upload` endpoint, you will receive the following response when creating an order.\n\n```json\n{\n \"upload_id\": \"\",\n \"upload_status\": \"IN_PROGRESS\",\n \"upload_url\": \"v1/orders/order/upload/\",\n \"order_id\": null,\n \"order_url\": null\n}\n```\n\nYou need to store the `upload_id` so you can fetch the status of the order creation by calling `GET /orders/order/upload/`\n\nBased on the status of the upload (`upload_status`), you can know if the order is still in the progress of being created or has already been created. Both `order_id` and `order_url` will be filled in when the order has been created. The `order_id` will be filled in with the order id, which can then be used to fetch the order data and status from the system.\n\n**Example payload `GET /orders/order/upload/e01b3db1-4e49-4241-a91e-7534da884d46`** with a created order\n\n```json\n{\n \"upload_id\": \"e01b3db1-4e49-4241-a91e-7534da884d46\",\n \"upload_status\": \"COMPLETED\",\n \"upload_url\": \"v1/orders/order/upload/e01b3db1-4e49-4241-a91e-7534da884d46\",\n \"order_id\": \"a2a84715-0027-49af-ad30-494c0ccf75cc\",\n \"order_url\": \"v1/orders/order/a2a84715-0027-49af-ad30-494c0ccf75cc\"\n}\n```\n\n## Order identifier\n\nThe `order_identifier` is used to uniquely identify orders that are being created via the API. This means that the same `order_identifier` needs to be used when updating orders. Multiple identical updates after each other are idempotent and will not fail the request.\n\nThe `order_identifier` main usage is for `deduplication`, you cannot use the `order_identifier` to fetch an order.\n\n## Create an order\n\nThe first example is a simple transport from our london office to our Ghent office.\nPlease note that the transport service will need to be matched with the one in your system.\n\n```json\n{\n \"operation\": \"CREATE\",\n \"consignments\": [\n {\n \"delivery_stop\": {\n \"date\": \"2022-05-03\",\n \"location\": {\n \"name\": \"Qargo Ghent office\",\n \"address\": \"Gaston Crommenlaan 4\",\n \"postal_code\": \"9050\",\n \"city\": \"Ghent\",\n \"country\": \"BE\"\n },\n \"reference_number\": \"D12345\"\n },\n \"pickup_stop\": {\n \"date\": \"2022-04-21\",\n \"location\": {\n \"name\": \"Qargo London office\",\n \"address\": \"71-91 Aldwych\",\n \"postal_code\": \"WC2B 4HN\",\n \"city\": \"London\",\n \"country\": \"UK\"\n },\n \"reference_number\": \"P123456\"\n }\n }\n ],\n \"customer_reference_number\": \"T12345\",\n \"customer\": {\n \"code\": \"00020\"\n },\n \"order_identifier\": \"T1234393\",\n \"transport_service\": {\n \"name\": \"General\"\n }\n}\n```\n\nNote: it is possible to 'export' existing orders in the api to use as examples/templates.\nSee the [Export existing orders](/customer/docs/section/transport-order-creation-and-status/export-an-existing-order) section.\n\n## Update an order\n\nThe following order is an update of an existing order. Note the `UPDATE` value of the operation field.\n\nImportant remarks:\n\n- Not all the fields of the order can be updated\n- the `order_identifier` field is used to identify the order to update\n\n**Example of an order update**\n\n```json\n{\n \"order_identifier\": \"QARGO_TEST_0001\",\n \"operation\": \"UPDATE\",\n \"customer\": {\n \"name\": \"UPS SCS Coventry\"\n },\n \"consignments\": [\n {\n \"pickup_stop\": {\n \"location\": {\n \"name\": \"Qargo HQ\",\n \"address\": \"Gaston Crommenlaan 4,\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"Qargo HQ building\"\n },\n \"note\": \"Pickup 4 boxes of pasta\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"QACOLLI001\",\n \"planning_instructions\": \"If closed, call mobile number\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"+0912341431\",\n \"mobile_number\": \"+324567890\"\n },\n \"delivery_stop\": {\n \"location\": {\n \"name\": \"Grocery store\",\n \"address\": \"Resedastraat 20\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"Grocery store\"\n },\n \"note\": \"Don't forget to sign the documents\",\n \"date\": \"2024-08-21\",\n \"reference_number\": \"QADELIV001\",\n \"planning_instructions\": \"Alarm code: 123456\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"02123456\",\n \"mobile_number\": \"+329998888\"\n },\n \"goods\": [\n {\n \"description\": \"4 boxes of pasta\",\n \"quantity\": 4\n }\n ]\n }\n ],\n \"customer_reference_number\": \"QARGO_TEST_0001\",\n \"transport_service\": {\n \"code\": \"CONTAINER_BOOKING\"\n }\n}\n```\n\n## Cancel an order\n\nTo cancel an order, pass `DELETE` as `operation` value. This will cancel the order. If the order has already been cancelled, this will not result in an error. Executing multiple cancellations is a idempotent operation and will not fail the request.\n\nA cancelled order cannot be uncancelled. If you need to revert the cancel, you will need to recreate the original order **using a different order identifier**. Using the same order identifier will cause the system to try to update the cancelled order, which results in an error.\n\n```json\n{\n \"operation\": \"DELETE\",\n \"consignments\": [\n {\n \"delivery_stop\": {\n \"date\": \"2022-05-03\",\n \"location\": {\n \"name\": \"Qargo Ghent office\",\n \"address\": \"Gaston Crommenlaan 4\",\n \"postal_code\": \"9050\",\n \"city\": \"Ghent\",\n \"country\": \"BE\"\n },\n \"reference_number\": \"D12345\"\n },\n \"pickup_stop\": {\n \"date\": \"2022-04-21\",\n \"location\": {\n \"name\": \"Qargo London office\",\n \"address\": \"71-91 Aldwych\",\n \"postal_code\": \"WC2B 4HN\",\n \"city\": \"London\",\n \"country\": \"UK\"\n },\n \"reference_number\": \"P123456\"\n }\n }\n ],\n \"customer_reference_number\": \"T12345\",\n \"customer\": {\n \"code\": \"00020\"\n },\n \"order_identifier\": \"T1234393\",\n \"transport_service\": {\n \"name\": \"General\"\n }\n}\n```\n\n## Export an existing order\n\nIt is possible to export a manually created order in the api. We first need to determine the technical id of this order.\n\n![Retrieve order id](https://api.qargo.com/docs/static/order_id.png).\n\nThe order can be exported with the following endpoint:\n[Export order](/customer/docs/section/transport-order-creation-and-status/export-an-existing-order).\nThe output of this endpoint corresponds to the order creation format. Just make sure to use a different [`order_identifier`](/customer/docs/section/transport-order-creation-and-status/order-identifier), otherwise the 'new' order will be interpreted as an update.\n\n\n## Fetch order data and status\n\nWith the `GET /orders/order/` [endpoint](/customer/docs/api-order/get_order_details_v1_orders_order__order_id__get), you can fetch the data related to the order. This contains the current `status` of the order along with other data.\n\n## Container orders\n\nThere are 2 types of container orders that can be created using the API, `IMPORT` and `EXPORT`.\n\n### Import\n\nThis scenario contains of 2 main stops additional optional stops.\n\n1. Pickup of a loaded container\n2. Unload container\n3. Drop off empty container (Optional, configured in `teardown_stops`)\n\nThe `container_scenario` property is set as `IMPORT` and the drop off location of the container is specified in the the `teardown_stops` property. The optional `teardown_stops` describe the stops of the container after the consignment has been completed\n\n**Example `IMPORT` container scenario**\n\n```json\n{\n \"order_identifier\": \"QARGO_TEST_0002\",\n \"operation\": \"CREATE\",\n \"customer\": {\n \"name\": \"UPS SCS Coventry\"\n },\n \"teardown_stops\": [\n {\n \"location\": {\n \"name\": \"Container yard\",\n \"address\": \"Scheepzatestraat 1\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\"\n },\n \"note\": \"Drop off the container on the designated location\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"CONT0001\",\n \"planning_instructions\": \"Put next to the red container\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"+0912341431\",\n \"mobile_number\": \"+324567890\"\n }\n ],\n \"consignments\": [\n {\n \"pickup_stop\": {\n \"location\": {\n \"name\": \"Container pickup location\",\n \"address\": \"Gaston Crommenlaan 4,\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"This is the container pickup location\"\n },\n \"note\": \"Pick up the green container\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"CONT0002\",\n \"planning_instructions\": \"Code of the container is 1234\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"+0912341431\",\n \"mobile_number\": \"+324567890\"\n },\n \"delivery_stop\": {\n \"location\": {\n \"name\": \"Sports store\",\n \"address\": \"Resedastraat 20\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"This is the delivery location of the container goods\"\n },\n \"note\": \"1000 boxes of shoes\",\n \"date\": \"2024-08-21\",\n \"reference_number\": \"CONT0003\",\n \"planning_instructions\": \"Use mobile number if gate is closed\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"02123456\",\n \"mobile_number\": \"+329998888\"\n }\n }\n ],\n \"container\": {\n \"container_scenario\": \"IMPORT\"\n },\n \"customer_reference_number\": \"QARGO_TEST_0002\",\n \"transport_service\": {\n \"code\": \"CONTAINERS\"\n }\n}\n```\n\n### Export\n\nThis scenario contains 2 main stops with additional optional stops:\n\n1. Pickup empty container (Optional, configured in `setup_stops`)\n2. Load empty container\n3. Drop off loaded container\n\nThe `container_scenario` is set as `EXPORT` and the `setup_stops` property allows to define additional optional stops.\n\n**Example of an `EXPORT` `container_scenario`**\n\n```json\n{\n \"order_identifier\": \"QARGO_TEST_0003\",\n \"operation\": \"CREATE\",\n \"customer\": {\n \"name\": \"UPS SCS Coventry\"\n },\n \"setup_stops\": [\n {\n \"location\": {\n \"name\": \"Container yard\",\n \"address\": \"Scheepzatestraat 1\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\"\n },\n \"note\": \"Pickup empty container on the designated location\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"CONT0001\",\n \"planning_instructions\": \"Blue container, next to the red container\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"+0912341431\",\n \"mobile_number\": \"+324567890\"\n }\n ],\n \"consignments\": [\n {\n \"pickup_stop\": {\n \"location\": {\n \"name\": \"Container loading location\",\n \"address\": \"Gaston Crommenlaan 4,\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"Qargo HQ, has a container loading bay\"\n },\n \"note\": \"Fill with 1000 boxes of Qargo shirts\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"CONT0002\",\n \"planning_instructions\": \"Code of the container is 1234\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"+0912341431\",\n \"mobile_number\": \"+324567890\"\n },\n \"delivery_stop\": {\n \"location\": {\n \"name\": \"Train station container hub\",\n \"address\": \"Resedastraat 20\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"This is the dropoff location of the loaded container\"\n },\n \"note\": \"1000 boxes of shoes\",\n \"date\": \"2024-08-21\",\n \"reference_number\": \"CONT0003\",\n \"planning_instructions\": \"Use mobile number if gate is closed\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"02123456\",\n \"mobile_number\": \"+329998888\"\n }\n }\n ],\n \"container\": {\n \"container_scenario\": \"EXPORT\"\n },\n \"customer_reference_number\": \"QARGO_TEST_0003\",\n \"transport_service\": {\n \"code\": \"CONTAINERS\"\n }\n}\n```\n\n### Create a loaded container import transport order\n\nThe following order picks up a filled container, delivers it to our office, and returns the empty container.\nThis examples also demonstrates how to model ADR information.\n\n```json\n{\n \"operation\": \"CREATE\",\n \"consignments\": [\n {\n \"delivery_stop\": {\n \"location\": {\n \"name\": \"Qargo Ghent office\",\n \"address\": \"Gaston Crommenlaan 4\",\n \"postal_code\": \"9050\",\n \"city\": \"Ghent\",\n \"country\": \"BE\"\n },\n \"note\": \"unloading address comments\",\n \"reference_number\": \"D123956\"\n },\n \"pickup_stop\": {\n \"location\": {\n \"address\": \"Europaweg\",\n \"city\": \"Rotterdam\",\n \"country\": \"NL\",\n \"name\": \"APM terminals Maasvlakte II\"\n },\n \"reference_number\": \"P123956\"\n },\n \"goods\": [\n {\n \"good_items\": {\n \"adr\": {\n \"name\": \"DISINFECTANT, LIQUID, CORROSIVE, N.O.S.\",\n \"un_number\": \"1903\"\n }\n },\n \"ordered_quantity\": 100,\n \"ordered_total_volume_value\": 43000,\n \"packaging_type\": {\n \"code\": \"PYZ\"\n }\n }\n ]\n }\n ],\n \"container_number\": \"MSCU5285725\",\n \"container_scenario\": \"IMPORT\",\n \"container_type\": {\n \"code\": \"22G0\"\n },\n \"customer\": {\n \"code\": \"00083\"\n },\n \"customer_reference_number\": \"C2325995\",\n \"order_identifier\": \"ord-12332423\",\n \"teardown_input\": [\n {\n \"location\": {\n \"address\": \"Butaanweg 52-54\",\n \"city\": \"Rotterdam\",\n \"country\": \"NL\",\n \"name\": \"OCC Overbeek Cont. Control.\"\n }\n }\n ],\n \"transport_service\": {\n \"name\": \"Container\"\n }\n}\n```\n\n### Create a loaded container export transport order\n\nThis example shows how to create a transport that exports a loaded container.\nThe setup section specifies the empty container pickup.\n\n```json\n{\n \"operation\": \"CREATE\",\n \"consignments\": [\n {\n \"delivery_stop\": {\n \"location\": {\n \"address\": \"Europaweg\",\n \"city\": \"Rotterdam\",\n \"country\": \"NL\",\n \"name\": \"APM terminals Maasvlakte II\"\n },\n \"reference_number\": \"3432423908987\"\n },\n \"pickup_stop\": {\n \"location\": {\n \"name\": \"Qargo Ghent office\",\n \"address\": \"Gaston Crommenlaan 4\",\n \"postal_code\": \"9050\",\n \"city\": \"Ghent\",\n \"country\": \"BE\"\n },\n \"reference_number\": \"3432441\"\n },\n \"goods\": [\n {\n \"absolute_max_temperature_value\": \"-8.0\",\n \"description\": \"Plastic buckets\",\n \"ordered_quantity\": 1500,\n \"packaging_type\": {\n \"code\": \"PE\"\n }\n }\n ]\n }\n ],\n \"container_number\": \"MSCU5285725\",\n \"container_scenario\": \"EXPORT\",\n \"container_type\": {\n \"code\": \"22RE\"\n },\n \"customer\": {\n \"code\": \"00007\"\n },\n \"customer_reference_number\": \"PUC-888315\",\n \"order_identifier\": \"d18f8309-0f26-4687-b32b-749008a0cb8e\",\n \"setup_input\": [\n {\n \"location\": {\n \"address\": \"Butaanweg 52-54\",\n \"city\": \"Rotterdam\",\n \"country\": \"NL\",\n \"name\": \"OCC Overbeek Cont. Control.\"\n }\n }\n ],\n \"transport_service\": {\n \"name\": \"Container\"\n }\n}\n```\n\n## Adding custom stops\n\nIn Qargo you can define custom stop actions. These stops can be added to configure additional stops related to the order.\n\nThese stops can be defined in the `standalone_stops` property.\n\nUsing `standalone_stops` to configure stops adds the following requirements to the order:\n\n1. Every stop needs to have a unique positive integer assigned to it. This will determine the sequence of the stops in the order.\n2. Every stops needs to have a `custom_activity` assigned to it. This will determine the type of stop that is being added to the order.\n\n**Example custom stops for an order**\n\n```json\n{\n \"import_configuration\": {\n \"code\": \"API\"\n },\n \"transport_service\": {\n \"code\": \"YOUR_TRANSPORT_SERVICE_CODE\"\n },\n \"customer\": {\n \"code\": \"CUSTOMER_CODE\"\n },\n \"operation\": \"CREATE\",\n \"order_identifier\": \"EXT-ORDER-001\",\n \"customer_reference_number\": \"CUST-REF-001\",\n \"consignments\": [\n {\n \"pickup_stop\": {\n \"activity\": \"PICKUP\",\n \"date\": \"2026-04-01\",\n \"location\": {\n \"name\": \"Warehouse Antwerp\",\n \"address\": \"Kaai 100\",\n \"city\": \"Antwerp\",\n \"postal_code\": \"2000\",\n \"country\": \"BE\"\n },\n \"position\": {\n \"optimal\": true,\n \"position\": 1\n }\n },\n \"delivery_stop\": {\n \"activity\": \"DELIVERY\",\n \"date\": \"2026-04-01\",\n \"location\": {\n \"name\": \"Distribution Center Ghent\",\n \"address\": \"Industrieweg 50\",\n \"city\": \"Ghent\",\n \"postal_code\": \"9000\",\n \"country\": \"BE\"\n },\n \"position\": {\n \"optimal\": true,\n \"position\": 3\n }\n },\n \"standalone_stops\": [\n {\n \"activity\": \"CUSTOM\",\n \"custom_activity_label\": \"WEEG\",\n \"date\": \"2026-04-01\",\n \"location\": {\n \"name\": \"Weigh Station Mechelen\",\n \"address\": \"Weegbrug 1\",\n \"city\": \"Mechelen\",\n \"postal_code\": \"2800\",\n \"country\": \"BE\"\n },\n \"position\": {\n \"optimal\": true,\n \"position\": 2\n }\n }\n ],\n \"goods\": [\n {\n \"description\": \"Palletized goods\",\n \"quantity\": 10,\n \"package_type\": \"EURO_PALLET\",\n \"total_weight\": 5000\n }\n ]\n }\n ]\n}\n```\n\n**Example custom stops for an container order**\n\n```json\n{\n \"order_identifier\": \"QARGO_TEST_0005\",\n \"operation\": \"CREATE\",\n \"customer\": {\n \"name\": \"UPS SCS Coventry\"\n },\n \"setup_stops\": [\n {\n \"location\": {\n \"name\": \"Stop 1\",\n \"address\": \"Scheepzatestraat 1\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\"\n },\n \"note\": \"Stop 1 notes\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"Stop 1 reference number\",\n \"planning_instructions\": \"Stop 1 instructions\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"+0912341431\",\n \"mobile_number\": \"+324567890\",\n \"activity\": \"COLLECT_EMPTY_CONTAINER\",\n \"position\": {\n \"position\": 1\n }\n }\n ],\n \"consignments\": [\n {\n \"standalone_stops\": [\n {\n \"location\": {\n \"name\": \"Stop 2\",\n \"address\": \"Vlierstraat 4,\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"HQ\"\n },\n \"note\": \"Stop 2 notes\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"Stop 2 number\",\n \"planning_instructions\": \"Stop 2 instructions\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"+0912341431\",\n \"mobile_number\": \"+324567890\",\n \"custom_activity\": \"WEGEN\",\n \"position\": {\n \"position\": 2\n }\n },\n {\n \"location\": {\n \"name\": \"Stop 6\",\n \"address\": \"Vlierstraat 4,\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"HQ\"\n },\n \"note\": \"Stop 6 notes\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"Stop 6 number\",\n \"planning_instructions\": \"Stop 6 instructions\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"+0912341431\",\n \"mobile_number\": \"+324567890\",\n \"custom_activity\": \"WEGEN\",\n \"position\": {\n \"position\": 6\n }\n },\n {\n \"location\": {\n \"name\": \"Stop 3\",\n \"address\": \"Corbiestraat 4,\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\"\n },\n \"note\": \"Stop 3 notes\",\n \"date\": \"2024-08-22\",\n \"reference_number\": \"Stop 3 reference number\",\n \"planning_instructions\": \"Stop 3 instructions\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"+0912341431\",\n \"mobile_number\": \"+324567890\",\n \"custom_activity\": \"INKLAREN\",\n \"position\": {\n \"position\": 3\n }\n }\n ],\n \"pickup_stop\": {\n \"location\": {\n \"name\": \"Stop 4\",\n \"address\": \"Gaston Crommenlaan 4,\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"HQ\"\n },\n \"note\": \"Stop 4 notes\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"Stop 4 reference number\",\n \"planning_instructions\": \"Stop 4 instructions\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"+0912341431\",\n \"mobile_number\": \"+324567890\",\n \"activity\": \"PICKUP_EXPORT\",\n \"position\": {\n \"position\": 4\n }\n },\n \"delivery_stop\": {\n \"location\": {\n \"name\": \"Stop 5\",\n \"address\": \"Resedastraat 20\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"Delivery\"\n },\n \"note\": \"Stop 5 notes\",\n \"date\": \"2024-08-21\",\n \"reference_number\": \"Stop 5 reference number\",\n \"planning_instructions\": \"Stop 5 instructions\",\n \"email\": \"info@qargo.com\",\n \"phone_number\": \"02123456\",\n \"mobile_number\": \"+329998888\",\n \"activity\": \"DELIVERY_EXPORT\",\n \"position\": {\n \"position\": 5\n }\n }\n }\n ],\n \"container\": {\n \"container_scenario\": \"EXPORT\"\n },\n \"customer_reference_number\": \"QARGO_TEST_0005\",\n \"transport_service\": {\n \"code\": \"CONTAINER_BOOKING\"\n }\n}\n```\n\n## Examples\n\n### Basic order\n\n```json\n{\n \"order_identifier\": \"DEFAULT_ORDER\",\n \"operation\": \"CREATE\",\n \"customer\": { \"name\": \"Qargo\" },\n \"import_configuration\": { \"code\": \"API\" },\n \"consignments\": [\n {\n \"pickup_stop\": {\n \"location\": {\n \"name\": \"Qargo\",\n \"address\": \"Gaston Crommenlaan 4\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"HQ\"\n },\n \"note\": \"Collection notes\",\n \"date\": \"2024-07-19\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\"\n },\n \"delivery_stop\": {\n \"location\": {\n \"name\": \"Qargo London\",\n \"address\": \"71-91 Aldwych\",\n \"postal_code\": \"WC2B 4HN\",\n \"city\": \"London\",\n \"country\": \"GB\",\n \"description\": \"Delivery\"\n },\n \"note\": \"Delivery notes\",\n \"date\": \"2024-07-19\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\"\n },\n \"goods\": [{ \"quantity\": 1 }]\n }\n ],\n \"customer_reference_number\": \"QARGO-123\",\n \"transport_service\": { \"code\": \"QARGO\" },\n \"service_level\": { \"code\": \"QARGO_NEXT_DAY\" }\n}\n```\n\n### Container IMPORT scenario\n\n```json\n{\n \"order_identifier\": \"CONTAINER_IMPORT_ORDER\",\n \"operation\": \"CREATE\",\n \"customer\": { \"name\": \"QARGO\" },\n \"import_configuration\": { \"code\": \"API\" },\n \"teardown_stops\": [\n {\n \"location\": {\n \"name\": \"Ghent Container Yard\",\n \"address\": \"Scheepzatestraat 1\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\"\n },\n \"note\": \"Empty container drop-off\",\n \"date\": \"2024-08-24\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\"\n }\n ],\n \"consignments\": [\n {\n \"pickup_stop\": {\n \"location\": {\n \"name\": \"Qargo Ghent\",\n \"address\": \"Gaston Crommenlaan 4,\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"\"\n },\n \"note\": \"\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\"\n },\n \"delivery_stop\": {\n \"location\": {\n \"name\": \"Qargo London\",\n \"address\": \"71-91 Aldwych\",\n \"postal_code\": \"WC2B 4HN\",\n \"city\": \"London\",\n \"country\": \"GB\",\n \"description\": \"Delivery\"\n },\n \"note\": \"Delivery notes\",\n \"date\": \"2024-08-22\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\"\n }\n }\n ],\n \"container\": { \"container_scenario\": \"IMPORT\", \"seal_number\": \"SEAL12345\" },\n \"customer_reference_number\": \"QARGO-01\",\n \"transport_service\": { \"code\": \"CONTAINER_TRANSPORT_SERVICE\" }\n}\n```\n\n### Container EXPORT scenario\n\n```json\n{\n \"order_identifier\": \"CONTAINER_EXPORT_ORDER\",\n \"operation\": \"CREATE\",\n \"customer\": { \"name\": \"QARGO\" },\n \"import_configuration\": { \"code\": \"API\" },\n \"setup_stops\": [\n {\n \"location\": {\n \"name\": \"Ghent Container Yard\",\n \"address\": \"Scheepzatestraat 1\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\"\n },\n \"note\": \"Empty container pickup location\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\"\n }\n ],\n \"consignments\": [\n {\n \"pickup_stop\": {\n \"location\": {\n \"name\": \"Qargo Ghent\",\n \"address\": \"Gaston Crommenlaan 4,\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"\"\n },\n \"note\": \"\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\"\n },\n \"delivery_stop\": {\n \"location\": {\n \"name\": \"Qargo London\",\n \"address\": \"71-91 Aldwych\",\n \"postal_code\": \"WC2B 4HN\",\n \"city\": \"London\",\n \"country\": \"GB\",\n \"description\": \"Delivery\"\n },\n \"note\": \"Delivery notes\",\n \"date\": \"2024-08-22\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\"\n }\n }\n ],\n \"container\": { \"container_scenario\": \"EXPORT\", \"seal_number\": \"SEAL12345\" },\n \"customer_reference_number\": \"QARGO-00003\",\n \"transport_service\": { \"code\": \"CONTAINER_TRANSPORT_SERVICE\" }\n}\n```\n\n### Order with multiple stops example\n\n```json\n{\n \"order_identifier\": \"MULTIPLE_STOPS_ORDER\",\n \"operation\": \"CREATE\",\n \"customer\": { \"name\": \"QARGO\" },\n \"consignments\": [\n {\n \"standalone_stops\": [\n {\n \"location\": {\n \"name\": \"Customs Ghent\",\n \"address\": \"Sint-Lievenslaan 27\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"Customs office location\"\n },\n \"note\": \"\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\",\n \"custom_activity\": \"CUSTOMS\",\n \"position\": { \"position\": 1 }\n },\n {\n \"location\": {\n \"name\": \"Truck weight station\",\n \"address\": \"Belgicastraat 10\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"HQ\"\n },\n \"note\": \"\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\",\n \"custom_activity\": \"WEIGHT_STATION\",\n \"position\": { \"position\": 2 }\n },\n {\n \"location\": {\n \"name\": \"Truckwash Ghent\",\n \"address\": \"Traktaatweg 23\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\"\n },\n \"note\": \"\",\n \"date\": \"2024-08-23\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\",\n \"custom_activity\": \"WASHING\",\n \"position\": { \"position\": 5 }\n }\n ],\n \"pickup_stop\": {\n \"location\": {\n \"name\": \"Qargo Ghent\",\n \"address\": \"Gaston Crommenlaan 4,\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"\"\n },\n \"note\": \"\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\",\n \"activity\": \"PICKUP\",\n \"position\": { \"position\": 3 }\n },\n \"delivery_stop\": {\n \"location\": {\n \"name\": \"Qargo London\",\n \"address\": \"71-91 Aldwych\",\n \"postal_code\": \"WC2B 4HN\",\n \"city\": \"London\",\n \"country\": \"GB\",\n \"description\": \"Delivery\"\n },\n \"note\": \"Delivery notes\",\n \"date\": \"2024-08-22\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\",\n \"activity\": \"DELIVERY\",\n \"position\": { \"position\": 4 }\n }\n }\n ],\n \"customer_reference_number\": \"QARGO_001\",\n \"transport_service\": { \"code\": \"FULL_LOADS\" }\n}\n```\n\n### Order with ADR goods\n\n`technical_name_by_locale` is writable; use it to provide localized technical names for the dangerous goods. Each key\nmust be a supported locale code, and each value is the technical name for that locale. `adr_name_by_locale` is\nread-only; the API generates this field automatically and ignores any submitted value. The example below provides\ntechnical names for four locales.\n\n```json\n{\n \"order_identifier\": \"DANGEROUS_GOODS_ORDER\",\n \"operation\": \"CREATE\",\n \"customer\": { \"name\": \"QARGO\" },\n \"import_configuration\": { \"code\": \"API\" },\n \"consignments\": [\n {\n \"pickup_stop\": {\n \"location\": {\n \"name\": \"Qargo Ghent\",\n \"address\": \"Gaston Crommenlaan 4,\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"\"\n },\n \"note\": \"\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\"\n },\n \"delivery_stop\": {\n \"location\": {\n \"name\": \"Qargo London\",\n \"address\": \"71-91 Aldwych\",\n \"postal_code\": \"WC2B 4HN\",\n \"city\": \"London\",\n \"country\": \"GB\",\n \"description\": \"Delivery\"\n },\n \"note\": \"Delivery notes\",\n \"date\": \"2024-08-22\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\"\n },\n \"goods\": [\n {\n \"packaged_items\": [\n {\n \"adr\": {\n \"un_number\": \"1956\",\n \"packaging_type\": \"BOX\",\n \"emergency_phone_number\": \"+32456789010\",\n \"technical_name_by_locale\": {\n \"de-DE\": \"NEG Stoffname\",\n \"en\": \"NEG Substance name\",\n \"fr-FR\": \"NEG Nom de la substance\",\n \"nl-BE\": \"NEG Stofnaam\"\n }\n },\n \"quantity\": 5,\n \"total_volume_l\": 100,\n \"total_weight_kg\": 100,\n \"description\": \"Dangerous and flammable goods\"\n }\n ],\n \"description\": \"Fuel\",\n \"quantity\": 1,\n \"product_name\": \"FUEL\"\n }\n ]\n }\n ],\n \"customer_reference_number\": \"QARGO-001\",\n \"transport_service\": { \"code\": \"HAZARDOUS\" },\n \"service_level\": { \"code\": \"NEXT_DAY\" }\n}\n```\n\n### Order with pallets and custom barcodes\n\n```json\n{\n \"order_identifier\": \"PALLETS_WITH_BARCODES_ORDER\",\n \"operation\": \"CREATE\",\n \"customer\": { \"name\": \"QARGO\" },\n \"import_configuration\": { \"code\": \"API\" },\n \"consignments\": [\n {\n \"pickup_stop\": {\n \"location\": {\n \"name\": \"Qargo Ghent\",\n \"address\": \"Gaston Crommenlaan 4,\",\n \"postal_code\": \"9000\",\n \"city\": \"Gent\",\n \"state\": \"Oost-Vlaanderen\",\n \"country\": \"BE\",\n \"description\": \"\"\n },\n \"note\": \"\",\n \"date\": \"2024-08-20\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\"\n },\n \"delivery_stop\": {\n \"location\": {\n \"name\": \"Qargo London\",\n \"address\": \"71-91 Aldwych\",\n \"postal_code\": \"WC2B 4HN\",\n \"city\": \"London\",\n \"country\": \"GB\",\n \"description\": \"Delivery\"\n },\n \"note\": \"Delivery notes\",\n \"date\": \"2024-08-22\",\n \"reference_number\": \"\",\n \"planning_instructions\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"mobile_number\": \"\"\n },\n \"goods\": [\n {\n \"quantity\": 1,\n \"packaging_type\": {\n \"name\": \"Full Pallet\",\n \"packaging_size\": { \"code\": \"FP\" }\n },\n \"handling_units\": [\n { \"barcode\": { \"value\": \"01J93R8V517R7133FVCM3ZCJNN\" } }\n ]\n },\n {\n \"quantity\": 2,\n \"packaging_type\": {\n \"name\": \"Half Pallet\",\n \"packaging_size\": { \"code\": \"HP\" }\n },\n \"handling_units\": [\n { \"barcode\": { \"value\": \"01J93R9024CNTJJPQG8WDP2PVX\" } },\n { \"barcode\": { \"value\": \"01J93R9PKY3A5C9S6T4VV12C8B\" } }\n ]\n }\n ]\n }\n ],\n \"customer_reference_number\": \"QARGO-0001\",\n \"transport_service\": { \"code\": \"PALLETS\" },\n \"service_level\": { \"code\": \"PREMIUM_NEXT_DAY\" }\n}\n```\n\n# Changelog\n\nRecent additions and changes to the API, newest first.\n\n## 2026-09-04\n\n**Outgoing data**\n\n- **Added:** Goods in outbound order payloads — operational visibility, fleet and subcontractor dispatch, intermodal and location bookings — gain an optional `hs_codes` object, carrying `count`: the number of HS codes for the good. The field is omitted when not set on the good.\n - _Affects:_ [Customer portal](/customer/docs/use-case-customer-portal), [Fleet dispatch](/customer/docs/use-case-fleet-dispatch), [Intermodal](/customer/docs/use-case-intermodal-partner), [Location booking](/customer/docs/use-case-location-booking), [Order](/customer/docs/use-case-order), [Subcontractor dispatch](/customer/docs/use-case-subcontractor-dispatch), [Visibility](/customer/docs/use-case-visibility)\n\n## 2026-08-19\n\n**API**\n\n- **Added:** `PaymentTermCode` gains `END_OF_MONTH_0_NET_20`, for a payment term of end of this month plus 20 days.\n - _Affects:_ [Accounting](/customer/docs/api-accounting), [Company](/customer/docs/api-company), [Order](/customer/docs/api-order), [Task](/customer/docs/api-task), [Trip](/customer/docs/api-trip)\n\n## 2026-08-14\n\n**API**\n\n- **Fixed:** The `/me` response now includes `active_tenant_slug` for CUSTOMER-role tokens, matching other API roles.\n - _Affects:_ [System](/customer/docs/system)\n - _Endpoints:_ `GET /me`\n\n## 2026-08-12\n\n**API**\n\n- **Changed:** Charge `status` now reports `INVOICE_POSTED` for charges on a posted invoice and `DO_NOT_INVOICE` for charges excluded from invoicing. These were previously reported as `CREATED`, including on existing charges, so invoiced and uninvoiced charges can now be told apart. Treat the status as an open set and map unrecognised values to `CREATED`.\n - _Affects:_ [Order](/customer/docs/use-case-order), [Customer portal](/customer/docs/use-case-customer-portal)\n - _Endpoints:_ `GET /v1/orders/order/{order_id}/charges`, `POST /v1/orders/order/{order_id}/charges/approval`\n\n## 2026-08-11\n\n**Outgoing data**\n\n- **Added:** `VisibilityOrderStatus` in operational visibility payloads gains `BLOCKED`, for an order that is blocked or on hold. Treat the order status as an open set and ignore values you do not recognise rather than rejecting the event.\n - _Affects:_ [Customer portal](/customer/docs/use-case-customer-portal), [Order](/customer/docs/use-case-order), [Visibility](/customer/docs/use-case-visibility)\n\n## 2026-08-05\n\n**Outgoing data**\n\n- **Added:** `ResourceType` in operational visibility payloads gains `HANDLING`, for handling equipment such as a forklift assigned to a stop, and `SUBCONTRACTOR`, which the payload has been able to carry for some time but was undocumented. Treat the resource type as an open set and ignore values you do not recognise rather than rejecting the event.\n - _Affects:_ [Customer portal](/customer/docs/use-case-customer-portal), [Order](/customer/docs/use-case-order), [Visibility](/customer/docs/use-case-visibility)\n\n## 2026-07-29\n\n**Outgoing data**\n\n- **Changed:** `location.name` is no longer guaranteed in operational visibility payloads. A location without a name, such as an address-only one created automatically by an order import, previously blocked the entire visibility event from being sent; it is now sent with `name` omitted. Treat the field as optional and fall back to `address` and `city` when it is absent.\n - _Affects:_ [Customer portal](/customer/docs/use-case-customer-portal), [Order](/customer/docs/use-case-order), [Visibility](/customer/docs/use-case-visibility)\n\n## 2026-07-23\n\n**API**\n\n- **Fixed:** Updating a resource no longer returns a server error when `note` or `external_id` is omitted; the value is now stored as an empty string, matching create. Sending an explicit `null` for `note`, `external_id`, `name`, or `locale` is now rejected with a validation error (422) instead of failing with a server error on update, or being silently ignored on create.\n - _Affects:_ [Resource](/customer/docs/api-resource)\n - _Endpoints:_ `POST /v1/resources/resource`, `PUT /v1/resources/resource/{resource_id}`, `PATCH /v1/resources/resource/{resource_id}`\n- **Added:** Stops in order status responses now include `stop_type`, identifying the consignment pickup (`PICKUP`) and delivery (`DELIVERY`) stops. The field is empty for other stops.\n - _Affects:_ [Order](/customer/docs/api-order)\n - _Endpoints:_ `GET /v1/orders/order/{order_id}/status`\n\n**Outgoing data**\n\n- **Added:** Resources in visibility events can now report the `BARGE` and `AIRPLANE` types.\n - _Affects:_ [Customer portal](/customer/docs/use-case-customer-portal), [Order](/customer/docs/use-case-order), [Visibility](/customer/docs/use-case-visibility)\n\n## 2026-07-22\n\n**API**\n\n- **Removed:** Order status responses no longer include `first_pickup_stop`. The same information can be derived from the `stops` array, which is ordered by stop sequence: the first stop with a pickup `activity_label` is the first pickup stop, and likewise the last stop with a delivery `activity_label` is the last delivery stop.\n - _Affects:_ [Order](/customer/docs/api-order)\n - _Endpoints:_ `GET /v1/orders/order/{order_id}/status`\n\n## 2026-07-10\n\n**API**\n\n- **Added:** Order status responses now include `first_pickup_stop`.\n - _Affects:_ [Order](/customer/docs/api-order)\n - _Endpoints:_ `GET /v1/orders/order/{order_id}/status`\n- **Changed:** `last_delivery_stop` now uses the documented order-status stop shape.\n - _Affects:_ [Order](/customer/docs/api-order)\n - _Endpoints:_ `GET /v1/orders/order/{order_id}/status`\n\n## 2026-07-06\n\n**API**\n\n- **Changed:** Validation error responses now return an `errors` array instead of the flat `detail`, `field` and `path` fields. Each item is a `ValidationErrorDetail` with `message`, `field`, `path` and `detail`; the array is always present and non-empty, so a single failure is a one-item array and integrators can handle one and many failures the same way.\n - _Affects:_ [Accounting](/customer/docs/api-accounting), [Authentication](/customer/docs/api-authentication), [Company](/customer/docs/api-company), [Document](/customer/docs/api-document), [Order](/customer/docs/api-order), [Resource](/customer/docs/api-resource), [Task](/customer/docs/api-task), [Trip](/customer/docs/api-trip)\n\n## 2026-06-03\n\n**Outgoing data**\n\n- **Added:** Operational order visibility now includes goods information.\n - _Affects:_ [Customer portal](/customer/docs/use-case-customer-portal), [Order](/customer/docs/use-case-order), [Visibility](/customer/docs/use-case-visibility)\n\n## 2026-03-10\n\n**Outgoing data**\n\n- **Added:** Operational order visibility now includes stop ETA times (`eta_start_time`, `eta_end_time`).\n - _Affects:_ [Customer portal](/customer/docs/use-case-customer-portal), [Order](/customer/docs/use-case-order), [Visibility](/customer/docs/use-case-visibility)\n\n## 2026-01-09\n\n**Outgoing data**\n\n- **Added:** Operational order visibility now includes the customer `id`.\n - _Affects:_ [Customer portal](/customer/docs/use-case-customer-portal), [Order](/customer/docs/use-case-order), [Visibility](/customer/docs/use-case-visibility)", "version": "1.2.0" }, "servers": [ { "url": "https://api.qargo.com" } ], "paths": { "/v1/documents/document/{id}/download": { "get": { "tags": [ "API / Document", "Use case / Accounting", "Use case / Order", "Use case / Master data sync", "Use case / Customer portal" ], "summary": "Download Document", "description": "Download a document by its ID. You can choose to download the document directly or stream it.", "operationId": "download_document_v1_documents_document__id__download_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "direct", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Direct" }, "description": "Query parameter to indicate that the response should contain all the document bytes" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/orders/order/upload": { "post": { "tags": [ "API / Order", "Use case / Order", "Use case / Customer portal" ], "summary": "Import Order", "description": "Create or update orders in Qargo. See the \"Transport order creation & status\" section for more info.", "operationId": "import_order_v1_orders_order_upload_post", "security": [ { "oAuth2ClientCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderImport" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/orders/order/upload/{upload_id}": { "get": { "tags": [ "API / Order", "Use case / Order", "Use case / Customer portal" ], "summary": "Get Order Import Status", "description": "Get the status of an order import", "operationId": "get_order_import_status_v1_orders_order_upload__upload_id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "upload_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Upload Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderImport" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/orders/order/{order_id}": { "get": { "tags": [ "API / Order", "Use case / Order", "Use case / Customer portal" ], "summary": "Get Order Details", "description": "Fetch order detail", "operationId": "get_order_details_v1_orders_order__order_id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Order Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/orders/order/{order_id}/charges": { "get": { "tags": [ "API / Order", "Use case / Order", "Use case / Customer portal" ], "summary": "List Order Charges", "description": "Charges for a certain order. Note that these charges are not final and may change", "operationId": "List_Order_Charges_v1_orders_order__order_id__charges_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Order Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderChargesOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/orders/order/{order_id}/charges/approval": { "post": { "tags": [ "API / Order", "Use case / Order", "Use case / Customer portal" ], "summary": "Approve Order Charges", "description": "Approve or reject certain charges on the order", "operationId": "Approve_Order_Charges_v1_orders_order__order_id__charges_approval_post", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Order Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargesApprovalInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderChargesOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/orders/order/{order_id}/documents": { "get": { "tags": [ "API / Order", "Use case / Order", "Use case / Customer portal" ], "summary": "List Order Documents", "description": "Fetch documents for an order. This includes `consignment` documents", "operationId": "list_order_documents_v1_orders_order__order_id__documents_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Order Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" }, "title": "Response List Order Documents V1 Orders Order Order Id Documents Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/orders/order/{order_id}/export": { "get": { "tags": [ "API / Order", "Use case / Order", "Use case / Customer portal" ], "summary": "Order Export", "description": "Provides a minimal set of order data that can be used as a blueprint to create a new order", "operationId": "order_export_v1_orders_order__order_id__export_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Order Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderExport" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/orders/order/{order_id}/status": { "get": { "tags": [ "API / Order", "Use case / Order", "Use case / Customer portal" ], "summary": "Order Status", "description": "Order status endpoint. Provides information on the status of the order", "operationId": "order_status_v1_orders_order__order_id__status_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Order Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderWithStatus" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "https://": { "post": { "tags": [ "Use case / Visibility", "Webhooks / Outbound", "Use case / Order", "Use case / Customer portal" ], "summary": "Operational Visibility Event", "description": "Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates.\n\nBy default, Qargo sends payloads using the `OperationalVisibilityUpdate` schema:\n\n- `order` for `OrderUpdate`, `StopUpdate`, `DocumentUpdate`, `EtaUpdate`, and `HandlingUnitUpdate` events.\n\n`OrderImportUpdate` and other events not listed above may not include `order`. The `trip` field is not populated\nby default; including it requires a custom webhook format configured by Qargo.\n\nA custom webhook format configured by Qargo may use a different structure.", "operationId": "operational_visibility_event_webhook_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OperationalVisibilityUpdate" }, { "type": "object" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/auth/token": { "post": { "tags": [ "API / Authentication" ], "summary": "Generate Token", "operationId": "generate_token_v1_auth_token_post", "security": [ { "oAuth2ClientCredentials": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/me": { "get": { "tags": [ "System" ], "summary": "Who Am I", "operationId": "who_am_i_me_get", "security": [ { "oAuth2ClientCredentials": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "title": "Response Who Am I Me Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/accounts": { "get": { "tags": [ "API / Accounting", "Use case / Master data sync", "Use case / Accounting" ], "summary": "List Accounts", "description": "Lists accounting codes (GL / nominal codes) for the tenant, with optional filtering and pagination.", "operationId": "List_accounts_v1_accounting_accounts_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "archived", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Archived" }, "description": "Filter by archived status. Omit to return all accounts." }, { "name": "billing_entity_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Billing Entity Code" }, "description": "Filter by billing entity code." }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "description": "Accounting code to match exactly." }, { "name": "code:in", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code:In" }, "description": "Accounting codes to match. Comma-separated list." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAccountOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/accounts/{id}": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Account", "description": "Retrieves a single accounting code (GL / nominal code) by its ID.", "operationId": "Retrieve_account_v1_accounting_accounts__id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__accounting__models__master_data__AccountOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/company": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "List Companies (Deprecated)", "description": "(deprecated, use /company instead)", "operationId": "list_companies__deprecated__v1_accounting_company_get", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "updated_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated After" }, "description": "Filter to fetch the companies updated after this time. Format is ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "description": "Company code to match exactly." }, { "name": "code:in", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code:In" }, "description": "Company codes to match. Comma-separated list." }, { "name": "accounting_customer_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accounting Customer Code" }, "description": "Accounting customer code to match exactly. Holds the code of the default billing entity." }, { "name": "accounting_customer_code:in", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accounting Customer Code:In" }, "description": "Accounting customer codes to match. Comma-separated list. Holds the code of the default billing entity." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCompanyOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "post": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Create Company (Deprecated)", "description": "(deprecated, use /company instead)", "operationId": "create_company__deprecated__v1_accounting_company_post", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/company/{id}": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Get Company (Deprecated)", "description": "(deprecated, use /company/{id} instead)", "operationId": "get_company__deprecated__v1_accounting_company__id__get", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "put": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Update Company (Deprecated)", "description": "(deprecated, use /company/{id} instead)", "operationId": "update_company__deprecated__v1_accounting_company__id__put", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "patch": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Update Company (Deprecated)", "description": "(deprecated, use /company/{id} instead)", "operationId": "update_company__deprecated__v1_accounting_company__id__patch", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPartialInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "delete": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Archive Company (Deprecated)", "description": "Archive the company. This is a soft-delete: the company record is preserved and its `archived_customer`, `archived_subcontractor`, and `archived_buyer_or_seller` flags are set to `true` so it no longer appears in active lists.(deprecated, use /company/{id} instead)", "operationId": "Archive_company__deprecated__v1_accounting_company__id__delete", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/exchange-rate": { "post": { "tags": [ "API / Accounting", "Use case / Master data sync", "Use case / Accounting" ], "summary": "Create An Exchange Rate", "description": "Creates an exchange rate in Qargo for the given currency pair and date.", "operationId": "Create_an_exchange_rate_v1_accounting_exchange_rate_post", "security": [ { "oAuth2ClientCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangeRateInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangeRateOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "get": { "tags": [ "API / Accounting", "Use case / Master data sync", "Use case / Accounting" ], "summary": "List Exchange Rates", "description": "Retrieves a list of exchange rates with optional currency and date filters. When filtering by both from_currency and to_currency, results are returned in the requested direction regardless of how they are stored internally.", "operationId": "List_exchange_rates_v1_accounting_exchange_rate_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "from_currency", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/CurrencyCode" }, { "type": "null" } ], "title": "From Currency" }, "description": "Filter by source currency code (ISO 4217)." }, { "name": "from_currency:in", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Currency:In" }, "description": "Source currency codes to match (ISO 4217). Comma-separated list. Matches either side of the currency pair." }, { "name": "to_currency", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/CurrencyCode" }, { "type": "null" } ], "title": "To Currency" }, "description": "Filter by target currency code (ISO 4217)." }, { "name": "to_currency:in", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To Currency:In" }, "description": "Target currency codes to match (ISO 4217). Comma-separated list. Matches either side of the currency pair." }, { "name": "exchange_rate_date:gte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Exchange Rate Date:Gte" }, "description": "Filter exchange rates on or after this date." }, { "name": "exchange_rate_date:lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Exchange Rate Date:Lte" }, "description": "Filter exchange rates on or before this date." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExchangeRateOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/purchase-credit-note/{id}": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Purchase Credit Note", "operationId": "Retrieve_purchase_credit_note_v1_accounting_purchase_credit_note__id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseCreditNote" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "patch": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Update Purchase Credit Note", "operationId": "Update_purchase_credit_note_v1_accounting_purchase_credit_note__id__patch", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseCreditNoteInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseCreditNote" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/purchase-credit-note/{id}/documents": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Purchase Credit Note Documents", "operationId": "Retrieve_purchase_credit_note_documents_v1_accounting_purchase_credit_note__id__documents_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" }, "title": "Response Retrieve Purchase Credit Note Documents V1 Accounting Purchase Credit Note Id Documents Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/purchase-credit-note/{id}/refund/update-status": { "post": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Report Refund Status For Purchase Credit Note", "operationId": "Report_refund_status_for_purchase_credit_note_v1_accounting_purchase_credit_note__id__refund_update_status_post", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundStatusUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundStatusUpdate" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/purchase-invoice/{id}": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Purchase Invoice", "operationId": "Retrieve_purchase_invoice_v1_accounting_purchase_invoice__id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoice" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "patch": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Update Purchase Invoice", "operationId": "Update_purchase_invoice_v1_accounting_purchase_invoice__id__patch", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoiceInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoice" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/purchase-invoice/{id}/documents": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Purchase Invoice Documents", "operationId": "Retrieve_purchase_invoice_documents_v1_accounting_purchase_invoice__id__documents_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" }, "title": "Response Retrieve Purchase Invoice Documents V1 Accounting Purchase Invoice Id Documents Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/purchase-invoice/{id}/payment/update-status": { "post": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Report Payment Status For Purchase Invoice", "operationId": "Report_payment_status_for_purchase_invoice_v1_accounting_purchase_invoice__id__payment_update_status_post", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentStatusUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentStatusUpdate" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/purchase_invoice/{id}": { "get": { "tags": [ "API / Accounting", "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Purchase Invoice (Deprecated)", "description": "(deprecated, use /purchase-invoice/{id} instead)", "operationId": "Retrieve_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__get", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoice" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "patch": { "tags": [ "API / Accounting", "API / Accounting", "Use case / Accounting" ], "summary": "Update Purchase Invoice (Deprecated)", "description": "(deprecated, use /purchase-invoice/{id} instead)", "operationId": "Update_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__patch", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoiceInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseInvoice" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/purchase_invoice/{id}/documents": { "get": { "tags": [ "API / Accounting", "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Purchase Invoice Documents (Deprecated)", "description": "(deprecated, use /purchase-invoice/{id}/documents instead)", "operationId": "Retrieve_purchase_invoice_documents__deprecated__v1_accounting_purchase_invoice__id__documents_get", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" }, "title": "Response Retrieve Purchase Invoice Documents Deprecated V1 Accounting Purchase Invoice Id Documents Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/purchase_invoice/{id}/payment/update-status": { "post": { "tags": [ "API / Accounting", "API / Accounting", "Use case / Accounting" ], "summary": "Report Payment Status For Purchase Invoice (Deprecated)", "description": "(deprecated, use /purchase-invoice/{id}/payment/update-status instead)", "operationId": "Report_payment_status_for_purchase_invoice__deprecated__v1_accounting_purchase_invoice__id__payment_update_status_post", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentStatusUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentStatusUpdate" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales-credit-note/": { "post": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Create A Sales Credit Note", "operationId": "Create_a_sales_credit_note_v1_accounting_sales_credit_note__post", "security": [ { "oAuth2ClientCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNoteInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNoteOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales-credit-note/{id}": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Sales Credit Note", "operationId": "Retrieve_sales_credit_note_v1_accounting_sales_credit_note__id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNoteOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "patch": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Update Credit Note", "operationId": "Update_credit_note_v1_accounting_sales_credit_note__id__patch", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNotePatchInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNoteOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales-credit-note/{id}/documents": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Sales Credit Note Documents", "operationId": "Retrieve_sales_credit_note_documents_v1_accounting_sales_credit_note__id__documents_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" }, "title": "Response Retrieve Sales Credit Note Documents V1 Accounting Sales Credit Note Id Documents Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales-credit-note/{id}/refund/update-status": { "post": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Report Refund Status For Sales Credit Note", "operationId": "Report_refund_status_for_sales_credit_note_v1_accounting_sales_credit_note__id__refund_update_status_post", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundStatusUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundStatusUpdate" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales-invoice/": { "post": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Create A Sales Invoice", "operationId": "Create_a_sales_invoice_v1_accounting_sales_invoice__post", "security": [ { "oAuth2ClientCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoiceInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoiceOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales-invoice/{id}": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Sales Invoice", "operationId": "Retrieve_sales_invoice_v1_accounting_sales_invoice__id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoiceOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "patch": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Update Sales Invoice", "operationId": "Update_sales_invoice_v1_accounting_sales_invoice__id__patch", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoicePatchInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoiceOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales-invoice/{id}/documents": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Sales Invoice Documents", "operationId": "Retrieve_sales_invoice_documents_v1_accounting_sales_invoice__id__documents_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" }, "title": "Response Retrieve Sales Invoice Documents V1 Accounting Sales Invoice Id Documents Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales-invoice/{id}/payment/update-status": { "post": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Report Payment Status For Sales Invoice", "operationId": "Report_payment_status_for_sales_invoice_v1_accounting_sales_invoice__id__payment_update_status_post", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentStatusUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentStatusUpdate" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales_credit_note/{id}": { "get": { "tags": [ "API / Accounting", "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Sales Credit Note (Deprecated)", "description": "(deprecated, use /sales-credit-note/{id} instead)", "operationId": "Retrieve_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__get", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNoteOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "patch": { "tags": [ "API / Accounting", "API / Accounting", "Use case / Accounting" ], "summary": "Update Credit Note (Deprecated)", "description": "(deprecated, use /sales-credit-note/{id} instead)", "operationId": "Update_credit_note__deprecated__v1_accounting_sales_credit_note__id__patch", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNotePatchInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCreditNoteOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales_credit_note/{id}/documents": { "get": { "tags": [ "API / Accounting", "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Sales Credit Note Documents (Deprecated)", "description": "(deprecated, use /sales-credit-note/{id}/documents instead)", "operationId": "Retrieve_sales_credit_note_documents__deprecated__v1_accounting_sales_credit_note__id__documents_get", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" }, "title": "Response Retrieve Sales Credit Note Documents Deprecated V1 Accounting Sales Credit Note Id Documents Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales_credit_note/{id}/refund/update-status": { "post": { "tags": [ "API / Accounting", "API / Accounting", "Use case / Accounting" ], "summary": "Report Refund Status For Sales Credit Note (Deprecated)", "description": "(deprecated, use /sales-credit-note/{id}/refund/update-status instead)", "operationId": "Report_refund_status_for_sales_credit_note__deprecated__v1_accounting_sales_credit_note__id__refund_update_status_post", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundStatusUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundStatusUpdate" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales_invoice/{id}": { "get": { "tags": [ "API / Accounting", "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Sales Invoice (Deprecated)", "description": "(deprecated, use /sales-invoice/{id} instead)", "operationId": "Retrieve_sales_invoice__deprecated__v1_accounting_sales_invoice__id__get", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoiceOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "patch": { "tags": [ "API / Accounting", "API / Accounting", "Use case / Accounting" ], "summary": "Update Sales Invoice (Deprecated)", "description": "(deprecated, use /sales-invoice/{id} instead)", "operationId": "Update_sales_invoice__deprecated__v1_accounting_sales_invoice__id__patch", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoicePatchInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesInvoiceOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales_invoice/{id}/documents": { "get": { "tags": [ "API / Accounting", "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Sales Invoice Documents (Deprecated)", "description": "(deprecated, use /sales-invoice/{id}/documents instead)", "operationId": "Retrieve_sales_invoice_documents__deprecated__v1_accounting_sales_invoice__id__documents_get", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" }, "title": "Response Retrieve Sales Invoice Documents Deprecated V1 Accounting Sales Invoice Id Documents Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sales_invoice/{id}/payment/update-status": { "post": { "tags": [ "API / Accounting", "API / Accounting", "Use case / Accounting" ], "summary": "Report Payment Status For Sales Invoice (Deprecated)", "description": "(deprecated, use /sales-invoice/{id}/payment/update-status instead)", "operationId": "Report_payment_status_for_sales_invoice__deprecated__v1_accounting_sales_invoice__id__payment_update_status_post", "deprecated": true, "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentStatusUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentStatusUpdate" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sync-tasks": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "List Invoices/Credit Notes To Sync", "operationId": "List_invoices_credit_notes_to_sync_v1_accounting_sync_tasks_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "billing_entity_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Billing Entity Code" }, "description": "Billing entity code to filter tasks, useful if multiple billing entities are linked to the same integration" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableTasks" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sync-tasks/{id}": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Get Details Of Invoice/Credit Note To Sync", "operationId": "Get_details_of_Invoice_Credit_note_to_sync_v1_accounting_sync_tasks__id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskDetail" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/sync-tasks/{id}/update-status": { "post": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Report Sync Status For Invoice/Credit Note", "description": "Reports the sync status for an invoice/credit note task. No billing_entity_code is required.", "operationId": "Report_sync_status_for_invoice_credit_note_v1_accounting_sync_tasks__id__update_status_post", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskUpdateInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskUpdate" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/tax-rates": { "get": { "tags": [ "API / Accounting", "Use case / Master data sync", "Use case / Accounting" ], "summary": "List Tax Rates", "description": "Lists tax rates for the tenant, with optional filtering and pagination.", "operationId": "List_tax_rates_v1_accounting_tax_rates_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "archived", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Archived" }, "description": "Filter by archived status. Omit to return all tax rates." }, { "name": "billing_entity_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Billing Entity Code" }, "description": "Filter by billing entity code." }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "description": "Tax rate code to match exactly." }, { "name": "code:in", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code:In" }, "description": "Tax rate codes to match. Comma-separated list." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTaxRateOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/accounting/tax-rates/{id}": { "get": { "tags": [ "API / Accounting", "Use case / Accounting" ], "summary": "Retrieve Tax Rate", "description": "Retrieves a single tax rate by its ID.", "operationId": "Retrieve_tax_rate_v1_accounting_tax_rates__id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRateOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/companies/company": { "get": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "List Companies", "operationId": "list_companies_v1_companies_company_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "updated_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated After" }, "description": "Filter to fetch the companies updated after this time. Format is ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "description": "Company code to match exactly." }, { "name": "code:in", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code:In" }, "description": "Company codes to match. Comma-separated list." }, { "name": "accounting_customer_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accounting Customer Code" }, "description": "Accounting customer code to match exactly. Holds the code of the default billing entity." }, { "name": "accounting_customer_code:in", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accounting Customer Code:In" }, "description": "Accounting customer codes to match. Comma-separated list. Holds the code of the default billing entity." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCompanyOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "post": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "Create Company", "operationId": "create_company_v1_companies_company_post", "security": [ { "oAuth2ClientCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/companies/company/{company_id}/documents": { "get": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "Get Company Documents", "description": "Fetch all documents for a specific company.", "operationId": "get_company_documents_v1_companies_company__company_id__documents_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "description": "Pagination cursor. Mutually exclusive with other query parameters" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCompanyDocumentOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "post": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "Create Company Document", "description": "Upload a document for a specific company.", "operationId": "create_company_document_v1_companies_company__company_id__documents_post", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadedCompanyDocumentWithValidity" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDocumentOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/companies/company/{company_id}/validity": { "get": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "List Company Validities", "description": "List all validities for a company.", "operationId": "List_company_validities_v1_companies_company__company_id__validity_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "start_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Time" }, "description": "Filter to fetch unavailabilities after this time" }, { "name": "end_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time" }, "description": "Filter to fetch unavailabilities before this time" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCompanyValidityOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "post": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "Create Company Validity Request", "description": "Create a new validity request for a company.", "operationId": "Create_company_validity_request_v1_companies_company__company_id__validity_post", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyValidityInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyValidityOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/companies/company/{company_id}/validity/{id}": { "get": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "Get Company Validity", "description": "Fetches a specific validity for a company.", "operationId": "Get_company_validity_v1_companies_company__company_id__validity__id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyValidityOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "put": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "Update Company Validity", "description": "Update an existing validity for a company.", "operationId": "Update_company_validity_v1_companies_company__company_id__validity__id__put", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyValidityInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyValidityOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "delete": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "Delete Company Validity", "description": "Delete a company validity.", "operationId": "Delete_company_validity_v1_companies_company__company_id__validity__id__delete", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/companies/company/{company_id}/validity/{id}/documents": { "get": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "Get Company Validity Documents", "description": "Fetch all documents associated with a specific company validity.", "operationId": "Get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Company Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" }, "title": "Response Get Company Validity Documents V1 Companies Company Company Id Validity Id Documents Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/companies/company/{id}": { "get": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "Get Company", "operationId": "get_company_v1_companies_company__id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "put": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "Update Company", "operationId": "update_company_v1_companies_company__id__put", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "patch": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "Update Company", "operationId": "update_company_v1_companies_company__id__patch", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPartialInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "delete": { "tags": [ "API / Company", "Use case / Master data sync" ], "summary": "Archive Company", "description": "Archive the company. This is a soft-delete: the company record is preserved and its `archived_customer`, `archived_subcontractor`, and `archived_buyer_or_seller` flags are set to `true` so it no longer appears in active lists.", "operationId": "Archive_company_v1_companies_company__id__delete", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/documents/document/upload_content": { "post": { "tags": [ "API / Document", "Use case / Document import" ], "summary": "Upload Document Content", "description": "Upload document content.", "operationId": "Upload_document_content_v1_documents_document_upload_content_post", "security": [ { "oAuth2ClientCredentials": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Upload_document_content_v1_documents_document_upload_content_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentUploadResponse" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/locations/location": { "post": { "tags": [ "API / Location", "Use case / Master data sync" ], "summary": "Create Location", "description": "Create a new location.", "operationId": "Create_location_v1_locations_location_post", "security": [ { "oAuth2ClientCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationDetailInput" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "get": { "tags": [ "API / Location", "Use case / Master data sync" ], "summary": "List Locations", "description": "List all locations.", "operationId": "List_locations_v1_locations_location_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "description": "External location identifier to match exactly." }, { "name": "external_id:in", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id:In" }, "description": "External location identifiers to match. Comma-separated list." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLocationOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/locations/location/{location_id}": { "put": { "tags": [ "API / Location", "Use case / Master data sync" ], "summary": "Update Location", "description": "Update an existing location. An update that moves the coordinates far from the current position creates and returns a new location, leaving already existing orders on the original one.", "operationId": "Update_location_v1_locations_location__location_id__put", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "location_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Location Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationDetailInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "patch": { "tags": [ "API / Location", "Use case / Master data sync" ], "summary": "Patch Location", "description": "Partially update an existing location. An update that moves the coordinates far from the current position creates and returns a new location, leaving already existing orders on the original one.", "operationId": "Patch_location_v1_locations_location__location_id__patch", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "location_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Location Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialLocationDetailInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "get": { "tags": [ "API / Location", "Use case / Master data sync" ], "summary": "Get Location", "description": "Fetches a location.", "operationId": "Get_location_v1_locations_location__location_id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "location_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Location Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationDetailOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/resources/resource": { "post": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Create Resource", "description": "Create a new resource.", "operationId": "Create_resource_v1_resources_resource_post", "security": [ { "oAuth2ClientCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DriverResourceInput" }, { "$ref": "#/components/schemas/TractorResourceInput" }, { "$ref": "#/components/schemas/TruckResourceInput" }, { "$ref": "#/components/schemas/VanResourceInput" }, { "$ref": "#/components/schemas/TrailerResourceInput" }, { "$ref": "#/components/schemas/FullTrailerResourceInput" }, { "$ref": "#/components/schemas/ChassisResourceInput" }, { "$ref": "#/components/schemas/ContainerResourceInput" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DriverResourceOutput" }, { "$ref": "#/components/schemas/TractorResourceOutput" }, { "$ref": "#/components/schemas/TruckResourceOutput" }, { "$ref": "#/components/schemas/VanResourceOutput" }, { "$ref": "#/components/schemas/TrailerResourceOutput" }, { "$ref": "#/components/schemas/FullTrailerResourceOutput" }, { "$ref": "#/components/schemas/ChassisResourceOutput" }, { "$ref": "#/components/schemas/ContainerResourceOutput" } ], "title": "Response Create Resource V1 Resources Resource Post" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "get": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "List Resources", "description": "List all resources", "operationId": "List_resources_v1_resources_resource_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "updated_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated After" }, "description": "Filter to fetch the resources updated after this time. Timestamp format is ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "description": "External resource identifier to match exactly." }, { "name": "external_id:in", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id:In" }, "description": "External resource identifiers to match. Comma-separated list." }, { "name": "resource_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ResourceTypeEnum" }, { "type": "null" } ], "title": "Resource Type" }, "description": "Resource type to match exactly." }, { "name": "resource_type:in", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Type:In" }, "description": "Resource types to match. Comma-separated list." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResourceOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/resources/resource/{resource_id}": { "put": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Update Resource", "description": "Update an existing resource.", "operationId": "Update_resource_v1_resources_resource__resource_id__put", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DriverResourceInput" }, { "$ref": "#/components/schemas/TractorResourceInput" }, { "$ref": "#/components/schemas/TruckResourceInput" }, { "$ref": "#/components/schemas/VanResourceInput" }, { "$ref": "#/components/schemas/TrailerResourceInput" }, { "$ref": "#/components/schemas/FullTrailerResourceInput" }, { "$ref": "#/components/schemas/ChassisResourceInput" }, { "$ref": "#/components/schemas/ContainerResourceInput" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DriverResourceOutput" }, { "$ref": "#/components/schemas/TractorResourceOutput" }, { "$ref": "#/components/schemas/TruckResourceOutput" }, { "$ref": "#/components/schemas/VanResourceOutput" }, { "$ref": "#/components/schemas/TrailerResourceOutput" }, { "$ref": "#/components/schemas/FullTrailerResourceOutput" }, { "$ref": "#/components/schemas/ChassisResourceOutput" }, { "$ref": "#/components/schemas/ContainerResourceOutput" } ], "title": "Response Update Resource V1 Resources Resource Resource Id Put" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "patch": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Patch Resource", "description": "Partially update an existing resource.", "operationId": "Patch_resource_v1_resources_resource__resource_id__patch", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PartialDriverResourceInput" }, { "$ref": "#/components/schemas/PartialTractorResourceInput" }, { "$ref": "#/components/schemas/PartialTruckResourceInput" }, { "$ref": "#/components/schemas/PartialVanResourceInput" }, { "$ref": "#/components/schemas/PartialTrailerResourceInput" }, { "$ref": "#/components/schemas/PartialFullTrailerResourceInput" }, { "$ref": "#/components/schemas/PartialChassisResourceInput" }, { "$ref": "#/components/schemas/PartialBaseResourceInput" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DriverResourceOutput" }, { "$ref": "#/components/schemas/TractorResourceOutput" }, { "$ref": "#/components/schemas/TruckResourceOutput" }, { "$ref": "#/components/schemas/VanResourceOutput" }, { "$ref": "#/components/schemas/TrailerResourceOutput" }, { "$ref": "#/components/schemas/FullTrailerResourceOutput" }, { "$ref": "#/components/schemas/ChassisResourceOutput" }, { "$ref": "#/components/schemas/ContainerResourceOutput" } ], "title": "Response Patch Resource V1 Resources Resource Resource Id Patch" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "delete": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Archive Resource", "description": "Archive a resource", "operationId": "Archive_resource_v1_resources_resource__resource_id__delete", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "get": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Get Resource", "description": "Fetches a resource", "operationId": "Get_resource_v1_resources_resource__resource_id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DriverResourceOutput" }, { "$ref": "#/components/schemas/TractorResourceOutput" }, { "$ref": "#/components/schemas/TruckResourceOutput" }, { "$ref": "#/components/schemas/VanResourceOutput" }, { "$ref": "#/components/schemas/TrailerResourceOutput" }, { "$ref": "#/components/schemas/FullTrailerResourceOutput" }, { "$ref": "#/components/schemas/ChassisResourceOutput" }, { "$ref": "#/components/schemas/ContainerResourceOutput" } ], "title": "Response Get Resource V1 Resources Resource Resource Id Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/resources/resource/{resource_id}/unavailability": { "get": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "List Resource Unavailabilities", "description": "List all unavailabilities for a resource", "operationId": "List_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "start_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Time" }, "description": "Filter to fetch unavailabilities after this time" }, { "name": "end_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time" }, "description": "Filter to fetch unavailabilities before this time" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResourceUnavailabilityOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "post": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Create Resource Unavailabilities", "description": "Create a new unavailability for a resource.", "operationId": "Create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnavailabilityInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnavailabilityOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/resources/resource/{resource_id}/unavailability/{id}": { "get": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Get Resource Unavailability", "description": "Fetch a resource unavailability", "operationId": "Get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnavailabilityOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "put": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Update Resource Unavailabilities", "description": "Update an existing unavailability for a resource.", "operationId": "Update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnavailabilityInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUnavailabilityOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "delete": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Delete Resource Unavailabilities", "description": "Delete a resource unavailability", "operationId": "Delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/resources/resource/{resource_id}/validity": { "get": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "List Resource Validities", "description": "List all validities for a resource", "operationId": "List_resource_validities_v1_resources_resource__resource_id__validity_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "start_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Time" }, "description": "Filter to fetch unavailabilities after this time" }, { "name": "end_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time" }, "description": "Filter to fetch unavailabilities before this time" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResourceValidityOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "post": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Create Resource Validity Request", "description": "Create a new validity request for a resource.", "operationId": "Create_resource_validity_request_v1_resources_resource__resource_id__validity_post", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceValidityInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceValidityOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/resources/resource/{resource_id}/validity/{id}": { "get": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Get Resource Validity", "description": "Fetches a specific validity for a resource", "operationId": "Get_resource_validity_v1_resources_resource__resource_id__validity__id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceValidityOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "put": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Update Resource Validity", "description": "Update an existing validity for a resource.", "operationId": "Update_resource_validity_v1_resources_resource__resource_id__validity__id__put", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceValidityInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceValidityOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } }, "delete": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Delete Resource Validity", "description": "Delete a resource validity", "operationId": "Delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/resources/resource/{resource_id}/validity/{id}/documents": { "get": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "Get Resource Validity Documents", "description": "Fetch all documents associated with a specific resource validity.", "operationId": "Get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" }, "title": "Response Get Resource Validity Documents V1 Resources Resource Resource Id Validity Id Documents Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/resources/resource_groups": { "get": { "tags": [ "API / Resource", "Use case / Master data sync" ], "summary": "List Resource Groups", "description": "List the resource groups resources can be allocated to. Archived resource groups are not included.", "operationId": "List_resource_groups_v1_resources_resource_groups_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "description": "Resource group code to match exactly." }, { "name": "code:in", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code:In" }, "description": "Resource group codes to match. Comma-separated list." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResourceGroupOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/tasks/available-tasks": { "get": { "tags": [ "API / Task" ], "summary": "List Available Tasks", "operationId": "list_available_tasks_v1_tasks_available_tasks_get", "security": [ { "oAuth2ClientCredentials": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableTasks" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/tasks/task/{id}": { "get": { "tags": [ "API / Task" ], "summary": "Get Task Detail", "operationId": "get_task_detail_v1_tasks_task__id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskDetail" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/tasks/task/{id}/update-status": { "post": { "tags": [ "API / Task" ], "summary": "Update Task Status", "operationId": "update_task_status_v1_tasks_task__id__update_status_post", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskUpdateInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskUpdate" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/trips/trip/{trip_id}": { "get": { "tags": [ "API / Trip" ], "summary": "Get Trip By Id", "description": "Get trip", "operationId": "get_trip_by_id_v1_trips_trip__trip_id__get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "trip_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Trip Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/trips/trip/{trip_id}/costs": { "get": { "tags": [ "API / Trip" ], "summary": "Get Trip Costs", "description": "Get the cost charges associated with this trip", "operationId": "get_trip_costs_v1_trips_trip__trip_id__costs_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "trip_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Trip Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripCostsOutput" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/trips/trip/{trip_id}/documents": { "get": { "tags": [ "API / Trip" ], "summary": "Get Trip Documents", "description": "Fetch trip documents. This includes `order` and `consignment` documents", "operationId": "get_trip_documents_v1_trips_trip__trip_id__documents_get", "security": [ { "oAuth2ClientCredentials": [] } ], "parameters": [ { "name": "trip_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Trip Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" }, "title": "Response Get Trip Documents V1 Trips Trip Trip Id Documents Get" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook": { "post": { "tags": [ "Use case / Order", "Webhooks / Inbound" ], "summary": "Create/Update/Cancel Orders", "description": "Webhook for creating/updating and cancelling transport orders.\n\nThis is the fully asynchronous version of the order upload api.\nThe documented schema is our default input format, but we can also map custom formats.\n\nNote that this webhook uses Basic Auth instead of the OAuth credentials used for the api.\nPlease contact integrations@qargo.com to request credentials.", "operationId": "order-import-webhook", "security": [ { "BasicAuthWebhookCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrderInput" }, { "type": "string", "format": "binary" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrderImportResponse" }, { "type": "null" } ], "title": "Response Order-Import-Webhook" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook/billing-document-update": { "post": { "tags": [ "Use case / Accounting", "Webhooks / Inbound" ], "summary": "External Billing Document (Invoice/Credit-Note) Update", "description": "Update billing document metadata (invoices, credit notes) from an external accounting system.\n\nThis webhook uses **Basic Auth** (webhook credentials), not the OAuth credentials used for the API.\nContact integrations@qargo.com to request credentials.\n\nUse this endpoint to push document status changes or related metadata updates back to Qargo.\nThis is typically triggered when your external accounting system processes billing documents.", "operationId": "billing-document-update-webhook", "security": [ { "BasicAuthWebhookCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingDocumentUpdatePayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook/document-import": { "post": { "tags": [ "Use case / Document import", "Webhooks / Inbound" ], "summary": "Generic Document Import", "description": "Webhook for importing documents and attaching them to existing orders in Qargo.\n\n## How it works\n\n1. An external system sends a file to this endpoint with metadata as query parameters.\n2. The system matches the document to an order in Qargo using the provided query parameters.\n3. The document is created and attached to the matched order.\n\n## Query parameters\n\nThe `filename` parameter is always required. Additional query parameters are **configurable\nper integration** during setup and are used to pass metadata about the file and to match\nthe document to an order.\n\nQuery parameters can carry two types of information:\n\n### File metadata\n\nInformation about the document itself, for example:\n- `filename` (required) — Name of the uploaded file including extension\n- `document_type` — The type of document, see the **Document types** section below\n- `document_name` — Display name for the document in Qargo\n\n### Matching to Qargo orders\n\nInformation used to resolve which order the document should be attached to.\nThe following order fields can be matched against:\n\n- `customer_reference_number` — The customer reference number on the order\n- `name` — The order name (e.g. `OR-12345`)\n- `id` — The order UUID\n\nThe match must resolve to **exactly one order**. If no order or multiple orders match,\nthe import will be discarded.\n\nThe actual set of query parameters and how they map to the above is configured per integration.\n\n## Document types\n\nThe `document_type` parameter must be one of the following values:\n\n| Document type |\n|---|\n| `ADDRESS_LABEL` |\n| `ANALYSIS_CERTIFICATE` |\n| `ANNEX_VII_WASTE_SHIPMENT` |\n| `APPROVAL_LOADING_LIST` |\n| `ATR` |\n| `AUTHORIZATION_PREFERENTIAL_ORIGIN` |\n| `BILL_OF_LADING_INSTRUCTIONS` |\n| `CATTLE_TRANSPORT_JOURNAL` |\n| `CERTIFICATE_OF_ORIGIN` |\n| `CERTIFICATE_OF_SHIPMENT` |\n| `CLAIM` |\n| `CMR_INSURANCE` |\n| `COMMERCIAL_INVOICE` |\n| `CONFIRMATION_TARIFF_SHIPPING_LINE` |\n| `CONSIGNEE_SIGNATURE` |\n| `CONSIGNOR_SIGNATURE` |\n| `CONTAINER_CLEANING_CERTIFICATE` |\n| `CUSTOMER_PAPERWORK` |\n| `CUSTOMS_DECLARATION_INSTRUCTIONS` |\n| `CUSTOMS_DOCUMENT` |\n| `CUSTOMS_INVOICE` |\n| `DANGEROUS_GOODS_DECLARATION` |\n| `DEFENSE_MUNITIONS_VEHICLE_STABLING_REQUEST_FORM` |\n| `DISPATCH_CONFIRMATION` |\n| `DRAFT_BILL_OF_LADING` |\n| `DRIVER_SIGNATURE` |\n| `DUTCH_CUSTOMS_RELEASE` |\n| `EQUIPMENT_INTERCHANGE_RECEIPT` |\n| `EUR1` |\n| `EUR_MED` |\n| `EXPORT_ACCOMPANYING_DOCUMENT` |\n| `EXPORT_DECLARATION` |\n| `EXPORT_DOCUMENT` |\n| `EXTRA_COST_CONFIRMATION` |\n| `EXTRA_PERMITTED_WEIGHT` |\n| `EX_A_EXPORT_DECLARATION` |\n| `FINAL_BILL_OF_LADING` |\n| `GOODS_IN` |\n| `GOODS_OUT` |\n| `GPS_TRACKER_REPORT` |\n| `IFP` |\n| `IMDG` |\n| `IMPORT_DECLARATION` |\n| `IMPORT_DOCUMENT` |\n| `IM_A` |\n| `INSURANCE_DOCUMENT` |\n| `LOCATION_INFO` |\n| `LUMPER_RECEIPT` |\n| `MANIFEST` |\n| `MULTIMODAL_DANGEROUS_GOODS_DECL` |\n| `ORDER_ACCEPTANCE` |\n| `ORDER_CONFIRMATION` |\n| `ORIGINAL_CMR` |\n| `OTHER_ADMINISTRATION` |\n| `PALLET_LABEL` |\n| `PALLET_LABEL_EXTERNAL` |\n| `PALLET_NOTE` |\n| `PHOTO_DAMAGED_GOODS` |\n| `PHOTO_OF_GOODS_DELIVERY` |\n| `PHOTO_OF_GOODS_PICKUP` |\n| `PHOTO_SEAL_NUMBER` |\n| `PICKUP_CMR` |\n| `PICKUP_NOTE` |\n| `PREFILLED_CMR` |\n| `PRICE_OFFER_CUSTOMER` |\n| `PROOF_OF_DELIVERY` |\n| `PROOF_OF_DELIVERY_DRIVER_APP` |\n| `PROOF_OF_DELIVERY_SIGNED` |\n| `PROOF_OF_PICKUP` |\n| `PROOF_OF_PICKUP_SIGNED` |\n| `QUOTE` |\n| `RECEIPT` |\n| `SAFETY_SECURITY_DECLARATION` |\n| `SECURITY_PLAN_FORM` |\n| `SINGLE_ADMINISTRATIVE_DOCUMENT` |\n| `STANDARD_OPERATING_PROCEDURE` |\n| `STICKER_LABEL` |\n| `T1_DOCUMENT` |\n| `T2_DOCUMENT` |\n| `TEMPERATURE_REPORT` |\n| `TIMESLOT_CONFIRMATION` |\n| `TRANSIT_DOCUMENT` |\n| `UK_EXPORTER_DRA` |\n| `UK_IMPORTER_DRA` |\n| `VGM_CONTAINER` |\n| `VISITOR_SAFETY_INSTRUCTION` |\n| `WAITING_HOURS_INFORMATION` |\n| `WASTE` |\n| `WAYBILL` |\n| `WEIGHING_TICKET` |\n\n## Content encoding\n\n| Content format | Content-Type header | Behavior |\n|---|---|---|\n| Binary (e.g. PDF, image) | `application/pdf`, `image/png`, etc. | Passed through as-is |\n| Text | `text/plain`, `text/xml`, etc. | Encoded as UTF-8 bytes |\n| Base64-encoded string | Non-text or no header | Base64 decode attempted; raw string used on failure |\n\nPlease provide the `Content-Type` header matching the file format.\n\n## Error handling\n\n| Scenario | Behavior |\n|----------|----------|\n| No order matches the provided criteria | Import is discarded |\n| Multiple orders match the criteria | Import is discarded |\n| Document metadata not provided | Import is discarded |", "operationId": "document-import-webhook", "security": [ { "BasicAuthWebhookCredentials": [] } ], "parameters": [ { "name": "filename", "in": "query", "required": true, "schema": { "type": "string", "title": "Filename" }, "description": "Name of the file being uploaded, including extension. This is used as the primary source for the file name in Qargo." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "string", "format": "binary" }, { "type": "object" }, { "type": "array", "items": {} }, { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ], "description": "The document content as binary file data or a JSON message.", "title": "File" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentImportResponse" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook/e-invoicing": { "post": { "tags": [ "Use case / E-invoicing", "Webhooks / Inbound" ], "summary": "Send E-Invoices", "description": "Webhook to receive e-invoices in structured format or as file uploads.\n\n## Supported Formats\nThis endpoint accepts e-invoices in multiple formats:\n\n- **JSON payloads**: Structured data using application/json content type.\n- **XML payloads**: Structured data using application/xml content type. Must be a valid UBL document.\n- **File uploads**: JSON + binary files (PDF, XML, etc.) using multipart/form-data.\n\n## Multipart Upload Support\nWhen using multipart form data, the endpoint expects:\n- First part: JSON document (PurchaseEInvoiceInput or PurchaseECreditNoteInput). XML is not supported at the moment.\n- Subsequent parts: Supporting documents (invoice PDF, CMR PDF, etc.).\n\n## Examples\n\n**JSON payload example (application/json).**\n\n```json\n{\n \"name\": \"INV-2023-001\",\n \"date\": \"2023-01-15\",\n \"due_date\": \"2023-02-15\",\n \"invoice_type\": \"PURCHASE\",\n \"currency\": \"EUR\",\n \"total_excl_tax\": 999.99,\n \"total_incl_tax\": 1209.99,\n \"total_tax\": 210.00,\n \"custom_fields\": {},\n \"supplier\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"Supplier Company Ltd\",\n \"vat_number\": \"BE1234.123.123\",\n \"billing_location\": {\n \"address\": \"Gaston Crommenlaan 4\",\n \"city\": \"Gent\",\n \"postal_code\": \"9050\",\n \"country\": \"BE\"\n }\n },\n \"customer_reference_numbers\": [\"12345\"],\n \"line_items\": [\n {\n \"description\": \"International freight transport\",\n \"amount\": 999.99,\n \"currency\": \"EUR\",\n \"tax_rate\": {\n \"percentage\": 21.0,\n \"name\": \"21% VAT\",\n \"tax_type\": \"VAT\"\n },\n \"account\": {\n \"code\": \"6000\"\n },\n \"references\": {\n \"order_name\": \"OR-1234\"\n }\n }\n ],\n \"attachments\": [\n {\n \"document\": {\n \"base64\": \"JVBERi0xLjQKJcfs... (truncated for brevity) ...\",\n \"content_type\": \"application/pdf\",\n \"document_type\": \"INVOICE\",\n \"filename\": \"invoice_123.pdf\"\n }\n }\n ]\n}\n```\n\n**Credit note example (application/json).** Note: credit notes do not have a `due_date` field.\n\n```json\n{\n \"name\": \"CN-2023-001\",\n \"date\": \"2023-03-01\",\n \"invoice_type\": \"PURCHASE_CREDIT_NOTE\",\n \"currency\": \"EUR\",\n \"total_excl_tax\": -200.00,\n \"total_incl_tax\": -242.00,\n \"total_tax\": -42.00,\n \"supplier\": {\n \"name\": \"Supplier Company Ltd\",\n \"vat_number\": \"BE1234.123.123\"\n },\n \"customer_reference_numbers\": [\"12345\"],\n \"line_items\": [\n {\n \"amount\": -200.00,\n \"currency\": \"EUR\",\n \"tax_rate\": {\n \"percentage\": 21.0,\n \"tax_type\": \"VAT\"\n },\n \"account\": {\n \"code\": \"6000\"\n }\n }\n ]\n}\n```\n\n**XML payload example (application/xml).**\n\n```xml\n\n urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0\n urn:fdc:peppol.eu:2017:poacc:billing:01:1.0\n 25900027\n 2025-10-28\n 2025-10-28\n 380\n EUR\n 25900027\n \n 600947\n \n JVBERi0xLjQKJcfs... (truncated for brevity) ...\n \n \n \n \n 0564730040\n \n qargo-peppol-dev\n \n \n Gaston Crommenlaan 4\n Gent\n 9050\n Oost-Vlaanderen\n \n BE\n \n \n \n BE0772640434\n \n VAT\n \n \n \n qargo-peppol-dev\n 0564730040\n \n \n +324854244512\n simon@qargo.com\n \n \n \n \n \n 0772640434\n \n Qargo\n \n \n Gaston Crommenlaan 4\n Gent\n 9050\n \n BE\n \n \n \n Qargo\n 0772640434\n \n \n \n \n 162.71\n \n 774.83\n 162.71\n \n S\n 21.00\n \n VAT\n \n \n \n \n \n 774.83\n 774.83\n 937.54\n 937.54\n \n \n 1\n 1.0\n 65.00\n \n Administratiekost\n \n S\n 21.00\n \n VAT\n \n \n \n \n 65.0\n \n \n \n 2\n 1.0\n 709.83\n \n Transport charge\n \n S\n 21.00\n \n VAT\n \n \n \n \n 709.83\n \n \n\n```\n\n**Multipart Form Data example.**\n\n```\nPOST /v1/webhook/e-invoicing\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundaryABC123XYZ\n\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"document\"; filename=\"invoice_data.json\"\nContent-Type: application/json\n\n{\n \"name\": \"INV-2023-001\",\n \"date\": \"2023-01-15\",\n \"due_date\": \"2023-02-15\",\n \"invoice_type\": \"PURCHASE\",\n \"currency\": \"EUR\",\n \"total_excl_tax\": 999.99,\n \"total_incl_tax\": 1209.99,\n \"total_tax\": 210.00,\n \"custom_fields\": {},\n \"supplier\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"Supplier Company Ltd\",\n \"vat_number\": \"BE1234.123.123\",\n \"billing_location\": {\n \"address\": \"Gaston Crommenlaan 4\",\n \"city\": \"Gent\",\n \"postal_code\": \"9050\",\n \"country\": \"BE\"\n }\n },\n \"customer_reference_numbers\": [\"12345\"],\n \"line_items\": [\n {\n \"description\": \"International freight transport\",\n \"amount\": 999.99,\n \"currency\": \"EUR\",\n \"tax_rate\": {\n \"percentage\": 21.0,\n \"name\": \"21% VAT\",\n \"tax_type\": \"VAT\"\n },\n \"account\": {\n \"code\": \"6000\"\n },\n \"references\": {\n \"order_name\": \"OR-1234\"\n }\n }\n ]\n}\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"invoice\"; filename=\"invoice_123.pdf\"\nContent-Type: application/pdf\n\n[binary PDF content]\n----WebKitFormBoundaryABC123XYZ\nContent-Disposition: form-data; name=\"cmr\"; filename=\"cmr_document.pdf\"\nContent-Type: application/pdf\n\n[binary PDF content]\n----WebKitFormBoundaryABC123XYZ--\n```\n\n## Processing Notes on Multipart Uploads\n- First part must be the JSON document containing invoice/credit note data.\n- Supporting documents follow as additional parts.\n- Content-Type headers determine document processing.", "operationId": "e-invoicing-webhook", "security": [ { "BasicAuthWebhookCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PurchaseEInvoiceInput" }, { "$ref": "#/components/schemas/PurchaseECreditNoteInput" }, { "type": "string", "format": "binary" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook/fleet-document-upload": { "post": { "tags": [ "Use case / Fleet dispatch", "Webhooks / Inbound", "Use case / Document import" ], "summary": "External Document Upload From A Fleet Application", "description": "Upload a document to a specific stop or stop group on a fleet-dispatched trip.\n\nThis webhook uses **Basic Auth** (webhook credentials), not the OAuth credentials used for the API.\nContact integrations@qargo.com to request credentials.\n\n---\n\n## Query parameters\n\n| Parameter | Required | Description |\n|-----------|----------|-------------|\n| `question_path_key` | Yes | Maps the file to a document type in Qargo (e.g. `CMR`, `POD`, `WEIGHT_NOTE`) |\n| `stop_id` | No* | The Qargo UUID of the stop to attach the document to |\n| `stop_group_id` | No* | The Qargo UUID of the stop group to attach the document to |\n\n*Provide either `stop_id` or `stop_group_id` to identify where to attach the document.\n\n## Headers\n\n| Header | Required | Description |\n|--------|----------|-------------|\n| `Content-Type` | Yes | MIME type of the file (e.g. `application/pdf`, `image/jpeg`) |\n| `Content-Disposition` | No | Provides the filename: `attachment; filename=\"POD.pdf\"` |\n\n## Filename handling\n\nThe uploaded file's name in Qargo is determined by:\n\n1. If `Content-Disposition` includes a `filename` — that value is used, combined with the question path key default.\n For example: `filename=\"pod1234.pdf\"` with question path key default `POD.pdf` → stored as `pod1234_POD.pdf`.\n2. If no `Content-Disposition` is provided — the default filename from the question path key configuration is used.\n\n## Example\n\n```\ncurl -X POST \\\n \"https://api.qargo.com/v1/webhook/fleet-document-upload\\\n ?question_path_key=POD&stop_id=\" \\\n -u \":\" \\\n -H \"Content-Type: application/pdf\" \\\n -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n --data-binary @/path/to/document.pdf\n```", "operationId": "fleet-document-upload-webhook", "security": [ { "BasicAuthWebhookCredentials": [] } ], "parameters": [ { "name": "question_path_key", "in": "query", "required": true, "schema": { "type": "string", "title": "Question Path Key" }, "description": "The question path key to map the file in Qargo, for example: CMR/POD" }, { "name": "stop_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stop Id" }, "description": "The stop ID to which the document is related" }, { "name": "stop_group_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stop Group Id" }, "description": "The stop group ID to which the document is related" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "string", "format": "binary" }, { "type": "object" }, { "type": "array", "items": {} }, { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ], "description": "A single binary file or JSON message", "title": "File" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook/fleet-status-update": { "post": { "tags": [ "Use case / Fleet dispatch", "Webhooks / Inbound" ], "summary": "External Status Update From A Fleet Application", "description": "Webhook for updating the status, ETA, and data of stops from an external fleet application.\n\nNote that this webhook uses Basic Auth instead of the OAuth credentials used for the api.\nPlease contact integrations@qargo.com to request credentials.\n\nAll `event_time`, `eta_start`, and `eta_end` date-time values must include a timezone offset,\nfor example `2025-06-15T10:30:00Z` or `2025-06-15T12:30:00+02:00`.\n\n---\n\n## Identifying a stop\n\nEach update targets either a single **stop** or a **stop group**. Provide one per update entry.\n\n### By stop ID (preferred)\n\nIf you know the Qargo stop UUID, pass it directly in `stop.id`:\n\n```json\n{\n \"updates\": [\n {\n \"stop\": { \"id\": \"a1b2c3d4-0000-0000-0000-000000000000\", \"status\": \"AT_STOP\" },\n \"event_time\": \"2025-06-15T10:30:00Z\"\n }\n ]\n}\n```\n\n### By matching criteria\n\nWhen the stop ID is not known, use `stop.match` to find the stop by its related entities.\nThe matcher uses **all provided criteria combined** (AND logic) and expects **exactly one stop**\nto match. If zero or multiple stops match, the update is discarded.\n\nAvailable matching fields:\n\n| Object | Field | Description |\n|----------------|------------------------------|------------------------------------------------------|\n| `trip` | `name.matches_any` | Trip name(s) |\n| `order` | `name.matches_any` | Order name(s) |\n| `order` | `customer_reference_number.matches_any` | Customer reference number(s) |\n| `order` | `id.matches_any` | Order UUID(s) |\n| `consignment` | `reference_number.matches_any` | Consignment reference number(s) |\n| `consignment` | `order_sequence_number` | Consignment sequence number within the order (integer) |\n| `stop` | `reference_number.matches_any` | Stop reference number(s) |\n| `stop` | `stop_type` | `PICKUP` or `DELIVERY` |\n\nEach `matches_any` field accepts a list of values — the stop matches if its value equals **any** of them.\nWhen multiple fields are provided, they are all required to match (AND).\n\n**Example — match by order reference + stop type:**\n\n```json\n{\n \"updates\": [\n {\n \"stop\": {\n \"match\": {\n \"matches_all\": [\n {\n \"order\": { \"customer_reference_number\": { \"matches_any\": [\"REF-12345\"] } },\n \"stop\": { \"stop_type\": \"DELIVERY\" }\n }\n ]\n },\n \"status\": \"COMPLETED\"\n },\n \"event_time\": \"2025-06-15T14:00:00Z\"\n }\n ]\n}\n```\n\n**Example — match by trip name + consignment reference:**\n\n```json\n{\n \"updates\": [\n {\n \"stop\": {\n \"match\": {\n \"matches_all\": [\n {\n \"trip\": { \"name\": { \"matches_any\": [\"T-20250615-001\"] } },\n \"consignment\": { \"reference_number\": { \"matches_any\": [\"CONS-98765\"] } }\n }\n ]\n },\n \"status\": \"AT_STOP\",\n \"eta_end\": \"2025-06-15T16:00:00Z\"\n },\n \"event_time\": \"2025-06-15T14:30:00Z\"\n }\n ]\n}\n```\n\n## Stop group updates\n\nA stop group represents multiple stops grouped by activity and location. When updating via\n`stop_group`, the status applies to **all stops** in that group. The stop group `id` is always\nrequired — matching by criteria is not supported for stop groups.\n\n```json\n{\n \"updates\": [\n {\n \"stop_group\": {\n \"id\": \"b2c3d4e5-0000-0000-0000-000000000000\",\n \"status\": \"COMPLETED\"\n },\n \"event_time\": \"2025-06-15T16:00:00Z\"\n }\n ]\n}\n```\n\n## Statuses\n\n- `AT_STOP` — the vehicle has arrived at the stop location.\n- `COMPLETED` — the stop activity is finished.\n- *Omit* `status` to update only the ETA or data fields without changing the stop status.", "operationId": "fleet-status-update-webhook", "security": [ { "BasicAuthWebhookCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FleetStatusUpdatePayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook/intermodal-status": { "post": { "tags": [ "Use case / Intermodal [partner]", "Webhooks / Inbound" ], "summary": "Intermodal Booking Status Update Webhook", "description": "Inbound webhook to receive intermodal booking status updates from the external intermodal booking system.", "operationId": "intermodal-booking-status-webhook", "security": [ { "BasicAuthWebhookCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/IntermodalBookingStatusPayload" }, { "type": "string" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook/location-booking-update": { "post": { "tags": [ "Use case / Location booking", "Webhooks / Inbound" ], "summary": "Location Booking Update Webhook", "description": "Inbound webhook to receive location booking updates from external systems.", "operationId": "location-booking-update-webhook", "security": [ { "BasicAuthWebhookCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationBookingUpdatePayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/LocationBookingUpdateResponse" }, { "type": "null" } ], "title": "Response Location-Booking-Update-Webhook" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook/partial-order-update": { "post": { "tags": [ "Use case / Order", "Webhooks / Inbound" ], "summary": "Partial Order Update", "description": "Webhook for partial order updates. Push to the endpoint to update specific fields of an existing order.", "operationId": "partial-order-update", "security": [ { "BasicAuthWebhookCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderUpdatePayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PartialOrderUpdateResponse" }, { "type": "null" } ], "title": "Response Partial-Order-Update" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook/subco-document-upload": { "post": { "tags": [ "Use case / Subcontractor dispatch", "Webhooks / Inbound", "Use case / Document import" ], "summary": "External Document Update With Payload", "description": "Upload a document to a specific stop on a subcontracted trip.\n\nThis webhook uses **Basic Auth** (webhook credentials), not the OAuth credentials used for the API.\nContact integrations@qargo.com to request credentials.\n\n---\n\n## Query parameters\n\n| Parameter | Required | Description |\n|-----------|----------|-------------|\n| `question_path_key` | Yes | Maps the file to a document type in Qargo (e.g. `CMR`, `POD`, `WEIGHT_NOTE`) |\n| `stop_id` | Yes | The Qargo UUID of the stop to attach the document to |\n\n## Headers\n\n| Header | Required | Description |\n|--------|----------|-------------|\n| `Content-Type` | Yes | MIME type of the file (e.g. `application/pdf`, `image/jpeg`) |\n| `Content-Disposition` | No | Provides the filename: `attachment; filename=\"POD.pdf\"` |\n\n## Filename handling\n\nThe uploaded file's name in Qargo is determined by:\n\n1. If `Content-Disposition` includes a `filename` — that value is used, combined with the question path key default.\n For example: `filename=\"pod1234.pdf\"` with question path key default `POD.pdf` → stored as `pod1234_POD.pdf`.\n2. If no `Content-Disposition` is provided — the default filename from the question path key configuration is used.\n\n## Example\n\n```\ncurl -X POST \\\n \"https://api.qargo.com/v1/webhook/subco-document-upload\\\n ?question_path_key=POD&stop_id=\" \\\n -u \":\" \\\n -H \"Content-Type: application/pdf\" \\\n -H \"Content-Disposition: attachment; filename=POD.pdf\" \\\n --data-binary @/path/to/document.pdf\n```", "operationId": "subcontractor-document-upload-webhook", "security": [ { "BasicAuthWebhookCredentials": [] } ], "parameters": [ { "name": "question_path_key", "in": "query", "required": true, "schema": { "type": "string", "title": "Question Path Key" }, "description": "The question path key to map the file in Qargo, for example: CMR/POD" }, { "name": "stop_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Stop Id" }, "description": "The stop ID to which the document is related" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "string", "format": "binary" }, { "type": "object" }, { "type": "array", "items": {} }, { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ], "description": "A single binary file or JSON message", "title": "File" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook/subco-status-update": { "post": { "tags": [ "Use case / Subcontractor dispatch", "Webhooks / Inbound" ], "summary": "External Status Update", "description": "Webhook for updating the status, ETA, and data of stops from an external subcontractor system.\n\nNote that this webhook uses Basic Auth instead of the OAuth credentials used for the api.\nPlease contact integrations@qargo.com to request credentials.\n\nAll `event_time`, `eta_start`, and `eta_end` date-time values must include a timezone offset,\nfor example `2025-06-15T10:30:00Z` or `2025-06-15T12:30:00+02:00`.\n\n---\n\n## Identifying a stop\n\nEach update targets a single stop. You can identify it by its Qargo UUID or by matching criteria.\n\n### By stop ID (preferred)\n\nIf you know the Qargo stop UUID, pass it directly in `stop.id`:\n\n```json\n{\n \"updates\": [\n {\n \"stop\": { \"id\": \"a1b2c3d4-0000-0000-0000-000000000000\", \"status\": \"AT_STOP\" },\n \"event_time\": \"2025-06-15T10:30:00Z\"\n }\n ]\n}\n```\n\n### By matching criteria\n\nWhen the stop ID is not known, use `stop.match` to find the stop by its related entities.\nThe matcher uses **all provided criteria combined** (AND logic) and expects **exactly one stop**\nto match. If zero or multiple stops match, the update is discarded.\n\nAvailable matching fields:\n\n| Object | Field | Description |\n|----------------|------------------------------|------------------------------------------------------|\n| `trip` | `name.matches_any` | Trip name(s) |\n| `order` | `name.matches_any` | Order name(s) |\n| `order` | `customer_reference_number.matches_any` | Customer reference number(s) |\n| `order` | `id.matches_any` | Order UUID(s) |\n| `consignment` | `reference_number.matches_any` | Consignment reference number(s) |\n| `consignment` | `order_sequence_number` | Consignment sequence number within the order (integer) |\n| `stop` | `reference_number.matches_any` | Stop reference number(s) |\n| `stop` | `stop_type` | `PICKUP` or `DELIVERY` |\n\nEach `matches_any` field accepts a list of values — the stop matches if its value equals **any** of them.\nWhen multiple fields are provided, they are all required to match (AND).\n\n**Example — match by order reference + stop type:**\n\n```json\n{\n \"updates\": [\n {\n \"stop\": {\n \"match\": {\n \"matches_all\": [\n {\n \"order\": { \"customer_reference_number\": { \"matches_any\": [\"REF-12345\"] } },\n \"stop\": { \"stop_type\": \"DELIVERY\" }\n }\n ]\n },\n \"status\": \"COMPLETED\"\n },\n \"event_time\": \"2025-06-15T14:00:00Z\"\n }\n ]\n}\n```\n\n**Example — match by trip name + consignment reference:**\n\n```json\n{\n \"updates\": [\n {\n \"stop\": {\n \"match\": {\n \"matches_all\": [\n {\n \"trip\": { \"name\": { \"matches_any\": [\"T-20250615-001\"] } },\n \"consignment\": { \"reference_number\": { \"matches_any\": [\"CONS-98765\"] } }\n }\n ]\n },\n \"status\": \"AT_STOP\",\n \"eta_end\": \"2025-06-15T16:00:00Z\"\n },\n \"event_time\": \"2025-06-15T14:30:00Z\"\n }\n ]\n}\n```\n\n## Statuses\n\n- `AT_STOP` — the vehicle has arrived at the stop location.\n- `COMPLETED` — the stop activity is finished.\n- *Omit* `status` to update only the ETA or data fields without changing the stop status.", "operationId": "subcontractor-status-update-webhook", "security": [ { "BasicAuthWebhookCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubcontractorStatusUpdatePayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook/tracking-update": { "post": { "tags": [ "Use case / Tracking", "Webhooks / Inbound" ], "summary": "Tracking Update", "description": "Webhook for tracking updates.\n\nPush to the endpoint to update tracking information for a resource.", "operationId": "tracking-update", "security": [ { "BasicAuthWebhookCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackingUpdatePayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TrackingUpdateResponse" }, { "type": "null" } ], "title": "Response Tracking-Update" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "/v1/webhook/trip-import": { "post": { "tags": [ "Use case / Trip import", "Webhooks / Inbound" ], "summary": "Import Trip", "description": "Webhook for planning a list of stops on a trip and assigning resources.\n\nThe documented schema is our default input format, but we can also map custom formats,\nkeeping in mind the limitations that are documented under use cases.\n\nNote that this webhook uses Basic Auth instead of the OAuth credentials used for the api.\nPlease contact integrations@qargo.com to request credentials.", "operationId": "trip-import-webhook", "security": [ { "BasicAuthWebhookCredentials": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TripImportInput" }, { "type": "string", "format": "binary" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TripImportResponse" }, { "type": "null" } ], "title": "Response Trip-Import-Webhook" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "https://": { "post": { "tags": [ "Use case / Visibility", "Webhooks / Outbound", "Use case / Accounting" ], "summary": "Accounting Visibility Event", "description": "Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates.\n\nNote that both support our canonical VisibilityUpdate schema,\nbut the body can also be a custom mapped format.", "operationId": "Accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AccountingVisibilityUpdate" }, { "type": "object" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "https://": { "post": { "tags": [ "Use case / Fleet dispatch", "Webhooks / Outbound" ], "summary": "Fleet Dispatch Payload", "description": "Payload for sending fleet app dispatches.\nIn this case, we send the payload to an external endpoint for processing.\n\nBy default, we send our standard `FleetDispatch` schema,\nbut the body can also be a custom mapped format.", "operationId": "fleet-dispatch-payload", "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FleetDispatch" }, { "type": "string" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FleetDispatchResponse" }, { "type": "null" } ], "title": "Response Fleet-Dispatch-Payload" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "https://": { "post": { "tags": [ "Use case / Subcontractor dispatch", "Webhooks / Outbound" ], "summary": "Subcontractor Dispatch Payload", "description": "Payload for sending a trip dispatch.\nIn this case, we send the payload to an external endpoint for processing.\n\nBy default, we send our standard `SubcontractorDispatch` schema,\nbut the body can also be a custom mapped format.", "operationId": "subcontractor-dispatch-payload", "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SubcontractorDispatch" }, { "type": "string" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SubcontractorDispatchResponse" }, { "type": "null" } ], "title": "Response Subcontractor-Dispatch-Payload" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "https://": { "post": { "tags": [ "Use case / Intermodal [partner]", "Webhooks / Outbound" ], "summary": "Intermodal Booking Payload", "description": "Outbound webhook to send intermodal bookings to the external intermodal booking system.", "operationId": "Intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/IntermodalBookingsPushPayload" }, { "type": "string" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } }, "https://": { "post": { "tags": [ "Use case / Location booking", "Webhooks / Outbound" ], "summary": "Location Booking Dispatch Payload", "description": "Payload for sending location booking dispatches.\n\nBy default, we send our standard `LocationDispatchOutput` schema,\nbut the body can also be a custom mapped format.", "operationId": "location-dispatch-payload", "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/LocationDispatchOutput" }, { "type": "string" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/LocationBookingDispatchResponse" }, { "type": "null" } ], "title": "Response Location-Dispatch-Payload" } } } }, "400": { "description": "Bad Request — invalid input or malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid authentication credentials" }, "403": { "description": "Forbidden — insufficient permissions for this operation" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests — rate limit exceeded. See the `Retry-After` header" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable — temporarily unable to handle the request" } } } } }, "components": { "schemas": { "ADR-Input": { "properties": { "adr_name_by_locale": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Adr Name By Locale", "description": "ADR name by locale, generated from ADR master data. This field is read-only; values submitted during order import are ignored. Keys, when present, are one of: `en`, `en-GB`, `en-US`, `nl-BE`, `fi-FI`, `fr-FR`, `de-DE`, `it-IT`, `es-ES`, `hu-HU`, `pt-PT`, `tr-TR`, `pl-PL`, `ro-RO`, `ru-RU`, `bg-BG`, `lt-LT`, `mk-MK`, or `cs-CZ`. Values are the corresponding localized ADR names.", "examples": [ { "de-DE": "SALZSÄURE", "en": "HYDROCHLORIC ACID" } ] }, "un_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Un Number", "description": "See https://adr-tool.com/lists-of-un-numbers" }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/ADRPackagingType" }, { "type": "null" } ], "description": "Packaging type" }, "emergency_phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Emergency Phone Number", "description": "Emergency phone number" }, "technical_name_by_locale": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Technical Name By Locale", "description": "Technical name by locale. Keys are locale codes and values are the corresponding localized technical names. Supported locale codes: `en`, `en-GB`, `en-US`, `nl-BE`, `fi-FI`, `fr-FR`, `de-DE`, `it-IT`, `es-ES`, `hu-HU`, `pt-PT`, `tr-TR`, `pl-PL`, `ro-RO`, `ru-RU`, `bg-BG`, `lt-LT`, `mk-MK`, and `cs-CZ`.", "examples": [ { "de-DE": "NEG Stoffname", "en": "NEG Substance name", "fr-FR": "NEG Nom de la substance", "nl-BE": "NEG Stofnaam" } ] }, "classification_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Classification Code", "description": "ADR classification code" }, "transport_category_tunnel_restriction_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transport Category Tunnel Restriction Code", "description": "A letter code (A-E) that reflects restrictions for carrying the substance through road tunnels - Helps improve ADR matching beyond just using UN number" }, "packing_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Packing Group", "description": "Indicates danger level - Helps improve ADR matching beyond just using UN number" }, "adr_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Adr Class", "description": "Identifies the primary hazard category of the substance - Helps improve ADR matching beyond just using UN number" }, "physical_state": { "anyOf": [ { "$ref": "#/components/schemas/ADRPhysicalState" }, { "type": "null" } ], "description": "Describes the form of the substance. Indicates whether the substance is a solid, liquid or gas" }, "hazard_identification_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hazard Identification Number", "description": "Also known as Kemler code. Used in ADR labeling" }, "division": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Division", "description": "ADR division/subclass (e.g. '1.2', '2.1'). Populated for classes 1, 2, 4, 5 and 6" }, "labels": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Labels", "description": "Subsidiary hazard class labels (ADR), '+'-separated when multiple. Example: '6.1+5.1'." }, "special_provisions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Special Provisions", "description": "ADR special provisions code(s) applying to this substance. Example: '274 640D'." } }, "type": "object", "title": "ADR" }, "ADR-Output": { "properties": { "adr_name_by_locale": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Adr Name By Locale", "description": "ADR name by locale, generated from ADR master data. This field is read-only; values submitted during order import are ignored. Keys, when present, are one of: `en`, `en-GB`, `en-US`, `nl-BE`, `fi-FI`, `fr-FR`, `de-DE`, `it-IT`, `es-ES`, `hu-HU`, `pt-PT`, `tr-TR`, `pl-PL`, `ro-RO`, `ru-RU`, `bg-BG`, `lt-LT`, `mk-MK`, or `cs-CZ`. Values are the corresponding localized ADR names.", "examples": [ { "de-DE": "SALZSÄURE", "en": "HYDROCHLORIC ACID" } ] }, "un_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Un Number", "description": "See https://adr-tool.com/lists-of-un-numbers" }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/ADRPackagingType" }, { "type": "null" } ], "description": "Packaging type" }, "emergency_phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Emergency Phone Number", "description": "Emergency phone number" }, "technical_name_by_locale": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Technical Name By Locale", "description": "Technical name by locale. Keys are locale codes and values are the corresponding localized technical names. Supported locale codes: `en`, `en-GB`, `en-US`, `nl-BE`, `fi-FI`, `fr-FR`, `de-DE`, `it-IT`, `es-ES`, `hu-HU`, `pt-PT`, `tr-TR`, `pl-PL`, `ro-RO`, `ru-RU`, `bg-BG`, `lt-LT`, `mk-MK`, and `cs-CZ`.", "examples": [ { "de-DE": "NEG Stoffname", "en": "NEG Substance name", "fr-FR": "NEG Nom de la substance", "nl-BE": "NEG Stofnaam" } ] }, "classification_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Classification Code", "description": "ADR classification code" }, "tunnel_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tunnel Code", "description": "A letter code (A-E) that reflects restrictions for carrying the substance through road tunnels - Helps improve ADR matching beyond just using UN number" }, "packing_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Packing Group", "description": "Indicates danger level - Helps improve ADR matching beyond just using UN number" }, "adr_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Adr Class", "description": "Identifies the primary hazard category of the substance - Helps improve ADR matching beyond just using UN number" }, "physical_state": { "anyOf": [ { "$ref": "#/components/schemas/ADRPhysicalState" }, { "type": "null" } ], "description": "Describes the form of the substance. Indicates whether the substance is a solid, liquid or gas" }, "hazard_identification_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hazard Identification Number", "description": "Also known as Kemler code. Used in ADR labeling" }, "division": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Division", "description": "ADR division/subclass (e.g. '1.2', '2.1'). Populated for classes 1, 2, 4, 5 and 6" }, "labels": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Labels", "description": "Subsidiary hazard class labels (ADR), '+'-separated when multiple. Example: '6.1+5.1'." }, "special_provisions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Special Provisions", "description": "ADR special provisions code(s) applying to this substance. Example: '274 640D'." } }, "type": "object", "title": "ADR" }, "ADRInput": { "properties": { "un_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Un Number" }, "packaging_type": { "anyOf": [ { "type": "string", "enum": [ "BOX", "COMPOSITE_PACKAGING", "DRUM", "GAS_RECEPTABLE", "INTERMEDIATE_BULK_CONTAINER", "JERRICAN", "LARGE_PACKAGING", "LIGHT_GAUGE_METAL_PACKAGINGS", "BAG", "TANK_CONTAINER" ] }, { "type": "null" } ], "title": "Packaging Type" }, "emergency_phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Emergency Phone Number" }, "technical_name_by_locale": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Technical Name By Locale" }, "packing_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Packing Group" }, "adr_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Adr Class" }, "tunnel_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tunnel Code" }, "physical_state": { "anyOf": [ { "type": "string", "enum": [ "UNKNOWN", "SOLID", "LIQUID", "GAS", "GAS_OR_LIQUID" ] }, { "type": "null" } ], "title": "Physical State" } }, "type": "object", "title": "ADRInput" }, "ADRPackagingType": { "type": "string", "enum": [ "BOX", "COMPOSITE_PACKAGING", "DRUM", "GAS_RECEPTABLE", "INTERMEDIATE_BULK_CONTAINER", "JERRICAN", "LARGE_PACKAGING", "LIGHT_GAUGE_METAL_PACKAGINGS", "BAG", "TANK_CONTAINER" ], "title": "ADRPackagingType" }, "ADRPhysicalState": { "type": "string", "enum": [ "UNKNOWN", "SOLID", "LIQUID", "GAS", "GAS_OR_LIQUID" ], "title": "ADRPhysicalState" }, "ADRType": { "type": "string", "enum": [ "ADR", "LIMITED_QUANTITY" ], "title": "ADRType" }, "AccountPartialInput": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Accounting code (GL / nominal code)." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Display name of the account." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity this account belongs to, referenced by code." }, "archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Archived", "description": "Whether this account is archived." } }, "type": "object", "title": "AccountPartialInput" }, "AccountingVisibilityUpdate": { "properties": { "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp", "description": "Event timestamp in UTC" }, "updates": { "items": { "anyOf": [ { "$ref": "#/components/schemas/SalesInvoiceStatusUpdate" }, { "$ref": "#/components/schemas/SalesCreditNoteStatusUpdate" }, { "$ref": "#/components/schemas/PurchaseInvoiceStatusUpdate" }, { "$ref": "#/components/schemas/PurchaseCreditNoteStatusUpdate" } ] }, "type": "array", "title": "Updates", "description": "Set of updates for invoices and credit notes. Note that by default these events will only trigger on status transitions, not on field changes. Note that this is a combination of invoicing and accounting updates." } }, "type": "object", "required": [ "timestamp", "updates" ], "title": "AccountingVisibilityUpdate" }, "AdditionalExportBorderProcessEnum": { "type": "string", "enum": [ "GVMS", "ELO", "PBN", "EIDR" ], "title": "AdditionalExportBorderProcessEnum" }, "AdditionalGoodsInformation": { "properties": { "is_dangerous_goods": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Dangerous Goods", "description": "Whether the goods are classified as dangerous goods." }, "goods_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Goods Description", "description": "Description of the goods." }, "goods_movement_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Goods Movement Reference", "description": "Goods Movement Reference (GMR)." } }, "type": "object", "title": "AdditionalGoodsInformation" }, "AdditionalImportBorderProcessEnum": { "type": "string", "enum": [ "GVMS", "ELO", "PBN", "TEMPORARY_STORAGE", "EIDR" ], "title": "AdditionalImportBorderProcessEnum" }, "AdditionalTransitBorderProcessEnum": { "type": "string", "enum": [ "LRN" ], "title": "AdditionalTransitBorderProcessEnum" }, "AmazonExtraFields": { "properties": { "asn_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asn Number", "description": "Amazon Shipment ID" }, "fba_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fba Number", "description": "Amazon FBA ID" }, "po_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Po Number", "description": "Amazon PO ID" }, "amazon_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amazon Number", "description": "Amazon order number" }, "carton_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Carton Count", "description": "Number of cartons" }, "unit_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unit Count", "description": "Number of units" }, "booking_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Booking Date", "description": "Amazon booking date" }, "booking_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Booking Time", "description": "Amazon booking time" } }, "type": "object", "title": "AmazonExtraFields" }, "AvailableTask": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "invoice_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Invoice Id" }, "task_type": { "$ref": "#/components/schemas/TaskType" }, "status": { "$ref": "#/components/schemas/TaskStatus" } }, "type": "object", "required": [ "id", "task_type", "status" ], "title": "AvailableTask", "description": "Reference to a task available for processing." }, "AvailableTasks": { "properties": { "tasks": { "items": { "$ref": "#/components/schemas/AvailableTask" }, "type": "array", "title": "Tasks" } }, "type": "object", "required": [ "tasks" ], "title": "AvailableTasks" }, "BankAccount": { "properties": { "bic_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bic Code" }, "iban_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Iban Code" } }, "type": "object", "title": "BankAccount" }, "BarcodeInput": { "properties": { "value": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Value", "description": "Barcode value" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/BarcodeSource" }, { "type": "null" } ], "description": "Source system of the barcode" } }, "type": "object", "title": "BarcodeInput" }, "BarcodeOutput": { "properties": { "value": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Value", "description": "Barcode value" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/BarcodeSource" }, { "type": "null" } ], "description": "Source system of the barcode" } }, "type": "object", "title": "BarcodeOutput" }, "BarcodeSource": { "type": "string", "enum": [ "APC", "EXTERNAL", "QARGO", "HAZCHEM", "PALLETFORCE", "PALLETLINE", "PALLETLINE_OPTIMA", "PALLETWAYS", "PALLETXPRESS_IE", "PALLET_TRACK", "PALLEX", "POLE", "TPN", "UPN" ], "title": "BarcodeSource" }, "BasePaymentTerm": { "properties": { "code": { "$ref": "#/components/schemas/PaymentTermCode", "description": "Payment term codes and their explanations:\n- `END_OF_MONTH_2`: End of next two months\n- `END_OF_MONTH_1`: End of next month\n- `END_OF_MONTH_0_NET_90`: End of this month, plus 90 days\n- `END_OF_MONTH_0_NET_75`: End of this month, plus 75 days\n- `END_OF_MONTH_0_NET_70`: End of this month, plus 70 days\n- `END_OF_MONTH_0_NET_65`: End of this month, plus 65 days\n- `END_OF_MONTH_0_NET_60`: End of this month, plus 60 days\n- `END_OF_MONTH_0_NET_50`: End of this month, plus 50 days\n- `END_OF_MONTH_0_NET_45`: End of this month, plus 45 days\n- `END_OF_MONTH_0_NET_35`: End of this month, plus 35 days\n- `END_OF_MONTH_0_NET_31`: End of this month, plus 31 days\n- `END_OF_MONTH_0_NET_30`: End of this month, plus 30 days\n- `END_OF_MONTH_0_NET_25`: End of this month, plus 25 days\n- `END_OF_MONTH_0_NET_21`: End of this month, plus 21 days\n- `END_OF_MONTH_0_NET_20`: End of this month, plus 20 days\n- `END_OF_MONTH_0_NET_14`: End of this month, plus 14 days\n- `END_OF_MONTH_0_NET_7`: End of this month, plus 7 days\n- `END_OF_MONTH_0_NET_1`: End of this month, plus 1 day\n- `END_OF_MONTH_0`: End of month\n- `PREPAID`: Prepaid\n- `CUSTOM_DUE_DATE`: Custom due date, set on invoice creation. Not allowed to set via the API\n- `UPON_RECEIPT`: Upon receipt\n- `NET_1`: 1 day after receipt\n- `NET_2`: 2 days after receipt\n- `NET_3`: 3 days after receipt\n- `NET_5`: 5 days after receipt\n- `NET_7`: 7 days after receipt\n- `NET_8`: 8 days after receipt\n- `NET_10`: 10 days after receipt\n- `NET_12`: 12 days after receipt\n- `NET_14`: 14 days after receipt\n- `NET_15`: 15 days after receipt\n- `NET_20`: 20 days after receipt\n- `NET_21`: 21 days after receipt\n- `NET_28`: 28 days after receipt\n- `NET_30`: 30 days after receipt\n- `NET_35`: 35 days after receipt\n- `NET_40`: 40 days after receipt\n- `NET_42`: 42 days after receipt\n- `NET_45`: 45 days after receipt\n- `NET_48`: 48 days after receipt\n- `NET_49`: 49 days after receipt\n- `NET_50`: 50 days after receipt\n- `NET_52`: 52 days after receipt\n- `NET_55`: 55 days after receipt\n- `NET_56`: 56 days after receipt\n- `NET_60`: 60 days after receipt\n- `NET_63`: 63 days after receipt\n- `NET_70`: 70 days after receipt\n- `NET_75`: 75 days after receipt\n- `NET_77`: 77 days after receipt\n- `NET_80`: 80 days after receipt\n- `NET_84`: 84 days after receipt\n- `NET_90`: 90 days after receipt\n- `NET_91`: 91 days after receipt\n- `NET_98`: 98 days after receipt\n- `NET_120`: 120 days after receipt", "examples": [ "END_OF_MONTH_2" ] } }, "type": "object", "required": [ "code" ], "title": "BasePaymentTerm" }, "BaseStatusUpdate": { "properties": { "stop": { "$ref": "#/components/schemas/StopStatusUpdate", "description": "Update a stop. Can update status and data of a stop.\n Updates on the data are based on a mapping defined in Qargo" }, "event_time": { "type": "string", "format": "date-time", "title": "Event Time", "description": "Time of the event in UTC. Include a timezone offset, for example `Z` or `+02:00`." } }, "type": "object", "required": [ "stop", "event_time" ], "title": "BaseStatusUpdate" }, "BaseTaxRate": { "properties": { "percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Percentage", "examples": [ 21 ] } }, "type": "object", "title": "BaseTaxRate", "description": "Original base tax rate, before applying customer/transport specific tax rules." }, "BillingDocumentMatchInput": { "properties": { "sales_invoice": { "$ref": "#/components/schemas/SalesInvoiceMatch" } }, "type": "object", "required": [ "sales_invoice" ], "title": "BillingDocumentMatchInput" }, "BillingDocumentMatchTarget": { "properties": { "matches_all": { "items": { "$ref": "#/components/schemas/BillingDocumentMatchInput" }, "type": "array", "title": "Matches All" } }, "type": "object", "title": "BillingDocumentMatchTarget" }, "BillingDocumentUpdate": { "properties": { "sales_invoice": { "anyOf": [ { "$ref": "#/components/schemas/SalesInvoiceUpdate" }, { "type": "null" } ] } }, "type": "object", "title": "BillingDocumentUpdate" }, "BillingDocumentUpdatePayload": { "properties": { "updates": { "items": { "$ref": "#/components/schemas/BillingDocumentUpdate" }, "type": "array", "title": "Updates", "description": "List of updates to process" } }, "type": "object", "title": "BillingDocumentUpdatePayload" }, "BillingEntity": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the billing entity in Qargo." }, "legal_name": { "type": "string", "title": "Legal Name", "description": "Legal name of the billing entity.", "examples": [ "Qargo BV" ] }, "vat_number": { "type": "string", "title": "Vat Number", "description": "VAT number of the billing entity.", "examples": [ "NL123456789B01" ] }, "code": { "type": "string", "title": "Code", "description": "Code of the billing entity.", "examples": [ "QARGO" ] }, "company_registration_number": { "type": "string", "title": "Company Registration Number", "description": "Company registration number of the billing entity.", "examples": [ "12345678" ] }, "is_default": { "type": "boolean", "title": "Is Default", "description": "Indicates whether this billing entity is the default one.", "default": false } }, "type": "object", "required": [ "id", "legal_name", "vat_number", "code", "company_registration_number" ], "title": "BillingEntity" }, "BillingEntityReference": { "properties": { "code": { "type": "string", "title": "Code", "description": "Code of the reference" } }, "type": "object", "required": [ "code" ], "title": "BillingEntityReference" }, "BillingLocation": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the location", "examples": [ "" ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Human-readable label for a location in operational views.", "examples": [ "Main Office" ] }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "Identifier from an external (master data) system." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "First address line of the location", "examples": [ "Gaston Crommenlaan 4" ] }, "address_second_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Second Line", "description": "Second address line of the location", "examples": [ "" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City of the location", "examples": [ "Ghent" ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "State of the location", "examples": [ "" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country code (ISO 3166-1 alpha-2) of the location", "examples": [ "BE" ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code", "description": "Postal code of the location", "examples": [ "9050" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the location", "examples": [ "Qargo HQ" ] } }, "type": "object", "title": "BillingLocation" }, "Body_Upload_document_content_v1_documents_document_upload_content_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_Upload_document_content_v1_documents_document_upload_content_post" }, "Booking": { "properties": { "booking_id": { "type": "string", "format": "uuid", "title": "Booking Id", "description": "Unique technical Qargo id for the booking." }, "booking_name": { "type": "string", "title": "Booking Name", "description": "Human-readable name of the booking in Qargo." }, "booking_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Booking Reference", "description": "Unique human-readable reference for the booking." }, "shipping_company": { "$ref": "#/components/schemas/ShippingCompany" }, "shipping_route": { "$ref": "#/components/schemas/ShippingRoute" }, "transport_type": { "$ref": "#/components/schemas/TransportType" }, "trailer": { "anyOf": [ { "$ref": "#/components/schemas/Trailer" }, { "type": "null" } ] }, "container": { "anyOf": [ { "$ref": "#/components/schemas/Container" }, { "type": "null" } ] }, "vehicle": { "anyOf": [ { "$ref": "#/components/schemas/Vehicle" }, { "type": "null" } ] }, "plugging": { "anyOf": [ { "$ref": "#/components/schemas/Plugging" }, { "type": "null" } ] }, "dimensions": { "$ref": "#/components/schemas/BookingDimensions" }, "customs": { "anyOf": [ { "$ref": "#/components/schemas/Customs" }, { "type": "null" } ] }, "temperature_requirements": { "anyOf": [ { "$ref": "#/components/schemas/TemperatureRequirements" }, { "type": "null" } ], "description": "Temperature settings for the booking." }, "additional_goods_information": { "anyOf": [ { "$ref": "#/components/schemas/AdditionalGoodsInformation" }, { "type": "null" } ], "description": "Additional information about the goods." }, "seal_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Seal Number", "description": "Container seal number." }, "vessel_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vessel Name", "description": "Name of the vessel." }, "voyage_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Voyage Code", "description": "Voyage code." }, "imo_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Imo Number", "description": "IMO number (formerly Lloyd's number)." }, "references": { "anyOf": [ { "$ref": "#/components/schemas/IntermodalBookingReferences" }, { "type": "null" } ], "description": "Booking references for the conveyances at the port of loading (POL) and port of discharge (POD)." }, "execution_data": { "$ref": "#/components/schemas/BookingExecutionData", "description": "Carrier-side execution data for the booking, such as movement statuses." } }, "type": "object", "required": [ "booking_id", "booking_name", "shipping_company", "shipping_route", "transport_type", "dimensions" ], "title": "Booking" }, "BookingDimensions": { "properties": { "resource_type": { "anyOf": [ { "$ref": "#/components/schemas/BookingVehicleType" }, { "type": "null" } ], "description": "Type of resource used in the booking." }, "length": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Length", "description": "Total vehicle length (combined tractor and trailer if both are present)." }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Width", "description": "Maximum vehicle width (combined tractor and trailer if both are present)." }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Height", "description": "Maximum vehicle height (combined tractor and trailer if both are present)." }, "tare_weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tare Weight", "description": "Tare weight of the vehicle or container in kg." }, "cargo_weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cargo Weight", "description": "Total cargo weight in kg (sum of the goods weights on the orders in this booking)." }, "verified_gross_mass": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Verified Gross Mass", "description": "Verified Gross Mass (VGM) in kg, equal to tare weight plus cargo weight. SOLAS compliant." }, "is_loaded": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Loaded", "description": "Whether the vehicle is loaded." }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weight", "description": "Total weight (VGM) in kg. Replaced by `verified_gross_mass`, please use `verified_gross_mass` instead.", "deprecated": true } }, "type": "object", "title": "BookingDimensions" }, "BookingExecutionData": { "properties": { "execution_statuses": { "items": { "$ref": "#/components/schemas/IntermodalExecutionStatus" }, "type": "array", "title": "Execution Statuses", "description": "Operational movement statuses reported by the carrier, in chronological order." }, "skip_dispatch": { "type": "boolean", "title": "Skip Dispatch", "description": "Whether the booking has been finalized and no longer accepts dispatch modifications.", "default": false } }, "type": "object", "title": "BookingExecutionData" }, "BookingExecutionStatus": { "properties": { "event_time": { "type": "string", "format": "date-time", "title": "Event Time", "description": "Time of the event (ISO 8601 format with a timezone offset, e.g. `Z` or `+02:00`).", "examples": [ "2024-12-31T08:00:00Z" ] }, "ok": { "type": "boolean", "title": "Ok", "description": "Is the status ok" }, "type": { "type": "string", "title": "Type", "description": "Type of the status" }, "remark": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remark", "description": "extra remark about the status" } }, "type": "object", "required": [ "event_time", "ok", "type" ], "title": "BookingExecutionStatus" }, "BookingMatch": { "properties": { "booking_reference": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "name": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] } }, "type": "object", "title": "BookingMatch" }, "BookingMatchTarget": { "properties": { "matches_all": { "items": { "$ref": "#/components/schemas/BookingMatch" }, "type": "array", "title": "Matches All" } }, "type": "object", "title": "BookingMatchTarget" }, "BookingOperation": { "type": "string", "enum": [ "CREATE", "UPDATE", "CANCEL" ], "title": "BookingOperation" }, "BookingStatus": { "type": "string", "enum": [ "TO_REQUEST", "REQUESTED", "BOOKED", "CANCELLED", "REJECTED" ], "title": "BookingStatus" }, "BookingTrip": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Qargo Trip id" }, "name": { "type": "string", "title": "Name", "description": "Qargo Trip name" }, "status": { "$ref": "#/components/schemas/TripStatus", "description": "Status of the trip" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" } }, "type": "object", "required": [ "id", "name", "status" ], "title": "BookingTrip" }, "BookingVehicleType": { "type": "string", "enum": [ "ARTICULATED", "ResourceType.VAN", "ResourceType.RIGID", "ResourceType.TRACTOR", "TANK_CONTAINER", "CURTAINSIDER", "REEFER", "BOX", "CONTAINER", "CHASSIS" ], "title": "BookingVehicleType" }, "BuyerSellerCompanyOutput-Input": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the company." }, "is_archived": { "type": "boolean", "title": "Is Archived", "description": "Indicates whether this company is archived as buyer/seller of an consignment", "default": false }, "name": { "type": "string", "title": "Name", "description": "Name of the company.", "examples": [ "Qargo" ] }, "legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Name", "description": "Legal name of the company.", "examples": [ "Qargo Ltd" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "External reference to this company record", "examples": [ "QARGO" ] }, "contacts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CompanyContactOutput" }, "type": "array" }, { "type": "null" } ], "title": "Contacts", "description": "List of contacts associated with the company" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "billing_location": { "anyOf": [ { "$ref": "#/components/schemas/LocationOutput" }, { "type": "null" } ], "description": "Billing address of the company." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional notes about the company.", "examples": [ "Additional notes" ] }, "reference_numbers": { "$ref": "#/components/schemas/CompanyReferenceNumbers", "description": "Reference numbers of the company" } }, "type": "object", "required": [ "id", "name" ], "title": "BuyerSellerCompanyOutput" }, "BuyerSellerCompanyOutput-Output": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the company." }, "is_archived": { "type": "boolean", "title": "Is Archived", "description": "Indicates whether this company is archived as buyer/seller of an consignment", "default": false }, "name": { "type": "string", "title": "Name", "description": "Name of the company.", "examples": [ "Qargo" ] }, "legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Name", "description": "Legal name of the company.", "examples": [ "Qargo Ltd" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "External reference to this company record", "examples": [ "QARGO" ] }, "contacts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CompanyContactOutput" }, "type": "array" }, { "type": "null" } ], "title": "Contacts", "description": "List of contacts associated with the company" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "billing_location": { "anyOf": [ { "$ref": "#/components/schemas/LocationOutput" }, { "type": "null" } ], "description": "Billing address of the company." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional notes about the company.", "examples": [ "Additional notes" ] }, "reference_numbers": { "$ref": "#/components/schemas/CompanyReferenceNumbers", "description": "Reference numbers of the company" } }, "type": "object", "required": [ "id", "name" ], "title": "BuyerSellerCompanyOutput" }, "BuyerSellerField": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "row_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Row Id" } }, "type": "object", "title": "BuyerSellerField" }, "CentralTransportNetworkConsignmentExtraFields": { "properties": { "hub": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hub", "description": "Central Transport Network hub" }, "trunk": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trunk", "description": "Central Transport Network trunk" }, "alternative_hubs": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alternative Hubs", "description": "Alternative hubs as a comma separated list e.g. `Central,South`" } }, "type": "object", "title": "CentralTransportNetworkConsignmentExtraFields" }, "CentralTransportNetworkConsignmentInput": { "properties": { "hub": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hub" }, "trunk": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trunk" } }, "type": "object", "title": "CentralTransportNetworkConsignmentInput" }, "ChargeApprovalInput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the charge to approve/reject" }, "approval_status": { "$ref": "#/components/schemas/ChargeApprovalStatusInput", "description": "Approval status of the charge", "default": "APPROVED" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Comment for approval/rejection" } }, "type": "object", "required": [ "id" ], "title": "ChargeApprovalInput" }, "ChargeApprovalStatus": { "type": "string", "enum": [ "TO_REQUEST", "REQUESTED", "REJECTED_INTERNAL", "REJECTED", "APPROVED" ], "title": "ChargeApprovalStatus" }, "ChargeApprovalStatusInput": { "type": "string", "enum": [ "APPROVED", "REJECTED" ], "title": "ChargeApprovalStatusInput" }, "ChargeInput": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the charge" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the charge" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the charge" }, "amount_excl_tax": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Amount Excl Tax", "description": "Amount excluding tax" }, "tax_rate": { "anyOf": [ { "$ref": "#/components/schemas/TaxRateReference" }, { "type": "null" } ], "description": "Tax rate reference for this charge, defaults to tax rate on price list item." }, "price_list_item": { "$ref": "#/components/schemas/PriceListItemReference", "description": "Price list item reference for this charge" } }, "type": "object", "required": [ "amount_excl_tax", "price_list_item" ], "title": "ChargeInput" }, "ChargeOutput": { "type": "object" }, "ChargeStatus": { "type": "string", "enum": [ "CREATED", "DO_NOT_INVOICE", "INVOICED", "INVOICED_EXTERNAL", "INVOICE_POSTED" ], "title": "ChargeStatus", "description": "Invoicing lifecycle of a charge.\n\n- CREATED: Not yet invoiced. Statuses outside this list are also reported as CREATED.\n- DO_NOT_INVOICE: Marked to be excluded from invoicing.\n- INVOICED: On an invoice that has not been posted yet.\n- INVOICED_EXTERNAL: Invoiced outside Qargo.\n- INVOICE_POSTED: On a posted invoice." }, "ChargeWithApprovalOutput": { "type": "object" }, "ChargesApprovalInput": { "properties": { "charges": { "items": { "$ref": "#/components/schemas/ChargeApprovalInput" }, "type": "array", "title": "Charges" } }, "type": "object", "required": [ "charges" ], "title": "ChargesApprovalInput" }, "ChassisProperties-Input": { "properties": { "tare_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Tare Weight Kg", "description": "Tare weight of the chassis in kg", "examples": [ 5000 ] }, "exterior_length_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Length M", "description": "Exterior length of the chassis in meter", "examples": [ 12 ] }, "exterior_width_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Width M", "description": "Exterior width of the chassis in meter", "examples": [ 2.5 ] }, "exterior_height_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Height M", "description": "Exterior height of the chassis in meter", "examples": [ 1.5 ] }, "gross_weight_vehicle_rating_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Gross Weight Vehicle Rating Weight Kg", "description": "Gross vehicle weight rating of the chassis in kg", "examples": [ 30000 ] }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the chassis" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the chassis" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the chassis" }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the chassis" }, "axle_configuration": { "anyOf": [ { "type": "string", "enum": [ "AC_12_TRAILER", "AC_10_TRAILER", "AC_8_TRAILER", "AC_6_TRAILER", "AC_4_TRAILER", "AC_2_TRAILER" ] }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the chassis" } }, "type": "object", "title": "ChassisProperties" }, "ChassisProperties-Output": { "properties": { "tare_weight_kg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tare Weight Kg", "description": "Tare weight of the chassis in kg", "examples": [ 5000 ] }, "exterior_length_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Length M", "description": "Exterior length of the chassis in meter", "examples": [ 12 ] }, "exterior_width_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Width M", "description": "Exterior width of the chassis in meter", "examples": [ 2.5 ] }, "exterior_height_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Height M", "description": "Exterior height of the chassis in meter", "examples": [ 1.5 ] }, "gross_weight_vehicle_rating_weight_kg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gross Weight Vehicle Rating Weight Kg", "description": "Gross vehicle weight rating of the chassis in kg", "examples": [ 30000 ] }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the chassis" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the chassis" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the chassis" }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the chassis" }, "axle_configuration": { "anyOf": [ { "type": "string", "enum": [ "AC_12_TRAILER", "AC_10_TRAILER", "AC_8_TRAILER", "AC_6_TRAILER", "AC_4_TRAILER", "AC_2_TRAILER" ] }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the chassis" } }, "type": "object", "title": "ChassisProperties" }, "ChassisResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "chassis": { "anyOf": [ { "$ref": "#/components/schemas/ChassisProperties-Input" }, { "type": "null" } ], "description": "Chassis specific properties" } }, "type": "object", "required": [ "name" ], "title": "ChassisResourceInput" }, "ChassisResourceOutput": { "properties": { "row_id": { "type": "string", "format": "uuid", "title": "Row Id", "description": "Identifier of the reference" }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "External identifier of the resource" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the resource" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntity" }, { "type": "null" } ], "description": "Billing entity associated with the resource" }, "extras": { "items": { "$ref": "#/components/schemas/ResourceExtraOutput" }, "type": "array", "title": "Extras", "description": "Stop extras this resource is compatible with" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active", "description": "Is the resource active" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "timestamp_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp Updated", "description": "Timestamp of the last update of the resource" }, "resource_groups": { "items": { "$ref": "#/components/schemas/ResourceGroupOutput" }, "type": "array", "title": "Resource Groups", "description": "Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded." }, "chassis": { "anyOf": [ { "$ref": "#/components/schemas/ChassisProperties-Output" }, { "type": "null" } ], "description": "Chassis specific properties" } }, "type": "object", "required": [ "row_id", "name" ], "title": "ChassisResourceOutput" }, "ChepOrderInput": { "properties": { "load_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Load Id" } }, "type": "object", "title": "ChepOrderInput" }, "CommercialInvoiceInput": { "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value" } }, "type": "object", "title": "CommercialInvoiceInput" }, "CompanyBillingEntity": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Unique identifier of the billing entity associated with the company." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the billing entity associated with the company." }, "accounting_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accounting Code", "description": "Accounting code linked to the billing entity for the company." } }, "type": "object", "title": "CompanyBillingEntity" }, "CompanyContactInput": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Unique identifier of the contact. When creating a new contact, this field should be omitted or set to null. This field only needs to be provided when updating an existing contact of the company" }, "is_archived": { "type": "boolean", "title": "Is Archived", "description": "Indicates whether a contact should be archived. Set to true to archive the contact.", "default": false }, "roles": { "items": { "$ref": "#/components/schemas/ContactType" }, "type": "array", "title": "Roles", "description": "List of roles associated with the contact." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the contact person associated with the company.", "examples": [ "John Doe" ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional notes about the contact person." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "Email address of the contact person." }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "Phone number of the contact person. Expected format is E.164 (e.g., +32485123456).", "examples": [ "+32485123456" ] } }, "type": "object", "title": "CompanyContactInput" }, "CompanyContactOutput": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Unique identifier of the contact" }, "roles": { "items": { "$ref": "#/components/schemas/ContactType" }, "type": "array", "title": "Roles", "description": "List of roles associated with the contact." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the contact person associated with the company.", "examples": [ "John Doe" ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional notes about the contact person." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "Email address of the contact person." }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "Phone number of the contact person.", "examples": [ "+32485123456" ] } }, "type": "object", "title": "CompanyContactOutput" }, "CompanyDetailOutput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the company." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "External reference to this company record", "examples": [ "" ] }, "currency": { "type": "string", "title": "Currency", "description": "Currency of the company (ISO 4217, 3 letter code)", "examples": [ "EUR" ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "Custom fields of the company" }, "is_customer": { "type": "boolean", "title": "Is Customer", "description": "Indicate that this company is a customer", "default": false }, "is_subcontractor": { "type": "boolean", "title": "Is Subcontractor", "description": "Indicate that this company is a subcontractor (supplier)", "default": false }, "is_buyer_or_seller": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Buyer Or Seller", "description": "Indicates that this company is a buyer or seller of a consignment" }, "name": { "type": "string", "title": "Name", "description": "Name of the company.", "examples": [ "John Doe" ] }, "legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Name", "description": "Legal name of the company.", "examples": [ "John Doe" ] }, "vat_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vat Number", "description": "VAT number of the company.", "examples": [ "BE1234.123.123" ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional notes about the company", "examples": [ "" ] }, "tax_type": { "anyOf": [ { "$ref": "#/components/schemas/TaxTypeEnum" }, { "type": "null" } ], "description": "default tax type of the company", "examples": [ "VAT" ] }, "status": { "$ref": "#/components/schemas/CustomerStatus", "description": "The status indicates whether an order can be linked to this customer. The available statuses are: \n - `PROSPECT`: The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed.\n - `NOT_APPROVED`: The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply.\n - `APPROVED`: The customer is approved. Orders can be placed without restrictions.\n - `WARNING`: The customer is approved, but a warning is triggered when attempting to create an order in Qargo. The operator can dismiss the warning and proceed with the order.\n - `BLOCKED`: The customer is blocked; no new orders can be created.\n\n For a company representing other companies, it can only create orders if it holds the `APPROVED` status.", "default": "APPROVED", "examples": [ "APPROVED" ] }, "accounting_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accounting Code", "description": "Default customer accounting code linked to the accounting system. Please use the accounting codes on the billing entities, as these are split per billing entity and between sales/purchase sides.", "examples": [ "1234" ] }, "billing_location": { "anyOf": [ { "$ref": "#/components/schemas/LocationOutput" }, { "type": "null" } ], "description": "Billing address of the company." }, "payment_term": { "anyOf": [ { "$ref": "#/components/schemas/BasePaymentTerm" }, { "type": "null" } ], "description": "Payment term information of the company" }, "locale": { "type": "string", "title": "Locale", "description": "Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "archived_customer": { "type": "boolean", "title": "Archived Customer", "description": "Indicate that this company is archived as a customer" }, "archived_subcontractor": { "type": "boolean", "title": "Archived Subcontractor", "description": "Indicate that this company is archived as a subcontractor" }, "archived_buyer_or_seller": { "type": "boolean", "title": "Archived Buyer Or Seller", "description": "Indicates that this company is archived as buyer/seller of a consignment" }, "credit_policy": { "anyOf": [ { "$ref": "#/components/schemas/CreditPolicyOutput" }, { "type": "null" } ], "description": "Credit policy of the customer" }, "default_invoice_customer": { "anyOf": [ { "$ref": "#/components/schemas/api__accounting__models__company__CompanyReferenceOutput" }, { "type": "null" } ], "description": "Default invoice customer (bill-to) for this company. When set, charges for this customer are billed to the referenced company instead." }, "reference_numbers": { "$ref": "#/components/schemas/CompanyReferenceNumbers", "description": "Reference numbers of the company" }, "bank_accounts": { "items": { "$ref": "#/components/schemas/BankAccount" }, "type": "array", "title": "Bank Accounts", "description": "List of associated bank accounts." }, "contacts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CompanyContactOutput" }, "type": "array" }, { "type": "null" } ], "title": "Contacts", "description": "List of contacts associated with the company" }, "sales": { "$ref": "#/components/schemas/SalesCompanyFields-Output", "description": "Sales related fields of the company" }, "purchase": { "$ref": "#/components/schemas/PurchaseCompanyFields-Output", "description": "Purchase related fields of the company" }, "timestamp_updated": { "type": "string", "format": "date-time", "title": "Timestamp Updated", "description": "The date and time when the company was last updated." }, "is_blocked": { "type": "boolean", "title": "Is Blocked", "description": "Set to true to disallow new order creation for companies representing companies.\n\n**Note**: Deprecated in favor of `status`.", "default": false, "deprecated": true }, "credit_limit_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Credit Limit Total", "description": "The limit for total amount that has been invoiced but not paid. **Deprecated**: use `credit_policy.limit` instead.", "deprecated": true, "examples": [ 12000 ] } }, "type": "object", "required": [ "id", "currency", "name", "locale", "archived_customer", "archived_subcontractor", "archived_buyer_or_seller", "timestamp_updated" ], "title": "CompanyDetailOutput" }, "CompanyDocumentOutput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the document" }, "name": { "type": "string", "title": "Name", "description": "Name of the document" }, "type": { "anyOf": [ { "$ref": "#/components/schemas/SubcontractorDocumentWithValidityTypeInput" }, { "$ref": "#/components/schemas/SubcontractorInsuranceDocumentTypeInput" }, { "$ref": "#/components/schemas/CustomerDocumentTypeInput" }, { "$ref": "#/components/schemas/SubcontractorDocumentWithoutValidityTypeInput" } ], "title": "Type", "description": "Type of the document." }, "download_url": { "type": "string", "title": "Download Url", "description": "Relative URL from the base URL to download the document", "default": "" }, "subject_type": { "type": "string", "title": "Subject Type", "description": "Linked subject of the document" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Type", "description": "Content type of the document" }, "validity": { "anyOf": [ { "$ref": "#/components/schemas/CompanyValidityOutput" }, { "type": "null" } ], "description": "Validity information associated with the document." } }, "type": "object", "required": [ "id", "name", "type", "subject_type" ], "title": "CompanyDocumentOutput" }, "CompanyInput": { "properties": { "is_customer": { "type": "boolean", "title": "Is Customer", "description": "Indicate that this company is a customer", "default": false }, "is_buyer_or_seller": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Buyer Or Seller", "description": "Indicates that this company is a buyer or seller of a consignment" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the company.", "examples": [ "John Doe" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "External reference to this company record", "examples": [ "" ] }, "currency": { "type": "string", "title": "Currency", "description": "Currency of the company (ISO 4217, 3 letter code)", "examples": [ "EUR" ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "Custom fields of the company" }, "credit_policy": { "anyOf": [ { "$ref": "#/components/schemas/CreditPolicyInput" }, { "type": "null" } ], "description": "Credit policy of the customer" }, "default_invoice_customer_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Default Invoice Customer Id", "description": "ID of the default invoice customer (bill-to) for this company. When set, charges for this customer are billed to the referenced company instead." }, "is_subcontractor": { "type": "boolean", "title": "Is Subcontractor", "description": "Indicate that this company is a subcontractor (supplier)", "default": false }, "archived_customer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Archived Customer", "description": "Set to `true` to archive the customer role of this company, or `false` to reactivate it. Has no effect if `is_customer` is `false`." }, "archived_subcontractor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Archived Subcontractor", "description": "Set to `true` to archive the subcontractor role of this company, or `false` to reactivate it. Has no effect if `is_subcontractor` is `false`." }, "legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Name", "description": "Legal name of the company.", "examples": [ "John Doe" ] }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "vat_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vat Number", "description": "VAT number of the company.", "examples": [ "BE1234.123.123" ] }, "reference_numbers": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReferenceNumbers" }, { "type": "null" } ], "description": "Reference numbers of the company" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional notes about the company", "examples": [ "" ] }, "tax_type": { "anyOf": [ { "$ref": "#/components/schemas/TaxTypeEnum" }, { "type": "null" } ], "description": "DESCRIPTION_HERE", "default": "VAT", "examples": [ "VAT" ] }, "bank_accounts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/BankAccount" }, "type": "array" }, { "type": "null" } ], "title": "Bank Accounts", "description": "List of associated bank accounts.", "default": [] }, "accounting_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accounting Code", "description": "Code linked to the accounting system", "examples": [ "1234" ] }, "billing_location": { "anyOf": [ { "$ref": "#/components/schemas/BillingLocation" }, { "type": "null" } ], "description": "Billing address of the company." }, "payment_term": { "anyOf": [ { "$ref": "#/components/schemas/BasePaymentTerm" }, { "type": "null" } ], "description": "Payment term information of the company" }, "contacts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CompanyContactInput" }, "type": "array" }, { "type": "null" } ], "title": "Contacts", "description": "List of contacts associated with the company" }, "sales": { "$ref": "#/components/schemas/SalesCompanyFields-Input", "description": "Sales related fields of the company" }, "purchase": { "$ref": "#/components/schemas/PurchaseCompanyFields-Input", "description": "Purchase related fields of the company" }, "credit_limit_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Credit Limit Total", "description": "The limit for total amount that has been invoiced but not paid. **Deprecated**: use `credit_policy.limit` instead.", "deprecated": true, "examples": [ 12000 ] }, "is_blocked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Blocked", "description": "Set to true to disallow new order creation for companies representing companies.\n\n**Note**: Deprecated in favor of `status` under the `sales` and `purchase` fields.an update of `status` will always prevail over `is_blocked` update.", "deprecated": true }, "status": { "anyOf": [ { "$ref": "#/components/schemas/CustomerStatus" }, { "type": "null" } ], "description": "The status indicates whether an order can be linked to this customer. The available statuses are: \n - `PROSPECT`: The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed.\n - `NOT_APPROVED`: The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply.\n - `APPROVED`: The customer is approved. Orders can be placed without restrictions.\n - `WARNING`: The customer is approved, but a warning is triggered when attempting to create an order in Qargo. The operator can dismiss the warning and proceed with the order.\n - `BLOCKED`: The customer is blocked; no new orders can be created.\n\n For a company representing other companies, it can only create orders if it holds the `APPROVED` status.**Note**: Deprecated in favor of `status` under the `sales` and `purchase` fields.", "deprecated": true, "examples": [ "APPROVED" ] } }, "type": "object", "required": [ "currency" ], "title": "CompanyInput" }, "CompanyMatch": { "properties": { "name": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "code": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] } }, "type": "object", "title": "CompanyMatch" }, "CompanyOutput-Input": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the company." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "External reference to this company record", "examples": [ "" ] }, "currency": { "type": "string", "title": "Currency", "description": "Currency of the company (ISO 4217, 3 letter code)", "examples": [ "EUR" ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "Custom fields of the company" }, "is_customer": { "type": "boolean", "title": "Is Customer", "description": "Indicate that this company is a customer", "default": false }, "is_subcontractor": { "type": "boolean", "title": "Is Subcontractor", "description": "Indicate that this company is a subcontractor (supplier)", "default": false }, "is_buyer_or_seller": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Buyer Or Seller", "description": "Indicates that this company is a buyer or seller of a consignment" }, "name": { "type": "string", "title": "Name", "description": "Name of the company.", "examples": [ "John Doe" ] }, "legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Name", "description": "Legal name of the company.", "examples": [ "John Doe" ] }, "vat_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vat Number", "description": "VAT number of the company.", "examples": [ "BE1234.123.123" ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional notes about the company", "examples": [ "" ] }, "tax_type": { "anyOf": [ { "$ref": "#/components/schemas/TaxTypeEnum" }, { "type": "null" } ], "description": "default tax type of the company", "examples": [ "VAT" ] }, "status": { "$ref": "#/components/schemas/CustomerStatus", "description": "The status indicates whether an order can be linked to this customer. The available statuses are: \n - `PROSPECT`: The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed.\n - `NOT_APPROVED`: The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply.\n - `APPROVED`: The customer is approved. Orders can be placed without restrictions.\n - `WARNING`: The customer is approved, but a warning is triggered when attempting to create an order in Qargo. The operator can dismiss the warning and proceed with the order.\n - `BLOCKED`: The customer is blocked; no new orders can be created.\n\n For a company representing other companies, it can only create orders if it holds the `APPROVED` status.", "default": "APPROVED", "examples": [ "APPROVED" ] }, "accounting_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accounting Code", "description": "Default customer accounting code linked to the accounting system. Please use the accounting codes on the billing entities, as these are split per billing entity and between sales/purchase sides.", "examples": [ "1234" ] }, "billing_location": { "anyOf": [ { "$ref": "#/components/schemas/LocationOutput" }, { "type": "null" } ], "description": "Billing address of the company." }, "payment_term": { "anyOf": [ { "$ref": "#/components/schemas/BasePaymentTerm" }, { "type": "null" } ], "description": "Payment term information of the company" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "reference_numbers": { "$ref": "#/components/schemas/CompanyReferenceNumbers", "description": "Reference numbers of the company" }, "bank_accounts": { "items": { "$ref": "#/components/schemas/BankAccount" }, "type": "array", "title": "Bank Accounts", "description": "List of associated bank accounts." }, "contacts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CompanyContactOutput" }, "type": "array" }, { "type": "null" } ], "title": "Contacts", "description": "List of contacts associated with the company" }, "is_blocked": { "type": "boolean", "title": "Is Blocked", "description": "Set to true to disallow new order creation for companies representing companies.\n\n**Note**: Deprecated in favor of `status`.", "default": false, "deprecated": true } }, "type": "object", "required": [ "id", "currency", "name" ], "title": "CompanyOutput" }, "CompanyOutput-Output": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the company." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "External reference to this company record", "examples": [ "" ] }, "currency": { "type": "string", "title": "Currency", "description": "Currency of the company (ISO 4217, 3 letter code)", "examples": [ "EUR" ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "Custom fields of the company" }, "is_customer": { "type": "boolean", "title": "Is Customer", "description": "Indicate that this company is a customer", "default": false }, "is_subcontractor": { "type": "boolean", "title": "Is Subcontractor", "description": "Indicate that this company is a subcontractor (supplier)", "default": false }, "is_buyer_or_seller": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Buyer Or Seller", "description": "Indicates that this company is a buyer or seller of a consignment" }, "name": { "type": "string", "title": "Name", "description": "Name of the company.", "examples": [ "John Doe" ] }, "legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Name", "description": "Legal name of the company.", "examples": [ "John Doe" ] }, "vat_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vat Number", "description": "VAT number of the company.", "examples": [ "BE1234.123.123" ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional notes about the company", "examples": [ "" ] }, "tax_type": { "anyOf": [ { "$ref": "#/components/schemas/TaxTypeEnum" }, { "type": "null" } ], "description": "default tax type of the company", "examples": [ "VAT" ] }, "status": { "$ref": "#/components/schemas/CustomerStatus", "description": "The status indicates whether an order can be linked to this customer. The available statuses are: \n - `PROSPECT`: The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed.\n - `NOT_APPROVED`: The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply.\n - `APPROVED`: The customer is approved. Orders can be placed without restrictions.\n - `WARNING`: The customer is approved, but a warning is triggered when attempting to create an order in Qargo. The operator can dismiss the warning and proceed with the order.\n - `BLOCKED`: The customer is blocked; no new orders can be created.\n\n For a company representing other companies, it can only create orders if it holds the `APPROVED` status.", "default": "APPROVED", "examples": [ "APPROVED" ] }, "accounting_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accounting Code", "description": "Default customer accounting code linked to the accounting system. Please use the accounting codes on the billing entities, as these are split per billing entity and between sales/purchase sides.", "examples": [ "1234" ] }, "billing_location": { "anyOf": [ { "$ref": "#/components/schemas/LocationOutput" }, { "type": "null" } ], "description": "Billing address of the company." }, "payment_term": { "anyOf": [ { "$ref": "#/components/schemas/BasePaymentTerm" }, { "type": "null" } ], "description": "Payment term information of the company" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "reference_numbers": { "$ref": "#/components/schemas/CompanyReferenceNumbers", "description": "Reference numbers of the company" }, "bank_accounts": { "items": { "$ref": "#/components/schemas/BankAccount" }, "type": "array", "title": "Bank Accounts", "description": "List of associated bank accounts." }, "contacts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CompanyContactOutput" }, "type": "array" }, { "type": "null" } ], "title": "Contacts", "description": "List of contacts associated with the company" }, "is_blocked": { "type": "boolean", "title": "Is Blocked", "description": "Set to true to disallow new order creation for companies representing companies.\n\n**Note**: Deprecated in favor of `status`.", "default": false, "deprecated": true } }, "type": "object", "required": [ "id", "currency", "name" ], "title": "CompanyOutput" }, "CompanyPartialInput": { "properties": { "is_customer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Customer", "description": "Indicate that this company is a customer. At least one of `is_customer` or `is_subcontractor` must be set." }, "is_buyer_or_seller": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Buyer Or Seller", "description": "Indicates that this company is a buyer or seller of a consignment" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the company.", "examples": [ "John Doe" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "External reference to this company record", "examples": [ "" ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency", "description": "Currency of the company (ISO 4217, 3 letter code)", "examples": [ "EUR" ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "Custom fields of the company" }, "credit_policy": { "anyOf": [ { "$ref": "#/components/schemas/CreditPolicyInput" }, { "type": "null" } ], "description": "Credit policy of the customer" }, "default_invoice_customer_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Default Invoice Customer Id", "description": "ID of the default invoice customer (bill-to) for this company. When set, charges for this customer are billed to the referenced company instead." }, "is_subcontractor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Subcontractor", "description": "Indicate that this company is a subcontractor (supplier). At least one of `is_customer` or `is_subcontractor` must be set." }, "archived_customer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Archived Customer", "description": "Set to `true` to archive the customer role of this company, or `false` to reactivate it. Has no effect if `is_customer` is `false`." }, "archived_subcontractor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Archived Subcontractor", "description": "Set to `true` to archive the subcontractor role of this company, or `false` to reactivate it. Has no effect if `is_subcontractor` is `false`." }, "legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Name", "description": "Legal name of the company.", "examples": [ "John Doe" ] }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "vat_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vat Number", "description": "VAT number of the company.", "examples": [ "BE1234.123.123" ] }, "reference_numbers": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReferenceNumbers" }, { "type": "null" } ], "description": "Reference numbers of the company" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional notes about the company", "examples": [ "" ] }, "tax_type": { "anyOf": [ { "$ref": "#/components/schemas/TaxTypeEnum" }, { "type": "null" } ], "description": "DESCRIPTION_HERE", "examples": [ "VAT" ] }, "bank_accounts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/BankAccount" }, "type": "array" }, { "type": "null" } ], "title": "Bank Accounts", "description": "List of associated bank accounts." }, "accounting_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accounting Code", "description": "Code linked to the accounting system", "examples": [ "1234" ] }, "billing_location": { "anyOf": [ { "$ref": "#/components/schemas/BillingLocation" }, { "type": "null" } ], "description": "Billing address of the company." }, "payment_term": { "anyOf": [ { "$ref": "#/components/schemas/BasePaymentTerm" }, { "type": "null" } ], "description": "Payment term information of the company" }, "contacts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CompanyContactInput" }, "type": "array" }, { "type": "null" } ], "title": "Contacts", "description": "List of contacts associated with the company" }, "sales": { "$ref": "#/components/schemas/SalesCompanyFields-Input", "description": "Sales related fields of the company" }, "purchase": { "$ref": "#/components/schemas/PurchaseCompanyFields-Input", "description": "Purchase related fields of the company" }, "credit_limit_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Credit Limit Total", "description": "The limit for total amount that has been invoiced but not paid. **Deprecated**: use `credit_policy.limit` instead.", "deprecated": true, "examples": [ 12000 ] }, "is_blocked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Blocked", "description": "Set to true to disallow new order creation for companies representing companies.\n\n**Note**: Deprecated in favor of `status` under the `sales` and `purchase` fields.an update of `status` will always prevail over `is_blocked` update.", "deprecated": true }, "status": { "anyOf": [ { "$ref": "#/components/schemas/CustomerStatus" }, { "type": "null" } ], "description": "The status indicates whether an order can be linked to this customer. The available statuses are: \n - `PROSPECT`: The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed.\n - `NOT_APPROVED`: The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply.\n - `APPROVED`: The customer is approved. Orders can be placed without restrictions.\n - `WARNING`: The customer is approved, but a warning is triggered when attempting to create an order in Qargo. The operator can dismiss the warning and proceed with the order.\n - `BLOCKED`: The customer is blocked; no new orders can be created.\n\n For a company representing other companies, it can only create orders if it holds the `APPROVED` status.**Note**: Deprecated in favor of `status` under the `sales` and `purchase` fields.", "deprecated": true, "examples": [ "APPROVED" ] } }, "type": "object", "title": "CompanyPartialInput" }, "CompanyReference": { "properties": { "row_id": { "type": "string", "format": "uuid", "title": "Row Id", "description": "Identifier of the reference" } }, "type": "object", "required": [ "row_id" ], "title": "CompanyReference" }, "CompanyReferenceNumbers": { "properties": { "eori_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Eori Number", "description": "Economic Operator Registration and Identification", "examples": [ "" ] }, "duns_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duns Number", "description": "D-U-N-S Number", "examples": [ "" ] }, "scac_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scac Code", "description": "Standard Carrier Alpha Code", "examples": [ "" ] }, "company_registration_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Registration Number", "description": "Company Registration Number", "examples": [ "" ] }, "tss_registration_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tss Registration Number", "description": "TSS registration number", "examples": [ "" ] } }, "type": "object", "title": "CompanyReferenceNumbers" }, "CompanySummaryOutput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the company." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "External reference to this company record", "examples": [ "" ] }, "currency": { "type": "string", "title": "Currency", "description": "Currency of the company (ISO 4217, 3 letter code)", "examples": [ "EUR" ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "Custom fields of the company" }, "is_customer": { "type": "boolean", "title": "Is Customer", "description": "Indicate that this company is a customer", "default": false }, "is_subcontractor": { "type": "boolean", "title": "Is Subcontractor", "description": "Indicate that this company is a subcontractor (supplier)", "default": false }, "is_buyer_or_seller": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Buyer Or Seller", "description": "Indicates that this company is a buyer or seller of a consignment" }, "name": { "type": "string", "title": "Name", "description": "Name of the company.", "examples": [ "John Doe" ] }, "legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Name", "description": "Legal name of the company.", "examples": [ "John Doe" ] }, "vat_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vat Number", "description": "VAT number of the company.", "examples": [ "BE1234.123.123" ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional notes about the company", "examples": [ "" ] }, "tax_type": { "anyOf": [ { "$ref": "#/components/schemas/TaxTypeEnum" }, { "type": "null" } ], "description": "default tax type of the company", "examples": [ "VAT" ] }, "status": { "$ref": "#/components/schemas/CustomerStatus", "description": "The status indicates whether an order can be linked to this customer. The available statuses are: \n - `PROSPECT`: The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed.\n - `NOT_APPROVED`: The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply.\n - `APPROVED`: The customer is approved. Orders can be placed without restrictions.\n - `WARNING`: The customer is approved, but a warning is triggered when attempting to create an order in Qargo. The operator can dismiss the warning and proceed with the order.\n - `BLOCKED`: The customer is blocked; no new orders can be created.\n\n For a company representing other companies, it can only create orders if it holds the `APPROVED` status.", "default": "APPROVED", "examples": [ "APPROVED" ] }, "accounting_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accounting Code", "description": "Default customer accounting code linked to the accounting system. Please use the accounting codes on the billing entities, as these are split per billing entity and between sales/purchase sides.", "examples": [ "1234" ] }, "billing_location": { "anyOf": [ { "$ref": "#/components/schemas/LocationOutput" }, { "type": "null" } ], "description": "Billing address of the company." }, "payment_term": { "anyOf": [ { "$ref": "#/components/schemas/BasePaymentTerm" }, { "type": "null" } ], "description": "Payment term information of the company" }, "is_blocked": { "type": "boolean", "title": "Is Blocked", "description": "Set to true to disallow new order creation for companies representing companies.\n\n**Note**: Deprecated in favor of `status`.", "default": false, "deprecated": true } }, "type": "object", "required": [ "id", "currency", "name" ], "title": "CompanySummaryOutput" }, "CompanyValidity": { "properties": { "start_time": { "type": "string", "format": "date-time", "title": "Start Time", "description": "Start time of the validity" }, "end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time", "description": "End time of the validity from a planning perspective" }, "legal_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Legal End Time", "description": "End time of the validity from a legal perspective" }, "generate_unavailability": { "type": "boolean", "title": "Generate Unavailability", "description": "Generate a planning unavailability once the validity end time has passed", "default": false }, "type": { "$ref": "#/components/schemas/SubcontractorValidityReason" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "ID of the validity in the external master data system" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "required": [ "start_time", "type" ], "title": "CompanyValidity" }, "CompanyValidityInput": { "properties": { "start_time": { "type": "string", "format": "date-time", "title": "Start Time", "description": "Start time of the validity" }, "end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time", "description": "End time of the validity from a planning perspective" }, "legal_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Legal End Time", "description": "End time of the validity from a legal perspective" }, "generate_unavailability": { "type": "boolean", "title": "Generate Unavailability", "description": "Generate a planning unavailability once the validity end time has passed", "default": false }, "type": { "$ref": "#/components/schemas/SubcontractorValidityReason" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "ID of the validity in the external master data system" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "documents": { "items": { "$ref": "#/components/schemas/UploadedDocumentBase_Union_SubcontractorDocumentWithValidityTypeInput__SubcontractorInsuranceDocumentTypeInput__" }, "type": "array", "title": "Documents", "description": "List of documents associated with the validity" } }, "type": "object", "required": [ "start_time", "type" ], "title": "CompanyValidityInput" }, "CompanyValidityOutput": { "properties": { "start_time": { "type": "string", "format": "date-time", "title": "Start Time", "description": "Start time of the validity" }, "end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time", "description": "End time of the validity from a planning perspective" }, "legal_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Legal End Time", "description": "End time of the validity from a legal perspective" }, "generate_unavailability": { "type": "boolean", "title": "Generate Unavailability", "description": "Generate a planning unavailability once the validity end time has passed", "default": false }, "type": { "$ref": "#/components/schemas/SubcontractorValidityReason" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "ID of the validity in the external master data system" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the validity" } }, "type": "object", "required": [ "start_time", "type", "id" ], "title": "CompanyValidityOutput" }, "ConsignmentBuyerSellerOutput-Input": { "properties": { "company": { "anyOf": [ { "$ref": "#/components/schemas/BuyerSellerCompanyOutput-Input" }, { "type": "null" } ], "description": "Company information for the buyer/seller" }, "eori_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Eori Number", "description": "Economic Operator Registration and Identification" } }, "type": "object", "title": "ConsignmentBuyerSellerOutput" }, "ConsignmentBuyerSellerOutput-Output": { "properties": { "company": { "anyOf": [ { "$ref": "#/components/schemas/BuyerSellerCompanyOutput-Output" }, { "type": "null" } ], "description": "Company information for the buyer/seller" }, "eori_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Eori Number", "description": "Economic Operator Registration and Identification" } }, "type": "object", "title": "ConsignmentBuyerSellerOutput" }, "ConsignmentCommercialInvoiceExtraField": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the commercial invoice" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "Value of the commercial invoice" }, "currency_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency Code", "description": "Currency code of the commercial invoice" } }, "type": "object", "title": "ConsignmentCommercialInvoiceExtraField" }, "ConsignmentCustomsExportInfo": { "properties": { "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "ISO 3166-1 alpha-2 country of the export declaration" }, "declaration_type": { "anyOf": [ { "$ref": "#/components/schemas/ExportDeclarationTypeEnum" }, { "type": "null" } ], "description": "Declaration type code (e.g. EU, EX)" }, "additional_border_processes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AdditionalExportBorderProcessEnum" }, "type": "array" }, { "type": "null" } ], "title": "Additional Border Processes", "description": "Additional border processes for this declaration" }, "mrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mrn", "description": "Movement Reference Number of the export declaration" }, "exs_mrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exs Mrn", "description": "Exit Summary Declaration MRN" }, "ducr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ducr", "description": "Declaration Unique Consignment Reference (UK only)" }, "location_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Location Id", "description": "Identifier of the customs location" }, "emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Emails", "description": "Email addresses associated with this declaration" } }, "type": "object", "title": "ConsignmentCustomsExportInfo" }, "ConsignmentCustomsImportInfo": { "properties": { "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "ISO 3166-1 alpha-2 country of the import declaration" }, "declaration_type": { "anyOf": [ { "$ref": "#/components/schemas/ImportDeclarationTypeEnum" }, { "type": "null" } ], "description": "Declaration type code (e.g. IM)" }, "additional_border_processes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AdditionalImportBorderProcessEnum" }, "type": "array" }, { "type": "null" } ], "title": "Additional Border Processes", "description": "Additional border processes for this declaration" }, "mrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mrn", "description": "Movement Reference Number of the import declaration" }, "ens_mrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ens Mrn", "description": "Entry Summary Declaration MRN" }, "ducr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ducr", "description": "Declaration Unique Consignment Reference (UK only)" }, "temporary_storage_ucn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temporary Storage Ucn", "description": "Temporary storage UCN" }, "temporary_storage_crn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Temporary Storage Crn", "description": "Temporary storage CRN (BE only)" }, "emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Emails", "description": "Email addresses associated with this declaration" } }, "type": "object", "title": "ConsignmentCustomsImportInfo" }, "ConsignmentCustomsTransitInfoInput": { "properties": { "sequence_number": { "type": "integer", "title": "Sequence Number", "description": "Identifier and ordering key for partial updates (required)" }, "declaration_type": { "anyOf": [ { "$ref": "#/components/schemas/TransitDeclarationTypeEnum" }, { "type": "null" } ], "description": "Declaration type code (e.g. T1, T2)" }, "additional_border_processes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AdditionalTransitBorderProcessEnum" }, "type": "array" }, { "type": "null" } ], "title": "Additional Border Processes", "description": "Additional border processes for this declaration" }, "lrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lrn", "description": "Local Reference Number" }, "mrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mrn", "description": "Movement Reference Number" }, "start_office": { "anyOf": [ { "$ref": "#/components/schemas/TransitOffice" }, { "type": "null" } ], "description": "Office of departure" }, "end_office": { "anyOf": [ { "$ref": "#/components/schemas/TransitOffice" }, { "type": "null" } ], "description": "Office of destination" }, "valid_to_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Valid To Date", "description": "Validity end date (ISO 8601)" }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Existing transit declaration identifier (for updates)" } }, "type": "object", "required": [ "sequence_number" ], "title": "ConsignmentCustomsTransitInfoInput" }, "ConsignmentCustomsTransitInfoOutput": { "properties": { "sequence_number": { "type": "integer", "title": "Sequence Number", "description": "Identifier and ordering key for partial updates (required)" }, "declaration_type": { "anyOf": [ { "$ref": "#/components/schemas/TransitDeclarationTypeEnum" }, { "type": "null" } ], "description": "Declaration type code (e.g. T1, T2)" }, "additional_border_processes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AdditionalTransitBorderProcessEnum" }, "type": "array" }, { "type": "null" } ], "title": "Additional Border Processes", "description": "Additional border processes for this declaration" }, "lrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lrn", "description": "Local Reference Number" }, "mrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mrn", "description": "Movement Reference Number" }, "start_office": { "anyOf": [ { "$ref": "#/components/schemas/TransitOffice" }, { "type": "null" } ], "description": "Office of departure" }, "end_office": { "anyOf": [ { "$ref": "#/components/schemas/TransitOffice" }, { "type": "null" } ], "description": "Office of destination" }, "valid_to_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Valid To Date", "description": "Validity end date (ISO 8601)" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the transit declaration" } }, "type": "object", "required": [ "sequence_number", "id" ], "title": "ConsignmentCustomsTransitInfoOutput" }, "ConsignmentData": { "properties": { "pickup_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopData" }, { "type": "null" } ] }, "delivery_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopData" }, { "type": "null" } ] }, "consignment_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consignment Reference Number" }, "cmr_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cmr Reference Number" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "transport_network": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentTransportNetwork" }, { "type": "null" } ] }, "central_transport_network": { "anyOf": [ { "$ref": "#/components/schemas/CentralTransportNetworkConsignmentInput" }, { "type": "null" } ] }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineConsignmentInput" }, { "type": "null" } ] }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceConsignmentInput" }, { "type": "null" } ] }, "palletxpress_ie": { "anyOf": [ { "$ref": "#/components/schemas/PalletXpressIeConsignmentInput" }, { "type": "null" } ] }, "tpn": { "anyOf": [ { "$ref": "#/components/schemas/TPNConsignmentInput" }, { "type": "null" } ] }, "pallet_track": { "anyOf": [ { "$ref": "#/components/schemas/PalletTrackConsignmentInput" }, { "type": "null" } ] }, "palletways": { "anyOf": [ { "$ref": "#/components/schemas/PalletwaysConsignmentInput" }, { "type": "null" } ] }, "project44": { "anyOf": [ { "$ref": "#/components/schemas/Project44ConsignmentInput" }, { "type": "null" } ] }, "hazchem": { "anyOf": [ { "$ref": "#/components/schemas/HazchemConsignmentInput" }, { "type": "null" } ] }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonConsignmentExtraFields" }, { "type": "null" } ] }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentImportExportExtraFieldsInput-Input" }, { "type": "null" } ] }, "goods": { "anyOf": [ { "items": { "$ref": "#/components/schemas/GoodData" }, "type": "array" }, { "type": "null" } ], "title": "Goods" }, "standalone_stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopData" }, "type": "array" }, { "type": "null" } ], "title": "Standalone Stops" }, "shipper_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Shipper Name" }, "shipper_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Shipper Reference Number" }, "buyer": { "anyOf": [ { "$ref": "#/components/schemas/BuyerSellerField" }, { "type": "null" } ] }, "seller": { "anyOf": [ { "$ref": "#/components/schemas/BuyerSellerField" }, { "type": "null" } ] }, "buyer_eori_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Buyer Eori Number" }, "seller_eori_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Seller Eori Number" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "consignee_signature": { "anyOf": [ { "$ref": "#/components/schemas/SignatureInput" }, { "type": "null" } ] }, "consignor_signature": { "anyOf": [ { "$ref": "#/components/schemas/SignatureInput" }, { "type": "null" } ] } }, "type": "object", "title": "ConsignmentData" }, "ConsignmentEntityUpdate": { "properties": { "operation": { "$ref": "#/components/schemas/ConsignmentUpdateOperation" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentUpdateData" }, { "$ref": "#/components/schemas/ConsignmentData" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "operation" ], "title": "ConsignmentEntityUpdate" }, "ConsignmentImportExportExtraFieldsInput-Input": { "properties": { "commercial_invoice": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentCommercialInvoiceExtraField" }, { "type": "null" } ] }, "export_declaration": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentCustomsExportInfo" }, { "type": "null" } ] }, "import_declaration": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentCustomsImportInfo" }, { "type": "null" } ] }, "transit_declarations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ConsignmentCustomsTransitInfoInput" }, "type": "array", "maxItems": 1 }, { "type": "null" } ], "title": "Transit Declarations", "description": "At most one transit declaration on input. (Multi-transit available via UI; the public API will lift this cap in a later release.)" } }, "type": "object", "title": "ConsignmentImportExportExtraFieldsInput" }, "ConsignmentImportExportExtraFieldsInput-Output": { "properties": { "commercial_invoice": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentCommercialInvoiceExtraField" }, { "type": "null" } ] }, "export_declaration": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentCustomsExportInfo" }, { "type": "null" } ] }, "import_declaration": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentCustomsImportInfo" }, { "type": "null" } ] }, "transit_declarations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ConsignmentCustomsTransitInfoInput" }, "type": "array", "maxItems": 1 }, { "type": "null" } ], "title": "Transit Declarations", "description": "At most one transit declaration on input. (Multi-transit available via UI; the public API will lift this cap in a later release.)" } }, "type": "object", "title": "ConsignmentImportExportExtraFieldsInput" }, "ConsignmentImportExportExtraFieldsOutput-Input": { "properties": { "commercial_invoice": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentCommercialInvoiceExtraField" }, { "type": "null" } ] }, "export_declaration": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentCustomsExportInfo" }, { "type": "null" } ] }, "import_declaration": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentCustomsImportInfo" }, { "type": "null" } ] }, "transit_declarations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ConsignmentCustomsTransitInfoOutput" }, "type": "array" }, { "type": "null" } ], "title": "Transit Declarations" } }, "type": "object", "title": "ConsignmentImportExportExtraFieldsOutput" }, "ConsignmentImportExportExtraFieldsOutput-Output": { "properties": { "commercial_invoice": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentCommercialInvoiceExtraField" }, { "type": "null" } ] }, "export_declaration": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentCustomsExportInfo" }, { "type": "null" } ] }, "import_declaration": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentCustomsImportInfo" }, { "type": "null" } ] }, "transit_declarations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ConsignmentCustomsTransitInfoOutput" }, "type": "array" }, { "type": "null" } ], "title": "Transit Declarations" } }, "type": "object", "title": "ConsignmentImportExportExtraFieldsOutput" }, "ConsignmentInput-Input": { "properties": { "consignment_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consignment Reference Number", "description": "Consignment reference number" }, "cmr_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cmr Reference Number" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Additional user defined fields to fill in" }, "transport_network": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentTransportNetwork" }, { "type": "null" } ], "description": "Transport network" }, "central_transport_network": { "anyOf": [ { "$ref": "#/components/schemas/CentralTransportNetworkConsignmentExtraFields" }, { "type": "null" } ] }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineConsignmentExtraFields" }, { "type": "null" } ] }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceConsignmentExtraFields" }, { "type": "null" } ] }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonConsignmentExtraFields" }, { "type": "null" } ] }, "pickup_stop": { "$ref": "#/components/schemas/StopInput-Input", "description": "First stop on this consignment." }, "delivery_stop": { "$ref": "#/components/schemas/StopInput-Input", "description": "Last stop on this consignment." }, "goods": { "anyOf": [ { "items": { "$ref": "#/components/schemas/GoodInput-Input" }, "type": "array" }, { "type": "null" } ], "title": "Goods" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentImportExportExtraFieldsInput-Input" }, { "type": "null" } ] }, "buyer": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "description": "Buyer information for this consignment" }, "seller": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "description": "Seller information for this consignment" } }, "type": "object", "required": [ "pickup_stop", "delivery_stop" ], "title": "ConsignmentInput" }, "ConsignmentInput-Output": { "properties": { "consignment_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consignment Reference Number", "description": "Consignment reference number" }, "cmr_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cmr Reference Number" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Additional user defined fields to fill in" }, "transport_network": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentTransportNetwork" }, { "type": "null" } ], "description": "Transport network" }, "central_transport_network": { "anyOf": [ { "$ref": "#/components/schemas/CentralTransportNetworkConsignmentExtraFields" }, { "type": "null" } ] }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineConsignmentExtraFields" }, { "type": "null" } ] }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceConsignmentExtraFields" }, { "type": "null" } ] }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonConsignmentExtraFields" }, { "type": "null" } ] }, "pickup_stop": { "$ref": "#/components/schemas/StopInput-Output", "description": "First stop on this consignment." }, "delivery_stop": { "$ref": "#/components/schemas/StopInput-Output", "description": "Last stop on this consignment." }, "goods": { "anyOf": [ { "items": { "$ref": "#/components/schemas/GoodInput-Output" }, "type": "array" }, { "type": "null" } ], "title": "Goods" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentImportExportExtraFieldsInput-Output" }, { "type": "null" } ] }, "buyer": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "description": "Buyer information for this consignment" }, "seller": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "description": "Seller information for this consignment" } }, "type": "object", "required": [ "pickup_stop", "delivery_stop" ], "title": "ConsignmentInput" }, "ConsignmentMatch": { "properties": { "reference_number": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "order_sequence_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order Sequence Number" } }, "type": "object", "title": "ConsignmentMatch" }, "ConsignmentOutput-Input": { "properties": { "consignment_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consignment Reference Number", "description": "Consignment reference number" }, "cmr_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cmr Reference Number" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Additional user defined fields to fill in" }, "transport_network": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentTransportNetwork" }, { "type": "null" } ], "description": "Transport network" }, "central_transport_network": { "anyOf": [ { "$ref": "#/components/schemas/CentralTransportNetworkConsignmentExtraFields" }, { "type": "null" } ] }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineConsignmentExtraFields" }, { "type": "null" } ] }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceConsignmentExtraFields" }, { "type": "null" } ] }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonConsignmentExtraFields" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the consignment" }, "pickup_stop": { "$ref": "#/components/schemas/StopOutput-Input", "description": "First stop on this consignment." }, "delivery_stop": { "$ref": "#/components/schemas/StopOutput-Input", "description": "Last stop on this consignment." }, "goods": { "anyOf": [ { "items": { "$ref": "#/components/schemas/GoodOutput-Input" }, "type": "array" }, { "type": "null" } ], "title": "Goods" }, "signatures": { "items": { "$ref": "#/components/schemas/Signature" }, "type": "array", "title": "Signatures", "description": "List of signatures related to the consignment" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentImportExportExtraFieldsOutput-Input" }, { "type": "null" } ] }, "buyer": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentBuyerSellerOutput-Input" }, { "type": "null" } ], "description": "Buyer information for this consignment" }, "seller": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentBuyerSellerOutput-Input" }, { "type": "null" } ], "description": "Seller information for this consignment" } }, "type": "object", "required": [ "id", "pickup_stop", "delivery_stop" ], "title": "ConsignmentOutput" }, "ConsignmentOutput-Output": { "properties": { "consignment_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consignment Reference Number", "description": "Consignment reference number" }, "cmr_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cmr Reference Number" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Additional user defined fields to fill in" }, "transport_network": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentTransportNetwork" }, { "type": "null" } ], "description": "Transport network" }, "central_transport_network": { "anyOf": [ { "$ref": "#/components/schemas/CentralTransportNetworkConsignmentExtraFields" }, { "type": "null" } ] }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineConsignmentExtraFields" }, { "type": "null" } ] }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceConsignmentExtraFields" }, { "type": "null" } ] }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonConsignmentExtraFields" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the consignment" }, "pickup_stop": { "$ref": "#/components/schemas/StopOutput-Output", "description": "First stop on this consignment." }, "delivery_stop": { "$ref": "#/components/schemas/StopOutput-Output", "description": "Last stop on this consignment." }, "goods": { "anyOf": [ { "items": { "$ref": "#/components/schemas/GoodOutput-Output" }, "type": "array" }, { "type": "null" } ], "title": "Goods" }, "signatures": { "items": { "$ref": "#/components/schemas/Signature" }, "type": "array", "title": "Signatures", "description": "List of signatures related to the consignment" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentImportExportExtraFieldsOutput-Output" }, { "type": "null" } ] }, "buyer": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentBuyerSellerOutput-Output" }, { "type": "null" } ], "description": "Buyer information for this consignment" }, "seller": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentBuyerSellerOutput-Output" }, { "type": "null" } ], "description": "Seller information for this consignment" } }, "type": "object", "required": [ "id", "pickup_stop", "delivery_stop" ], "title": "ConsignmentOutput" }, "ConsignmentTransportNetwork": { "properties": { "requesting_depot_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Requesting Depot Code", "description": "Depot code of the requesting depot" }, "collection_depot_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Collection Depot Code", "description": "Depot code of the collection depot" }, "delivery_depot_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery Depot Code", "description": "Depot code of the delivery depot" } }, "type": "object", "title": "ConsignmentTransportNetwork" }, "ConsignmentUpdateData": { "properties": { "consignment_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consignment Reference Number" }, "cmr_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cmr Reference Number" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "transport_network": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentTransportNetwork" }, { "type": "null" } ] }, "central_transport_network": { "anyOf": [ { "$ref": "#/components/schemas/CentralTransportNetworkConsignmentInput" }, { "type": "null" } ] }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineConsignmentInput" }, { "type": "null" } ] }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceConsignmentInput" }, { "type": "null" } ] }, "palletxpress_ie": { "anyOf": [ { "$ref": "#/components/schemas/PalletXpressIeConsignmentInput" }, { "type": "null" } ] }, "tpn": { "anyOf": [ { "$ref": "#/components/schemas/TPNConsignmentInput" }, { "type": "null" } ] }, "pallet_track": { "anyOf": [ { "$ref": "#/components/schemas/PalletTrackConsignmentInput" }, { "type": "null" } ] }, "palletways": { "anyOf": [ { "$ref": "#/components/schemas/PalletwaysConsignmentInput" }, { "type": "null" } ] }, "project44": { "anyOf": [ { "$ref": "#/components/schemas/Project44ConsignmentInput" }, { "type": "null" } ] }, "hazchem": { "anyOf": [ { "$ref": "#/components/schemas/HazchemConsignmentInput" }, { "type": "null" } ] }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonConsignmentExtraFields" }, { "type": "null" } ] }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentImportExportExtraFieldsInput-Input" }, { "type": "null" } ] }, "shipper_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Shipper Name" }, "shipper_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Shipper Reference Number" }, "buyer_eori_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Buyer Eori Number" }, "seller_eori_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Seller Eori Number" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "consignee_signature": { "anyOf": [ { "$ref": "#/components/schemas/SignatureInput" }, { "type": "null" } ] }, "consignor_signature": { "anyOf": [ { "$ref": "#/components/schemas/SignatureInput" }, { "type": "null" } ] } }, "type": "object", "title": "ConsignmentUpdateData" }, "ConsignmentUpdateOperation": { "type": "string", "enum": [ "CREATE", "UPDATE", "DELETE", "CANCEL", "UNCANCEL" ], "title": "ConsignmentUpdateOperation", "description": "Operation type for partial consignment structural updates.\n\nConsignments additionally support CANCEL / UNCANCEL, which move the consignment between\nCANCELLED and a plannable state while keeping the record. They are not valid on any other\nentity, so they live here instead of on UpdateOperation." }, "ContactType": { "type": "string", "enum": [ "BILLING", "OPERATIONS", "BOOKINGS", "NOTIFICATIONS", "CLEANING", "HEATING", "STORAGE", "CONTAINER_RELEASE", "DRIVER", "OTHER", "CMR_PROCESSING", "PAYMENT_REMINDERS", "CLAIMS_INSURANCE", "CUSTOMS", "IT", "QUALITY", "SALES", "CUSTOMER_CONTACT" ], "title": "ContactType" }, "Container": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the resource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Is the resource archived" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyOutput-Input" }, { "type": "null" } ], "description": "Subcontractor linked to the resource" }, "resource_type": { "anyOf": [ { "$ref": "#/components/schemas/ResourceTypeEnum" }, { "type": "null" } ], "description": "Type of the resource" }, "container_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Container Number", "description": "Container number" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the container" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the container" }, "standard_size": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Standard Size", "description": "Standard size of the container" }, "iso_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Iso Code", "description": "ISO 6346 container type code (e.g. '22G1', '45G1')" } }, "type": "object", "title": "Container" }, "ContainerDocumentTypes": { "type": "string", "enum": [ "COMMUNICATION_SUBCONTRACTOR", "CONTAINER_CERTIFICATE", "CONTAINER_DAMAGE_REPORT", "CONTAINER_INSPECTION_REPORT", "CONTAINER_LEASE", "CONTAINER_MAINTENANCE_REPORT", "CONTAINER_REPAIR_REPORT", "CONTAINER_TANK_TEST_CERTIFICATE_2Y5", "CONTAINER_TANK_TEST_CERTIFICATE_5Y", "CONTAINER_TANK_TEST_CERTIFICATE" ], "title": "ContainerDocumentTypes" }, "ContainerExtraFields": { "properties": { "seal_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Seal Number", "description": "Container seal number" }, "port_of_loading": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Port Of Loading", "description": "Port of loading" }, "port_of_unloading": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Port Of Unloading", "description": "Port of unloading" }, "origin_of_goods": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Origin Of Goods", "description": "Origin of goods" }, "unique_consignment_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unique Consignment Number", "description": "Unique consignment number" }, "ocean_liner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ocean Liner Name", "description": "Ocean liner name" }, "ocean_liner_scac": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ocean Liner Scac", "description": "Ocean liner SCAC" }, "pin_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pin Code", "description": "PIN code" }, "ship_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ship Name", "description": "Ship name" }, "closing_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Closing Date", "description": "Closing date" }, "tare_weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tare Weight", "description": "Tare weight" }, "container_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Container Number", "description": "Number of the container" }, "container_type": { "anyOf": [ { "$ref": "#/components/schemas/ContainerType" }, { "type": "null" } ], "description": "Type of the container" }, "container_scenario": { "anyOf": [ { "$ref": "#/components/schemas/ContainerScenario" }, { "type": "null" } ], "description": "Scenario of the container" }, "secure_release": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Secure Release", "description": "Is secure release enabled" } }, "type": "object", "title": "ContainerExtraFields" }, "ContainerMatchInput": { "properties": { "name": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "generic_id": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "integration_object_id": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ], "description": "The resource ID in the given context of your integration. " } }, "type": "object", "title": "ContainerMatchInput", "example": { "generic_id": { "matches_any": [ "CONT-001" ] } } }, "ContainerOrderInput": { "properties": { "seal_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Seal Number" }, "port_of_loading": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Port Of Loading" }, "port_of_unloading": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Port Of Unloading" }, "origin_of_goods": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Origin Of Goods" }, "unique_consignment_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unique Consignment Number" }, "ocean_liner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ocean Liner Name" }, "ocean_liner_scac": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ocean Liner Scac" }, "pin_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pin Code" }, "ship_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ship Name" }, "closing_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Closing Date" }, "tare_weight": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tare Weight" }, "container_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Container Number" }, "container_type": { "anyOf": [ { "$ref": "#/components/schemas/ContainerTypeInput" }, { "type": "null" } ] }, "container_scenario": { "anyOf": [ { "$ref": "#/components/schemas/ContainerScenario" }, { "type": "null" } ] }, "secure_release": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Secure Release" } }, "type": "object", "title": "ContainerOrderInput" }, "ContainerProperties": { "properties": { "container_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Container Number", "description": "Container number" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the container" }, "standard_size": { "anyOf": [ { "type": "string", "enum": [ "FEET_20", "FEET_23", "FEET_24", "FEET_25", "FEET_26", "FEET_30", "FEET_35", "FEET_40", "FEET_45" ] }, { "type": "null" } ], "title": "Standard Size", "description": "Standard size of the container" }, "iso_code": { "anyOf": [ { "type": "string", "maxLength": 4 }, { "type": "null" } ], "title": "Iso Code", "description": "ISO 6346 container type code (e.g. '22G1', '45G1')" } }, "type": "object", "title": "ContainerProperties" }, "ContainerResource-Input": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the resource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Is the resource archived" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyOutput-Input" }, { "type": "null" } ], "description": "Subcontractor linked to the resource" }, "resource_type": { "anyOf": [ { "$ref": "#/components/schemas/ResourceTypeEnum" }, { "type": "null" } ], "description": "Type of the resource" }, "container_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Container Number", "description": "Container number" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the container" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the container" }, "standard_size": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Standard Size", "description": "Standard size of the container" }, "iso_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Iso Code", "description": "ISO 6346 container type code (e.g. '22G1', '45G1')" } }, "type": "object", "title": "ContainerResource" }, "ContainerResource-Output": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the resource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Is the resource archived" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyOutput-Output" }, { "type": "null" } ], "description": "Subcontractor linked to the resource" }, "resource_type": { "anyOf": [ { "$ref": "#/components/schemas/ResourceTypeEnum" }, { "type": "null" } ], "description": "Type of the resource" }, "container_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Container Number", "description": "Container number" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the container" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the container" }, "standard_size": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Standard Size", "description": "Standard size of the container" }, "iso_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Iso Code", "description": "ISO 6346 container type code (e.g. '22G1', '45G1')" } }, "type": "object", "title": "ContainerResource" }, "ContainerResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "container": { "anyOf": [ { "$ref": "#/components/schemas/ContainerProperties" }, { "type": "null" } ], "description": "Container specific properties" } }, "type": "object", "required": [ "name" ], "title": "ContainerResourceInput" }, "ContainerResourceOutput": { "properties": { "row_id": { "type": "string", "format": "uuid", "title": "Row Id", "description": "Identifier of the reference" }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "External identifier of the resource" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the resource" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntity" }, { "type": "null" } ], "description": "Billing entity associated with the resource" }, "extras": { "items": { "$ref": "#/components/schemas/ResourceExtraOutput" }, "type": "array", "title": "Extras", "description": "Stop extras this resource is compatible with" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active", "description": "Is the resource active" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "timestamp_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp Updated", "description": "Timestamp of the last update of the resource" }, "resource_groups": { "items": { "$ref": "#/components/schemas/ResourceGroupOutput" }, "type": "array", "title": "Resource Groups", "description": "Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded." }, "container": { "anyOf": [ { "$ref": "#/components/schemas/ContainerProperties" }, { "type": "null" } ], "description": "Container specific properties" } }, "type": "object", "required": [ "row_id", "name" ], "title": "ContainerResourceOutput" }, "ContainerScenario": { "type": "string", "enum": [ "IMPORT", "EXPORT" ], "title": "ContainerScenario" }, "ContainerType": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable identifier" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Machine readable identifier" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "container_iso_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Container Iso Code", "description": "International standard ISO code identifying the container size and type (e.g. '22G1', '42G1')" } }, "type": "object", "title": "ContainerType" }, "ContainerTypeInput": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" } }, "type": "object", "title": "ContainerTypeInput" }, "CreditNoteStatus": { "type": "string", "enum": [ "DRAFT", "PRE_INVOICED", "INVOICED", "POSTED" ], "title": "CreditNoteStatus", "description": "Status description:\n- DRAFT: Credit note is in draft state and not yet credited.\n- PRE_INVOICED: Credit note is in pre-invoiced state and not yet credited (Purchase credit note only).\n- INVOICED: Credit note is credited but not yet posted.\n- POSTED: Credit note is credited and posted." }, "CreditPolicyInput": { "properties": { "limit": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Limit", "description": "The limit for total amount that has been invoiced but not paid.", "examples": [ 10000 ] } }, "type": "object", "title": "CreditPolicyInput" }, "CreditPolicyOutput": { "properties": { "limit": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Limit", "description": "The limit for total amount that has been invoiced but not paid.", "examples": [ 10000 ] } }, "type": "object", "title": "CreditPolicyOutput" }, "CurrencyCode": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "FOK", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KID", "KMF", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ], "title": "CurrencyCode" }, "Customer": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the customer" } }, "type": "object", "title": "Customer" }, "CustomerDocumentTypeInput": { "type": "string", "enum": [ "AUTHORIZATION_PREFERENTIAL_ORIGIN", "BANK_DETAILS", "CMR_INSURANCE", "COMMUNICATION", "COMPANY_TDS", "CREDIT_REPORT", "DGSA_CERTIFICATE", "ECMT_TRANSPORT_LICENSE", "EU_TRANSPORT_LICENSE", "FREIGHT_FORWARDER_LICENSE", "INSURANCE_3RD_PARTY_TRAILER", "MEETING_SUMMARY", "NATIONAL_TRANSPORT_LICENSE", "OTHER", "QUESTIONNAIRE_CUSTOMER", "QUESTIONNAIRE_SUBCONTRACTOR", "SERVICE_LEVEL_AGREEMENT", "SQAS_CERTIFICATE", "TRAILER_CLEANING_CERTIFICATE", "VAT_VIES_VALIDATION", "WASTE_PERMIT_GREEN_EU", "WASTE_PERMIT_ORANGE_EU", "WASTE_PERMIT_ORANGE_GREEN_EU" ], "title": "CustomerDocumentTypeInput" }, "CustomerField": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "row_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Row Id" } }, "type": "object", "title": "CustomerField" }, "CustomerReference": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "The unique Qargo ID of the customer. Use this to distinguish between different customers sharing the same accounting code." }, "accounting_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accounting Code", "description": "Accounting code that uniquely identifies the customer in the accounting system." } }, "type": "object", "title": "CustomerReference" }, "CustomerStatus": { "type": "string", "enum": [ "PROSPECT", "NOT_APPROVED", "APPROVED", "WARNING", "BLOCKED" ], "title": "CustomerStatus" }, "Customs": { "properties": { "pre_boarding_notification": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pre Boarding Notification", "description": "Pre-Boarding Notification (PBN) reference." }, "has_customs_territory_crossing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Customs Territory Crossing", "description": "Whether the intermodal leg crosses a customs territory boundary" } }, "type": "object", "title": "Customs" }, "CustomsMetadata": { "properties": { "customs_office_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customs Office Code" } }, "type": "object", "title": "CustomsMetadata" }, "DachserExtraFields": { "properties": { "consolidator_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consolidator Reference Number", "description": "Consolidator reference number" } }, "type": "object", "title": "DachserExtraFields" }, "DaySchedule": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "description": "Whether the location is open on this day.", "default": false }, "intervals": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TimeInterval" }, "type": "array" }, { "type": "null" } ], "title": "Intervals", "description": "Opening intervals for the day. Multiple intervals allow for split opening hours." } }, "type": "object", "title": "DaySchedule" }, "DayScheduleInput": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "description": "Whether the location is open on this day." }, "intervals": { "items": { "$ref": "#/components/schemas/TimeIntervalInput" }, "type": "array", "title": "Intervals", "description": "Opening intervals for the day. Multiple intervals allow for split opening hours." } }, "type": "object", "required": [ "enabled" ], "title": "DayScheduleInput" }, "Department": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the department" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the department" } }, "type": "object", "title": "Department" }, "DispatchExecution": { "properties": { "external_id": { "type": "string", "title": "External Id", "description": "ID in external system" } }, "type": "object", "required": [ "external_id" ], "title": "DispatchExecution" }, "DispatchOperation": { "type": "string", "enum": [ "CREATE", "UPDATE", "CANCEL" ], "title": "DispatchOperation" }, "DispatchOrder": { "properties": { "transport_service": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "title": "Transport service", "description": "Transport service within Qargo" }, "customer_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order reference number from customer" }, "service_level": { "anyOf": [ { "$ref": "#/components/schemas/ServiceLevel" }, { "type": "null" } ] }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "department": { "anyOf": [ { "$ref": "#/components/schemas/Department" }, { "type": "null" } ], "description": "Department linked to order" }, "neutral_order_type": { "anyOf": [ { "type": "string", "enum": [ "NO_NEUTRAL_ORDER", "MASK_DELIVERY", "MASK_PICKUP" ] }, { "type": "null" } ], "title": "Neutral Order Type", "description": "Neutral order" }, "container": { "anyOf": [ { "$ref": "#/components/schemas/ContainerExtraFields" }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "User defined additional fields for this order." }, "vehicle_category": { "anyOf": [ { "$ref": "#/components/schemas/VehicleCategory" }, { "type": "null" } ], "title": "Vehicle category" }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceExtraFields" }, { "type": "null" } ], "title": "Palletforce specific fields" }, "kuehne_nagel": { "anyOf": [ { "$ref": "#/components/schemas/KuehneNagelExtraFields" }, { "type": "null" } ], "title": "Kuehn Nagel specific fields" }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineExtraFields" }, { "type": "null" } ], "title": "Palletline specific fields" }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonOrderExtraFields" }, { "type": "null" } ], "title": "Transporeon specific fields" }, "dachser": { "anyOf": [ { "$ref": "#/components/schemas/DachserExtraFields" }, { "type": "null" } ], "title": "Dachser specific fields" }, "contact_emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Contact Emails", "description": "List of contact emails to notify about the order" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ImportExportExtraFields" }, { "type": "null" } ], "title": "Fields specific to import and export" }, "is_consignment_info_validated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Consignment Info Validated", "description": "Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it." }, "stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopOutput-Input" }, "type": "array" }, { "type": "null" } ], "title": "Stops", "description": "List of stops in the order, ordered by their sequence" }, "order_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Identifier", "description": "Identifier of the order when created from an external source" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for order" }, "consignments": { "items": { "$ref": "#/components/schemas/ConsignmentOutput-Input" }, "type": "array", "title": "Consignments" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/OrderPricingOutput" }, { "type": "null" } ], "description": "Pricing fields related to order" }, "customer": { "anyOf": [ { "$ref": "#/components/schemas/CompanyOutput-Input" }, { "type": "null" } ], "title": "Customer" }, "created_by_user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By User", "description": "User who created the order" }, "created_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created Timestamp", "description": "Timestamp of creation" }, "start_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Input" }, { "type": "null" } ], "description": "First stop on this order" }, "end_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Input" }, { "type": "null" } ], "description": "Last stop on this order" }, "quote_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quote Name", "description": "Name of the quote" }, "name": { "type": "string", "title": "Name", "description": "Name of the order" }, "container_load_unload_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Input" }, { "type": "null" } ], "title": "Container load/unload stop", "description": "This field practically maps to the container yard. `setup_stops` (for pick-up) and `teardown_stops` (for drop-off) are replacing this field, please use them instead.", "deprecated": true } }, "type": "object", "required": [ "id", "consignments", "name" ], "title": "DispatchOrder" }, "DispatchOrderOutput": { "properties": { "transport_service": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "title": "Transport service", "description": "Transport service within Qargo" }, "customer_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order reference number from customer" }, "service_level": { "anyOf": [ { "$ref": "#/components/schemas/ServiceLevel" }, { "type": "null" } ] }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "department": { "anyOf": [ { "$ref": "#/components/schemas/Department" }, { "type": "null" } ], "description": "Department linked to order" }, "neutral_order_type": { "anyOf": [ { "type": "string", "enum": [ "NO_NEUTRAL_ORDER", "MASK_DELIVERY", "MASK_PICKUP" ] }, { "type": "null" } ], "title": "Neutral Order Type", "description": "Neutral order" }, "container": { "anyOf": [ { "$ref": "#/components/schemas/ContainerExtraFields" }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "User defined additional fields for this order." }, "vehicle_category": { "anyOf": [ { "$ref": "#/components/schemas/VehicleCategory" }, { "type": "null" } ], "title": "Vehicle category" }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceExtraFields" }, { "type": "null" } ], "title": "Palletforce specific fields" }, "kuehne_nagel": { "anyOf": [ { "$ref": "#/components/schemas/KuehneNagelExtraFields" }, { "type": "null" } ], "title": "Kuehn Nagel specific fields" }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineExtraFields" }, { "type": "null" } ], "title": "Palletline specific fields" }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonOrderExtraFields" }, { "type": "null" } ], "title": "Transporeon specific fields" }, "dachser": { "anyOf": [ { "$ref": "#/components/schemas/DachserExtraFields" }, { "type": "null" } ], "title": "Dachser specific fields" }, "contact_emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Contact Emails", "description": "List of contact emails to notify about the order" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ImportExportExtraFields" }, { "type": "null" } ], "title": "Fields specific to import and export" }, "is_consignment_info_validated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Consignment Info Validated", "description": "Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it." }, "stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopOutput-Input" }, "type": "array" }, { "type": "null" } ], "title": "Stops", "description": "List of stops in the order, ordered by their sequence" }, "order_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Identifier", "description": "Identifier of the order when created from an external source" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for order" }, "consignments": { "items": { "$ref": "#/components/schemas/OrderConsignmentOutput-Input" }, "type": "array", "title": "Consignments" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/OrderPricingOutput" }, { "type": "null" } ], "description": "Pricing fields related to order" }, "customer": { "$ref": "#/components/schemas/CompanyOutput-Input", "title": "Customer" }, "created_by_user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By User", "description": "User who created the order" }, "created_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created Timestamp", "description": "Timestamp of creation" }, "start_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Input" }, { "type": "null" } ], "description": "First stop on this order" }, "end_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Input" }, { "type": "null" } ], "description": "Last stop on this order" }, "quote_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quote Name", "description": "Name of the quote" }, "container_load_unload_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Input" }, { "type": "null" } ], "title": "Container load/unload stop", "description": "This field practically maps to the container yard. `setup_stops` (for pick-up) and `teardown_stops` (for drop-off) are replacing this field, please use them instead.", "deprecated": true } }, "type": "object", "required": [ "id", "consignments", "customer" ], "title": "DispatchOrderOutput" }, "DispatchResourceAllocation": { "properties": { "resource": { "anyOf": [ { "$ref": "#/components/schemas/GenericResource-Input" }, { "$ref": "#/components/schemas/DriverResource-Input" }, { "$ref": "#/components/schemas/ContainerResource-Input" }, { "$ref": "#/components/schemas/VehicleResource-Input" } ], "title": "Resource", "description": "Resource assigned to the trip" }, "execution": { "anyOf": [ { "$ref": "#/components/schemas/DispatchExecution" }, { "type": "null" } ], "description": "Contains dispatch related information" } }, "type": "object", "required": [ "resource" ], "title": "DispatchResourceAllocation" }, "Document": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the document" }, "name": { "type": "string", "title": "Name", "description": "Name of the document" }, "type": { "type": "string", "title": "Type", "description": "Type of the document" }, "download_url": { "type": "string", "title": "Download Url", "description": "Relative URL from the base URL to download the document", "default": "" }, "subject_type": { "type": "string", "title": "Subject Type", "description": "Linked subject of the document" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Type", "description": "Content type of the document" } }, "type": "object", "required": [ "id", "name", "type", "subject_type" ], "title": "Document" }, "DocumentImportResponse": { "properties": { "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorStatus" }, "type": "array" }, { "type": "null" } ], "title": "Errors", "description": "List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.", "examples": [ { "error_message": "The payload is invalid.", "error_type": "USER_INPUT_ERROR" }, { "error_message": "Not supported.", "error_type": "NOT_SUPPORTED" }, { "error_message": "Unknown error.", "error_type": "INTERNAL_ERROR" } ] } }, "type": "object", "title": "DocumentImportResponse", "description": "Response schema for the document import webhook.\nThis schema is used to return errors or success messages." }, "DocumentUpdate": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "type": { "type": "string", "const": "Document", "title": "Type" }, "status": { "$ref": "#/components/schemas/VisibilityDocumentStatus" }, "document": { "$ref": "#/components/schemas/VisibilityDocument" } }, "type": "object", "required": [ "type", "status", "document" ], "title": "DocumentUpdate", "description": "Send update event when a document is uploaded to Qargo." }, "DocumentUploadResponse": { "properties": { "upload_id": { "type": "string", "format": "uuid", "title": "Upload Id", "description": "Unique identifier for the uploaded document" } }, "type": "object", "required": [ "upload_id" ], "title": "DocumentUploadResponse" }, "DriverDocumentTypes": { "type": "string", "enum": [ "A1_DOCUMENT", "CARGO_INSURANCE", "BBS_CERTIFICATE", "COMMUNICATION_SUBCONTRACTOR", "DOMESTIC_CARGO_INSURANCE", "DRIVER_ADR_LICENSE", "DRIVER_AEO_REGULATED_AGENT_LICENSE", "DRIVER_ALFAPASS", "DRIVER_CARD", "DRIVER_CARGOCARD_ACCESS_CARD", "DRIVER_CIVIL_LIABILITY_EXPLOITATION", "DRIVER_CIVIL_LIABILITY_INSURANCE", "DRIVER_CODE_95", "DRIVER_CPC_CARD", "DRIVER_DRIVING_LICENSE", "DRIVER_IDENTITY_CARD", "DRIVER_IMI_PORTAL", "DRIVER_INSURANCE", "DRIVER_LONG_HEAVY_VEHICLE_CERT", "DRIVER_MEDICAL_EXAM", "DRIVER_PERSONAL_PROTECTIVE_EQUIPMENT", "DRIVER_POSTING_DOCUMENT", "DRIVER_REFUGEE_TRAINING_LICENSE", "DRIVER_SICK_NOTE", "DRIVER_TRAINING", "EUROVIGNET", "EXCEPTIONAL_TRANSPORT_LICENSE", "FINE", "FORKLIFT_LICENSE", "FUEL_CARD", "OTHER", "PAYSCALE_DRIVER", "SAFETY_CERTIFICATE_TERMINAL", "SITE_MOVEMENT_SHEET", "TOLL_CARD", "VCA_BASIC_SAFETY", "VEHICLE_ADR_CERTIFICATE" ], "title": "DriverDocumentTypes" }, "DriverMatchInput": { "properties": { "name": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "generic_id": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "integration_object_id": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ], "description": "The resource ID in the given context of your integration. " } }, "type": "object", "title": "DriverMatchInput", "example": { "name": { "matches_any": [ "John Doe" ] } } }, "DriverMode": { "type": "string", "enum": [ "ACCOMPANIED", "UNACCOMPANIED" ], "title": "DriverMode" }, "DriverProperties": { "properties": { "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name", "description": "First name of the driver" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name", "description": "Last name of the driver" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Address", "description": "Email of the driver" }, "date_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Of Birth", "description": "Date of birth of the driver", "examples": [ "2025-04-10" ] }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "Phone number of the driver", "examples": [ "+32412345678" ] }, "start_stop_location": { "anyOf": [ { "$ref": "#/components/schemas/LocationReference" }, { "type": "null" } ], "description": "Location used as the driver's start and stop location for planning. Must reference a valid location in the tenant's location master data. Set to null to remove the start/stop location." } }, "type": "object", "title": "DriverProperties" }, "DriverResource-Input": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the resource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Is the resource archived" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyOutput-Input" }, { "type": "null" } ], "description": "Subcontractor linked to the resource" }, "resource_type": { "anyOf": [ { "$ref": "#/components/schemas/ResourceTypeEnum" }, { "type": "null" } ], "description": "Type of the resource" }, "date_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Of Birth", "description": "Date of birth of the driver" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "Email of the driver" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name", "description": "First name of the driver" }, "home_address": { "anyOf": [ { "$ref": "#/components/schemas/LocationOutput" }, { "type": "null" } ], "description": "Home address of the driver" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name", "description": "Last name of the driver" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the driver" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "Phone number of the driver" }, "start_stop_location": { "anyOf": [ { "$ref": "#/components/schemas/LocationReference" }, { "type": "null" } ], "description": "Location used as the driver's start and stop location for planning. Must reference a valid location. Set to null to unset the driver's start and stop location." } }, "type": "object", "title": "DriverResource" }, "DriverResource-Output": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the resource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Is the resource archived" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyOutput-Output" }, { "type": "null" } ], "description": "Subcontractor linked to the resource" }, "resource_type": { "anyOf": [ { "$ref": "#/components/schemas/ResourceTypeEnum" }, { "type": "null" } ], "description": "Type of the resource" }, "date_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Of Birth", "description": "Date of birth of the driver" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "Email of the driver" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name", "description": "First name of the driver" }, "home_address": { "anyOf": [ { "$ref": "#/components/schemas/LocationOutput" }, { "type": "null" } ], "description": "Home address of the driver" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name", "description": "Last name of the driver" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the driver" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "Phone number of the driver" }, "start_stop_location": { "anyOf": [ { "$ref": "#/components/schemas/LocationReference" }, { "type": "null" } ], "description": "Location used as the driver's start and stop location for planning. Must reference a valid location. Set to null to unset the driver's start and stop location." } }, "type": "object", "title": "DriverResource" }, "DriverResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "driver": { "anyOf": [ { "$ref": "#/components/schemas/DriverProperties" }, { "type": "null" } ], "description": "Driver specific properties" } }, "type": "object", "required": [ "name" ], "title": "DriverResourceInput" }, "DriverResourceOutput": { "properties": { "row_id": { "type": "string", "format": "uuid", "title": "Row Id", "description": "Identifier of the reference" }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "External identifier of the resource" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the resource" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntity" }, { "type": "null" } ], "description": "Billing entity associated with the resource" }, "extras": { "items": { "$ref": "#/components/schemas/ResourceExtraOutput" }, "type": "array", "title": "Extras", "description": "Stop extras this resource is compatible with" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active", "description": "Is the resource active" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "timestamp_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp Updated", "description": "Timestamp of the last update of the resource" }, "resource_groups": { "items": { "$ref": "#/components/schemas/ResourceGroupOutput" }, "type": "array", "title": "Resource Groups", "description": "Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded." }, "driver": { "anyOf": [ { "$ref": "#/components/schemas/DriverProperties" }, { "type": "null" } ], "description": "Driver specific properties" } }, "type": "object", "required": [ "row_id", "name" ], "title": "DriverResourceOutput" }, "DropCollectEmptyInput": { "properties": { "location": { "anyOf": [ { "$ref": "#/components/schemas/Location" }, { "type": "null" } ], "description": "Location of an additional drop/collect. This location will be added after the stop this is associated with." }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "Date the main drop/collect", "examples": [ "2024-12-31" ] } }, "type": "object", "title": "DropCollectEmptyInput" }, "EInvoiceAttachment": { "properties": { "document": { "$ref": "#/components/schemas/EInvoiceDocumentAttachment" } }, "type": "object", "required": [ "document" ], "title": "EInvoiceAttachment" }, "EInvoiceCompanyInput": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "The unique identifier of the company." }, "name": { "type": "string", "title": "Name", "description": "Name of the company.", "examples": [ "John Doe" ] }, "vat_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vat Number", "description": "VAT number of the company.", "examples": [ "BE1234.123.123" ] }, "billing_location": { "anyOf": [ { "$ref": "#/components/schemas/Location" }, { "type": "null" } ], "description": "Billing address of the company." } }, "type": "object", "required": [ "name" ], "title": "EInvoiceCompanyInput" }, "EInvoiceDocumentAttachment": { "properties": { "base64": { "type": "string", "title": "Base64", "description": "Base64 encoded content of the document attachment." }, "content_type": { "type": "string", "title": "Content Type", "description": "MIME type of the document attachment, e.g., 'application/pdf', 'application/xml'." }, "document_type": { "$ref": "#/components/schemas/EInvoiceDocumentType", "description": "Type of the document attachment." }, "filename": { "type": "string", "title": "Filename", "description": "Filename of the document attachment." } }, "type": "object", "required": [ "base64", "content_type", "document_type", "filename" ], "title": "EInvoiceDocumentAttachment" }, "EInvoiceDocumentType": { "type": "string", "enum": [ "INVOICE", "CREDIT_NOTE", "OTHER" ], "title": "EInvoiceDocumentType" }, "EInvoiceLineItem": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Freeform description field.", "default": "", "examples": [ "Charge description" ] }, "amount": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Amount", "description": "Amount of the charge line.", "examples": [ "100" ] }, "account": { "anyOf": [ { "$ref": "#/components/schemas/api__order__models__charge__AccountInput" }, { "type": "null" } ], "description": "Accounting account associated with this line item." }, "tax_rate": { "anyOf": [ { "$ref": "#/components/schemas/api__accounting__models__invoice__TaxRate" }, { "type": "null" } ], "description": "Tax rate applied to this line item." }, "currency": { "type": "string", "title": "Currency", "description": "Currency of the line item.", "examples": [ "USD" ] }, "references": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "References", "description": "References associated with this line item.", "examples": [ { "order_name": "OR-1234" } ] } }, "type": "object", "required": [ "amount", "currency" ], "title": "EInvoiceLineItem" }, "EInvoicingOutput": { "properties": { "number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Number", "description": "E-invoicing registration number." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "E-invoicing verification URL." }, "regulator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regulator", "description": "E-invoicing regulator." } }, "type": "object", "title": "EInvoicingOutput" }, "EWC": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Six-digit European Waste Catalogue code, without spaces or the hazardous asterisk.", "examples": [ "060502" ] }, "is_hazardous": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Hazardous", "description": "Whether the code carries an asterisk in the official list. Derived from the code; read-only." }, "entry_type": { "anyOf": [ { "$ref": "#/components/schemas/EWCEntryType" }, { "type": "null" } ], "description": "Classification following Commission notice 2018/C 124/01. Mirror entries are ones where the asterisk alone does not decide hazardousness. Derived from the code; read-only." }, "description_by_locale": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Description By Locale", "description": "EWC description by locale, generated from EWC master data. This field is read-only; values submitted during order import are ignored. Keys, when present, are one of: `en`, `en-GB`, `en-US`, `nl-BE`, `fi-FI`, `fr-FR`, `de-DE`, `it-IT`, `es-ES`, `hu-HU`, `pt-PT`, `tr-TR`, `pl-PL`, `ro-RO`, `ru-RU`, `bg-BG`, `lt-LT`, `mk-MK`, or `cs-CZ`. Values are the corresponding localized descriptions.", "examples": [ { "en": "wastes containing other heavy metals" } ] } }, "type": "object", "title": "EWC" }, "EWCEntryType": { "type": "string", "enum": [ "ABSOLUTE_HAZARDOUS", "ABSOLUTE_NON_HAZARDOUS", "MIRROR_HAZARDOUS", "MIRROR_NON_HAZARDOUS" ], "title": "EWCEntryType" }, "EWCInput": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Six-digit European Waste Catalogue code, without spaces or the hazardous asterisk. Matched against the EWC catalogue" } }, "type": "object", "title": "EWCInput" }, "EmbeddedDocument": { "properties": { "content": { "type": "string", "title": "Content", "description": "A base64 encoded representation of the document" }, "mime_type": { "type": "string", "title": "Mime Type", "description": "A valid mime-type as per IANA specifications (https://www.iana.org/assignments/media-types/media-types.xhtml)", "examples": [ "application/json", "application/pdf" ] }, "filename": { "type": "string", "title": "Filename" } }, "type": "object", "required": [ "content", "mime_type", "filename" ], "title": "EmbeddedDocument" }, "Entity": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable identifier" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Machine readable identifier" } }, "type": "object", "title": "Entity" }, "ErrorStatus": { "properties": { "error_type": { "$ref": "#/components/schemas/ErrorType" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message", "description": "(User visible) error message" } }, "type": "object", "required": [ "error_type" ], "title": "ErrorStatus" }, "ErrorType": { "type": "string", "enum": [ "USER_INPUT_ERROR", "INTERNAL_ERROR", "NOT_SUPPORTED" ], "title": "ErrorType" }, "EtaUpdate": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "type": { "type": "string", "const": "Eta", "title": "Type" }, "stops": { "items": { "$ref": "#/components/schemas/VisibilityStop" }, "type": "array", "minItems": 1, "title": "Stops", "description": "List of stops with updated ETAs" } }, "type": "object", "required": [ "type", "stops" ], "title": "EtaUpdate", "description": "Send update event on stop ETA change." }, "ExchangeRate": { "properties": { "rate_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Rate Date", "examples": [ "2022-01-01" ] }, "rate": { "type": "number", "title": "Rate", "examples": [ 1 ] }, "inverse_rate": { "type": "number", "title": "Inverse Rate", "examples": [ 1 ] } }, "type": "object", "required": [ "rate", "inverse_rate" ], "title": "ExchangeRate" }, "ExchangeRateInput": { "properties": { "exchange_rate": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "string" } ], "title": "Exchange Rate", "description": "The exchange rate value. Must be a positive number." }, "exchange_rate_date": { "type": "string", "format": "date", "title": "Exchange Rate Date", "description": "The date for this exchange rate." }, "from_currency": { "$ref": "#/components/schemas/CurrencyCode", "description": "Source currency code (ISO 4217)." }, "to_currency": { "$ref": "#/components/schemas/CurrencyCode", "description": "Target currency code (ISO 4217)." }, "inverse_exchange_rate": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "string" } ], "title": "Inverse Exchange Rate", "description": "The inverse exchange rate value. Must be a positive number." } }, "type": "object", "required": [ "exchange_rate", "exchange_rate_date", "from_currency", "to_currency", "inverse_exchange_rate" ], "title": "ExchangeRateInput" }, "ExchangeRateOutput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier for the exchange rate." }, "exchange_rate": { "type": "number", "title": "Exchange Rate", "description": "The exchange rate value." }, "exchange_rate_date": { "type": "string", "format": "date", "title": "Exchange Rate Date", "description": "The date for this exchange rate." }, "from_currency": { "$ref": "#/components/schemas/CurrencyCode", "description": "Source currency code (ISO 4217)." }, "to_currency": { "$ref": "#/components/schemas/CurrencyCode", "description": "Target currency code (ISO 4217)." }, "inverse_exchange_rate": { "type": "number", "title": "Inverse Exchange Rate", "description": "The inverse exchange rate value." } }, "type": "object", "required": [ "id", "exchange_rate", "exchange_rate_date", "from_currency", "to_currency", "inverse_exchange_rate" ], "title": "ExchangeRateOutput" }, "ExecutionStatusUpdate": { "properties": { "execution_statuses": { "items": { "$ref": "#/components/schemas/BookingExecutionStatus" }, "type": "array", "title": "Execution Statuses", "description": "List of execution statuses to update" } }, "type": "object", "title": "ExecutionStatusUpdate" }, "ExportDeclarationTypeEnum": { "type": "string", "enum": [ "EU", "EX" ], "title": "ExportDeclarationTypeEnum" }, "ExternalExecutionMetadata": { "properties": { "completed": { "type": "boolean", "title": "Completed", "default": false } }, "type": "object", "title": "ExternalExecutionMetadata" }, "ExtraField": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable identifier" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Machine readable identifier" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" } }, "type": "object", "title": "ExtraField" }, "FieldMatchInput": { "properties": { "matches_any": { "items": { "type": "string" }, "type": "array", "title": "Matches Any" } }, "type": "object", "title": "FieldMatchInput" }, "FixedTimestampType": { "type": "string", "enum": [ "ENFORCED_TIMEWINDOW", "SET_BY_USER", "CALCULATED" ], "title": "FixedTimestampType" }, "FleetDispatch": { "properties": { "operation": { "$ref": "#/components/schemas/DispatchOperation" }, "payload": { "$ref": "#/components/schemas/FleetDispatchOutput" } }, "type": "object", "required": [ "operation", "payload" ], "title": "FleetDispatch" }, "FleetDispatchOutput": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the dispatched trip" }, "name": { "type": "string", "title": "Name" }, "orders": { "items": { "$ref": "#/components/schemas/DispatchOrder" }, "type": "array", "title": "Orders" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "Custom fields of the dispatched trip" }, "resource_allocations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DispatchResourceAllocation" }, "type": "array" }, { "type": "null" } ], "title": "Resource Allocations" }, "stop_groups": { "items": { "$ref": "#/components/schemas/StopGroup" }, "type": "array", "title": "Stop Groups", "description": "List of stop groups" }, "templates": { "items": { "$ref": "#/components/schemas/FleetDispatchTemplate" }, "type": "array", "title": "Templates", "description": "List of templates to be rendered on the fleet device" } }, "type": "object", "required": [ "name", "orders", "resource_allocations", "stop_groups", "templates" ], "title": "FleetDispatchOutput" }, "FleetDispatchResponse": { "properties": { "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorStatus" }, "type": "array" }, { "type": "null" } ], "title": "Errors", "description": "List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.", "examples": [ { "error_message": "The payload is invalid.", "error_type": "USER_INPUT_ERROR" }, { "error_message": "Not supported.", "error_type": "NOT_SUPPORTED" }, { "error_message": "Unknown error.", "error_type": "INTERNAL_ERROR" } ] } }, "type": "object", "title": "FleetDispatchResponse", "description": "Response schema for the subcontractor dispatch payload.\nThis schema is used to return errors or success messages." }, "FleetDispatchStatusUpdate": { "properties": { "stop": { "$ref": "#/components/schemas/StopStatusUpdate", "description": "Update a stop. Can update status and data of a stop.\n Updates on the data are based on a mapping defined in Qargo" }, "event_time": { "type": "string", "format": "date-time", "title": "Event Time", "description": "Time of the event in UTC. Include a timezone offset, for example `Z` or `+02:00`." }, "stop_group": { "anyOf": [ { "$ref": "#/components/schemas/StopGroupStatusUpdate" }, { "type": "null" } ], "description": "Stops can be grouped together according to their activity and location.\n This is called a stop group. \nUpdate a stop group. Can update status and data of the stops in a stop group.\n Updates on the data are based on a mapping defined in Qargo. The updates apply to each stop in the group." } }, "type": "object", "required": [ "stop", "event_time", "stop_group" ], "title": "FleetDispatchStatusUpdate" }, "FleetDispatchTemplate": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Title to be displayed on fleet app" }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtitle", "description": "Subtitle to be displayed on fleet app" } }, "type": "object", "title": "FleetDispatchTemplate" }, "FleetStatusUpdatePayload": { "properties": { "updates": { "items": { "$ref": "#/components/schemas/FleetDispatchStatusUpdate" }, "type": "array", "title": "Updates", "description": "List of status updates for stops and stop groups" } }, "type": "object", "required": [ "updates" ], "title": "FleetStatusUpdatePayload" }, "FullTrailerResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "full_trailer": { "anyOf": [ { "$ref": "#/components/schemas/TrailerProperties-Input" }, { "type": "null" } ], "description": "Trailer specific properties" } }, "type": "object", "required": [ "name" ], "title": "FullTrailerResourceInput" }, "FullTrailerResourceOutput": { "properties": { "row_id": { "type": "string", "format": "uuid", "title": "Row Id", "description": "Identifier of the reference" }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "External identifier of the resource" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the resource" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntity" }, { "type": "null" } ], "description": "Billing entity associated with the resource" }, "extras": { "items": { "$ref": "#/components/schemas/ResourceExtraOutput" }, "type": "array", "title": "Extras", "description": "Stop extras this resource is compatible with" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active", "description": "Is the resource active" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "timestamp_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp Updated", "description": "Timestamp of the last update of the resource" }, "resource_groups": { "items": { "$ref": "#/components/schemas/ResourceGroupOutput" }, "type": "array", "title": "Resource Groups", "description": "Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded." }, "full_trailer": { "anyOf": [ { "$ref": "#/components/schemas/TrailerProperties-Output" }, { "type": "null" } ], "description": "Trailer specific properties" } }, "type": "object", "required": [ "row_id", "name" ], "title": "FullTrailerResourceOutput" }, "Gateway": { "properties": { "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "Gateway" }, "GenericResource-Input": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the resource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Is the resource archived" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyOutput-Input" }, { "type": "null" } ], "description": "Subcontractor linked to the resource" }, "resource_type": { "anyOf": [ { "$ref": "#/components/schemas/ResourceTypeEnum" }, { "type": "null" } ], "description": "Type of the resource" } }, "type": "object", "title": "GenericResource" }, "GenericResource-Output": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the resource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Is the resource archived" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyOutput-Output" }, { "type": "null" } ], "description": "Subcontractor linked to the resource" }, "resource_type": { "anyOf": [ { "$ref": "#/components/schemas/ResourceTypeEnum" }, { "type": "null" } ], "description": "Type of the resource" } }, "type": "object", "title": "GenericResource" }, "GoodData": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity" }, "total_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Loading Meters" }, "total_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Pallet Spaces" }, "total_volume_m3": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Volume M3" }, "total_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Weight Kg" }, "unit_height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Height M" }, "unit_length_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Length M" }, "unit_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Loading Meters" }, "unit_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Pallet Spaces" }, "unit_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Weight Kg" }, "unit_width_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Width M" }, "absolute_min_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Min Temperature Degrees" }, "absolute_max_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Max Temperature Degrees" }, "ordered_transport_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ordered Transport Temperature Degrees" }, "specific_gravity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Specific Gravity" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "adr_type": { "anyOf": [ { "type": "string", "enum": [ "ADR", "LIMITED_QUANTITY" ] }, { "type": "null" } ], "title": "Adr Type" }, "waste_category": { "anyOf": [ { "type": "string", "enum": [ "WASTE", "DANGEROUS_WASTE" ] }, { "type": "null" } ], "title": "Waste Category" }, "product": { "anyOf": [ { "$ref": "#/components/schemas/GoodProductInput" }, { "type": "null" } ] }, "extras": { "anyOf": [ { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Extras" }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/GoodPackagingType" }, { "type": "null" } ] }, "handling_units": { "anyOf": [ { "items": { "$ref": "#/components/schemas/HandlingUnitData" }, "type": "array" }, { "type": "null" } ], "title": "Handling Units" }, "packaged_items": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PackagedItemInput" }, "type": "array" }, { "type": "null" } ], "title": "Packaged Items" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "hs_codes": { "anyOf": [ { "$ref": "#/components/schemas/GoodHSCodesInput" }, { "type": "null" } ] } }, "type": "object", "title": "GoodData" }, "GoodEntityUpdate": { "properties": { "operation": { "$ref": "#/components/schemas/UpdateOperation" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/GoodUpdateData" }, { "$ref": "#/components/schemas/GoodData" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "operation" ], "title": "GoodEntityUpdate" }, "GoodHSCodesExtraFields": { "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Count", "description": "Number of HS codes for the good, used for customs rate calculation" } }, "type": "object", "title": "GoodHSCodesExtraFields" }, "GoodHSCodesInput": { "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Count" } }, "type": "object", "title": "GoodHSCodesInput" }, "GoodInput-Input": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity" }, "total_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Loading Meters" }, "total_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Pallet Spaces" }, "total_volume_m3": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Volume M3" }, "total_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Weight Kg" }, "unit_height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Height M" }, "unit_length_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Length M" }, "unit_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Loading Meters" }, "unit_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Pallet Spaces" }, "unit_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Weight Kg" }, "unit_width_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Width M" }, "stackable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stackable" }, "packaged_items": { "items": { "$ref": "#/components/schemas/PackagedItem-Input" }, "type": "array", "title": "List of packaged items" }, "adr_type": { "anyOf": [ { "$ref": "#/components/schemas/ADRType" }, { "type": "null" } ] }, "waste_category": { "anyOf": [ { "$ref": "#/components/schemas/WasteCategory" }, { "type": "null" } ] }, "absolute_min_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Min Temperature Degrees" }, "absolute_max_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Max Temperature Degrees" }, "ordered_transport_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ordered Transport Temperature Degrees" }, "specific_gravity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Specific Gravity" }, "product": { "anyOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ], "description": "Product information" }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/PackagingType" }, { "type": "null" } ], "description": "Packaging type, for example Pallet" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExtraField" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Additional extra services/options for good" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "hs_codes": { "anyOf": [ { "$ref": "#/components/schemas/GoodHSCodesExtraFields" }, { "type": "null" } ] }, "handling_units": { "anyOf": [ { "items": { "$ref": "#/components/schemas/HandlingUnitInput-Input" }, "type": "array" }, { "type": "null" } ], "title": "Handling Units", "description": "List of handling units. A handling unit is used to transport, store or handle goods", "default": [] } }, "type": "object", "title": "GoodInput" }, "GoodInput-Output": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity" }, "total_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Loading Meters" }, "total_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Pallet Spaces" }, "total_volume_m3": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Volume M3" }, "total_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Weight Kg" }, "unit_height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Height M" }, "unit_length_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Length M" }, "unit_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Loading Meters" }, "unit_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Pallet Spaces" }, "unit_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Weight Kg" }, "unit_width_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Width M" }, "stackable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stackable" }, "packaged_items": { "items": { "$ref": "#/components/schemas/PackagedItem-Output" }, "type": "array", "title": "List of packaged items" }, "adr_type": { "anyOf": [ { "$ref": "#/components/schemas/ADRType" }, { "type": "null" } ] }, "waste_category": { "anyOf": [ { "$ref": "#/components/schemas/WasteCategory" }, { "type": "null" } ] }, "absolute_min_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Min Temperature Degrees" }, "absolute_max_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Max Temperature Degrees" }, "ordered_transport_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ordered Transport Temperature Degrees" }, "specific_gravity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Specific Gravity" }, "product": { "anyOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ], "description": "Product information" }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/PackagingType" }, { "type": "null" } ], "description": "Packaging type, for example Pallet" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExtraField" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Additional extra services/options for good" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "hs_codes": { "anyOf": [ { "$ref": "#/components/schemas/GoodHSCodesExtraFields" }, { "type": "null" } ] }, "handling_units": { "anyOf": [ { "items": { "$ref": "#/components/schemas/HandlingUnitInput-Output" }, "type": "array" }, { "type": "null" } ], "title": "Handling Units", "description": "List of handling units. A handling unit is used to transport, store or handle goods", "default": [] } }, "type": "object", "title": "GoodInput" }, "GoodMatch": { "properties": { "id": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] } }, "type": "object", "title": "GoodMatch" }, "GoodOutput-Input": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity" }, "total_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Loading Meters" }, "total_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Pallet Spaces" }, "total_volume_m3": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Volume M3" }, "total_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Weight Kg" }, "unit_height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Height M" }, "unit_length_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Length M" }, "unit_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Loading Meters" }, "unit_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Pallet Spaces" }, "unit_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Weight Kg" }, "unit_width_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Width M" }, "stackable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stackable" }, "packaged_items": { "items": { "$ref": "#/components/schemas/PackagedItemOutput-Input" }, "type": "array", "title": "List of packaged items" }, "adr_type": { "anyOf": [ { "$ref": "#/components/schemas/ADRType" }, { "type": "null" } ] }, "waste_category": { "anyOf": [ { "$ref": "#/components/schemas/WasteCategory" }, { "type": "null" } ] }, "absolute_min_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Min Temperature Degrees" }, "absolute_max_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Max Temperature Degrees" }, "ordered_transport_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ordered Transport Temperature Degrees" }, "specific_gravity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Specific Gravity" }, "product": { "anyOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ], "description": "Product information" }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/PackagingType" }, { "type": "null" } ], "description": "Packaging type, for example Pallet" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExtraField" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Additional extra services/options for good" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "hs_codes": { "anyOf": [ { "$ref": "#/components/schemas/GoodHSCodesExtraFields" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for this good" }, "incidents": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Incident" }, "type": "array" }, { "type": "null" } ], "title": "Incidents", "description": "List of incidents" }, "handling_units": { "anyOf": [ { "items": { "$ref": "#/components/schemas/HandlingUnitOutput-Input" }, "type": "array" }, { "type": "null" } ], "title": "Handling Units", "description": "List of handling units. A handling unit is used to transport, store or handle goods" }, "actual_delivery_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Actual Delivery Temperature Degrees" }, "actual_pickup_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Actual Pickup Temperature Degrees" } }, "type": "object", "required": [ "id" ], "title": "GoodOutput" }, "GoodOutput-Output": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity" }, "total_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Loading Meters" }, "total_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Pallet Spaces" }, "total_volume_m3": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Volume M3" }, "total_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Weight Kg" }, "unit_height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Height M" }, "unit_length_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Length M" }, "unit_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Loading Meters" }, "unit_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Pallet Spaces" }, "unit_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Weight Kg" }, "unit_width_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Width M" }, "stackable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stackable" }, "packaged_items": { "items": { "$ref": "#/components/schemas/PackagedItemOutput-Output" }, "type": "array", "title": "List of packaged items" }, "adr_type": { "anyOf": [ { "$ref": "#/components/schemas/ADRType" }, { "type": "null" } ] }, "waste_category": { "anyOf": [ { "$ref": "#/components/schemas/WasteCategory" }, { "type": "null" } ] }, "absolute_min_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Min Temperature Degrees" }, "absolute_max_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Max Temperature Degrees" }, "ordered_transport_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ordered Transport Temperature Degrees" }, "specific_gravity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Specific Gravity" }, "product": { "anyOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ], "description": "Product information" }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/PackagingType" }, { "type": "null" } ], "description": "Packaging type, for example Pallet" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExtraField" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Additional extra services/options for good" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "hs_codes": { "anyOf": [ { "$ref": "#/components/schemas/GoodHSCodesExtraFields" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for this good" }, "incidents": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Incident" }, "type": "array" }, { "type": "null" } ], "title": "Incidents", "description": "List of incidents" }, "handling_units": { "anyOf": [ { "items": { "$ref": "#/components/schemas/HandlingUnitOutput-Output" }, "type": "array" }, { "type": "null" } ], "title": "Handling Units", "description": "List of handling units. A handling unit is used to transport, store or handle goods" }, "actual_delivery_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Actual Delivery Temperature Degrees" }, "actual_pickup_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Actual Pickup Temperature Degrees" } }, "type": "object", "required": [ "id" ], "title": "GoodOutput" }, "GoodPackagingSize": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "type": "object", "title": "GoodPackagingSize" }, "GoodPackagingType": { "properties": { "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "packaging_size": { "anyOf": [ { "$ref": "#/components/schemas/GoodPackagingSize" }, { "type": "null" } ] } }, "type": "object", "title": "GoodPackagingType" }, "GoodProductInput": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "product_type": { "anyOf": [ { "$ref": "#/components/schemas/GoodProductType" }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" } }, "type": "object", "title": "GoodProductInput" }, "GoodProductType": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" } }, "type": "object", "title": "GoodProductType" }, "GoodUpdateData": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity" }, "total_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Loading Meters" }, "total_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Pallet Spaces" }, "total_volume_m3": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Volume M3" }, "total_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Weight Kg" }, "unit_height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Height M" }, "unit_length_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Length M" }, "unit_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Loading Meters" }, "unit_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Pallet Spaces" }, "unit_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Weight Kg" }, "unit_width_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Width M" }, "absolute_min_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Min Temperature Degrees" }, "absolute_max_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Max Temperature Degrees" }, "ordered_transport_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ordered Transport Temperature Degrees" }, "specific_gravity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Specific Gravity" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "adr_type": { "anyOf": [ { "type": "string", "enum": [ "ADR", "LIMITED_QUANTITY" ] }, { "type": "null" } ], "title": "Adr Type" }, "waste_category": { "anyOf": [ { "type": "string", "enum": [ "WASTE", "DANGEROUS_WASTE" ] }, { "type": "null" } ], "title": "Waste Category" }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/GoodPackagingType" }, { "type": "null" } ] }, "commodity_type": { "anyOf": [ { "$ref": "#/components/schemas/GoodProductInput" }, { "type": "null" } ] }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "hs_codes": { "anyOf": [ { "$ref": "#/components/schemas/GoodHSCodesInput" }, { "type": "null" } ] } }, "type": "object", "title": "GoodUpdateData" }, "HSCode": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Harmonized System Code for the good" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the HS code" } }, "type": "object", "title": "HSCode" }, "HSCodeField": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "title": "HSCodeField" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HandlingUnitData": { "properties": { "barcode": { "anyOf": [ { "$ref": "#/components/schemas/UpdateBarcodeInput" }, { "type": "null" } ] }, "alternative_barcodes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UpdateBarcodeInput" }, "type": "array" }, { "type": "null" } ], "title": "Alternative Barcodes" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, "type": "object", "title": "HandlingUnitData" }, "HandlingUnitEntityUpdate": { "properties": { "operation": { "$ref": "#/components/schemas/UpdateOperation" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/HandlingUnitUpdateData" }, { "$ref": "#/components/schemas/HandlingUnitData" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "operation" ], "title": "HandlingUnitEntityUpdate" }, "HandlingUnitInput-Input": { "properties": { "barcode": { "anyOf": [ { "$ref": "#/components/schemas/BarcodeInput" }, { "type": "null" } ], "description": "Barcode information" } }, "type": "object", "title": "HandlingUnitInput" }, "HandlingUnitInput-Output": { "properties": { "barcode": { "anyOf": [ { "$ref": "#/components/schemas/BarcodeInput" }, { "type": "null" } ], "description": "Barcode information" } }, "type": "object", "title": "HandlingUnitInput" }, "HandlingUnitMatch": { "properties": { "barcode": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] } }, "type": "object", "title": "HandlingUnitMatch" }, "HandlingUnitOutput-Input": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for this handling unit" }, "barcode": { "anyOf": [ { "$ref": "#/components/schemas/BarcodeOutput" }, { "type": "null" } ], "description": "Barcode information" } }, "type": "object", "required": [ "id" ], "title": "HandlingUnitOutput" }, "HandlingUnitOutput-Output": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for this handling unit" }, "barcode": { "anyOf": [ { "$ref": "#/components/schemas/BarcodeOutput" }, { "type": "null" } ], "description": "Barcode information" } }, "type": "object", "required": [ "id" ], "title": "HandlingUnitOutput" }, "HandlingUnitUpdate": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "type": { "type": "string", "const": "HandlingUnit", "title": "Type" }, "status": { "$ref": "#/components/schemas/VisibilityHandlingUnitStatus", "description": "Handling unit status. We only send an update for the following status updates:\n- SCANNED_IN\n- STORED\n- SCANNED_OUT\n" }, "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp", "description": "Timestamp of the status change in UTC. For barcodes scans, this will be the timestamp at which the scan was performed." }, "barcode": { "$ref": "#/components/schemas/BarcodeOutput", "description": "Barcode information" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By", "description": "User who created the scan" }, "stop_location_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stop Location Code", "description": "Optional code used to describe the location of the scan.", "examples": [ "DEPOT-001" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "source_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Status", "description": "The status as provided to Qargo by an external system" }, "stop": { "anyOf": [ { "$ref": "#/components/schemas/VisibilityStop" }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "status", "timestamp", "barcode" ], "title": "HandlingUnitUpdate", "description": "Send update event when a handling unit is updated in Qargo." }, "HandlingUnitUpdateData": { "properties": { "barcode": { "anyOf": [ { "$ref": "#/components/schemas/UpdateBarcodeInput" }, { "type": "null" } ] }, "alternative_barcodes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UpdateBarcodeInput" }, "type": "array" }, { "type": "null" } ], "title": "Alternative Barcodes" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, "type": "object", "title": "HandlingUnitUpdateData" }, "HazchemConsignmentInput": { "properties": { "consignment_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consignment Number" }, "tracking_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tracking Code" } }, "type": "object", "title": "HazchemConsignmentInput" }, "ImportConfiguration": { "properties": { "code": { "type": "string", "title": "Code", "description": "Import source in Qargo to route the order uploads to", "default": "API" } }, "type": "object", "title": "ImportConfiguration" }, "ImportDeclarationTypeEnum": { "type": "string", "enum": [ "IM" ], "title": "ImportDeclarationTypeEnum" }, "ImportExportExtraFields": { "properties": { "incoterm": { "anyOf": [ { "$ref": "#/components/schemas/Incoterm" }, { "type": "null" } ], "description": "Incoterm for the order. The available incoterms are:\n - `EXW`: Ex Works \n - `FCA`: Free Carrier \n - `FAS`: Free Alongside Ship \n - `FOB`: Free On Board\n - `CFR`: Cost and Freight \n - `CIF`: Cost, Insurance and Freight \n - `CPT`: Carriage Paid To\n - `CIP`: Carriage and Insurance Paid To\n - `DAP`: Delivered At Place\n - `DPU`: Delivered At Place Unloaded / Delivered at Terminal (DAT) \n - `DDP`: Delivered Duty Paid" }, "destination_country_of_goods": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Destination Country Of Goods", "description": "Destination country of goods in ISO 3166-1 alpha-2 format", "examples": [ "BE", "FR" ] }, "origin_country_of_goods": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Origin Country Of Goods", "description": "Origin country of goods in ISO 3166-1 alpha-2 format", "examples": [ "BE", "FR" ] } }, "type": "object", "title": "ImportExportExtraFields" }, "ImportExportInput": { "properties": { "hs_code_import": { "anyOf": [ { "$ref": "#/components/schemas/HSCodeField" }, { "type": "null" } ] }, "hs_code_export": { "anyOf": [ { "$ref": "#/components/schemas/HSCodeField" }, { "type": "null" } ] }, "commercial_invoice": { "anyOf": [ { "$ref": "#/components/schemas/CommercialInvoiceInput" }, { "type": "null" } ] } }, "type": "object", "title": "ImportExportInput" }, "Incident": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable identifier" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Machine readable identifier" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the incident" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" } }, "type": "object", "title": "Incident" }, "Incoterm": { "type": "string", "enum": [ "EXW", "FCA", "FAS", "FOB", "CFR", "CIF", "CPT", "CIP", "DAP", "DPU", "DDP" ], "title": "Incoterm" }, "IntermodalBookingPayload": { "properties": { "trip": { "$ref": "#/components/schemas/BookingTrip", "description": "Qargo Trip the booking belongs to" }, "orders": { "items": { "$ref": "#/components/schemas/OrderOutput-Input" }, "type": "array", "title": "Orders" }, "booking": { "$ref": "#/components/schemas/Booking" }, "trip_name": { "type": "string", "title": "Trip Name", "description": "Qargo Trip name. Replaced by `trip.name`, please use `trip.name` instead.", "deprecated": true } }, "type": "object", "required": [ "trip_name", "trip", "orders", "booking" ], "title": "IntermodalBookingPayload" }, "IntermodalBookingPushPayload": { "properties": { "operation": { "$ref": "#/components/schemas/BookingOperation" }, "payload": { "$ref": "#/components/schemas/IntermodalBookingPayload" }, "account_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Code" } }, "type": "object", "required": [ "operation", "payload", "account_code" ], "title": "IntermodalBookingPushPayload" }, "IntermodalBookingReferences": { "properties": { "arrival_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Arrival Reference Number", "description": "Booking reference for the arrival conveyance at the port of discharge." }, "departure_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Departure Reference Number", "description": "Booking reference for the departure conveyance at the port of loading." } }, "type": "object", "title": "IntermodalBookingReferences" }, "IntermodalBookingStatusPayload": { "properties": { "updates": { "items": { "$ref": "#/components/schemas/IntermodalBookingUpdate" }, "type": "array", "title": "Updates" } }, "type": "object", "required": [ "updates" ], "title": "IntermodalBookingStatusPayload" }, "IntermodalBookingUpdate": { "properties": { "match": { "anyOf": [ { "$ref": "#/components/schemas/BookingMatchTarget" }, { "type": "null" } ], "description": "Matching criteria to match the booking in Qargo" }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the booking in Qargo" }, "event_time": { "type": "string", "format": "date-time", "title": "Event Time", "description": "Time of the event (ISO 8601 format with a timezone offset, e.g. `Z` or `+02:00`).", "default": "2026-09-11T06:56:12.327308", "examples": [ "2024-12-31T08:00:00Z" ] }, "status": { "anyOf": [ { "$ref": "#/components/schemas/IntermodalStatuses" }, { "type": "null" } ], "description": "Status update for the booking." }, "stop_timestamps": { "anyOf": [ { "$ref": "#/components/schemas/IntermodalStopTimestampsGroup" }, { "type": "null" } ], "description": "Estimated and actual timestamps for the booking's departure and arrival stops. Whether these timestamps are applied depends on the integration's configuration in Qargo; they are ignored unless stop-time syncing is enabled for the integration." }, "booking_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Booking Reference", "description": "Operator's booking reference. Reference is filled in here, the field itself is not used to match the booking in Qargo." }, "references": { "anyOf": [ { "$ref": "#/components/schemas/IntermodalBookingReferences" }, { "type": "null" } ], "description": "Per-port booking references for the arrival and departure conveyances." }, "skip_dispatch": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Skip Dispatch", "description": "Marks the booking as final. Prevents further updates from being sent when the booking is updated in Qargo." }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "Identifier of the booking in your own system. When supplied, Qargo stores it as the identifier for this booking, taking precedence over `booking_reference`. The value is only recorded on updates that also carry `booking_reference` or set the status to `BOOKED`." }, "booking_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Booking Id", "description": "Unique technical Qargo id for the booking. Replaced by `id`, please use `id` instead.", "deprecated": true }, "timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp", "description": "Time of the event. Replaced by `event_time`, please use `event_time` instead.", "deprecated": true } }, "type": "object", "title": "IntermodalBookingUpdate" }, "IntermodalBookingsPushPayload": { "properties": { "operations": { "items": { "$ref": "#/components/schemas/IntermodalBookingPushPayload" }, "type": "array", "title": "Operations" } }, "type": "object", "required": [ "operations" ], "title": "IntermodalBookingsPushPayload" }, "IntermodalExecutionStatus": { "properties": { "event_time": { "type": "string", "format": "date-time", "title": "Event Time", "description": "Time of the event (ISO 8601 format with a timezone offset, e.g. `Z` or `+02:00`).", "examples": [ "2024-12-31T08:00:00Z" ] }, "ok": { "type": "boolean", "title": "Ok", "description": "Is the status ok" }, "type": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/IntermodalExecutionStatusEnum" } ], "title": "Type", "description": "Type of the status" }, "remark": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remark", "description": "extra remark about the status" } }, "type": "object", "required": [ "event_time", "ok", "type" ], "title": "IntermodalExecutionStatus" }, "IntermodalExecutionStatusEnum": { "type": "string", "enum": [ "GATE_IN", "CLEARED_CUSTOMS", "CHECKED_IN", "ON_BOARD", "DEPARTED", "ARRIVED", "DISCHARGED", "GATE_OUT" ], "title": "IntermodalExecutionStatusEnum" }, "IntermodalStatuses": { "properties": { "booking_status": { "anyOf": [ { "$ref": "#/components/schemas/BookingStatus" }, { "type": "null" } ], "description": "Lifecycle status of the booking request: whether it is being processed, accepted, or rejected. At least one of `booking_status`, `execution_statuses`, or `failure` must be set." }, "execution_statuses": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IntermodalExecutionStatus" }, "type": "array" }, { "type": "null" } ], "title": "Execution Statuses", "description": "Operational movement statuses reported during execution, in chronological order. At least one of `booking_status`, `execution_statuses`, or `failure` must be set." }, "failure": { "anyOf": [ { "$ref": "#/components/schemas/ErrorStatus" }, { "type": "null" } ], "description": "Error details when the booking request could not be processed. At least one of `booking_status`, `execution_statuses`, or `failure` must be set." } }, "type": "object", "title": "IntermodalStatuses" }, "IntermodalStopTimestamps": { "properties": { "eta_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Eta Timestamp", "description": "Estimated time of arrival at the stop (ISO 8601 format with a timezone offset, e.g. `Z` or `+02:00`).", "examples": [ "2024-12-31T08:00:00Z" ] }, "actual_start_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Actual Start Timestamp", "description": "Actual time the stop started (arrival at the stop - ISO 8601 format with a timezone offset, e.g. `Z` or `+02:00`).", "examples": [ "2024-12-31T08:00:00Z" ] }, "actual_end_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Actual End Timestamp", "description": "Actual time the stop ended (departure from the stop - ISO 8601 format with a timezone offset, e.g. `Z` or `+02:00`).", "examples": [ "2024-12-31T08:00:00Z" ] } }, "type": "object", "title": "IntermodalStopTimestamps" }, "IntermodalStopTimestampsGroup": { "properties": { "departure": { "anyOf": [ { "$ref": "#/components/schemas/IntermodalStopTimestamps" }, { "type": "null" } ], "description": "Timestamps for the departure stop (port of loading)." }, "arrival": { "anyOf": [ { "$ref": "#/components/schemas/IntermodalStopTimestamps" }, { "type": "null" } ], "description": "Timestamps for the arrival stop (port of discharge)." } }, "type": "object", "title": "IntermodalStopTimestampsGroup" }, "InvoiceStatus": { "type": "string", "enum": [ "DRAFT", "PRE_INVOICED", "INVOICED", "INVOICE_POSTED" ], "title": "InvoiceStatus", "description": "Status description:\n- DRAFT: Invoice is in draft state and not yet invoiced.\n- PRE_INVOICED: Invoice is in pre-invoiced state and not yet invoiced (Purchase invoice only).\n- INVOICED: Invoice is invoiced but not yet posted.\n- INVOICE_POSTED: Invoice is invoiced and posted." }, "KuehneNagelExtraFields": { "properties": { "sender_depot_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sender Depot Code", "description": "Sender depot code" }, "receiver_depot_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Receiver Depot Code", "description": "Receiver depot code" } }, "type": "object", "title": "KuehneNagelExtraFields" }, "LegMatch": { "properties": { "leg_type": { "anyOf": [ { "$ref": "#/components/schemas/LegType" }, { "type": "null" } ] } }, "type": "object", "title": "LegMatch" }, "LegType": { "type": "string", "enum": [ "PICKUP", "TRANSFER", "DELIVERY", "DIRECT", "EMPTY" ], "title": "LegType" }, "LineItem": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Unique id of this line item. A Qargo invoice line can be represented with multiple LineItems if revenue/cost split is enabled." }, "invoice_line_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Invoice Line Id", "description": "Technical id of the invoice within the Qargo system" }, "name": { "type": "string", "title": "Name", "description": "Name of the charge line.", "examples": [ "Fuel charge" ] }, "amount": { "type": "string", "title": "Amount", "description": "Amount of the charge line.", "examples": [ "100" ] }, "code": { "type": "string", "title": "Code", "description": "Code of the type of charge line.", "examples": [ "FUEL" ] }, "account": { "anyOf": [ { "$ref": "#/components/schemas/api__order__models__charge__AccountOutput" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Freeform description field", "default": "", "examples": [ "Charge description" ] }, "tax_rate": { "anyOf": [ { "$ref": "#/components/schemas/api__accounting__models__invoice__TaxRate" }, { "type": "null" } ] }, "base_tax_rate": { "anyOf": [ { "$ref": "#/components/schemas/BaseTaxRate" }, { "type": "null" } ], "description": "Original tax rate before applying tax rules." }, "order_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Name", "description": "Name of the Qargo order linked to this line item. For purchase invoices, this is an empty string when `order_id` is `null`.", "examples": [ "Order-0001" ] }, "order_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Order Id", "description": "ID of the Qargo order linked to this line item. For purchase invoices, this is `null` when charges are not calculated per order and the line item is not split per order." }, "trip_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Trip Id", "description": "Linked Qargo trip id, for cost charges" }, "is_credit_charge": { "type": "boolean", "title": "Is Credit Charge", "default": false, "examples": [ false ] }, "invoice_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoice Name", "description": "Name of the source invoice this line item is linked to, if applicable.", "examples": [ "Invoice-0001" ] }, "currency": { "type": "string", "title": "Currency", "examples": [ "USD" ] }, "fraction": { "type": "string", "title": "Fraction", "description": "The api can split the charge lines according to revenue. This fraction indicates the percentage of the total amount of the split for this set of dimensions.", "default": "1", "examples": [ "0.5" ] }, "dimension_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dimension 1" }, "dimension_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dimension 2" }, "dimension_3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dimension 3" }, "dimension_4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dimension 4" }, "dimension_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dimension 5" }, "dimension_6": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dimension 6" } }, "type": "object", "required": [ "id", "invoice_line_id", "name", "amount", "code", "currency" ], "title": "LineItem", "description": "Represents a single invoice/credit line item.\n\nNote that a single invoice line can be split up in multiple line items\nif revenue split is enabled." }, "ListAccountOutput": { "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "items": { "items": { "$ref": "#/components/schemas/api__accounting__models__master_data__AccountOutput" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ListAccountOutput" }, "ListCompanyDocumentOutput": { "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "items": { "items": { "$ref": "#/components/schemas/CompanyDocumentOutput" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ListCompanyDocumentOutput" }, "ListCompanyOutput": { "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "items": { "items": { "$ref": "#/components/schemas/CompanyDetailOutput" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ListCompanyOutput" }, "ListCompanyValidityOutput": { "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "items": { "items": { "$ref": "#/components/schemas/CompanyValidityOutput" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ListCompanyValidityOutput" }, "ListExchangeRateOutput": { "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "items": { "items": { "$ref": "#/components/schemas/ExchangeRateOutput" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ListExchangeRateOutput" }, "ListLocationOutput": { "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "items": { "items": { "$ref": "#/components/schemas/LocationDetailOutput" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ListLocationOutput" }, "ListResourceGroupOutput": { "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "items": { "items": { "$ref": "#/components/schemas/ResourceGroupOutput" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ListResourceGroupOutput" }, "ListResourceOutput": { "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/DriverResourceOutput" }, { "$ref": "#/components/schemas/TractorResourceOutput" }, { "$ref": "#/components/schemas/TruckResourceOutput" }, { "$ref": "#/components/schemas/VanResourceOutput" }, { "$ref": "#/components/schemas/TrailerResourceOutput" }, { "$ref": "#/components/schemas/FullTrailerResourceOutput" }, { "$ref": "#/components/schemas/ChassisResourceOutput" }, { "$ref": "#/components/schemas/ContainerResourceOutput" } ] }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ListResourceOutput" }, "ListResourceUnavailabilityOutput": { "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "items": { "items": { "$ref": "#/components/schemas/ResourceUnavailabilityOutput" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ListResourceUnavailabilityOutput" }, "ListResourceValidityOutput": { "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "items": { "items": { "$ref": "#/components/schemas/ResourceValidityOutput" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ListResourceValidityOutput" }, "ListTaxRateOutput": { "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "items": { "items": { "$ref": "#/components/schemas/TaxRateOutput" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ListTaxRateOutput" }, "Location": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Technical code for integrations/mapping logic; should be treated as stable once set.", "examples": [ "LOC123" ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Human-readable label for a location in operational views.", "examples": [ "Main Office" ] }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "Identifier from an external (master data) system." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "First address line of the location", "examples": [ "Gaston Crommenlaan 4" ] }, "address_second_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Second Line", "description": "Second address line of the location", "examples": [ "" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City of the location", "examples": [ "Ghent" ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "State of the location", "examples": [ "" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country code (ISO 3166-1 alpha-2) of the location", "examples": [ "BE" ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code", "description": "Postal code of the location", "examples": [ "9050" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the location", "examples": [ "Qargo HQ" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Identifier of the location" }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latitude" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Longitude" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Location description" }, "location_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location Identifier", "description": "External location identifier" } }, "type": "object", "title": "Location" }, "LocationBookingDispatchResponse": { "properties": { "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorStatus" }, "type": "array" }, { "type": "null" } ], "title": "Errors", "description": "List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.", "examples": [ { "error_message": "The payload is invalid.", "error_type": "USER_INPUT_ERROR" }, { "error_message": "Not supported.", "error_type": "NOT_SUPPORTED" }, { "error_message": "Unknown error.", "error_type": "INTERNAL_ERROR" } ] } }, "type": "object", "title": "LocationBookingDispatchResponse", "description": "Response schema for the location booking dispatch payload.\nThis schema is used to return errors or success messages." }, "LocationBookingPayload": { "properties": { "booking_id": { "type": "string", "format": "uuid", "title": "Booking Id", "description": "Unique technical Qargo id for the booking" }, "booking_name": { "type": "string", "title": "Booking Name", "description": "Qargo Name of the booking, used for human readable reference" }, "location": { "$ref": "#/components/schemas/LocationOutput", "description": "Geographical location of the location booking" }, "stops": { "items": { "$ref": "#/components/schemas/StopOutput-Input" }, "type": "array", "title": "Stops", "description": "List of relevant stops for the location booking" }, "resource_allocations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DispatchResourceAllocation" }, "type": "array" }, { "type": "null" } ], "title": "Resource Allocations", "description": "List of resources allocated to the location booking" }, "trailer": { "anyOf": [ { "$ref": "#/components/schemas/Trailer" }, { "type": "null" } ], "description": "Trailer used in the location booking", "deprecated": true }, "vehicle": { "anyOf": [ { "$ref": "#/components/schemas/Vehicle" }, { "type": "null" } ], "description": "Vehicle used in the location booking", "deprecated": true } }, "type": "object", "required": [ "booking_id", "booking_name", "location" ], "title": "LocationBookingPayload" }, "LocationBookingTripSummary": { "properties": { "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "Custom fields associated with the trip" }, "estimated_start_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Estimated Start Timestamp", "description": "Estimated start time of the trip" } }, "type": "object", "title": "LocationBookingTripSummary" }, "LocationBookingUpdate": { "properties": { "match": { "anyOf": [ { "$ref": "#/components/schemas/BookingMatchTarget" }, { "type": "null" } ], "description": "Matching criteria to match the booking in Qargo" }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the booking in Qargo" }, "event_time": { "type": "string", "format": "date-time", "title": "Event Time", "description": "Time of the event (ISO 8601 format with a timezone offset, e.g. `Z` or `+02:00`).", "default": "2026-09-11T06:56:12.327308", "examples": [ "2024-12-31T08:00:00Z" ] }, "execution_status": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionStatusUpdate" }, { "type": "null" } ], "description": "Execution status updates" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/BookingStatus" }, { "type": "null" } ], "description": "New status of the location booking" }, "question_answers": { "type": "object", "title": "Question Answers", "description": "Question answers to update on the order. Mapping is configured in Qargo" } }, "type": "object", "title": "LocationBookingUpdate" }, "LocationBookingUpdatePayload": { "properties": { "updates": { "items": { "$ref": "#/components/schemas/LocationBookingUpdate" }, "type": "array", "title": "Updates" } }, "type": "object", "required": [ "updates" ], "title": "LocationBookingUpdatePayload" }, "LocationBookingUpdateResponse": { "properties": { "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorStatus" }, "type": "array" }, { "type": "null" } ], "title": "Errors", "description": "List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.", "examples": [ { "error_message": "The payload is invalid.", "error_type": "USER_INPUT_ERROR" }, { "error_message": "Not supported.", "error_type": "NOT_SUPPORTED" }, { "error_message": "Unknown error.", "error_type": "INTERNAL_ERROR" } ] } }, "type": "object", "title": "LocationBookingUpdateResponse", "description": "Response schema for the location booking update webhook.\nThis schema is used to return errors or success messages." }, "LocationDetailInput": { "properties": { "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latitude", "description": "Latitude of the location. When omitted on create, the coordinates are geocoded from the address.", "examples": [ 51.0543 ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Longitude", "description": "Longitude of the location. When omitted on create, the coordinates are geocoded from the address.", "examples": [ 3.7174 ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Free-text description of the location." }, "selectable_on_customer_portal": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Selectable On Customer Portal", "description": "Whether the location can be selected on the customer portal." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Technical code for integrations/mapping logic; should be treated as stable once set.", "examples": [ "LOC123" ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Human-readable label for a location in operational views.", "examples": [ "Main Office" ] }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "Identifier from an external (master data) system." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "First address line of the location", "examples": [ "Gaston Crommenlaan 4" ] }, "address_second_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Second Line", "description": "Second address line of the location", "examples": [ "" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City of the location", "examples": [ "Ghent" ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "State of the location", "examples": [ "" ] }, "country": { "type": "string", "title": "Country", "description": "Country code (ISO 3166-1 alpha-2) of the location", "examples": [ "BE" ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code", "description": "Postal code of the location", "examples": [ "9050" ] }, "name": { "type": "string", "title": "Name", "description": "Name of the location.", "examples": [ "Ghent Warehouse" ] }, "opening_hours": { "anyOf": [ { "$ref": "#/components/schemas/WeekScheduleInput" }, { "type": "null" } ], "description": "Weekly opening hours for all seven days. Replaces the full schedule when provided." } }, "type": "object", "required": [ "country", "name" ], "title": "LocationDetailInput" }, "LocationDetailOutput": { "properties": { "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latitude", "description": "Latitude of the location.", "examples": [ 51.0543 ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Longitude", "description": "Longitude of the location.", "examples": [ 3.7174 ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Free-text description of the location." }, "selectable_on_customer_portal": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Selectable On Customer Portal", "description": "Whether the location can be selected on the customer portal." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Technical code for integrations/mapping logic; should be treated as stable once set.", "examples": [ "LOC123" ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Human-readable label for a location in operational views.", "examples": [ "Main Office" ] }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "Identifier from an external (master data) system." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "First address line of the location", "examples": [ "Gaston Crommenlaan 4" ] }, "address_second_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Second Line", "description": "Second address line of the location", "examples": [ "" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City of the location", "examples": [ "Ghent" ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "State of the location", "examples": [ "" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country code (ISO 3166-1 alpha-2) of the location", "examples": [ "BE" ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code", "description": "Postal code of the location", "examples": [ "9050" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the location", "examples": [ "Qargo HQ" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Unique identifier of the location." }, "opening_hours": { "anyOf": [ { "$ref": "#/components/schemas/WeekSchedule" }, { "type": "null" } ], "description": "Weekly opening hours." } }, "type": "object", "title": "LocationDetailOutput" }, "LocationDispatchOutput": { "properties": { "operation": { "$ref": "#/components/schemas/BookingOperation" }, "payload": { "$ref": "#/components/schemas/LocationDispatchPayload" } }, "type": "object", "required": [ "operation", "payload" ], "title": "LocationDispatchOutput" }, "LocationDispatchPayload": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the trip" }, "name": { "type": "string", "title": "Name", "description": "Name of the trip, used for human readable reference" }, "orders": { "items": { "$ref": "#/components/schemas/DispatchOrderOutput" }, "type": "array", "title": "Orders" }, "scenario": { "$ref": "#/components/schemas/LocationScenario" }, "booking": { "$ref": "#/components/schemas/LocationBookingPayload" }, "trip_summary": { "anyOf": [ { "$ref": "#/components/schemas/LocationBookingTripSummary" }, { "type": "null" } ], "description": "Summary information about the trip" } }, "type": "object", "required": [ "id", "name", "scenario", "booking" ], "title": "LocationDispatchPayload" }, "LocationInput": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address" }, "address_second_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Second Line" }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latitude" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Longitude" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "location_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location Identifier" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "location_search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location Search" }, "place_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Place Id" } }, "type": "object", "title": "LocationInput" }, "LocationOutput": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Technical code for integrations/mapping logic; should be treated as stable once set.", "examples": [ "LOC123" ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Human-readable label for a location in operational views.", "examples": [ "Main Office" ] }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "Identifier from an external (master data) system." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "First address line of the location", "examples": [ "Gaston Crommenlaan 4" ] }, "address_second_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Second Line", "description": "Second address line of the location", "examples": [ "" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City of the location", "examples": [ "Ghent" ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "State of the location", "examples": [ "" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country code (ISO 3166-1 alpha-2) of the location", "examples": [ "BE" ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code", "description": "Postal code of the location", "examples": [ "9050" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the location", "examples": [ "Qargo HQ" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Unique identifier of the location" }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latitude", "description": "Latitude of the location" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Longitude", "description": "Longitude of the location" } }, "type": "object", "title": "LocationOutput" }, "LocationReference": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Identifier of the location" } }, "type": "object", "required": [ "id" ], "title": "LocationReference" }, "LocationScenario": { "type": "string", "enum": [ "INBOUND", "OUTBOUND", "INBOUND_OUTBOUND" ], "title": "LocationScenario" }, "LocationWithTerminalOutput-Input": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Technical code for integrations/mapping logic; should be treated as stable once set.", "examples": [ "LOC123" ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Human-readable label for a location in operational views.", "examples": [ "Main Office" ] }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "Identifier from an external (master data) system." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "First address line of the location", "examples": [ "Gaston Crommenlaan 4" ] }, "address_second_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Second Line", "description": "Second address line of the location", "examples": [ "" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City of the location", "examples": [ "Ghent" ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "State of the location", "examples": [ "" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country code (ISO 3166-1 alpha-2) of the location", "examples": [ "BE" ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code", "description": "Postal code of the location", "examples": [ "9050" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the location", "examples": [ "Qargo HQ" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Unique identifier of the location" }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latitude", "description": "Latitude of the location" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Longitude", "description": "Longitude of the location" }, "terminal_metadata": { "anyOf": [ { "$ref": "#/components/schemas/TerminalMetadata" }, { "type": "null" } ], "description": "Metadata related to the terminal" }, "customs_metadata": { "anyOf": [ { "$ref": "#/components/schemas/CustomsMetadata" }, { "type": "null" } ], "description": "Metadata related to customs" } }, "type": "object", "title": "LocationWithTerminalOutput" }, "LocationWithTerminalOutput-Output": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Technical code for integrations/mapping logic; should be treated as stable once set.", "examples": [ "LOC123" ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Human-readable label for a location in operational views.", "examples": [ "Main Office" ] }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "Identifier from an external (master data) system." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "First address line of the location", "examples": [ "Gaston Crommenlaan 4" ] }, "address_second_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Second Line", "description": "Second address line of the location", "examples": [ "" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City of the location", "examples": [ "Ghent" ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "State of the location", "examples": [ "" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country code (ISO 3166-1 alpha-2) of the location", "examples": [ "BE" ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code", "description": "Postal code of the location", "examples": [ "9050" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the location", "examples": [ "Qargo HQ" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Unique identifier of the location" }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latitude", "description": "Latitude of the location" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Longitude", "description": "Longitude of the location" }, "terminal_metadata": { "anyOf": [ { "$ref": "#/components/schemas/TerminalMetadata" }, { "type": "null" } ], "description": "Metadata related to the terminal" }, "customs_metadata": { "anyOf": [ { "$ref": "#/components/schemas/CustomsMetadata" }, { "type": "null" } ], "description": "Metadata related to customs" } }, "type": "object", "title": "LocationWithTerminalOutput" }, "ManuportOrderInput": { "properties": { "delivery_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery Number" }, "seal_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Seal Number" }, "order_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Number" }, "customer_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Id" }, "sender_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sender Id" } }, "type": "object", "title": "ManuportOrderInput" }, "MinimalOrderOutput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the order" }, "name": { "type": "string", "title": "Name", "description": "Name of the order" } }, "type": "object", "required": [ "id", "name" ], "title": "MinimalOrderOutput" }, "OperationEnum": { "type": "string", "enum": [ "CREATE", "UPDATE", "DELETE" ], "title": "OperationEnum" }, "OperationalVisibilityUpdate": { "properties": { "events": { "items": { "$ref": "#/components/schemas/VisibilityEvent" }, "type": "array", "title": "Events", "description": "Events tracked in this update. `PositionUpdate` is not implemented yet. 🚧 " }, "order": { "anyOf": [ { "$ref": "#/components/schemas/VisibilityOrder" }, { "type": "null" } ], "description": "Current state of the order. Included for `OrderUpdate`, `StopUpdate`, `DocumentUpdate`, `EtaUpdate`, and `HandlingUnitUpdate` events. Never included together with `trip` on the same event." }, "trip": { "anyOf": [ { "$ref": "#/components/schemas/VisibilityTrip" }, { "type": "null" } ], "description": "Current state of the trip. This field is not populated by default. Including it requires a custom webhook format configured by Qargo." } }, "type": "object", "required": [ "events" ], "title": "OperationalVisibilityUpdate" }, "OrderChargesOutput": { "properties": { "charges": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ChargeWithApprovalOutput" }, "type": "array" }, { "type": "null" } ], "title": "Charges", "description": "List of charges" } }, "type": "object", "title": "OrderChargesOutput" }, "OrderConsignmentOutput-Input": { "properties": { "consignment_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consignment Reference Number", "description": "Consignment reference number" }, "cmr_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cmr Reference Number" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Additional user defined fields to fill in" }, "transport_network": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentTransportNetwork" }, { "type": "null" } ], "description": "Transport network" }, "central_transport_network": { "anyOf": [ { "$ref": "#/components/schemas/CentralTransportNetworkConsignmentExtraFields" }, { "type": "null" } ] }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineConsignmentExtraFields" }, { "type": "null" } ] }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceConsignmentExtraFields" }, { "type": "null" } ] }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonConsignmentExtraFields" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the consignment" }, "pickup_stop": { "$ref": "#/components/schemas/StopOutput-Input", "description": "First stop on this consignment." }, "delivery_stop": { "$ref": "#/components/schemas/StopOutput-Input", "description": "Last stop on this consignment." }, "goods": { "anyOf": [ { "items": { "$ref": "#/components/schemas/GoodOutput-Input" }, "type": "array" }, { "type": "null" } ], "title": "Goods" }, "signatures": { "items": { "$ref": "#/components/schemas/Signature" }, "type": "array", "title": "Signatures", "description": "List of signatures related to the consignment" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentImportExportExtraFieldsOutput-Input" }, { "type": "null" } ] }, "buyer": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentBuyerSellerOutput-Input" }, { "type": "null" } ], "description": "Buyer information for this consignment" }, "seller": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentBuyerSellerOutput-Input" }, { "type": "null" } ], "description": "Seller information for this consignment" }, "tracking_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tracking Link", "description": "Public tracking page URL for this consignment. Returned on the tenant API only: always `null` for customer portal callers. Also `null` when the consignment has no tracking link, for example when the tracking link integration is not enabled on the tenant or the link has been revoked." } }, "type": "object", "required": [ "id", "pickup_stop", "delivery_stop" ], "title": "OrderConsignmentOutput" }, "OrderConsignmentOutput-Output": { "properties": { "consignment_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consignment Reference Number", "description": "Consignment reference number" }, "cmr_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cmr Reference Number" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Additional user defined fields to fill in" }, "transport_network": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentTransportNetwork" }, { "type": "null" } ], "description": "Transport network" }, "central_transport_network": { "anyOf": [ { "$ref": "#/components/schemas/CentralTransportNetworkConsignmentExtraFields" }, { "type": "null" } ] }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineConsignmentExtraFields" }, { "type": "null" } ] }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceConsignmentExtraFields" }, { "type": "null" } ] }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonConsignmentExtraFields" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the consignment" }, "pickup_stop": { "$ref": "#/components/schemas/StopOutput-Output", "description": "First stop on this consignment." }, "delivery_stop": { "$ref": "#/components/schemas/StopOutput-Output", "description": "Last stop on this consignment." }, "goods": { "anyOf": [ { "items": { "$ref": "#/components/schemas/GoodOutput-Output" }, "type": "array" }, { "type": "null" } ], "title": "Goods" }, "signatures": { "items": { "$ref": "#/components/schemas/Signature" }, "type": "array", "title": "Signatures", "description": "List of signatures related to the consignment" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentImportExportExtraFieldsOutput-Output" }, { "type": "null" } ] }, "buyer": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentBuyerSellerOutput-Output" }, { "type": "null" } ], "description": "Buyer information for this consignment" }, "seller": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentBuyerSellerOutput-Output" }, { "type": "null" } ], "description": "Seller information for this consignment" }, "tracking_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tracking Link", "description": "Public tracking page URL for this consignment. Returned on the tenant API only: always `null` for customer portal callers. Also `null` when the consignment has no tracking link, for example when the tracking link integration is not enabled on the tenant or the link has been revoked." } }, "type": "object", "required": [ "id", "pickup_stop", "delivery_stop" ], "title": "OrderConsignmentOutput" }, "OrderDetailOutput": { "properties": { "transport_service": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "title": "Transport service", "description": "Transport service within Qargo" }, "customer_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order reference number from customer" }, "service_level": { "anyOf": [ { "$ref": "#/components/schemas/ServiceLevel" }, { "type": "null" } ] }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "department": { "anyOf": [ { "$ref": "#/components/schemas/Department" }, { "type": "null" } ], "description": "Department linked to order" }, "neutral_order_type": { "anyOf": [ { "type": "string", "enum": [ "NO_NEUTRAL_ORDER", "MASK_DELIVERY", "MASK_PICKUP" ] }, { "type": "null" } ], "title": "Neutral Order Type", "description": "Neutral order" }, "container": { "anyOf": [ { "$ref": "#/components/schemas/ContainerExtraFields" }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "User defined additional fields for this order." }, "vehicle_category": { "anyOf": [ { "$ref": "#/components/schemas/VehicleCategory" }, { "type": "null" } ], "title": "Vehicle category" }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceExtraFields" }, { "type": "null" } ], "title": "Palletforce specific fields" }, "kuehne_nagel": { "anyOf": [ { "$ref": "#/components/schemas/KuehneNagelExtraFields" }, { "type": "null" } ], "title": "Kuehn Nagel specific fields" }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineExtraFields" }, { "type": "null" } ], "title": "Palletline specific fields" }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonOrderExtraFields" }, { "type": "null" } ], "title": "Transporeon specific fields" }, "dachser": { "anyOf": [ { "$ref": "#/components/schemas/DachserExtraFields" }, { "type": "null" } ], "title": "Dachser specific fields" }, "contact_emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Contact Emails", "description": "List of contact emails to notify about the order" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ImportExportExtraFields" }, { "type": "null" } ], "title": "Fields specific to import and export" }, "is_consignment_info_validated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Consignment Info Validated", "description": "Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it." }, "stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopOutput-Output" }, "type": "array" }, { "type": "null" } ], "title": "Stops", "description": "List of stops in the order, ordered by their sequence" }, "order_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Identifier", "description": "Identifier of the order when created from an external source" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for order" }, "consignments": { "items": { "$ref": "#/components/schemas/OrderConsignmentOutput-Output" }, "type": "array", "title": "Consignments" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/OrderPricingOutput" }, { "type": "null" } ], "description": "Pricing fields related to order" }, "customer": { "$ref": "#/components/schemas/CompanyOutput-Output", "title": "Customer" }, "created_by_user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By User", "description": "User who created the order" }, "created_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created Timestamp", "description": "Timestamp of creation" }, "start_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Output" }, { "type": "null" } ], "description": "First stop on this order" }, "end_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Output" }, { "type": "null" } ], "description": "Last stop on this order" }, "quote_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quote Name", "description": "Name of the quote" }, "container_load_unload_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Output" }, { "type": "null" } ], "title": "Container load/unload stop", "description": "This field practically maps to the container yard. `setup_stops` (for pick-up) and `teardown_stops` (for drop-off) are replacing this field, please use them instead.", "deprecated": true } }, "type": "object", "required": [ "id", "consignments", "customer" ], "title": "OrderDetailOutput" }, "OrderEntityUpdate": { "properties": { "operation": { "type": "string", "enum": [ "UPDATE", "DELETE" ], "title": "Operation" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/OrderUpdateData" }, { "type": "null" } ] } }, "type": "object", "required": [ "operation" ], "title": "OrderEntityUpdate" }, "OrderExport": { "properties": { "transport_service": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "title": "Transport service", "description": "Transport service within Qargo" }, "customer_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order reference number from customer" }, "service_level": { "anyOf": [ { "$ref": "#/components/schemas/ServiceLevel" }, { "type": "null" } ] }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "department": { "anyOf": [ { "$ref": "#/components/schemas/Department" }, { "type": "null" } ], "description": "Department linked to order" }, "neutral_order_type": { "anyOf": [ { "type": "string", "enum": [ "NO_NEUTRAL_ORDER", "MASK_DELIVERY", "MASK_PICKUP" ] }, { "type": "null" } ], "title": "Neutral Order Type", "description": "Neutral order" }, "container": { "anyOf": [ { "$ref": "#/components/schemas/ContainerExtraFields" }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "User defined additional fields for this order." }, "vehicle_category": { "anyOf": [ { "$ref": "#/components/schemas/VehicleCategory" }, { "type": "null" } ], "title": "Vehicle category" }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceExtraFields" }, { "type": "null" } ], "title": "Palletforce specific fields" }, "kuehne_nagel": { "anyOf": [ { "$ref": "#/components/schemas/KuehneNagelExtraFields" }, { "type": "null" } ], "title": "Kuehn Nagel specific fields" }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineExtraFields" }, { "type": "null" } ], "title": "Palletline specific fields" }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonOrderExtraFields" }, { "type": "null" } ], "title": "Transporeon specific fields" }, "dachser": { "anyOf": [ { "$ref": "#/components/schemas/DachserExtraFields" }, { "type": "null" } ], "title": "Dachser specific fields" }, "contact_emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Contact Emails", "description": "List of contact emails to notify about the order" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ImportExportExtraFields" }, { "type": "null" } ], "title": "Fields specific to import and export" }, "is_consignment_info_validated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Consignment Info Validated", "description": "Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it." }, "operation": { "$ref": "#/components/schemas/OperationEnum" }, "order_identifier": { "type": "string", "title": "Order Identifier", "description": "Identifier of the order when created from an external source" }, "import_configuration": { "anyOf": [ { "$ref": "#/components/schemas/ImportConfiguration" }, { "type": "null" } ], "description": "Additional import configuration", "default": { "code": "API" } }, "consignments": { "items": { "$ref": "#/components/schemas/ConsignmentInput-Output" }, "type": "array", "title": "Consignments" }, "customer": { "$ref": "#/components/schemas/Entity", "title": "Customer" }, "transport_network": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "title": "Transport network", "description": "Transport network within Qargo (Depot)" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/OrderPricingInput" }, { "type": "null" } ], "description": "Pricing fields related to order" }, "input_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Source", "description": "Source of this order input" }, "raw_input": { "anyOf": [ { "$ref": "#/components/schemas/RawInput" }, { "type": "null" } ], "description": "Original input document, for debugging purposes" }, "order_status": { "$ref": "#/components/schemas/OrderStatus", "description": "Status of the order", "default": "TO_PLAN" }, "setup_stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopInput-Output" }, "type": "array" }, { "type": "null" } ], "title": "Setup Stops", "description": "List of stops for a container export scenario" }, "teardown_stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopInput-Output" }, "type": "array" }, { "type": "null" } ], "title": "Teardown Stops", "description": "List of stops for a container import scenario" }, "container_load_unload_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopInput-Output" }, { "type": "null" } ], "title": "Container load/unload stop", "description": "This field practically maps to the container yard. `setup_stops` (for pick-up) and `teardown_stops` (for drop-off) are replacing this field, please use them instead.", "deprecated": true } }, "type": "object", "required": [ "operation", "order_identifier", "consignments", "customer" ], "title": "OrderExport" }, "OrderImport": { "properties": { "upload_id": { "type": "string", "format": "uuid", "title": "Upload Id", "description": "Unique identifier for the order import" }, "upload_status": { "$ref": "#/components/schemas/UploadStatus", "description": "Status of the order import" }, "upload_url": { "type": "string", "title": "Upload Url", "description": "URL to check the status of the order import, e.g. /v1/orders/order/upload/{upload_id}" }, "order_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Order Id", "description": "Unique identifier for the order, only available when it's an update to an existing order" }, "order_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Url", "description": "URL to check the status of the order, e.g. /v1/orders/order/{order_id}, only available when it's update to an existing order" } }, "type": "object", "required": [ "upload_id", "upload_status", "upload_url" ], "title": "OrderImport" }, "OrderImportExportInput": { "properties": { "incoterm": { "anyOf": [ { "$ref": "#/components/schemas/Incoterm" }, { "type": "null" } ] }, "mrns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Mrns" }, "ens_mrns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ens Mrns" }, "exs_mrns": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Exs Mrns" }, "ducrs": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ducrs" } }, "type": "object", "title": "OrderImportExportInput" }, "OrderImportResponse": { "properties": { "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorStatus" }, "type": "array" }, { "type": "null" } ], "title": "Errors", "description": "List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.", "examples": [ { "error_message": "The payload is invalid.", "error_type": "USER_INPUT_ERROR" }, { "error_message": "Not supported.", "error_type": "NOT_SUPPORTED" }, { "error_message": "Unknown error.", "error_type": "INTERNAL_ERROR" } ] } }, "type": "object", "title": "OrderImportResponse", "description": "Response schema for the order import webhook.\nThis schema is used to return errors or success messages." }, "OrderImportUpdate": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "type": { "type": "string", "const": "OrderImport", "title": "Type" }, "status": { "$ref": "#/components/schemas/VisibilityOrderImportStatus" }, "input_data": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Input Data", "description": "Parsed input data for the order import instance." } }, "type": "object", "required": [ "type", "status" ], "title": "OrderImportUpdate" }, "OrderInput": { "properties": { "transport_service": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "title": "Transport service", "description": "Transport service within Qargo" }, "customer_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order reference number from customer" }, "service_level": { "anyOf": [ { "$ref": "#/components/schemas/ServiceLevel" }, { "type": "null" } ] }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "department": { "anyOf": [ { "$ref": "#/components/schemas/Department" }, { "type": "null" } ], "description": "Department linked to order" }, "neutral_order_type": { "anyOf": [ { "type": "string", "enum": [ "NO_NEUTRAL_ORDER", "MASK_DELIVERY", "MASK_PICKUP" ] }, { "type": "null" } ], "title": "Neutral Order Type", "description": "Neutral order" }, "container": { "anyOf": [ { "$ref": "#/components/schemas/ContainerExtraFields" }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "User defined additional fields for this order." }, "vehicle_category": { "anyOf": [ { "$ref": "#/components/schemas/VehicleCategory" }, { "type": "null" } ], "title": "Vehicle category" }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceExtraFields" }, { "type": "null" } ], "title": "Palletforce specific fields" }, "kuehne_nagel": { "anyOf": [ { "$ref": "#/components/schemas/KuehneNagelExtraFields" }, { "type": "null" } ], "title": "Kuehn Nagel specific fields" }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineExtraFields" }, { "type": "null" } ], "title": "Palletline specific fields" }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonOrderExtraFields" }, { "type": "null" } ], "title": "Transporeon specific fields" }, "dachser": { "anyOf": [ { "$ref": "#/components/schemas/DachserExtraFields" }, { "type": "null" } ], "title": "Dachser specific fields" }, "contact_emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Contact Emails", "description": "List of contact emails to notify about the order" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ImportExportExtraFields" }, { "type": "null" } ], "title": "Fields specific to import and export" }, "is_consignment_info_validated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Consignment Info Validated", "description": "Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it." }, "operation": { "$ref": "#/components/schemas/OperationEnum" }, "order_identifier": { "type": "string", "title": "Order Identifier", "description": "Identifier of the order when created from an external source" }, "import_configuration": { "anyOf": [ { "$ref": "#/components/schemas/ImportConfiguration" }, { "type": "null" } ], "description": "Additional import configuration", "default": { "code": "API" } }, "consignments": { "items": { "$ref": "#/components/schemas/ConsignmentInput-Input" }, "type": "array", "title": "Consignments" }, "customer": { "$ref": "#/components/schemas/Entity", "title": "Customer" }, "transport_network": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "title": "Transport network", "description": "Transport network within Qargo (Depot)" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/OrderPricingInput" }, { "type": "null" } ], "description": "Pricing fields related to order" }, "input_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Source", "description": "Source of this order input" }, "raw_input": { "anyOf": [ { "$ref": "#/components/schemas/RawInput" }, { "type": "null" } ], "description": "Original input document, for debugging purposes" }, "order_status": { "$ref": "#/components/schemas/OrderStatus", "description": "Status of the order", "default": "TO_PLAN" }, "setup_stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopInput-Input" }, "type": "array" }, { "type": "null" } ], "title": "Setup Stops", "description": "List of stops for a container export scenario" }, "teardown_stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopInput-Input" }, "type": "array" }, { "type": "null" } ], "title": "Teardown Stops", "description": "List of stops for a container import scenario" }, "container_load_unload_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopInput-Input" }, { "type": "null" } ], "title": "Container load/unload stop", "description": "This field practically maps to the container yard. `setup_stops` (for pick-up) and `teardown_stops` (for drop-off) are replacing this field, please use them instead.", "deprecated": true } }, "type": "object", "required": [ "operation", "order_identifier", "consignments", "customer" ], "title": "OrderInput" }, "OrderMatch": { "properties": { "customer_reference_number": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "name": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "id": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] } }, "type": "object", "title": "OrderMatch" }, "OrderMetrics": { "properties": { "distance_empty_km": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Distance Empty Km", "description": "Distance in kilometers for empty vehicle" }, "distance_loaded_km": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Distance Loaded Km", "description": "Distance in kilometers for loaded vehicle" }, "distance_total_km": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Distance Total Km", "description": "Total distance in kilometers" } }, "type": "object", "title": "OrderMetrics" }, "OrderOutput-Input": { "properties": { "transport_service": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "title": "Transport service", "description": "Transport service within Qargo" }, "customer_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order reference number from customer" }, "service_level": { "anyOf": [ { "$ref": "#/components/schemas/ServiceLevel" }, { "type": "null" } ] }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "department": { "anyOf": [ { "$ref": "#/components/schemas/Department" }, { "type": "null" } ], "description": "Department linked to order" }, "neutral_order_type": { "anyOf": [ { "type": "string", "enum": [ "NO_NEUTRAL_ORDER", "MASK_DELIVERY", "MASK_PICKUP" ] }, { "type": "null" } ], "title": "Neutral Order Type", "description": "Neutral order" }, "container": { "anyOf": [ { "$ref": "#/components/schemas/ContainerExtraFields" }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "User defined additional fields for this order." }, "vehicle_category": { "anyOf": [ { "$ref": "#/components/schemas/VehicleCategory" }, { "type": "null" } ], "title": "Vehicle category" }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceExtraFields" }, { "type": "null" } ], "title": "Palletforce specific fields" }, "kuehne_nagel": { "anyOf": [ { "$ref": "#/components/schemas/KuehneNagelExtraFields" }, { "type": "null" } ], "title": "Kuehn Nagel specific fields" }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineExtraFields" }, { "type": "null" } ], "title": "Palletline specific fields" }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonOrderExtraFields" }, { "type": "null" } ], "title": "Transporeon specific fields" }, "dachser": { "anyOf": [ { "$ref": "#/components/schemas/DachserExtraFields" }, { "type": "null" } ], "title": "Dachser specific fields" }, "contact_emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Contact Emails", "description": "List of contact emails to notify about the order" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ImportExportExtraFields" }, { "type": "null" } ], "title": "Fields specific to import and export" }, "is_consignment_info_validated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Consignment Info Validated", "description": "Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it." }, "stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopOutput-Input" }, "type": "array" }, { "type": "null" } ], "title": "Stops", "description": "List of stops in the order, ordered by their sequence" }, "order_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Identifier", "description": "Identifier of the order when created from an external source" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for order" }, "consignments": { "items": { "$ref": "#/components/schemas/ConsignmentOutput-Input" }, "type": "array", "title": "Consignments" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/OrderPricingOutput" }, { "type": "null" } ], "description": "Pricing fields related to order" }, "customer": { "$ref": "#/components/schemas/CompanyOutput-Input", "title": "Customer" }, "created_by_user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By User", "description": "User who created the order" }, "created_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created Timestamp", "description": "Timestamp of creation" }, "start_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Input" }, { "type": "null" } ], "description": "First stop on this order" }, "end_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Input" }, { "type": "null" } ], "description": "Last stop on this order" }, "quote_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quote Name", "description": "Name of the quote" }, "container_load_unload_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Input" }, { "type": "null" } ], "title": "Container load/unload stop", "description": "This field practically maps to the container yard. `setup_stops` (for pick-up) and `teardown_stops` (for drop-off) are replacing this field, please use them instead.", "deprecated": true } }, "type": "object", "required": [ "id", "consignments", "customer" ], "title": "OrderOutput" }, "OrderOutput-Output": { "properties": { "transport_service": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "title": "Transport service", "description": "Transport service within Qargo" }, "customer_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order reference number from customer" }, "service_level": { "anyOf": [ { "$ref": "#/components/schemas/ServiceLevel" }, { "type": "null" } ] }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "department": { "anyOf": [ { "$ref": "#/components/schemas/Department" }, { "type": "null" } ], "description": "Department linked to order" }, "neutral_order_type": { "anyOf": [ { "type": "string", "enum": [ "NO_NEUTRAL_ORDER", "MASK_DELIVERY", "MASK_PICKUP" ] }, { "type": "null" } ], "title": "Neutral Order Type", "description": "Neutral order" }, "container": { "anyOf": [ { "$ref": "#/components/schemas/ContainerExtraFields" }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "User defined additional fields for this order." }, "vehicle_category": { "anyOf": [ { "$ref": "#/components/schemas/VehicleCategory" }, { "type": "null" } ], "title": "Vehicle category" }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceExtraFields" }, { "type": "null" } ], "title": "Palletforce specific fields" }, "kuehne_nagel": { "anyOf": [ { "$ref": "#/components/schemas/KuehneNagelExtraFields" }, { "type": "null" } ], "title": "Kuehn Nagel specific fields" }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineExtraFields" }, { "type": "null" } ], "title": "Palletline specific fields" }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonOrderExtraFields" }, { "type": "null" } ], "title": "Transporeon specific fields" }, "dachser": { "anyOf": [ { "$ref": "#/components/schemas/DachserExtraFields" }, { "type": "null" } ], "title": "Dachser specific fields" }, "contact_emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Contact Emails", "description": "List of contact emails to notify about the order" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ImportExportExtraFields" }, { "type": "null" } ], "title": "Fields specific to import and export" }, "is_consignment_info_validated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Consignment Info Validated", "description": "Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it." }, "stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopOutput-Output" }, "type": "array" }, { "type": "null" } ], "title": "Stops", "description": "List of stops in the order, ordered by their sequence" }, "order_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Identifier", "description": "Identifier of the order when created from an external source" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for order" }, "consignments": { "items": { "$ref": "#/components/schemas/ConsignmentOutput-Output" }, "type": "array", "title": "Consignments" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/OrderPricingOutput" }, { "type": "null" } ], "description": "Pricing fields related to order" }, "customer": { "$ref": "#/components/schemas/CompanyOutput-Output", "title": "Customer" }, "created_by_user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By User", "description": "User who created the order" }, "created_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created Timestamp", "description": "Timestamp of creation" }, "start_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Output" }, { "type": "null" } ], "description": "First stop on this order" }, "end_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Output" }, { "type": "null" } ], "description": "Last stop on this order" }, "quote_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quote Name", "description": "Name of the quote" }, "container_load_unload_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Output" }, { "type": "null" } ], "title": "Container load/unload stop", "description": "This field practically maps to the container yard. `setup_stops` (for pick-up) and `teardown_stops` (for drop-off) are replacing this field, please use them instead.", "deprecated": true } }, "type": "object", "required": [ "id", "consignments", "customer" ], "title": "OrderOutput" }, "OrderPricingInput": { "properties": { "requested_price": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Requested Price", "description": "Requested price" } }, "type": "object", "title": "OrderPricingInput" }, "OrderPricingOutput": { "properties": { "total_excl_tax": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Total Excl Tax", "description": "Total price excluding tax" }, "total_incl_tax": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Total Incl Tax", "description": "Total price including tax" }, "total_tax": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Total Tax", "description": "Total tax" }, "requested_price": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Requested Price", "description": "Requested price" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency", "description": "Currency code" }, "by_currency": { "additionalProperties": { "$ref": "#/components/schemas/OrderPricingTotalsOutput" }, "type": "object", "title": "By Currency", "description": "Pricing totals per currency, keyed by currency code. Each entry covers only the charges in that currency and does not repeat the currency code. Use these totals when the order has charges in more than one currency.", "examples": [ { "EUR": { "total_excl_tax": "100.00" } } ] } }, "type": "object", "title": "OrderPricingOutput" }, "OrderPricingTotalsOutput": { "properties": { "total_excl_tax": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Total Excl Tax", "description": "Total price excluding tax" }, "total_incl_tax": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Total Incl Tax", "description": "Total price including tax" }, "total_tax": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Total Tax", "description": "Total tax" } }, "type": "object", "title": "OrderPricingTotalsOutput" }, "OrderReference": { "properties": { "row_id": { "type": "string", "format": "uuid", "title": "Row Id", "description": "Identifier of the reference" } }, "type": "object", "required": [ "row_id" ], "title": "OrderReference" }, "OrderStatus": { "type": "string", "enum": [ "QUOTE", "TO_PLAN" ], "title": "OrderStatus" }, "OrderStatusStopOutput": { "properties": { "activity_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Activity Label", "description": "Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional freeform data for this stop" }, "reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "stop reference number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number" }, "mobile_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mobile Number" }, "time_window": { "anyOf": [ { "$ref": "#/components/schemas/TimeWindow" }, { "type": "null" } ], "title": "time_window" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopExtra" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Additional services/options for stop" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Additional user defined fields to fill in" }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "Requested date of the stop, as shown in the planning UI. Empty for stops without a requested date (e.g. standalone stops).", "examples": [ "2024-12-31" ] }, "depot": { "anyOf": [ { "$ref": "#/components/schemas/StopDepotOutput" }, { "type": "null" } ], "description": "Depot information for the stop. Only relevant for location bookings (load building)." }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for stop" }, "location": { "$ref": "#/components/schemas/LocationWithTerminalOutput-Output", "description": "Location of the stop" }, "mileage_km": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mileage Km", "description": "Mileage in kilometers" }, "end_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Timestamp", "description": "End of stop. The value depends on the stop status: the estimated end time until the stop reaches status COMPLETED, after which it is the actual end time reported during execution. ISO 8601 format in UTC.", "examples": [ "2024-12-31T08:15:00Z" ] }, "start_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Timestamp", "description": "Start of stop. The value depends on the stop status: the estimated start time until the stop reaches status AT_STOP, after which it is the actual start time reported during execution. ISO 8601 format in UTC.", "examples": [ "2024-12-31T08:00:00Z" ] }, "incidents": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Incident" }, "type": "array" }, { "type": "null" } ], "title": "Incidents", "description": "List of incidents" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "description": "Status of the stop. One of: TEMPLATE, BLOCKED, TO_PLAN, PLANNED, DISPATCHED, ROUTE_TO_STOP, AT_STOP, COMPLETED, CANCELLED, IGNORED.", "examples": [ "PLANNED" ] }, "consignment_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Consignment Id", "description": "ID of the consignment associated with this stop" }, "stop_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stop Type", "description": "Role of the stop in its consignment. One of: PICKUP, DELIVERY. Empty for other stops, such as drop/collect empty or resource setup stops.", "examples": [ "PICKUP" ] } }, "type": "object", "required": [ "id", "location" ], "title": "OrderStatusStopOutput" }, "OrderUpdate": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "type": { "type": "string", "const": "Order", "title": "Type" }, "update_type": { "$ref": "#/components/schemas/OrderUpdateType", "description": "Type of update:\n - STATUS: Status update, see status field\n - COST_APPROVAL_REQUEST: Cost approval request\n - CUSTOM: Custom event, see custom_event_code field\n", "default": "STATUS" }, "custom_event_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Event Code" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/VisibilityOrderStatus" }, { "type": "null" } ] } }, "type": "object", "required": [ "type" ], "title": "OrderUpdate", "description": "Send update event on order status change." }, "OrderUpdateData": { "properties": { "transport_service": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ] }, "transport_network": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ] }, "service_level": { "anyOf": [ { "$ref": "#/components/schemas/ServiceLevel" }, { "type": "null" } ] }, "customer": { "anyOf": [ { "$ref": "#/components/schemas/CustomerField" }, { "type": "null" } ] }, "customer_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Reference Number" }, "order_group": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ] }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions" }, "planning_group": { "anyOf": [ { "$ref": "#/components/schemas/PlanningGroup" }, { "type": "null" } ] }, "department": { "anyOf": [ { "$ref": "#/components/schemas/Department" }, { "type": "null" } ] }, "vehicle_category": { "anyOf": [ { "$ref": "#/components/schemas/VehicleCategory" }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "neutral_order_type": { "anyOf": [ { "type": "string", "enum": [ "NO_NEUTRAL_ORDER", "MASK_DELIVERY", "MASK_PICKUP" ] }, { "type": "null" } ], "title": "Neutral Order Type" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/UpdateOrderPricingInput" }, { "type": "null" } ] }, "container": { "anyOf": [ { "$ref": "#/components/schemas/ContainerOrderInput" }, { "type": "null" } ] }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceExtraFields" }, { "type": "null" } ] }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineExtraFields" }, { "type": "null" } ] }, "dachser": { "anyOf": [ { "$ref": "#/components/schemas/DachserExtraFields" }, { "type": "null" } ] }, "kuehne_nagel": { "anyOf": [ { "$ref": "#/components/schemas/KuehneNagelExtraFields" }, { "type": "null" } ] }, "chep": { "anyOf": [ { "$ref": "#/components/schemas/ChepOrderInput" }, { "type": "null" } ] }, "project44": { "anyOf": [ { "$ref": "#/components/schemas/Project44OrderInput" }, { "type": "null" } ] }, "shippeo": { "anyOf": [ { "$ref": "#/components/schemas/ShippeoOrderInput" }, { "type": "null" } ] }, "manuport": { "anyOf": [ { "$ref": "#/components/schemas/ManuportOrderInput" }, { "type": "null" } ] }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonOrderExtraFields" }, { "type": "null" } ] }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/OrderImportExportInput" }, { "type": "null" } ] }, "origin_country_of_goods": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Origin Country Of Goods" }, "destination_country_of_goods": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Destination Country Of Goods" }, "contact_emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Contact Emails" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, "type": "object", "title": "OrderUpdateData" }, "OrderUpdatePayload": { "properties": { "updates": { "items": { "$ref": "#/components/schemas/PartialOrderUpdate" }, "type": "array", "title": "Updates", "description": "List of orders to update" } }, "type": "object", "title": "OrderUpdatePayload" }, "OrderUpdateType": { "type": "string", "enum": [ "STATUS", "COST_APPROVAL_REQUEST", "CUSTOM" ], "title": "OrderUpdateType" }, "OrderWithStatus": { "properties": { "transport_service": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "title": "Transport service", "description": "Transport service within Qargo" }, "customer_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order reference number from customer" }, "service_level": { "anyOf": [ { "$ref": "#/components/schemas/ServiceLevel" }, { "type": "null" } ] }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "department": { "anyOf": [ { "$ref": "#/components/schemas/Department" }, { "type": "null" } ], "description": "Department linked to order" }, "neutral_order_type": { "anyOf": [ { "type": "string", "enum": [ "NO_NEUTRAL_ORDER", "MASK_DELIVERY", "MASK_PICKUP" ] }, { "type": "null" } ], "title": "Neutral Order Type", "description": "Neutral order" }, "container": { "anyOf": [ { "$ref": "#/components/schemas/ContainerExtraFields" }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "User defined additional fields for this order." }, "vehicle_category": { "anyOf": [ { "$ref": "#/components/schemas/VehicleCategory" }, { "type": "null" } ], "title": "Vehicle category" }, "palletforce": { "anyOf": [ { "$ref": "#/components/schemas/PalletforceExtraFields" }, { "type": "null" } ], "title": "Palletforce specific fields" }, "kuehne_nagel": { "anyOf": [ { "$ref": "#/components/schemas/KuehneNagelExtraFields" }, { "type": "null" } ], "title": "Kuehn Nagel specific fields" }, "palletline": { "anyOf": [ { "$ref": "#/components/schemas/PalletlineExtraFields" }, { "type": "null" } ], "title": "Palletline specific fields" }, "transporeon": { "anyOf": [ { "$ref": "#/components/schemas/TransporeonOrderExtraFields" }, { "type": "null" } ], "title": "Transporeon specific fields" }, "dachser": { "anyOf": [ { "$ref": "#/components/schemas/DachserExtraFields" }, { "type": "null" } ], "title": "Dachser specific fields" }, "contact_emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Contact Emails", "description": "List of contact emails to notify about the order" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ImportExportExtraFields" }, { "type": "null" } ], "title": "Fields specific to import and export" }, "is_consignment_info_validated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Consignment Info Validated", "description": "Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it." }, "stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OrderStatusStopOutput" }, "type": "array" }, { "type": "null" } ], "title": "Stops", "description": "List of stops in the order, ordered by their sequence" }, "order_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Identifier", "description": "Identifier of the order when created from an external source" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for order" }, "consignments": { "items": { "$ref": "#/components/schemas/OrderConsignmentOutput-Output" }, "type": "array", "title": "Consignments" }, "pricing": { "anyOf": [ { "$ref": "#/components/schemas/OrderPricingOutput" }, { "type": "null" } ], "description": "Pricing fields related to order" }, "customer": { "$ref": "#/components/schemas/CompanyOutput-Output", "title": "Customer" }, "created_by_user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By User", "description": "User who created the order" }, "created_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created Timestamp", "description": "Timestamp of creation" }, "start_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Output" }, { "type": "null" } ], "description": "First stop on this order" }, "end_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Output" }, { "type": "null" } ], "description": "Last stop on this order" }, "quote_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quote Name", "description": "Name of the quote" }, "shipments": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Shipment" }, "type": "array" }, { "type": "null" } ], "title": "Shipments", "description": "Shipment information" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "description": "Status of the order" }, "metrics": { "anyOf": [ { "$ref": "#/components/schemas/OrderMetrics" }, { "type": "null" } ], "description": "Metrics related to the order" }, "container_load_unload_stop": { "anyOf": [ { "$ref": "#/components/schemas/StopOutput-Output" }, { "type": "null" } ], "title": "Container load/unload stop", "description": "This field practically maps to the container yard. `setup_stops` (for pick-up) and `teardown_stops` (for drop-off) are replacing this field, please use them instead.", "deprecated": true } }, "additionalProperties": true, "type": "object", "required": [ "id", "consignments", "customer" ], "title": "OrderWithStatus" }, "PackagedItem-Input": { "properties": { "adr": { "anyOf": [ { "$ref": "#/components/schemas/ADR-Input" }, { "type": "null" } ] }, "waste": { "anyOf": [ { "$ref": "#/components/schemas/PackagedItemWaste-Input" }, { "type": "null" } ] }, "barcodes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Barcodes", "description": "List of barcodes associated with the packaged item" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/PackagedItemsImportExportExtraFields" }, { "type": "null" } ] }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/PackagingType" }, { "type": "null" } ], "description": "Packaging type, for example Pallet" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity", "description": "Quantity of packaged items" }, "total_net_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Net Weight Kg", "description": "Total net weight of packaged items in KG" }, "total_volume_l": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Volume L", "description": "Total volume of packaged items in liter" }, "total_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Weight Kg", "description": "Total weight of packaged items in KG" }, "unit_height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Height M" }, "unit_length_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Length M" }, "unit_width_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Width M" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the packaged item" } }, "type": "object", "title": "PackagedItem", "description": "Synonym: GoodItem" }, "PackagedItem-Output": { "properties": { "adr": { "anyOf": [ { "$ref": "#/components/schemas/ADR-Output" }, { "type": "null" } ] }, "waste": { "anyOf": [ { "$ref": "#/components/schemas/PackagedItemWaste-Output" }, { "type": "null" } ] }, "barcodes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Barcodes", "description": "List of barcodes associated with the packaged item" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/PackagedItemsImportExportExtraFields" }, { "type": "null" } ] }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/PackagingType" }, { "type": "null" } ], "description": "Packaging type, for example Pallet" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity", "description": "Quantity of packaged items" }, "total_net_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Net Weight Kg", "description": "Total net weight of packaged items in KG" }, "total_volume_l": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Volume L", "description": "Total volume of packaged items in liter" }, "total_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Weight Kg", "description": "Total weight of packaged items in KG" }, "unit_height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Height M" }, "unit_length_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Length M" }, "unit_width_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Width M" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the packaged item" } }, "type": "object", "title": "PackagedItem", "description": "Synonym: GoodItem" }, "PackagedItemCommercialInvoiceExtraField": { "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "Value of the commercial invoice" } }, "type": "object", "title": "PackagedItemCommercialInvoiceExtraField" }, "PackagedItemInput": { "properties": { "adr": { "anyOf": [ { "$ref": "#/components/schemas/ADRInput" }, { "type": "null" } ] }, "waste": { "anyOf": [ { "$ref": "#/components/schemas/PackagedItemWasteInput" }, { "type": "null" } ] }, "barcodes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Barcodes", "description": "List of barcodes associated with the packaged item." }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity" }, "total_volume_l": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Volume L" }, "total_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Weight Kg" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/ImportExportInput" }, { "type": "null" } ] } }, "type": "object", "title": "PackagedItemInput" }, "PackagedItemOutput-Input": { "properties": { "adr": { "anyOf": [ { "$ref": "#/components/schemas/ADR-Input" }, { "type": "null" } ] }, "waste": { "anyOf": [ { "$ref": "#/components/schemas/PackagedItemWaste-Input" }, { "type": "null" } ] }, "barcodes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Barcodes", "description": "List of barcodes associated with the packaged item" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/PackagedItemsImportExportExtraFields" }, { "type": "null" } ] }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/PackagingType" }, { "type": "null" } ], "description": "Packaging type, for example Pallet" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity", "description": "Quantity of packaged items" }, "total_net_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Net Weight Kg", "description": "Total net weight of packaged items in KG" }, "total_volume_l": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Volume L", "description": "Total volume of packaged items in liter" }, "total_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Weight Kg", "description": "Total weight of packaged items in KG" }, "unit_height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Height M" }, "unit_length_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Length M" }, "unit_width_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Width M" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the packaged item" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for this packaged item" } }, "type": "object", "required": [ "id" ], "title": "PackagedItemOutput" }, "PackagedItemOutput-Output": { "properties": { "adr": { "anyOf": [ { "$ref": "#/components/schemas/ADR-Output" }, { "type": "null" } ] }, "waste": { "anyOf": [ { "$ref": "#/components/schemas/PackagedItemWaste-Output" }, { "type": "null" } ] }, "barcodes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Barcodes", "description": "List of barcodes associated with the packaged item" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "import_export": { "anyOf": [ { "$ref": "#/components/schemas/PackagedItemsImportExportExtraFields" }, { "type": "null" } ] }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/PackagingType" }, { "type": "null" } ], "description": "Packaging type, for example Pallet" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity", "description": "Quantity of packaged items" }, "total_net_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Net Weight Kg", "description": "Total net weight of packaged items in KG" }, "total_volume_l": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Volume L", "description": "Total volume of packaged items in liter" }, "total_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Weight Kg", "description": "Total weight of packaged items in KG" }, "unit_height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Height M" }, "unit_length_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Length M" }, "unit_width_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Width M" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the packaged item" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for this packaged item" } }, "type": "object", "required": [ "id" ], "title": "PackagedItemOutput" }, "PackagedItemWaste-Input": { "properties": { "ewc": { "anyOf": [ { "$ref": "#/components/schemas/EWC" }, { "type": "null" } ], "description": "The European Waste Catalogue entry classifying this waste." }, "consistency": { "anyOf": [ { "items": { "$ref": "#/components/schemas/WasteConsistence" }, "type": "array" }, { "type": "null" } ], "title": "Consistency", "description": "Physical state of the waste. More than one value can apply." }, "persistent_organic_pollutants": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Persistent Organic Pollutants", "description": "Whether the waste contains persistent organic pollutants (POPs)." }, "processing_operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Processing Operation", "description": "Recovery or disposal operation code (R/D code).", "examples": [ "R1" ] }, "emitter_type": { "anyOf": [ { "$ref": "#/components/schemas/WasteEmitterType" }, { "type": "null" } ], "description": "Who is producing the waste: the producer itself, a collection round (`APPENDIX1`), a producer on a collection round (`APPENDIX1_PRODUCER`), a regrouping (`APPENDIX2`), or another holder." } }, "type": "object", "title": "PackagedItemWaste" }, "PackagedItemWaste-Output": { "properties": { "ewc": { "anyOf": [ { "$ref": "#/components/schemas/EWC" }, { "type": "null" } ], "description": "The European Waste Catalogue entry classifying this waste." }, "consistency": { "anyOf": [ { "items": { "$ref": "#/components/schemas/WasteConsistence" }, "type": "array" }, { "type": "null" } ], "title": "Consistency", "description": "Physical state of the waste. More than one value can apply." }, "persistent_organic_pollutants": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Persistent Organic Pollutants", "description": "Whether the waste contains persistent organic pollutants (POPs)." }, "processing_operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Processing Operation", "description": "Recovery or disposal operation code (R/D code).", "examples": [ "R1" ] }, "emitter_type": { "anyOf": [ { "$ref": "#/components/schemas/WasteEmitterType" }, { "type": "null" } ], "description": "Who is producing the waste: the producer itself, a collection round (`APPENDIX1`), a producer on a collection round (`APPENDIX1_PRODUCER`), a regrouping (`APPENDIX2`), or another holder." } }, "type": "object", "title": "PackagedItemWaste" }, "PackagedItemWasteInput": { "properties": { "ewc": { "anyOf": [ { "$ref": "#/components/schemas/EWCInput" }, { "type": "null" } ], "description": "The European Waste Catalogue entry classifying this waste." }, "consistency": { "anyOf": [ { "items": { "type": "string", "enum": [ "SOLID", "LIQUID", "GASEOUS", "DOUGHY" ] }, "type": "array" }, { "type": "null" } ], "title": "Consistency", "description": "Physical state of the waste. More than one value can apply." }, "persistent_organic_pollutants": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Persistent Organic Pollutants", "description": "Whether the waste contains persistent organic pollutants (POPs)." }, "processing_operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Processing Operation", "description": "Recovery or disposal operation code (R/D code).", "examples": [ "R1" ] }, "emitter_type": { "anyOf": [ { "type": "string", "enum": [ "PRODUCER", "OTHER", "APPENDIX1", "APPENDIX1_PRODUCER", "APPENDIX2" ] }, { "type": "null" } ], "title": "Emitter Type", "description": "Who is producing the waste: the producer itself, a collection round (`APPENDIX1`), a producer on a collection round (`APPENDIX1_PRODUCER`), a regrouping (`APPENDIX2`), or another holder." } }, "type": "object", "title": "PackagedItemWasteInput" }, "PackagedItemsImportExportExtraFields": { "properties": { "hs_code_import": { "anyOf": [ { "$ref": "#/components/schemas/HSCode" }, { "type": "null" } ], "description": "Harmonized System Code for importing the good" }, "hs_code_export": { "anyOf": [ { "$ref": "#/components/schemas/HSCode" }, { "type": "null" } ], "description": "Harmonized System Code for exporting the good" }, "shipping_marks": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Shipping Marks", "description": "Shipping marks for the good" }, "commercial_invoice": { "anyOf": [ { "$ref": "#/components/schemas/PackagedItemCommercialInvoiceExtraField" }, { "type": "null" } ] }, "sps_flag": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sps Flag", "description": "Sanitary & phytosanitary flag" }, "sps_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sps Reference", "description": "CHED / IPAFFS reference" }, "ggb_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ggb Reference", "description": "GGB reference (NL only)" } }, "type": "object", "title": "PackagedItemsImportExportExtraFields" }, "PackagingSize": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable identifier" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Machine readable identifier" }, "height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Height M", "description": "Height in meters" }, "length_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Length M", "description": "Length in meters" }, "width_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Width M", "description": "Width in meters" }, "weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weight Kg", "description": "Weight in kg" }, "loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Loading Meters", "description": "Loading meters" }, "pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pallet Spaces", "description": "Pallet spaces" } }, "type": "object", "title": "PackagingSize" }, "PackagingType": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable identifier" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Machine readable identifier" }, "export_alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Export Alias", "description": "Alias defined in the Qargo config" }, "packaging_size": { "anyOf": [ { "$ref": "#/components/schemas/PackagingSize" }, { "type": "null" } ], "description": "Size of packaging, for example Europallet" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" } }, "type": "object", "title": "PackagingType" }, "PalletTrackConsignmentInput": { "properties": { "tracking_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tracking Code" }, "job_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Job Number" } }, "type": "object", "title": "PalletTrackConsignmentInput" }, "PalletXpressIeConsignmentInput": { "properties": { "job_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Job Number" } }, "type": "object", "title": "PalletXpressIeConsignmentInput" }, "PalletforceConsignmentExtraFields": { "properties": { "palletforce_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Palletforce Id", "description": "Palletforce ID" } }, "type": "object", "title": "PalletforceConsignmentExtraFields" }, "PalletforceConsignmentInput": { "properties": { "customer_account_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Account Number" }, "palletforce_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Palletforce Id" } }, "type": "object", "title": "PalletforceConsignmentInput" }, "PalletforceExtraFields": { "properties": { "ni_company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ni Company Name", "description": "Northern Ireland company name" }, "ni_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ni Description", "description": "Northern Ireland shipping info" }, "ni_gbeori": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ni Gbeori", "description": "Northern Ireland GBEORI" }, "ni_tss_job_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ni Tss Job Reference", "description": "Northern Ireland TSS JON reference" }, "ni_tss_registration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ni Tss Registration", "description": "Northern Ireland TSS registration" } }, "type": "object", "title": "PalletforceExtraFields" }, "PalletlineConsignmentExtraFields": { "properties": { "palletline_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Palletline Id", "description": "Palletline ID" } }, "type": "object", "title": "PalletlineConsignmentExtraFields" }, "PalletlineConsignmentInput": { "properties": { "palletline_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Palletline Id" }, "third_party_label_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Third Party Label Id" } }, "type": "object", "title": "PalletlineConsignmentInput" }, "PalletlineExtraFields": { "properties": { "terms_of_carriage": { "anyOf": [ { "type": "string", "enum": [ "1300", "5000", "10000", "cmr", "other" ] }, { "type": "null" } ], "title": "Terms Of Carriage" } }, "type": "object", "title": "PalletlineExtraFields" }, "PalletwaysConsignmentInput": { "properties": { "tracking_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tracking Id" }, "consignment_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consignment Number" } }, "type": "object", "title": "PalletwaysConsignmentInput" }, "PartialBaseResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "resource_group": { "anyOf": [ { "$ref": "#/components/schemas/ResourceGroupReference" }, { "type": "null" } ], "description": "Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see `resource_groups` on the resource); this field manages only its primary allocation." } }, "type": "object", "title": "PartialBaseResourceInput" }, "PartialChassisResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "chassis": { "anyOf": [ { "$ref": "#/components/schemas/ChassisProperties-Input" }, { "type": "null" } ], "description": "Chassis specific properties" }, "resource_group": { "anyOf": [ { "$ref": "#/components/schemas/ResourceGroupReference" }, { "type": "null" } ], "description": "Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see `resource_groups` on the resource); this field manages only its primary allocation." } }, "type": "object", "title": "PartialChassisResourceInput" }, "PartialDriverResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "driver": { "anyOf": [ { "$ref": "#/components/schemas/DriverProperties" }, { "type": "null" } ], "description": "Driver specific properties" }, "resource_group": { "anyOf": [ { "$ref": "#/components/schemas/ResourceGroupReference" }, { "type": "null" } ], "description": "Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see `resource_groups` on the resource); this field manages only its primary allocation." } }, "type": "object", "title": "PartialDriverResourceInput" }, "PartialFullTrailerResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "full_trailer": { "anyOf": [ { "$ref": "#/components/schemas/TrailerProperties-Input" }, { "type": "null" } ], "description": "Trailer specific properties" }, "resource_group": { "anyOf": [ { "$ref": "#/components/schemas/ResourceGroupReference" }, { "type": "null" } ], "description": "Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see `resource_groups` on the resource); this field manages only its primary allocation." } }, "type": "object", "title": "PartialFullTrailerResourceInput" }, "PartialLocationDetailInput": { "properties": { "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latitude", "description": "Latitude of the location.", "examples": [ 51.0543 ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Longitude", "description": "Longitude of the location.", "examples": [ 3.7174 ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Free-text description of the location." }, "selectable_on_customer_portal": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Selectable On Customer Portal", "description": "Whether the location can be selected on the customer portal." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Technical code for integrations/mapping logic; should be treated as stable once set.", "examples": [ "LOC123" ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Human-readable label for a location in operational views.", "examples": [ "Main Office" ] }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "Identifier from an external (master data) system." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "First address line of the location", "examples": [ "Gaston Crommenlaan 4" ] }, "address_second_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Second Line", "description": "Second address line of the location", "examples": [ "" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City of the location", "examples": [ "Ghent" ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "State of the location", "examples": [ "" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country code (ISO 3166-1 alpha-2) of the location", "examples": [ "BE" ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code", "description": "Postal code of the location", "examples": [ "9050" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the location", "examples": [ "Qargo HQ" ] }, "opening_hours": { "anyOf": [ { "$ref": "#/components/schemas/WeekScheduleInput" }, { "type": "null" } ], "description": "Weekly opening hours for all seven days. Replaces the full schedule when provided." } }, "type": "object", "title": "PartialLocationDetailInput" }, "PartialOrderConsignment": { "properties": { "updates": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PartialOrderConsignmentUpdate" }, "type": "array" }, { "type": "null" } ], "title": "Updates" } }, "type": "object", "title": "PartialOrderConsignment" }, "PartialOrderConsignmentMatchInput": { "properties": { "consignment": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentMatch" }, { "type": "null" } ] } }, "type": "object", "title": "PartialOrderConsignmentMatchInput" }, "PartialOrderConsignmentMatchTarget": { "properties": { "matches_all": { "items": { "$ref": "#/components/schemas/PartialOrderConsignmentMatchInput" }, "type": "array", "title": "Matches All" } }, "type": "object", "title": "PartialOrderConsignmentMatchTarget" }, "PartialOrderConsignmentUpdate": { "properties": { "match": { "anyOf": [ { "$ref": "#/components/schemas/PartialOrderConsignmentMatchTarget" }, { "type": "null" } ] }, "good": { "anyOf": [ { "$ref": "#/components/schemas/PartialOrderGood" }, { "type": "null" } ] }, "stop": { "anyOf": [ { "$ref": "#/components/schemas/PartialOrderStop" }, { "type": "null" } ] }, "question_answers": { "type": "object", "title": "Question Answers", "description": "Question answers to update on the consignment. Mapping is configured in Qargo" }, "update": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentEntityUpdate" }, { "type": "null" } ] } }, "type": "object", "title": "PartialOrderConsignmentUpdate" }, "PartialOrderGood": { "properties": { "updates": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PartialOrderGoodUpdate" }, "type": "array" }, { "type": "null" } ], "title": "Updates" } }, "type": "object", "title": "PartialOrderGood" }, "PartialOrderGoodMatchInput": { "properties": { "good": { "anyOf": [ { "$ref": "#/components/schemas/GoodMatch" }, { "type": "null" } ] } }, "type": "object", "title": "PartialOrderGoodMatchInput" }, "PartialOrderGoodMatchTarget": { "properties": { "matches_all": { "items": { "$ref": "#/components/schemas/PartialOrderGoodMatchInput" }, "type": "array", "title": "Matches All" } }, "type": "object", "title": "PartialOrderGoodMatchTarget" }, "PartialOrderGoodTrace": { "properties": { "updates": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PartialOrderGoodTraceUpdate" }, "type": "array" }, { "type": "null" } ], "title": "Updates" } }, "type": "object", "title": "PartialOrderGoodTrace" }, "PartialOrderGoodTraceMatchInput": { "properties": { "handling_unit": { "anyOf": [ { "$ref": "#/components/schemas/HandlingUnitMatch" }, { "type": "null" } ] } }, "type": "object", "title": "PartialOrderGoodTraceMatchInput" }, "PartialOrderGoodTraceMatchTarget": { "properties": { "matches_all": { "items": { "$ref": "#/components/schemas/PartialOrderGoodTraceMatchInput" }, "type": "array", "title": "Matches All" } }, "type": "object", "title": "PartialOrderGoodTraceMatchTarget" }, "PartialOrderGoodTraceUpdate": { "properties": { "match": { "anyOf": [ { "$ref": "#/components/schemas/PartialOrderGoodTraceMatchTarget" }, { "type": "null" } ] }, "question_answers": { "type": "object", "title": "Question Answers", "description": "Question answers to update on the handling unit. Mapping is configured in Qargo" }, "update": { "anyOf": [ { "$ref": "#/components/schemas/HandlingUnitEntityUpdate" }, { "type": "null" } ] } }, "type": "object", "title": "PartialOrderGoodTraceUpdate" }, "PartialOrderGoodUpdate": { "properties": { "match": { "anyOf": [ { "$ref": "#/components/schemas/PartialOrderGoodMatchTarget" }, { "type": "null" } ] }, "handling_unit": { "anyOf": [ { "$ref": "#/components/schemas/PartialOrderGoodTrace" }, { "type": "null" } ] }, "question_answers": { "type": "object", "title": "Question Answers", "description": "Question answers to update on the good. Mapping is configured in Qargo" }, "update": { "anyOf": [ { "$ref": "#/components/schemas/GoodEntityUpdate" }, { "type": "null" } ] } }, "type": "object", "title": "PartialOrderGoodUpdate" }, "PartialOrderMatchInput": { "properties": { "order": { "anyOf": [ { "$ref": "#/components/schemas/OrderMatch" }, { "type": "null" } ] }, "company": { "anyOf": [ { "$ref": "#/components/schemas/CompanyMatch" }, { "type": "null" } ] } }, "type": "object", "title": "PartialOrderMatchInput" }, "PartialOrderMatchTarget": { "properties": { "matches_all": { "items": { "$ref": "#/components/schemas/PartialOrderMatchInput" }, "type": "array", "title": "Matches All" } }, "type": "object", "title": "PartialOrderMatchTarget" }, "PartialOrderStop": { "properties": { "updates": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PartialOrderStopUpdate" }, "type": "array" }, { "type": "null" } ], "title": "Updates" } }, "type": "object", "title": "PartialOrderStop" }, "PartialOrderStopMatchInput": { "properties": { "stop": { "anyOf": [ { "$ref": "#/components/schemas/StopMatch" }, { "type": "null" } ] } }, "type": "object", "title": "PartialOrderStopMatchInput" }, "PartialOrderStopMatchTarget": { "properties": { "matches_all": { "items": { "$ref": "#/components/schemas/PartialOrderStopMatchInput" }, "type": "array", "title": "Matches All" } }, "type": "object", "title": "PartialOrderStopMatchTarget" }, "PartialOrderStopUpdate": { "properties": { "match": { "anyOf": [ { "$ref": "#/components/schemas/PartialOrderStopMatchTarget" }, { "type": "null" } ] }, "question_answers": { "type": "object", "title": "Question Answers", "description": "Question answers to update on the stop. Mapping is configured in Qargo" }, "update": { "anyOf": [ { "$ref": "#/components/schemas/StopEntityUpdate" }, { "type": "null" } ] } }, "type": "object", "title": "PartialOrderStopUpdate" }, "PartialOrderUpdate": { "properties": { "match": { "anyOf": [ { "$ref": "#/components/schemas/PartialOrderMatchTarget" }, { "type": "null" } ], "description": "Matching criteria for the order to update" }, "consignment": { "anyOf": [ { "$ref": "#/components/schemas/PartialOrderConsignment" }, { "type": "null" } ] }, "question_answers": { "type": "object", "title": "Question Answers", "description": "Question answers to update on the order. Mapping is configured in Qargo" }, "update": { "anyOf": [ { "$ref": "#/components/schemas/OrderEntityUpdate" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Replaced by `match > order > id`. Please use `match > order > id` instead", "deprecated": true } }, "type": "object", "title": "PartialOrderUpdate" }, "PartialOrderUpdateResponse": { "properties": { "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorStatus" }, "type": "array" }, { "type": "null" } ], "title": "Errors", "description": "List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.", "examples": [ { "error_message": "The payload is invalid.", "error_type": "USER_INPUT_ERROR" }, { "error_message": "Not supported.", "error_type": "NOT_SUPPORTED" }, { "error_message": "Unknown error.", "error_type": "INTERNAL_ERROR" } ] } }, "type": "object", "title": "PartialOrderUpdateResponse", "description": "Response schema for the partial order update webhook.\nThis schema is used to return errors or success messages." }, "PartialTractorResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "tractor": { "anyOf": [ { "$ref": "#/components/schemas/TractorProperties-Input" }, { "type": "null" } ], "description": "Tractor specific properties" }, "resource_group": { "anyOf": [ { "$ref": "#/components/schemas/ResourceGroupReference" }, { "type": "null" } ], "description": "Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see `resource_groups` on the resource); this field manages only its primary allocation." } }, "type": "object", "title": "PartialTractorResourceInput" }, "PartialTrailerResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "trailer": { "anyOf": [ { "$ref": "#/components/schemas/TrailerProperties-Input" }, { "type": "null" } ], "description": "Trailer specific properties" }, "resource_group": { "anyOf": [ { "$ref": "#/components/schemas/ResourceGroupReference" }, { "type": "null" } ], "description": "Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see `resource_groups` on the resource); this field manages only its primary allocation." } }, "type": "object", "title": "PartialTrailerResourceInput" }, "PartialTruckResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "truck": { "anyOf": [ { "$ref": "#/components/schemas/TruckProperties-Input" }, { "type": "null" } ], "description": "Truck specific properties" }, "resource_group": { "anyOf": [ { "$ref": "#/components/schemas/ResourceGroupReference" }, { "type": "null" } ], "description": "Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see `resource_groups` on the resource); this field manages only its primary allocation." } }, "type": "object", "title": "PartialTruckResourceInput" }, "PartialVanResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource. Omit to leave the current value unchanged; send `\"\"` to clear it. Despite the `\"\"` default shown, omitting the field does not clear it.", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "van": { "anyOf": [ { "$ref": "#/components/schemas/VanProperties-Input" }, { "type": "null" } ], "description": "Van specific properties" }, "resource_group": { "anyOf": [ { "$ref": "#/components/schemas/ResourceGroupReference" }, { "type": "null" } ], "description": "Resource group to allocate the resource to. Set to null to remove the resource from its current group; omit the field to leave the allocation unchanged. A resource can belong to multiple groups (see `resource_groups` on the resource); this field manages only its primary allocation." } }, "type": "object", "title": "PartialVanResourceInput" }, "PaymentStatus": { "type": "string", "enum": [ "UNPAID", "PAID" ], "title": "PaymentStatus" }, "PaymentStatusUpdate": { "properties": { "status": { "$ref": "#/components/schemas/PaymentStatus" } }, "type": "object", "required": [ "status" ], "title": "PaymentStatusUpdate" }, "PaymentTermCode": { "type": "string", "enum": [ "END_OF_MONTH_2", "END_OF_MONTH_1", "END_OF_MONTH_0_NET_90", "END_OF_MONTH_0_NET_75", "END_OF_MONTH_0_NET_70", "END_OF_MONTH_0_NET_65", "END_OF_MONTH_0_NET_60", "END_OF_MONTH_0_NET_50", "END_OF_MONTH_0_NET_45", "END_OF_MONTH_0_NET_35", "END_OF_MONTH_0_NET_31", "END_OF_MONTH_0_NET_30", "END_OF_MONTH_0_NET_25", "END_OF_MONTH_0_NET_21", "END_OF_MONTH_0_NET_20", "END_OF_MONTH_0_NET_14", "END_OF_MONTH_0_NET_7", "END_OF_MONTH_0_NET_1", "END_OF_MONTH_0", "PREPAID", "CUSTOM_DUE_DATE", "UPON_RECEIPT", "NET_1", "NET_2", "NET_3", "NET_5", "NET_7", "NET_8", "NET_10", "NET_12", "NET_14", "NET_15", "NET_20", "NET_21", "NET_28", "NET_30", "NET_35", "NET_40", "NET_42", "NET_45", "NET_48", "NET_49", "NET_50", "NET_52", "NET_55", "NET_56", "NET_60", "NET_63", "NET_70", "NET_75", "NET_77", "NET_80", "NET_84", "NET_90", "NET_91", "NET_98", "NET_120" ], "title": "PaymentTermCode" }, "PlanningGroup": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the planning group" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the planning group" } }, "type": "object", "title": "PlanningGroup" }, "Plugging": { "properties": { "on_place_of_loading": { "type": "boolean", "title": "On Place Of Loading", "description": "Whether the unit is plugged in for power at the place of loading.", "default": false }, "on_vessel": { "type": "boolean", "title": "On Vessel", "description": "Whether the unit is plugged in for power while on the vessel.", "default": false }, "on_place_of_unloading": { "type": "boolean", "title": "On Place Of Unloading", "description": "Whether the unit is plugged in for power at the place of unloading.", "default": false } }, "type": "object", "title": "Plugging" }, "Position": { "properties": { "longitude": { "type": "number", "title": "Longitude", "description": "The longitude of the position" }, "latitude": { "type": "number", "title": "Latitude", "description": "The latitude of the position" } }, "type": "object", "required": [ "longitude", "latitude" ], "title": "Position" }, "PositionUpdate": { "properties": { "type": { "type": "string", "const": "Position", "title": "Type" }, "position": { "$ref": "#/components/schemas/Position" } }, "type": "object", "required": [ "type", "position" ], "title": "PositionUpdate", "description": "Send update event on resource (driver, vehicle, subcontractor) position update.\n\nSpec only, under development 🚧\"," }, "PriceListItemReference": { "properties": { "code": { "type": "string", "title": "Code", "description": "Code of the reference" } }, "type": "object", "required": [ "code" ], "title": "PriceListItemReference" }, "Product": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable identifier" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Machine readable identifier" }, "product_type": { "anyOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "null" } ], "description": "Product type" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" } }, "type": "object", "title": "Product" }, "Project44ConsignmentInput": { "properties": { "bill_of_lading": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bill Of Lading" }, "order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Id" } }, "type": "object", "title": "Project44ConsignmentInput" }, "Project44OrderInput": { "properties": { "bill_of_lading": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bill Of Lading" }, "order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Id" } }, "type": "object", "title": "Project44OrderInput" }, "PurchaseCompanyFields-Input": { "properties": { "payment_term": { "anyOf": [ { "$ref": "#/components/schemas/BasePaymentTerm" }, { "type": "null" } ], "description": "Payment term information of the company" }, "billing_entities": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CompanyBillingEntity" }, "type": "array" }, { "type": "null" } ], "title": "Billing Entities", "description": "List of billing entities associated with the company" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/SubcontractorStatus" }, { "type": "null" } ], "description": "The status indicates whether an order can be linked to this subcontractor. The available statuses are: \n - `NOT_APPROVED`: The subcontractor is not yet approved.\n - `APPROVED`: The subcontractor is approved.\n - `WARNING`: The subcontractor is approved, but a warning is triggered.\n - `BLOCKED`: The subcontractor is blocked; no new orders can be assigned.", "default": "APPROVED", "examples": [ "APPROVED" ] } }, "type": "object", "title": "PurchaseCompanyFields" }, "PurchaseCompanyFields-Output": { "properties": { "payment_term": { "anyOf": [ { "$ref": "#/components/schemas/BasePaymentTerm" }, { "type": "null" } ], "description": "Payment term information of the company" }, "billing_entities": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CompanyBillingEntity" }, "type": "array" }, { "type": "null" } ], "title": "Billing Entities", "description": "List of billing entities associated with the company" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/SubcontractorStatus" }, { "type": "null" } ], "description": "The status indicates whether an order can be linked to this subcontractor. The available statuses are: \n - `NOT_APPROVED`: The subcontractor is not yet approved.\n - `APPROVED`: The subcontractor is approved.\n - `WARNING`: The subcontractor is approved, but a warning is triggered.\n - `BLOCKED`: The subcontractor is blocked; no new orders can be assigned.", "default": "APPROVED", "examples": [ "APPROVED" ] } }, "type": "object", "title": "PurchaseCompanyFields" }, "PurchaseCreditNote": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "name": { "type": "string", "title": "Name", "examples": [ "Credit-Note-0001" ] }, "external_name": { "type": "string", "title": "External Name", "description": "Reference from crediting party" }, "date": { "type": "string", "format": "date", "title": "Date", "description": "invoice date", "examples": [ "2022-01-01" ] }, "booking_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Booking Date", "description": "booking date needs to be enabled else this will default to the date field", "examples": [ "2021-12-22" ] }, "currency": { "type": "string", "title": "Currency", "examples": [ "EUR" ] }, "exchange_rate": { "anyOf": [ { "$ref": "#/components/schemas/ExchangeRate" }, { "type": "null" } ] }, "total_excl_tax": { "type": "string", "title": "Total Excl Tax", "examples": [ "100" ] }, "total_incl_tax": { "type": "string", "title": "Total Incl Tax", "examples": [ "121" ] }, "total_tax": { "type": "string", "title": "Total Tax", "examples": [ "21" ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "default": {} }, "supplier": { "$ref": "#/components/schemas/CompanySummaryOutput" }, "customer_reference_numbers": { "items": { "type": "string" }, "type": "array", "title": "Customer Reference Numbers", "examples": [ [ "12345" ] ] }, "line_items": { "items": { "$ref": "#/components/schemas/LineItem" }, "type": "array", "title": "Line Items" }, "billing_entity": { "$ref": "#/components/schemas/BillingEntity", "description": "Billing entity linked to this credit note." } }, "type": "object", "required": [ "name", "external_name", "date", "currency", "total_excl_tax", "total_incl_tax", "total_tax", "supplier", "line_items", "billing_entity" ], "title": "PurchaseCreditNote" }, "PurchaseCreditNoteInput": { "properties": { "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields." } }, "type": "object", "title": "PurchaseCreditNoteInput" }, "PurchaseCreditNoteStatusUpdate": { "properties": { "type": { "type": "string", "const": "PurchaseCreditNote", "title": "Type" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the invoice or credit note" }, "status": { "$ref": "#/components/schemas/CreditNoteStatus" } }, "type": "object", "required": [ "type", "id", "status" ], "title": "PurchaseCreditNoteStatusUpdate" }, "PurchaseECreditNoteInput": { "properties": { "name": { "type": "string", "title": "Name", "description": "Reference from invoicing party.", "examples": [ "Invoice-0001" ] }, "date": { "type": "string", "format": "date", "title": "Date", "description": "Invoice transaction date.", "examples": [ "2022-01-01" ] }, "currency": { "type": "string", "title": "Currency", "description": "Currency code of the e-invoice.", "examples": [ "EUR" ] }, "exchange_rate": { "anyOf": [ { "$ref": "#/components/schemas/ExchangeRate" }, { "type": "null" } ], "description": "Exchange rate information if applicable." }, "total_excl_tax": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Total Excl Tax", "description": "Total amount excluding tax for the e-invoice.", "examples": [ "100" ] }, "total_incl_tax": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Total Incl Tax", "description": "Total amount including tax for the e-invoice.", "examples": [ "121" ] }, "total_tax": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Total Tax", "description": "Total tax amount for the e-invoice.", "examples": [ "21" ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Custom fields associated with this e-invoice." }, "supplier": { "$ref": "#/components/schemas/EInvoiceCompanyInput", "description": "Supplier company information." }, "customer_reference_numbers": { "items": { "type": "string" }, "type": "array", "title": "Customer Reference Numbers", "description": "Reference numbers used to match the invoice.", "examples": [ [ "12345" ] ] }, "line_items": { "items": { "$ref": "#/components/schemas/EInvoiceLineItem" }, "type": "array", "title": "Line Items", "description": "List of invoice lines associated with this e-invoice." }, "attachments": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EInvoiceAttachment" }, "type": "array" }, { "type": "null" } ], "title": "Attachments", "description": "List of document attachments associated with this e-invoice." }, "invoice_type": { "type": "string", "const": "PURCHASE_CREDIT_NOTE", "title": "Invoice Type", "description": "Indicates that this is a purchase credit note." } }, "type": "object", "required": [ "name", "date", "currency", "total_excl_tax", "total_incl_tax", "total_tax", "supplier", "line_items", "invoice_type" ], "title": "PurchaseECreditNoteInput" }, "PurchaseEInvoiceInput": { "properties": { "name": { "type": "string", "title": "Name", "description": "Reference from invoicing party.", "examples": [ "Invoice-0001" ] }, "date": { "type": "string", "format": "date", "title": "Date", "description": "Invoice transaction date.", "examples": [ "2022-01-01" ] }, "currency": { "type": "string", "title": "Currency", "description": "Currency code of the e-invoice.", "examples": [ "EUR" ] }, "exchange_rate": { "anyOf": [ { "$ref": "#/components/schemas/ExchangeRate" }, { "type": "null" } ], "description": "Exchange rate information if applicable." }, "total_excl_tax": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Total Excl Tax", "description": "Total amount excluding tax for the e-invoice.", "examples": [ "100" ] }, "total_incl_tax": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Total Incl Tax", "description": "Total amount including tax for the e-invoice.", "examples": [ "121" ] }, "total_tax": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "title": "Total Tax", "description": "Total tax amount for the e-invoice.", "examples": [ "21" ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Custom fields associated with this e-invoice." }, "supplier": { "$ref": "#/components/schemas/EInvoiceCompanyInput", "description": "Supplier company information." }, "customer_reference_numbers": { "items": { "type": "string" }, "type": "array", "title": "Customer Reference Numbers", "description": "Reference numbers used to match the invoice.", "examples": [ [ "12345" ] ] }, "line_items": { "items": { "$ref": "#/components/schemas/EInvoiceLineItem" }, "type": "array", "title": "Line Items", "description": "List of invoice lines associated with this e-invoice." }, "attachments": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EInvoiceAttachment" }, "type": "array" }, { "type": "null" } ], "title": "Attachments", "description": "List of document attachments associated with this e-invoice." }, "due_date": { "type": "string", "format": "date", "title": "Due Date", "description": "Payment due date.", "examples": [ "2022-01-01" ] }, "invoice_type": { "type": "string", "const": "PURCHASE", "title": "Invoice Type", "description": "Indicates that this is a purchase invoice." } }, "type": "object", "required": [ "name", "date", "currency", "total_excl_tax", "total_incl_tax", "total_tax", "supplier", "line_items", "due_date", "invoice_type" ], "title": "PurchaseEInvoiceInput" }, "PurchaseInvoice": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Technical id within the Qargo system" }, "name": { "type": "string", "title": "Name", "description": "Reference from invoicing party", "examples": [ "Credit-Note-0001" ] }, "external_name": { "type": "string", "title": "External Name", "description": "Reference from invoicing party" }, "date": { "type": "string", "format": "date", "title": "Date", "examples": [ "2022-01-01" ] }, "due_date": { "type": "string", "format": "date", "title": "Due Date", "examples": [ "2022-01-01" ] }, "booking_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Booking Date", "description": "booking date needs to be enabled else this will default to the date field", "examples": [ "2021-12-22" ] }, "currency": { "type": "string", "title": "Currency", "examples": [ "EUR" ] }, "exchange_rate": { "anyOf": [ { "$ref": "#/components/schemas/ExchangeRate" }, { "type": "null" } ] }, "total_excl_tax": { "type": "string", "title": "Total Excl Tax", "examples": [ "100" ] }, "total_incl_tax": { "type": "string", "title": "Total Incl Tax", "examples": [ "121" ] }, "total_tax": { "type": "string", "title": "Total Tax", "examples": [ "21" ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "default": {} }, "supplier": { "$ref": "#/components/schemas/CompanySummaryOutput" }, "customer_reference_numbers": { "items": { "type": "string" }, "type": "array", "title": "Customer Reference Numbers", "examples": [ [ "12345" ] ] }, "line_items": { "items": { "$ref": "#/components/schemas/LineItem" }, "type": "array", "title": "Line Items" }, "billing_entity": { "$ref": "#/components/schemas/BillingEntity", "description": "Billing entity linked to this invoice." } }, "type": "object", "required": [ "name", "external_name", "date", "due_date", "currency", "total_excl_tax", "total_incl_tax", "total_tax", "supplier", "line_items", "billing_entity" ], "title": "PurchaseInvoice" }, "PurchaseInvoiceInput": { "properties": { "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields." } }, "type": "object", "title": "PurchaseInvoiceInput" }, "PurchaseInvoiceStatusUpdate": { "properties": { "type": { "type": "string", "const": "PurchaseInvoice", "title": "Type" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the invoice or credit note" }, "status": { "$ref": "#/components/schemas/InvoiceStatus" } }, "type": "object", "required": [ "type", "id", "status" ], "title": "PurchaseInvoiceStatusUpdate" }, "RawInput": { "properties": { "content": { "type": "string", "title": "Content", "default": "base64 encoded raw data" }, "mime_type": { "type": "string", "title": "Mime Type", "default": "mime type of content" }, "filename": { "type": "string", "title": "Filename", "default": "Filename of content" } }, "type": "object", "title": "RawInput" }, "RefundStatus": { "type": "string", "enum": [ "OPEN", "REFUNDED" ], "title": "RefundStatus" }, "RefundStatusUpdate": { "properties": { "status": { "$ref": "#/components/schemas/RefundStatus" } }, "type": "object", "required": [ "status" ], "title": "RefundStatusUpdate" }, "RemoteDocument": { "properties": { "download_url": { "type": "string", "title": "Download Url", "description": "In most cases the /documents/document//download endpoint" } }, "type": "object", "required": [ "download_url" ], "title": "RemoteDocument" }, "ResourceAllocation-Input": { "properties": { "resource": { "anyOf": [ { "$ref": "#/components/schemas/GenericResource-Input" }, { "$ref": "#/components/schemas/DriverResource-Input" }, { "$ref": "#/components/schemas/ContainerResource-Input" }, { "$ref": "#/components/schemas/VehicleResource-Input" } ], "title": "Resource", "description": "Resource assigned to the trip" } }, "type": "object", "required": [ "resource" ], "title": "ResourceAllocation" }, "ResourceAllocation-Output": { "properties": { "resource": { "anyOf": [ { "$ref": "#/components/schemas/GenericResource-Output" }, { "$ref": "#/components/schemas/DriverResource-Output" }, { "$ref": "#/components/schemas/ContainerResource-Output" }, { "$ref": "#/components/schemas/VehicleResource-Output" } ], "title": "Resource", "description": "Resource assigned to the trip" } }, "type": "object", "required": [ "resource" ], "title": "ResourceAllocation" }, "ResourceAllocationOutput": { "type": "object" }, "ResourceExtraInput": { "properties": { "code": { "type": "string", "title": "Code", "description": "Code of the stop extra. Must match exactly one extra in the tenant." } }, "type": "object", "required": [ "code" ], "title": "ResourceExtraInput" }, "ResourceExtraOutput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the stop extra" }, "code": { "type": "string", "title": "Code", "description": "Code of the stop extra" }, "name": { "type": "string", "title": "Name", "description": "Name of the stop extra" } }, "type": "object", "required": [ "id", "code", "name" ], "title": "ResourceExtraOutput" }, "ResourceGroupOutput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Identifier of the resource group." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource group." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource group." } }, "type": "object", "required": [ "id" ], "title": "ResourceGroupOutput" }, "ResourceGroupReference": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Identifier of the resource group." } }, "type": "object", "required": [ "id" ], "title": "ResourceGroupReference" }, "ResourceOutput": { "type": "object" }, "ResourceType": { "type": "string", "enum": [ "VAN", "RIGID", "TRAILER", "FULL_TRAILER", "CONTAINER", "TRACTOR", "CHASSIS", "COMPARTMENT", "DRIVER", "FERRY", "TRAIN", "SUBCONTRACTOR", "BARGE", "AIRPLANE", "HANDLING" ], "title": "ResourceType" }, "ResourceTypeEnum": { "type": "string", "enum": [ "AIRPLANE", "BARGE", "CHASSIS", "COMPARTMENT", "CONTAINER", "DRIVER", "FERRY", "FULL_TRAILER", "HANDLING", "RIGID", "SUBCONTRACTOR", "TRACTOR", "TRAILER", "TRAIN", "VAN" ], "title": "ResourceTypeEnum" }, "ResourceUnavailabilityInput": { "properties": { "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "External identifier of the unavailability" }, "start_time": { "type": "string", "format": "date-time", "title": "Start Time", "description": "Start time of the unavailability" }, "end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time", "description": "End time of the unavailability, leave empty for open interval" }, "reason": { "$ref": "#/components/schemas/UnavailabilityReason" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "required": [ "start_time", "reason" ], "title": "ResourceUnavailabilityInput" }, "ResourceUnavailabilityOutput": { "properties": { "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "External identifier of the unavailability" }, "start_time": { "type": "string", "format": "date-time", "title": "Start Time", "description": "Start time of the unavailability" }, "end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time", "description": "End time of the unavailability, leave empty for open interval" }, "reason": { "$ref": "#/components/schemas/UnavailabilityReason" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the unavailability" } }, "type": "object", "required": [ "start_time", "reason", "id" ], "title": "ResourceUnavailabilityOutput" }, "ResourceUpdate": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "type": { "type": "string", "const": "Resource", "title": "Type" }, "resource": { "$ref": "#/components/schemas/VisibilityResource" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" } }, "type": "object", "required": [ "type", "resource" ], "title": "ResourceUpdate", "description": "Send update event on resource assignment (allocation).\n\nNot that by default, we can send updates on every resource assignment change.\nThis can be customised to only send an update at the moment that the transport\nis dispatched to the driver or subcontractor." }, "ResourceValidityInput": { "properties": { "start_time": { "type": "string", "format": "date-time", "title": "Start Time", "description": "Start time of the validity" }, "end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time", "description": "End time of the validity from a planning perspective" }, "legal_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Legal End Time", "description": "End time of the validity from a legal perspective" }, "generate_unavailability": { "type": "boolean", "title": "Generate Unavailability", "description": "Generate a planning unavailability once the validity end time has passed", "default": false }, "type": { "$ref": "#/components/schemas/ResourceValidityReason" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "ID of the validity in the external master data system" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "documents": { "items": { "$ref": "#/components/schemas/UploadedDocumentBase_Union_ContainerDocumentTypes__DriverDocumentTypes__VehicleDocumentTypes__" }, "type": "array", "title": "Documents", "description": "List of documents associated with the validity" } }, "type": "object", "required": [ "start_time", "type" ], "title": "ResourceValidityInput" }, "ResourceValidityOutput": { "properties": { "start_time": { "type": "string", "format": "date-time", "title": "Start Time", "description": "Start time of the validity" }, "end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Time", "description": "End time of the validity from a planning perspective" }, "legal_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Legal End Time", "description": "End time of the validity from a legal perspective" }, "generate_unavailability": { "type": "boolean", "title": "Generate Unavailability", "description": "Generate a planning unavailability once the validity end time has passed", "default": false }, "type": { "$ref": "#/components/schemas/ResourceValidityReason" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "ID of the validity in the external master data system" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the validity" } }, "type": "object", "required": [ "start_time", "type", "id" ], "title": "ResourceValidityOutput" }, "ResourceValidityReason": { "type": "string", "enum": [ "EUROVIGNET", "FUEL_CARD", "FINE", "CONTAINER_CERTIFICATE", "CONTAINER_DAMAGE_REPORT", "CONTAINER_INSPECTION_REPORT", "CONTAINER_LEASE", "CONTAINER_MAINTENANCE_REPORT", "CONTAINER_REPAIR_REPORT", "CONTAINER_TANK_TEST_CERTIFICATE_2Y5", "CONTAINER_TANK_TEST_CERTIFICATE_5Y", "CONTAINER_TANK_TEST_CERTIFICATE", "DRIVER_ADR_EXTRA_TRAINING", "DRIVER_ADR_LICENSE", "DRIVER_AEO_REGULATED_AGENT_LICENSE", "DRIVER_CARD", "DRIVER_CIVIL_LIABILITY_EXPLOITATION", "DRIVER_CIVIL_LIABILITY_INSURANCE", "DRIVER_CODE_95", "DRIVER_DRIVING_LICENSE", "DRIVER_IDENTITY_CARD", "DRIVER_IMI_PORTAL", "DRIVER_INSURANCE", "DRIVER_MEDICAL_EXAM", "DRIVER_PERSONAL_PROTECTIVE_EQUIPMENT", "DRIVER_RECUP", "DRIVER_REFUGEE_TRAINING_LICENSE", "DRIVER_SHIFT_PATTERN", "DRIVER_SICK_NOTE", "DRIVER_TRAINING", "BBS_CERTIFICATE", "FORKLIFT_LICENSE", "PAYSCALE_DRIVER", "VCA_BASIC_SAFETY", "TOLL_CARD", "SAFETY_CERTIFICATE_TERMINAL", "EXCEPTIONAL_TRANSPORT_LICENSE", "A1_DOCUMENT", "DRIVER_CPC_CARD", "DRIVER_POSTING_DOCUMENT", "SITE_MOVEMENT_SHEET", "DRIVER_PARENTAL_LEAVE", "DRIVER_JOB_APPLICATION_LEAVE", "DRIVER_PUBLIC_HOLIDAY", "DRIVER_SOCIAL_LEAVE", "DRIVER_UNION_LEAVE", "DRIVER_LONG_HEAVY_VEHICLE_CERT", "DRIVER_CARGOCARD_ACCESS_CARD", "DRIVER_ALFAPASS", "DRIVER_OFF_SHIFT_PATTERN", "DRIVER_REDUCED_WORKING_HOURS_SCHEME", "DRIVER_UNAUTHORISED_ABSENCE", "VEHICLE_MOT_TEST", "VEHICLE_REGISTRATION", "VEHICLE_INSURANCE_CERTIFICATE", "VEHICLE_TRANSPORT_LICENSE", "VEHICLE_DAMAGE_REPORT", "VEHICLE_MAINTENANCE_REPORT", "VEHICLE_ADR_CERTIFICATE", "VEHICLE_REPAIR_REPORT", "VEHICLE_TACHO", "VEHICLE_TIR", "VEHICLE_PHOTO", "VEHICLE_12_WEEKLY_CHECK", "VEHICLE_FIRE_EXTINGUISHER_SERVICE", "VEHICLE_UK_HGV_LEVY", "VEHICLE_ATP_CERTIFICATE", "VEHICLE_FRIDGE_MOTOR", "OVERSIZE_WL_PERMIT", "ROADTAX", "CERTIFICATE_OF_CONFORMITY", "BRAKE_TEST_CERTIFICATE", "BREAK_TEST_CERTIFICATE", "VEHICLE_IDENTIFICATION_REPORT", "VEHICLE_FRC_CERTIFICATE", "VEHICLE_GERMAN_SECURITY_INSPECTION", "VEHICLE_GERMAN_VEHICLE_INSPECTION", "CITERNE_CLEANING_CERTIFICATE", "HEAVY_LOAD_BE", "HEAVY_LOAD_DE", "HEAVY_LOAD_FR", "XL_CERTIFICATE", "VEHICLE_SERVICE", "VEHICLE_HIRE", "VEHICLE_BRAKE_TEST", "VEHICLE_HYDRAULIC_INSPECTION", "VEHICLE_LIFT_OPS_EQUIP_REGULATIONS", "VEHICLE_PRESSURE_TEST", "VEHICLE_TACHOGRAPH_CALIBRATION" ], "title": "ResourceValidityReason" }, "SalesCompanyFields-Input": { "properties": { "payment_term": { "anyOf": [ { "$ref": "#/components/schemas/BasePaymentTerm" }, { "type": "null" } ], "description": "Payment term information of the company" }, "billing_entities": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CompanyBillingEntity" }, "type": "array" }, { "type": "null" } ], "title": "Billing Entities", "description": "List of billing entities associated with the company" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/CustomerStatus" }, { "type": "null" } ], "description": "The status indicates whether an order can be linked to this customer. The available statuses are: \n - `PROSPECT`: The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed.\n - `NOT_APPROVED`: The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply.\n - `APPROVED`: The customer is approved. Orders can be placed without restrictions.\n - `WARNING`: The customer is approved, but a warning is triggered when attempting to create an order in Qargo. The operator can dismiss the warning and proceed with the order.\n - `BLOCKED`: The customer is blocked; no new orders can be created.\n\n For a company representing other companies, it can only create orders if it holds the `APPROVED` status.", "default": "APPROVED", "examples": [ "APPROVED" ] } }, "type": "object", "title": "SalesCompanyFields" }, "SalesCompanyFields-Output": { "properties": { "payment_term": { "anyOf": [ { "$ref": "#/components/schemas/BasePaymentTerm" }, { "type": "null" } ], "description": "Payment term information of the company" }, "billing_entities": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CompanyBillingEntity" }, "type": "array" }, { "type": "null" } ], "title": "Billing Entities", "description": "List of billing entities associated with the company" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/CustomerStatus" }, { "type": "null" } ], "description": "The status indicates whether an order can be linked to this customer. The available statuses are: \n - `PROSPECT`: The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed.\n - `NOT_APPROVED`: The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply.\n - `APPROVED`: The customer is approved. Orders can be placed without restrictions.\n - `WARNING`: The customer is approved, but a warning is triggered when attempting to create an order in Qargo. The operator can dismiss the warning and proceed with the order.\n - `BLOCKED`: The customer is blocked; no new orders can be created.\n\n For a company representing other companies, it can only create orders if it holds the `APPROVED` status.", "default": "APPROVED", "examples": [ "APPROVED" ] } }, "type": "object", "title": "SalesCompanyFields" }, "SalesCreditNoteInput": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "Credit note date", "examples": [ "2022-01-01" ] }, "booking_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Booking Date", "description": "booking date needs to be enabled else this will default to the date field", "examples": [ "2021-12-22" ] }, "currency": { "type": "string", "title": "Currency", "examples": [ "EUR" ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "default": {} }, "customer_reference_numbers": { "items": { "type": "string" }, "type": "array", "title": "Customer Reference Numbers", "examples": [ [ "12345" ] ] }, "customer": { "$ref": "#/components/schemas/CustomerReference", "description": "Customer reference for this credit note." }, "charges": { "items": { "$ref": "#/components/schemas/ChargeInput" }, "type": "array", "title": "Charges" }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity linked to this credit note. When having multiple billing entities make sure to specify the correct entity." } }, "type": "object", "required": [ "date", "currency", "customer", "charges" ], "title": "SalesCreditNoteInput" }, "SalesCreditNoteOutput": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "Credit note date", "examples": [ "2022-01-01" ] }, "booking_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Booking Date", "description": "booking date needs to be enabled else this will default to the date field", "examples": [ "2021-12-22" ] }, "currency": { "type": "string", "title": "Currency", "examples": [ "EUR" ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "default": {} }, "customer_reference_numbers": { "items": { "type": "string" }, "type": "array", "title": "Customer Reference Numbers", "examples": [ [ "12345" ] ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Technical id within the Qargo system" }, "name": { "type": "string", "title": "Name", "examples": [ "Credit-Note-0001" ] }, "e_invoicing": { "anyOf": [ { "$ref": "#/components/schemas/EInvoicingOutput" }, { "type": "null" } ], "description": "E-invoicing registration metadata." }, "exchange_rate": { "anyOf": [ { "$ref": "#/components/schemas/ExchangeRate" }, { "type": "null" } ] }, "total_excl_tax": { "type": "string", "title": "Total Excl Tax", "examples": [ "100" ] }, "total_incl_tax": { "type": "string", "title": "Total Incl Tax", "examples": [ "121" ] }, "total_tax": { "type": "string", "title": "Total Tax", "examples": [ "21" ] }, "customer": { "$ref": "#/components/schemas/CompanySummaryOutput" }, "line_items": { "items": { "$ref": "#/components/schemas/LineItem" }, "type": "array", "title": "Line Items" }, "billing_entity": { "$ref": "#/components/schemas/BillingEntity", "description": "Billing entity linked to this credit note." } }, "type": "object", "required": [ "date", "currency", "id", "name", "total_excl_tax", "total_incl_tax", "total_tax", "customer", "line_items", "billing_entity" ], "title": "SalesCreditNoteOutput" }, "SalesCreditNotePatchInput": { "properties": { "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields." } }, "type": "object", "title": "SalesCreditNotePatchInput" }, "SalesCreditNoteStatusUpdate": { "properties": { "type": { "type": "string", "const": "SalesCreditNote", "title": "Type" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the invoice or credit note" }, "status": { "$ref": "#/components/schemas/CreditNoteStatus" } }, "type": "object", "required": [ "type", "id", "status" ], "title": "SalesCreditNoteStatusUpdate" }, "SalesInvoiceInput": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "Invoicing date", "examples": [ "2022-01-01" ] }, "due_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Due Date", "examples": [ "2022-01-01" ] }, "booking_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Booking Date", "description": "booking date needs to be enabled else this will default to the date field", "examples": [ "2021-12-22" ] }, "currency": { "type": "string", "title": "Currency", "description": "Currency code (ISO 4217).", "examples": [ "EUR" ] }, "customer_reference_numbers": { "items": { "type": "string" }, "type": "array", "title": "Customer Reference Numbers", "description": "PO numbers", "default": [], "examples": [ [ "12345" ] ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "default": {} }, "customer": { "$ref": "#/components/schemas/CustomerReference" }, "charges": { "items": { "$ref": "#/components/schemas/ChargeInput" }, "type": "array", "title": "Charges" }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity linked to this invoice. When having multiple billing entities make sure to specify the correct entity." } }, "type": "object", "required": [ "date", "currency", "customer", "charges" ], "title": "SalesInvoiceInput" }, "SalesInvoiceMatch": { "properties": { "name": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] } }, "type": "object", "title": "SalesInvoiceMatch" }, "SalesInvoiceOutput": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "Invoicing date", "examples": [ "2022-01-01" ] }, "due_date": { "type": "string", "format": "date", "title": "Due Date", "examples": [ "2022-01-01" ] }, "booking_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Booking Date", "description": "booking date needs to be enabled else this will default to the date field", "examples": [ "2021-12-22" ] }, "currency": { "type": "string", "title": "Currency", "description": "Currency code (ISO 4217).", "examples": [ "EUR" ] }, "customer_reference_numbers": { "items": { "type": "string" }, "type": "array", "title": "Customer Reference Numbers", "description": "PO numbers", "default": [], "examples": [ [ "12345" ] ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "default": {} }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Technical id within the Qargo system" }, "name": { "type": "string", "title": "Name", "description": "Name of the invoice.", "examples": [ "Invoice-0001" ] }, "e_invoicing": { "anyOf": [ { "$ref": "#/components/schemas/EInvoicingOutput" }, { "type": "null" } ], "description": "E-invoicing registration metadata." }, "exchange_rate": { "anyOf": [ { "$ref": "#/components/schemas/ExchangeRate" }, { "type": "null" } ] }, "total_excl_tax": { "type": "string", "title": "Total Excl Tax", "examples": [ "100" ] }, "total_incl_tax": { "type": "string", "title": "Total Incl Tax", "examples": [ "121" ] }, "total_tax": { "type": "string", "title": "Total Tax", "examples": [ "21" ] }, "customer": { "$ref": "#/components/schemas/CompanySummaryOutput" }, "line_items": { "items": { "$ref": "#/components/schemas/LineItem" }, "type": "array", "title": "Line Items" }, "billing_entity": { "$ref": "#/components/schemas/BillingEntity", "description": "Billing entity linked to this invoice." } }, "type": "object", "required": [ "date", "due_date", "currency", "id", "name", "total_excl_tax", "total_incl_tax", "total_tax", "customer", "line_items", "billing_entity" ], "title": "SalesInvoiceOutput" }, "SalesInvoicePatchInput": { "properties": { "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields." } }, "type": "object", "title": "SalesInvoicePatchInput" }, "SalesInvoiceStatusUpdate": { "properties": { "type": { "type": "string", "const": "SalesInvoice", "title": "Type" }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the invoice or credit note" }, "status": { "$ref": "#/components/schemas/InvoiceStatus" } }, "type": "object", "required": [ "type", "id", "status" ], "title": "SalesInvoiceStatusUpdate" }, "SalesInvoiceUpdate": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "match": { "$ref": "#/components/schemas/BillingDocumentMatchTarget", "description": "Matcher for the billing document update, used to match to a billing document" } }, "type": "object", "title": "SalesInvoiceUpdate" }, "ServiceLevel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable identifier" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Machine readable identifier" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" } }, "type": "object", "title": "ServiceLevel" }, "Shipment": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for shipment" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable identifier" }, "orders": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OrderOutput-Output" }, "type": "array" }, { "type": "null" } ], "title": "Orders", "description": "List of orders in the shipment" }, "shipment_planning_group": { "anyOf": [ { "$ref": "#/components/schemas/PlanningGroup" }, { "type": "null" } ], "description": "Planning group linked to shipment" }, "stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopOutput-Output" }, "type": "array" }, { "type": "null" } ], "title": "Stops", "description": "List of stops in the shipment" }, "metrics": { "anyOf": [ { "$ref": "#/components/schemas/OrderMetrics" }, { "type": "null" } ], "description": "Metrics related to the shipment" }, "resource_allocations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceAllocation-Output" }, "type": "array" }, { "type": "null" } ], "title": "Resource Allocations", "description": "List of resources assigned to the shipment" }, "resource_allocations_by_type": { "anyOf": [ { "additionalProperties": { "items": { "$ref": "#/components/schemas/ResourceAllocation-Output" }, "type": "array" }, "type": "object" }, { "type": "null" } ], "title": "Resource Allocations By Type", "description": "List of resource allocations by type" } }, "type": "object", "required": [ "id" ], "title": "Shipment" }, "ShippeoOrderInput": { "properties": { "external_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Reference" } }, "type": "object", "title": "ShippeoOrderInput" }, "ShippingCompany": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable identifier" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Machine readable identifier" } }, "type": "object", "title": "ShippingCompany" }, "ShippingLocation": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Technical code for integrations/mapping logic; should be treated as stable once set.", "examples": [ "LOC123" ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Human-readable label for a location in operational views.", "examples": [ "Main Office" ] }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "Identifier from an external (master data) system." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "First address line of the location", "examples": [ "Gaston Crommenlaan 4" ] }, "address_second_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Second Line", "description": "Second address line of the location", "examples": [ "" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City of the location", "examples": [ "Ghent" ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "State of the location", "examples": [ "" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country code (ISO 3166-1 alpha-2) of the location", "examples": [ "BE" ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code", "description": "Postal code of the location", "examples": [ "9050" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the location", "examples": [ "Qargo HQ" ] }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Identifier of the location" }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latitude" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Longitude" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Location description" }, "location_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location Identifier", "description": "External location identifier" }, "terminal_metadata": { "anyOf": [ { "$ref": "#/components/schemas/TerminalMetadata" }, { "type": "null" } ], "description": "Metadata about the terminal." } }, "type": "object", "title": "ShippingLocation" }, "ShippingRoute": { "properties": { "start_stop": { "$ref": "#/components/schemas/ShippingStop", "description": "Origin stop of the route." }, "end_stop": { "$ref": "#/components/schemas/ShippingStop", "description": "Destination stop of the route." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Shipping route code. Optional when location details are not available." }, "modality": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Modality", "description": "Transport modality of the route. One of: RAIL, FERRY, BARGE, AIR.", "examples": [ "RAIL" ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Values for user-defined fields on the route." } }, "type": "object", "required": [ "start_stop", "end_stop" ], "title": "ShippingRoute" }, "ShippingStop": { "properties": { "location": { "$ref": "#/components/schemas/ShippingLocation" }, "reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Number", "description": "Reference number for the stop." }, "timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp", "description": "Time of the stop. Required for the route's start stop (ISO 8601 format with a timezone offset, e.g. `Z` or `+02:00`).", "examples": [ "2024-12-31T08:00:00Z" ] } }, "type": "object", "required": [ "location" ], "title": "ShippingStop" }, "Signature": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the person who signed" }, "position": { "anyOf": [ { "$ref": "#/components/schemas/Position" }, { "type": "null" } ], "description": "Position data where the signature was captured" }, "timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp", "description": "Timestamp when the signature was captured" }, "type": { "$ref": "#/components/schemas/SignatureType", "description": "Type of the signature" } }, "type": "object", "required": [ "type" ], "title": "Signature" }, "SignatureInput": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp" }, "position": { "anyOf": [ { "$ref": "#/components/schemas/Position" }, { "type": "null" } ] } }, "type": "object", "title": "SignatureInput" }, "SignatureType": { "type": "string", "enum": [ "CONSIGNOR", "CONSIGNEE", "DRIVER" ], "title": "SignatureType" }, "StopActivityConfigInput": { "properties": { "resource_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Resource Types" }, "dpc_start_or_end_stop_location": { "anyOf": [ { "$ref": "#/components/schemas/LocationInput" }, { "type": "null" } ] }, "dpc_drop_collect_empty_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Dpc Drop Collect Empty Date" }, "duration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration" } }, "type": "object", "title": "StopActivityConfigInput" }, "StopActivityInput": { "properties": { "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/StopActivityConfigInput" }, { "type": "null" } ] } }, "type": "object", "title": "StopActivityInput" }, "StopData": { "properties": { "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date" }, "reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number" }, "mobile_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mobile Number" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/LocationInput" }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "extras": { "anyOf": [ { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Extras" }, "time_window": { "anyOf": [ { "$ref": "#/components/schemas/TimeWindowInput" }, { "type": "null" } ] }, "position": { "anyOf": [ { "$ref": "#/components/schemas/StopPosition" }, { "type": "null" } ] }, "stop_type": { "anyOf": [ { "$ref": "#/components/schemas/StopTypeField" }, { "type": "null" } ] }, "stop_activity": { "anyOf": [ { "$ref": "#/components/schemas/StopActivityInput" }, { "type": "null" } ] }, "drop_collect_empty": { "anyOf": [ { "$ref": "#/components/schemas/UpdateDropCollectEmptyInput" }, { "type": "null" } ] }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, "type": "object", "title": "StopData" }, "StopDepotOutput": { "properties": { "load_sequence_number": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Load Sequence Number", "description": "Load sequence number for the stop" }, "unload_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Unload Timestamp", "description": "Timestamp for which the delivery is scheduled. ISO 8601 format in UTC.", "examples": [ "2024-12-31T14:30:00Z" ] }, "unload_sequence_number": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Unload Sequence Number", "description": "Unload sequence number for the stop" }, "load_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Load Timestamp", "description": "Timestamp for which the pickup is scheduled. ISO 8601 format in UTC.", "examples": [ "2024-12-31T08:00:00Z" ] }, "load_planned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Load Planned", "description": "Indicates if the load is planned for this stop" }, "unload_planned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Unload Planned", "description": "Indicates if the unload is planned for this stop" }, "load_pickup_stop_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Load Pickup Stop Id", "description": "Identifier of the pickup stop related to the load" }, "unload_delivery_stop_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Unload Delivery Stop Id", "description": "Identifier of the delivery stop related to the unload" } }, "type": "object", "title": "StopDepotOutput" }, "StopEntityUpdate": { "properties": { "operation": { "type": "string", "enum": [ "CREATE", "UPDATE", "DELETE" ], "title": "Operation" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/StopUpdateData" }, { "$ref": "#/components/schemas/StopData" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "operation" ], "title": "StopEntityUpdate" }, "StopExtra": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "default": "" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "default": "" }, "amazon": { "anyOf": [ { "$ref": "#/components/schemas/AmazonExtraFields" }, { "type": "null" } ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" } }, "type": "object", "title": "StopExtra" }, "StopGroup": { "properties": { "id": { "type": "string", "title": "Id", "description": "ID of the stop group" }, "templates": { "items": { "$ref": "#/components/schemas/StopGroupTemplate" }, "type": "array", "title": "Templates", "description": "List of templates to be rendered on the fleet device" }, "main_activity": { "type": "string", "title": "Main Activity", "description": "Activity of the fleet app that is linked to this stop group" }, "stops": { "items": { "$ref": "#/components/schemas/StopGroupStop" }, "type": "array", "title": "Stops", "description": "List of stops in the stop group" }, "location": { "$ref": "#/components/schemas/LocationOutput", "description": "Location of the stop group" }, "start_timestamp": { "type": "string", "format": "date-time", "title": "Start Timestamp", "description": "Start timestamp of the stop group" }, "end_timestamp": { "type": "string", "format": "date-time", "title": "End Timestamp", "description": "End timestamp of the stop group" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes", "description": "Notes for the stop group" } }, "type": "object", "required": [ "id", "templates", "main_activity", "stops", "location", "start_timestamp", "end_timestamp" ], "title": "StopGroup" }, "StopGroupStatusUpdate": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the stop group (from the original order/trip)" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/StopStatusUpdateEnum" }, { "type": "null" } ], "description": "Updated status of the stop group. All stops in the stop group will updated with this status." }, "question_answers": { "type": "object", "title": "Question Answers", "description": "Data related to the status update. This data can be mapped to different entities in Qargo." }, "eta_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Eta Start", "description": "Estimated arrival time (ETA) at the stop group in UTC. Include a timezone offset, for example `Z` or `+02:00`." }, "eta_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Eta End", "description": "Estimated departure time (ETD) from the stop group in UTC. Include a timezone offset, for example `Z` or `+02:00`." } }, "type": "object", "required": [ "id" ], "title": "StopGroupStatusUpdate", "description": "Update a stop group from an external source.\n\nCan update status and data of the stops in a stop group. Updates on the data happen based on the defined\nintegration_data_mapping in the integration configuration." }, "StopGroupStop": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the stop group" }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "Date of the stop group" }, "start_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Timestamp", "description": "Start timestamp of the stop group" }, "end_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Timestamp", "description": "End timestamp of the stop group" } }, "type": "object", "required": [ "id" ], "title": "StopGroupStop" }, "StopGroupTemplate": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Title to be displayed on fleet app" }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtitle", "description": "Subtitle to be displayed on fleet app" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Text to be displayed on fleet app" } }, "type": "object", "title": "StopGroupTemplate" }, "StopInput-Input": { "properties": { "activity_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Activity Label", "description": "Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional freeform data for this stop" }, "reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "stop reference number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number" }, "mobile_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mobile Number" }, "time_window": { "anyOf": [ { "$ref": "#/components/schemas/TimeWindow" }, { "type": "null" } ], "title": "time_window" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopExtra" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Additional services/options for stop" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Additional user defined fields to fill in" }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "Date on which stop happens. Optional for delivery stops when a service level is set on the order", "examples": [ "2024-12-31" ] }, "custom_activity_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Activity Label", "description": "Custom activity related to the order" }, "duration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration", "description": "Duration of the stop in seconds" }, "location": { "$ref": "#/components/schemas/Location", "description": "Location of the stop" }, "drop_collect_empty": { "anyOf": [ { "$ref": "#/components/schemas/DropCollectEmptyInput" }, { "type": "null" } ], "description": "Information for drop/collect empty stops" } }, "type": "object", "required": [ "location" ], "title": "StopInput" }, "StopInput-Output": { "properties": { "activity_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Activity Label", "description": "Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional freeform data for this stop" }, "reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "stop reference number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number" }, "mobile_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mobile Number" }, "time_window": { "anyOf": [ { "$ref": "#/components/schemas/TimeWindow" }, { "type": "null" } ], "title": "time_window" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopExtra" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Additional services/options for stop" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Additional user defined fields to fill in" }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "Date on which stop happens. Optional for delivery stops when a service level is set on the order", "examples": [ "2024-12-31" ] }, "custom_activity_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Activity Label", "description": "Custom activity related to the order" }, "duration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration", "description": "Duration of the stop in seconds" }, "location": { "$ref": "#/components/schemas/Location", "description": "Location of the stop" }, "drop_collect_empty": { "anyOf": [ { "$ref": "#/components/schemas/DropCollectEmptyInput" }, { "type": "null" } ], "description": "Information for drop/collect empty stops" } }, "type": "object", "required": [ "location" ], "title": "StopInput" }, "StopInsertPosition": { "properties": { "position": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Position", "description": "Position of the stop in the order. Needs to be an positive non-zero integer" } }, "type": "object", "title": "StopInsertPosition" }, "StopMatch": { "properties": { "reference_number": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "stop_type": { "anyOf": [ { "$ref": "#/components/schemas/StopType" }, { "type": "null" } ] }, "leg": { "anyOf": [ { "$ref": "#/components/schemas/LegMatch" }, { "type": "null" } ] } }, "type": "object", "title": "StopMatch" }, "StopMatchInput": { "properties": { "trip": { "anyOf": [ { "$ref": "#/components/schemas/TripMatch" }, { "type": "null" } ] }, "order": { "anyOf": [ { "$ref": "#/components/schemas/OrderMatch" }, { "type": "null" } ] }, "consignment": { "anyOf": [ { "$ref": "#/components/schemas/ConsignmentMatch" }, { "type": "null" } ] }, "stop": { "anyOf": [ { "$ref": "#/components/schemas/StopMatch" }, { "type": "null" } ] } }, "type": "object", "title": "StopMatchInput" }, "StopMatchTarget": { "properties": { "matches_all": { "items": { "$ref": "#/components/schemas/StopMatchInput" }, "type": "array", "title": "Matches All" } }, "type": "object", "title": "StopMatchTarget" }, "StopOutput-Input": { "properties": { "activity_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Activity Label", "description": "Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional freeform data for this stop" }, "reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "stop reference number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number" }, "mobile_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mobile Number" }, "time_window": { "anyOf": [ { "$ref": "#/components/schemas/TimeWindow" }, { "type": "null" } ], "title": "time_window" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopExtra" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Additional services/options for stop" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Additional user defined fields to fill in" }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "Requested date of the stop, as shown in the planning UI. Empty for stops without a requested date (e.g. standalone stops).", "examples": [ "2024-12-31" ] }, "depot": { "anyOf": [ { "$ref": "#/components/schemas/StopDepotOutput" }, { "type": "null" } ], "description": "Depot information for the stop. Only relevant for location bookings (load building)." }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for stop" }, "location": { "$ref": "#/components/schemas/LocationWithTerminalOutput-Input", "description": "Location of the stop" }, "mileage_km": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mileage Km", "description": "Mileage in kilometers" }, "end_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Timestamp", "description": "End of stop. The value depends on the stop status: the estimated end time until the stop reaches status COMPLETED, after which it is the actual end time reported during execution. ISO 8601 format in UTC.", "examples": [ "2024-12-31T08:15:00Z" ] }, "start_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Timestamp", "description": "Start of stop. The value depends on the stop status: the estimated start time until the stop reaches status AT_STOP, after which it is the actual start time reported during execution. ISO 8601 format in UTC.", "examples": [ "2024-12-31T08:00:00Z" ] }, "incidents": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Incident" }, "type": "array" }, { "type": "null" } ], "title": "Incidents", "description": "List of incidents" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "description": "Status of the stop. One of: TEMPLATE, BLOCKED, TO_PLAN, PLANNED, DISPATCHED, ROUTE_TO_STOP, AT_STOP, COMPLETED, CANCELLED, IGNORED.", "examples": [ "PLANNED" ] } }, "type": "object", "required": [ "id", "location" ], "title": "StopOutput" }, "StopOutput-Output": { "properties": { "activity_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Activity Label", "description": "Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional freeform data for this stop" }, "reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "stop reference number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number" }, "mobile_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mobile Number" }, "time_window": { "anyOf": [ { "$ref": "#/components/schemas/TimeWindow" }, { "type": "null" } ], "title": "time_window" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopExtra" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Additional services/options for stop" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Additional user defined fields to fill in" }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "Requested date of the stop, as shown in the planning UI. Empty for stops without a requested date (e.g. standalone stops).", "examples": [ "2024-12-31" ] }, "depot": { "anyOf": [ { "$ref": "#/components/schemas/StopDepotOutput" }, { "type": "null" } ], "description": "Depot information for the stop. Only relevant for location bookings (load building)." }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for stop" }, "location": { "$ref": "#/components/schemas/LocationWithTerminalOutput-Output", "description": "Location of the stop" }, "mileage_km": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mileage Km", "description": "Mileage in kilometers" }, "end_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Timestamp", "description": "End of stop. The value depends on the stop status: the estimated end time until the stop reaches status COMPLETED, after which it is the actual end time reported during execution. ISO 8601 format in UTC.", "examples": [ "2024-12-31T08:15:00Z" ] }, "start_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Timestamp", "description": "Start of stop. The value depends on the stop status: the estimated start time until the stop reaches status AT_STOP, after which it is the actual start time reported during execution. ISO 8601 format in UTC.", "examples": [ "2024-12-31T08:00:00Z" ] }, "incidents": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Incident" }, "type": "array" }, { "type": "null" } ], "title": "Incidents", "description": "List of incidents" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "description": "Status of the stop. One of: TEMPLATE, BLOCKED, TO_PLAN, PLANNED, DISPATCHED, ROUTE_TO_STOP, AT_STOP, COMPLETED, CANCELLED, IGNORED.", "examples": [ "PLANNED" ] } }, "type": "object", "required": [ "id", "location" ], "title": "StopOutput" }, "StopPosition": { "properties": { "position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Position" } }, "type": "object", "title": "StopPosition" }, "StopStatusUpdate": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the stop. If not known, use the `match` property instead." }, "match": { "anyOf": [ { "$ref": "#/components/schemas/StopMatchTarget" }, { "type": "null" } ], "description": "Matching criteria for the stop to update when the `id` is not known. This will attempt to find a match to a single stop using provided filtering criteria. If multiple stops are matched, this update will be discarded" }, "eta_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Eta Start", "description": "Estimated arrival time (ETA) at the stop in UTC. Include a timezone offset, for example `Z` or `+02:00`." }, "eta_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Eta End", "description": "Estimated departure time (ETD) from the stop in UTC. Include a timezone offset, for example `Z` or `+02:00`." }, "status": { "anyOf": [ { "$ref": "#/components/schemas/StopStatusUpdateEnum" }, { "type": "null" } ], "description": "Updated status of the stop." }, "question_answers": { "type": "object", "title": "Question Answers", "description": "Data related to the status update. This data can be mapped to different entities in Qargo." } }, "type": "object", "title": "StopStatusUpdate", "description": "Update a stop from an external source.\n\nCan update status and data of a stop. Updates on the data happen based on the defined integration_data_mapping\nin the integration configuration." }, "StopStatusUpdateEnum": { "type": "string", "enum": [ "AT_STOP", "COMPLETED" ], "title": "StopStatusUpdateEnum" }, "StopType": { "type": "string", "enum": [ "PICKUP", "DELIVERY", "DEPOT_LOAD", "DEPOT_UNLOAD" ], "title": "StopType" }, "StopTypeField": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "row_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Row Id" } }, "type": "object", "title": "StopTypeField" }, "StopUpdate": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "type": { "type": "string", "const": "Stop", "title": "Type" }, "stop": { "$ref": "#/components/schemas/VisibilityStop" } }, "type": "object", "required": [ "id", "type", "stop" ], "title": "StopUpdate", "description": "Send update event on stop status change, from order perspective." }, "StopUpdateData": { "properties": { "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date" }, "reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number" }, "mobile_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mobile Number" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/LocationInput" }, { "type": "null" } ] }, "time_window": { "anyOf": [ { "$ref": "#/components/schemas/TimeWindowInput" }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, "type": "object", "title": "StopUpdateData" }, "SubcontractorDispatch": { "properties": { "operation": { "$ref": "#/components/schemas/DispatchOperation" }, "payload": { "$ref": "#/components/schemas/SubcontractorDispatchOutput" } }, "type": "object", "required": [ "operation", "payload" ], "title": "SubcontractorDispatch" }, "SubcontractorDispatchOutput": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the dispatched trip" }, "name": { "type": "string", "title": "Name" }, "orders": { "items": { "$ref": "#/components/schemas/DispatchOrder" }, "type": "array", "title": "Orders" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "Custom fields of the dispatched trip" }, "resource_allocations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceAllocation-Input" }, "type": "array" }, { "type": "null" } ], "title": "Resource Allocations" }, "stops": { "items": { "$ref": "#/components/schemas/StopOutput-Input" }, "type": "array", "title": "Stops", "description": "List of stops, sorted on the sequence in which they have been planned" } }, "type": "object", "required": [ "name", "orders", "resource_allocations", "stops" ], "title": "SubcontractorDispatchOutput" }, "SubcontractorDispatchResponse": { "properties": { "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorStatus" }, "type": "array" }, { "type": "null" } ], "title": "Errors", "description": "List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.", "examples": [ { "error_message": "The payload is invalid.", "error_type": "USER_INPUT_ERROR" }, { "error_message": "Not supported.", "error_type": "NOT_SUPPORTED" }, { "error_message": "Unknown error.", "error_type": "INTERNAL_ERROR" } ] } }, "type": "object", "title": "SubcontractorDispatchResponse", "description": "Response schema for the subcontractor dispatch payload.\nThis schema is used to return errors or success messages." }, "SubcontractorDocumentWithValidityTypeInput": { "type": "string", "enum": [ "ATA_CARNET", "BANK_DETAILS", "CMR_INSURANCE", "COMMON_HEALTH_ENTRY_DOCUMENT", "COMMUNICATION", "COMMUNICATION_SUBCONTRACTOR", "SUBCONTRACTOR_CONTRACT", "CREDIT_REPORT", "DGSA_CERTIFICATE", "ECMT_TRANSPORT_LICENSE", "EU_TRANSPORT_LICENSE", "EXPORT_HEALTH_CERTIFICATE", "FINE", "FREIGHT_FORWARDER_LICENSE", "SUBCONTRACTOR_LICENSE", "NATIONAL_TRANSPORT_LICENSE", "OTHER", "SUBCONTRACTOR_PERMIT", "POWER_OF_ATTORNEY", "QUESTIONNAIRE_CUSTOMER", "QUESTIONNAIRE_SUBCONTRACTOR", "SERVICE_LEVEL_AGREEMENT", "SQAS_CERTIFICATE", "COMPANY_TDS", "TRAILER_CLEANING_CERTIFICATE", "VAT_VIES_VALIDATION", "SUBCONTRACTOR_WASTE_LICENSE", "WASTE_PERMIT_GREEN_EU", "WASTE_PERMIT_ORANGE_EU", "WASTE_PERMIT_ORANGE_GREEN_EU", "XL_CERTIFICATE" ], "title": "SubcontractorDocumentWithValidityTypeInput" }, "SubcontractorDocumentWithoutValidityTypeInput": { "type": "string", "enum": [ "ATA_CARNET", "BANK_DETAILS", "CARGO_INSURANCE", "CMR_INSURANCE", "COMMON_HEALTH_ENTRY_DOCUMENT", "COMMUNICATION_SUBCONTRACTOR", "COMMUNICATION", "COMPANY_TDS", "CREDIT_REPORT", "DGSA_CERTIFICATE", "DOMESTIC_CARGO_INSURANCE", "ECMT_TRANSPORT_LICENSE", "EU_TRANSPORT_LICENSE", "EXPORT_HEALTH_CERTIFICATE", "FINE", "FREIGHT_FORWARDER_LICENSE", "INSURANCE_3RD_PARTY_TRAILER", "NATIONAL_TRANSPORT_LICENSE", "OTHER", "POWER_OF_ATTORNEY", "QUESTIONNAIRE_CUSTOMER", "QUESTIONNAIRE_SUBCONTRACTOR", "SERVICE_LEVEL_AGREEMENT", "SQAS_CERTIFICATE", "SUBCONTRACTOR_CONTRACT", "SUBCONTRACTOR_INSURANCE", "SUBCONTRACTOR_LIABILITY_INSURANCE", "SUBCONTRACTOR_LICENSE", "SUBCONTRACTOR_MOTOR_INSURANCE", "SUBCONTRACTOR_PERMIT", "SUBCONTRACTOR_WASTE_LICENSE", "TRAILER_CLEANING_CERTIFICATE", "VAT_VIES_VALIDATION", "WASTE_PERMIT_GREEN_EU", "WASTE_PERMIT_ORANGE_EU", "WASTE_PERMIT_ORANGE_GREEN_EU", "XL_CERTIFICATE" ], "title": "SubcontractorDocumentWithoutValidityTypeInput" }, "SubcontractorInsuranceDocumentTypeInput": { "type": "string", "enum": [ "DOMESTIC_CARGO_INSURANCE", "SUBCONTRACTOR_INSURANCE", "INSURANCE_3RD_PARTY_TRAILER", "CARGO_INSURANCE", "SUBCONTRACTOR_LIABILITY_INSURANCE", "SUBCONTRACTOR_MOTOR_INSURANCE" ], "title": "SubcontractorInsuranceDocumentTypeInput" }, "SubcontractorMatchInput": { "properties": { "name": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "generic_id": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "integration_object_id": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ], "description": "The resource ID in the given context of your integration. " } }, "type": "object", "title": "SubcontractorMatchInput", "example": { "name": { "matches_any": [ "Acme Logistics" ] } } }, "SubcontractorStatus": { "type": "string", "enum": [ "NOT_APPROVED", "APPROVED", "WARNING", "BLOCKED" ], "title": "SubcontractorStatus" }, "SubcontractorStatusUpdatePayload": { "properties": { "updates": { "items": { "$ref": "#/components/schemas/BaseStatusUpdate" }, "type": "array", "title": "Updates", "description": "List of status updates for stops" } }, "type": "object", "required": [ "updates" ], "title": "SubcontractorStatusUpdatePayload" }, "SubcontractorValidityReason": { "type": "string", "enum": [ "ATA_CARNET", "BANK_DETAILS", "CMR_INSURANCE", "COMMON_HEALTH_ENTRY_DOCUMENT", "COMMUNICATION", "COMMUNICATION_SUBCONTRACTOR", "SUBCONTRACTOR_CONTRACT", "CREDIT_REPORT", "DGSA_CERTIFICATE", "ECMT_TRANSPORT_LICENSE", "EU_TRANSPORT_LICENSE", "EXPORT_HEALTH_CERTIFICATE", "FINE", "FREIGHT_FORWARDER_LICENSE", "SUBCONTRACTOR_LICENSE", "NATIONAL_TRANSPORT_LICENSE", "SUBCONTRACTOR_OTHER", "SUBCONTRACTOR_PERMIT", "POWER_OF_ATTORNEY", "QUESTIONNAIRE_CUSTOMER", "QUESTIONNAIRE_SUBCONTRACTOR", "SERVICE_LEVEL_AGREEMENT", "SQAS_CERTIFICATE", "COMPANY_TDS", "TRAILER_CLEANING_CERTIFICATE", "VAT_VIES_VALIDATION", "SUBCONTRACTOR_WASTE_LICENSE", "WASTE_PERMIT_GREEN_EU", "WASTE_PERMIT_ORANGE_EU", "WASTE_PERMIT_ORANGE_GREEN_EU", "XL_CERTIFICATE", "DOMESTIC_CARGO_INSURANCE", "SUBCONTRACTOR_INSURANCE", "INSURANCE_3RD_PARTY_TRAILER", "CARGO_INSURANCE", "SUBCONTRACTOR_LIABILITY_INSURANCE", "SUBCONTRACTOR_MOTOR_INSURANCE" ], "title": "SubcontractorValidityReason" }, "SubjectType": { "type": "string", "enum": [ "SALES_INVOICE", "SALES_CREDIT_NOTE", "PURCHASE_INVOICE", "PURCHASE_CREDIT_NOTE" ], "title": "SubjectType" }, "TPNConsignmentInput": { "properties": { "consignment_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consignment Number" } }, "type": "object", "title": "TPNConsignmentInput" }, "TachographActivityEnum": { "type": "string", "enum": [ "DRIVING", "WORKING", "BREAK", "REST", "WAITING", "UNKNOWN" ], "title": "TachographActivityEnum" }, "TaskDetail": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "status": { "$ref": "#/components/schemas/TaskStatus" }, "task_type": { "$ref": "#/components/schemas/TaskType" }, "execution_metadata": { "anyOf": [ { "$ref": "#/components/schemas/TaskInstanceExecutionMetadata" }, { "type": "null" } ] }, "payload": { "anyOf": [ { "$ref": "#/components/schemas/TaskPayload" }, { "type": "null" } ] }, "invoice_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Invoice Id" } }, "type": "object", "required": [ "id", "status", "task_type" ], "title": "TaskDetail" }, "TaskFailureStatus": { "properties": { "error_type": { "$ref": "#/components/schemas/ErrorType" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message", "description": "(User visible) error message" } }, "type": "object", "required": [ "error_type" ], "title": "TaskFailureStatus" }, "TaskInstanceExecutionMetadata": { "properties": { "external_execution": { "anyOf": [ { "$ref": "#/components/schemas/ExternalExecutionMetadata" }, { "type": "null" } ] } }, "type": "object", "title": "TaskInstanceExecutionMetadata" }, "TaskPayload": { "properties": { "subject_id": { "type": "string", "format": "uuid", "title": "Subject Id", "description": "Task target id" }, "subject_type": { "$ref": "#/components/schemas/SubjectType", "description": "Task target type" }, "documents": { "items": { "$ref": "#/components/schemas/Document" }, "type": "array", "title": "Documents", "description": "List of related documents" }, "instance": { "anyOf": [ { "$ref": "#/components/schemas/SalesInvoiceOutput" }, { "$ref": "#/components/schemas/PurchaseInvoice" }, { "$ref": "#/components/schemas/SalesCreditNoteOutput" }, { "$ref": "#/components/schemas/PurchaseCreditNote" } ], "title": "Instance" } }, "type": "object", "required": [ "subject_id", "subject_type", "instance" ], "title": "TaskPayload", "description": "Task execution input data." }, "TaskStatus": { "type": "string", "enum": [ "TODO", "COMPLETED", "FAILED", "WAITING" ], "title": "TaskStatus" }, "TaskStatusInput": { "type": "string", "enum": [ "COMPLETED", "FAILED" ], "title": "TaskStatusInput" }, "TaskType": { "type": "string", "enum": [ "POST_INVOICE", "POST_INVOICE_PURCHASE", "POST_CREDIT_NOTE", "POST_CREDIT_NOTE_PURCHASE", "PAID_INVOICE", "PAID_INVOICE_PURCHASE", "REFUNDED_CREDIT_NOTE", "REFUNDED_CREDIT_NOTE_PURCHASE", "DISPATCH" ], "title": "TaskType" }, "TaskUpdate": { "properties": { "status": { "$ref": "#/components/schemas/TaskStatus" } }, "type": "object", "required": [ "status" ], "title": "TaskUpdate", "description": "Update task status result." }, "TaskUpdateInput": { "properties": { "status": { "$ref": "#/components/schemas/TaskStatusInput" }, "failure": { "anyOf": [ { "$ref": "#/components/schemas/TaskFailureStatus" }, { "type": "null" } ] } }, "type": "object", "required": [ "status" ], "title": "TaskUpdateInput", "description": "Update task status on completion/failure.\n\nThe failure field can be used to provide more information on failure." }, "TaxRateInput": { "properties": { "name": { "type": "string", "title": "Name", "description": "Display name of the tax rate." }, "percentage": { "type": "number", "title": "Percentage", "description": "Tax percentage, e.g. 21.0." }, "base_percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Base Percentage", "description": "Base percentage before tax rule adjustments." }, "code": { "type": "string", "title": "Code", "description": "Code used in the external accounting software." }, "tax_type": { "$ref": "#/components/schemas/TaxRateType", "description": "Tax type classification." }, "invoice_type": { "$ref": "#/components/schemas/TaxRateInvoiceType", "description": "Invoice type this tax rate applies to." }, "description": { "type": "string", "title": "Description", "description": "Optional description of the tax rate.", "default": "" }, "billing_entity": { "$ref": "#/components/schemas/BillingEntityReference", "description": "Billing entity this tax rate belongs to, referenced by code." }, "archived": { "type": "boolean", "title": "Archived", "description": "Whether this tax rate is archived.", "default": false } }, "type": "object", "required": [ "name", "percentage", "code", "tax_type", "invoice_type", "billing_entity" ], "title": "TaxRateInput" }, "TaxRateInvoiceType": { "type": "string", "enum": [ "SALES", "SALES_CREDIT_NOTE", "PURCHASE", "PURCHASE_CREDIT_NOTE" ], "title": "TaxRateInvoiceType" }, "TaxRateOutput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the record in Qargo." }, "archived": { "type": "boolean", "title": "Archived", "description": "Whether this record has been archived." }, "name": { "type": "string", "title": "Name", "description": "Display name of the tax rate." }, "billing_entity": { "$ref": "#/components/schemas/BillingEntity", "description": "Billing entity this tax rate belongs to." }, "percentage": { "type": "number", "title": "Percentage", "description": "Tax percentage, e.g. 21.0." }, "base_percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Base Percentage", "description": "Base percentage before applying customer/transport-specific tax rules." }, "code": { "type": "string", "title": "Code", "description": "Code used in the external accounting software." }, "tax_type": { "$ref": "#/components/schemas/TaxRateType", "description": "Tax type classification." }, "invoice_type": { "$ref": "#/components/schemas/TaxRateInvoiceType", "description": "Invoice type this tax rate applies to." }, "description": { "type": "string", "title": "Description", "description": "Optional description of the tax rate." } }, "type": "object", "required": [ "id", "archived", "name", "billing_entity", "percentage", "code", "tax_type", "invoice_type", "description" ], "title": "TaxRateOutput" }, "TaxRatePartialInput": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Display name of the tax rate." }, "percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Percentage", "description": "Tax percentage, e.g. 21.0." }, "base_percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Base Percentage", "description": "Base percentage before tax rule adjustments." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code used in the external accounting software." }, "tax_type": { "anyOf": [ { "$ref": "#/components/schemas/TaxRateType" }, { "type": "null" } ], "description": "Tax type classification." }, "invoice_type": { "anyOf": [ { "$ref": "#/components/schemas/TaxRateInvoiceType" }, { "type": "null" } ], "description": "Invoice type this tax rate applies to." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Optional description of the tax rate." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity this tax rate belongs to, referenced by code." }, "archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Archived", "description": "Whether this tax rate is archived." } }, "type": "object", "title": "TaxRatePartialInput" }, "TaxRateReference": { "properties": { "code": { "type": "string", "title": "Code", "description": "Code of the reference" } }, "type": "object", "required": [ "code" ], "title": "TaxRateReference" }, "TaxRateType": { "type": "string", "enum": [ "VAT", "NO_VAT", "REVERSE_CHARGE", "TRANSIT", "CO_CONTRACTING", "OTHER" ], "title": "TaxRateType" }, "TaxTypeEnum": { "type": "string", "enum": [ "VAT", "REVERSE_CHARGE", "TRANSIT", "NO_VAT", "CO_CONTRACTING", "OTHER" ], "title": "TaxTypeEnum" }, "TemperatureRequirements": { "properties": { "desired_temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Desired Temperature", "description": "Desired temperature set point." }, "desired_dual_temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Desired Dual Temperature", "description": "Desired temperature set point for the second compartment, for dual-zone units." } }, "type": "object", "title": "TemperatureRequirements" }, "TerminalMetadata": { "properties": { "terminal_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Terminal Email" }, "sgkv_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sgkv Code" }, "uirr_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uirr Code" }, "unlo_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unlo Code" }, "gateway": { "anyOf": [ { "$ref": "#/components/schemas/Gateway" }, { "type": "null" } ] } }, "type": "object", "title": "TerminalMetadata" }, "TimeInterval": { "properties": { "start_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Time", "description": "Opening time of the interval, formatted as HH:MM.", "examples": [ "08:00" ] }, "end_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Time", "description": "Closing time of the interval, formatted as HH:MM.", "examples": [ "17:30" ] } }, "type": "object", "title": "TimeInterval" }, "TimeIntervalInput": { "properties": { "start_time": { "type": "string", "format": "time", "title": "Start Time", "description": "Opening time of the interval, formatted as HH:MM.", "examples": [ "08:00" ] }, "end_time": { "type": "string", "format": "time", "title": "End Time", "description": "Closing time of the interval, formatted as HH:MM.", "examples": [ "17:30" ] } }, "type": "object", "required": [ "start_time", "end_time" ], "title": "TimeIntervalInput" }, "TimeWindow": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable identifier" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Machine readable identifier" }, "start_time": { "anyOf": [ { "type": "string", "format": "time" }, { "type": "null" } ], "title": "Start Time", "description": "Start of time window", "examples": [ "09:30" ] }, "end_time": { "anyOf": [ { "type": "string", "format": "time" }, { "type": "null" } ], "title": "End Time", "description": "End of time window", "examples": [ "16:30" ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "is_enforced": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Enforced", "description": "Enforce the time window for this stop" }, "use_location_opening_hours": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Use Location Opening Hours", "description": "When true, the stop's time window is derived from the location's opening hours instead of explicit start/end times" } }, "type": "object", "title": "TimeWindow" }, "TimeWindowInput": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "start_time": { "anyOf": [ { "type": "string", "format": "time" }, { "type": "null" } ], "title": "Start Time" }, "end_time": { "anyOf": [ { "type": "string", "format": "time" }, { "type": "null" } ], "title": "End Time" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "is_enforced": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Enforced" } }, "type": "object", "title": "TimeWindowInput" }, "Token": { "properties": { "access_token": { "type": "string", "title": "Access Token" }, "token_type": { "type": "string", "title": "Token Type" }, "expires_in": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expires In" } }, "type": "object", "required": [ "access_token", "token_type", "expires_in" ], "title": "Token" }, "TrackingMatchInput": { "properties": { "resource": { "anyOf": [ { "$ref": "#/components/schemas/TrackingResourceMatchInput" }, { "type": "null" } ] } }, "type": "object", "title": "TrackingMatchInput" }, "TrackingMatchTarget": { "properties": { "matches_any": { "items": { "$ref": "#/components/schemas/TrackingMatchInput" }, "type": "array", "title": "Matches Any" } }, "type": "object", "title": "TrackingMatchTarget" }, "TrackingResourceMatchInput": { "properties": { "driver": { "anyOf": [ { "$ref": "#/components/schemas/DriverMatchInput" }, { "type": "null" } ] }, "vehicle": { "anyOf": [ { "$ref": "#/components/schemas/VehicleMatchInput" }, { "type": "null" } ] }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/SubcontractorMatchInput" }, { "type": "null" } ] }, "container": { "anyOf": [ { "$ref": "#/components/schemas/ContainerMatchInput" }, { "type": "null" } ] } }, "type": "object", "title": "TrackingResourceMatchInput" }, "TrackingUpdateData": { "properties": { "position": { "anyOf": [ { "$ref": "#/components/schemas/TrackingUpdatePositionData" }, { "type": "null" } ] }, "temperature": { "anyOf": [ { "$ref": "#/components/schemas/TrackingUpdateTemperatureData" }, { "type": "null" } ] }, "tachograph": { "anyOf": [ { "$ref": "#/components/schemas/TrackingUpdateTachographData" }, { "type": "null" } ] }, "fuel": { "anyOf": [ { "$ref": "#/components/schemas/TrackingUpdateFuelData" }, { "type": "null" } ] }, "mileage": { "anyOf": [ { "$ref": "#/components/schemas/TrackingUpdateMileageData" }, { "type": "null" } ] }, "weight": { "anyOf": [ { "$ref": "#/components/schemas/TrackingUpdateWeightData" }, { "type": "null" } ] }, "voltage": { "anyOf": [ { "$ref": "#/components/schemas/TrackingUpdateVoltageData" }, { "type": "null" } ] } }, "type": "object", "title": "TrackingUpdateData" }, "TrackingUpdateFuelData": { "properties": { "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp", "description": "Timestamp at which tracking event occured", "examples": [ "2024-01-15T10:30:00Z" ] }, "fuel_level_percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Fuel Level Percentage", "examples": [ 75 ] } }, "type": "object", "required": [ "timestamp" ], "title": "TrackingUpdateFuelData" }, "TrackingUpdateItem": { "properties": { "tracking_match": { "$ref": "#/components/schemas/TrackingMatchTarget" }, "tracking_update_data": { "items": { "$ref": "#/components/schemas/TrackingUpdateData" }, "type": "array", "title": "Tracking Update Data" } }, "type": "object", "required": [ "tracking_match" ], "title": "TrackingUpdateItem" }, "TrackingUpdateMileageData": { "properties": { "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp", "description": "Timestamp at which tracking event occured", "examples": [ "2024-01-15T10:30:00Z" ] }, "mileage_meter": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mileage Meter", "examples": [ 150000 ] } }, "type": "object", "required": [ "timestamp" ], "title": "TrackingUpdateMileageData" }, "TrackingUpdatePayload": { "properties": { "updates": { "items": { "$ref": "#/components/schemas/TrackingUpdateItem" }, "type": "array", "title": "Updates", "description": "List of tracking updates to process" } }, "type": "object", "title": "TrackingUpdatePayload" }, "TrackingUpdatePositionData": { "properties": { "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp", "description": "Timestamp at which tracking event occured", "examples": [ "2024-01-15T10:30:00Z" ] }, "latitude": { "type": "number", "title": "Latitude", "examples": [ 51.0543 ] }, "longitude": { "type": "number", "title": "Longitude", "examples": [ 3.7174 ] } }, "type": "object", "required": [ "timestamp", "latitude", "longitude" ], "title": "TrackingUpdatePositionData" }, "TrackingUpdateResponse": { "properties": { "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorStatus" }, "type": "array" }, { "type": "null" } ], "title": "Errors", "description": "List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.", "examples": [ { "error_message": "The payload is invalid.", "error_type": "USER_INPUT_ERROR" }, { "error_message": "Not supported.", "error_type": "NOT_SUPPORTED" }, { "error_message": "Unknown error.", "error_type": "INTERNAL_ERROR" } ] } }, "type": "object", "title": "TrackingUpdateResponse", "description": "Response schema for the tracking update webhook.\nThis schema is used to return errors or success messages." }, "TrackingUpdateTachographData": { "properties": { "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp", "description": "Timestamp at which tracking event occured", "examples": [ "2024-01-15T10:30:00Z" ] }, "activity": { "anyOf": [ { "$ref": "#/components/schemas/TachographActivityEnum" }, { "type": "null" } ], "description": "Tachograph activity", "examples": [ "DRIVING" ] }, "driving_since": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Driving Since", "examples": [ "2024-01-15T08:00:00Z" ] }, "resting_since": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Resting Since" }, "on_break_since": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "On Break Since" }, "waiting_since": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Waiting Since" }, "next_break_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Break At", "examples": [ "2024-01-15T12:30:00Z" ] }, "next_rest_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Rest At" } }, "type": "object", "required": [ "timestamp" ], "title": "TrackingUpdateTachographData" }, "TrackingUpdateTemperatureData": { "properties": { "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp", "description": "Timestamp at which tracking event occured", "examples": [ "2024-01-15T10:30:00Z" ] }, "temperatures": { "items": { "$ref": "#/components/schemas/TrackingUpdateTemperatureMeasurement" }, "type": "array", "title": "Temperatures" }, "temperature_setpoints": { "items": { "$ref": "#/components/schemas/TrackingUpdateTemperatureMeasurement" }, "type": "array", "title": "Temperature Setpoints" } }, "type": "object", "required": [ "timestamp" ], "title": "TrackingUpdateTemperatureData" }, "TrackingUpdateTemperatureMeasurement": { "properties": { "sensor": { "type": "string", "title": "Sensor", "description": "The sensor from which the temperature was measured", "examples": [ "sensor-1" ] }, "temperature": { "type": "number", "title": "Temperature", "description": "The measured temperature value in degrees Celsius", "examples": [ -18.5 ] } }, "type": "object", "required": [ "sensor", "temperature" ], "title": "TrackingUpdateTemperatureMeasurement" }, "TrackingUpdateVoltageData": { "properties": { "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp", "description": "Timestamp at which tracking event occured", "examples": [ "2024-01-15T10:30:00Z" ] }, "external_power_supply_voltage_mv": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "External Power Supply Voltage Mv", "description": "External supply voltage in millivolts. Report the voltage of the external power line, not the internal battery: a unit running on its own battery should report a value at or near zero.", "examples": [ 24000 ] } }, "type": "object", "required": [ "timestamp" ], "title": "TrackingUpdateVoltageData" }, "TrackingUpdateWeightData": { "properties": { "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp", "description": "Timestamp at which tracking event occured", "examples": [ "2024-01-15T10:30:00Z" ] }, "axle_weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Axle Weight", "examples": [ 8500 ] } }, "type": "object", "required": [ "timestamp" ], "title": "TrackingUpdateWeightData" }, "TractorProperties-Input": { "properties": { "tare_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Tare Weight Kg", "description": "Tare weight of the tractor in kg", "examples": [ 10000 ] }, "exterior_length_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Length M", "description": "Exterior length of the tractor in meter", "examples": [ 10 ] }, "exterior_width_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Width M", "description": "Exterior width of the tractor in meter", "examples": [ 5 ] }, "exterior_height_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Height M", "description": "Exterior height of the tractor in meter", "examples": [ 3 ] }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the tractor" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the tractor" }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the tractor" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the tractor" }, "axle_configuration": { "anyOf": [ { "type": "string", "enum": [ "AC_4_X_2", "AC_4_X_4", "AC_6_X_2", "AC_6_X_4", "AC_6_X_6", "AC_8_X_2", "AC_8_X_4", "AC_8_X_6", "AC_10_X_4", "AC_12_X_4" ] }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the tractor" }, "emission_class": { "anyOf": [ { "type": "string", "enum": [ "EURO_1", "EURO_2", "EURO_3", "EURO_4", "EURO_5", "EURO_6" ] }, { "type": "null" } ], "title": "Emission Class", "description": "Emission class of the tractor" }, "fuel_type": { "anyOf": [ { "type": "string", "enum": [ "DIESEL", "BIOFUELS", "LPG", "ELECTRIC", "HYBRID_ELECTRIC" ] }, { "type": "null" } ], "title": "Fuel Type", "description": "Fuel type of the tractor" } }, "type": "object", "title": "TractorProperties" }, "TractorProperties-Output": { "properties": { "tare_weight_kg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tare Weight Kg", "description": "Tare weight of the tractor in kg", "examples": [ 10000 ] }, "exterior_length_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Length M", "description": "Exterior length of the tractor in meter", "examples": [ 10 ] }, "exterior_width_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Width M", "description": "Exterior width of the tractor in meter", "examples": [ 5 ] }, "exterior_height_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Height M", "description": "Exterior height of the tractor in meter", "examples": [ 3 ] }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the tractor" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the tractor" }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the tractor" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the tractor" }, "axle_configuration": { "anyOf": [ { "type": "string", "enum": [ "AC_4_X_2", "AC_4_X_4", "AC_6_X_2", "AC_6_X_4", "AC_6_X_6", "AC_8_X_2", "AC_8_X_4", "AC_8_X_6", "AC_10_X_4", "AC_12_X_4" ] }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the tractor" }, "emission_class": { "anyOf": [ { "type": "string", "enum": [ "EURO_1", "EURO_2", "EURO_3", "EURO_4", "EURO_5", "EURO_6" ] }, { "type": "null" } ], "title": "Emission Class", "description": "Emission class of the tractor" }, "fuel_type": { "anyOf": [ { "type": "string", "enum": [ "DIESEL", "BIOFUELS", "LPG", "ELECTRIC", "HYBRID_ELECTRIC" ] }, { "type": "null" } ], "title": "Fuel Type", "description": "Fuel type of the tractor" } }, "type": "object", "title": "TractorProperties" }, "TractorResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "tractor": { "anyOf": [ { "$ref": "#/components/schemas/TractorProperties-Input" }, { "type": "null" } ], "description": "Tractor specific properties" } }, "type": "object", "required": [ "name" ], "title": "TractorResourceInput" }, "TractorResourceOutput": { "properties": { "row_id": { "type": "string", "format": "uuid", "title": "Row Id", "description": "Identifier of the reference" }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "External identifier of the resource" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the resource" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntity" }, { "type": "null" } ], "description": "Billing entity associated with the resource" }, "extras": { "items": { "$ref": "#/components/schemas/ResourceExtraOutput" }, "type": "array", "title": "Extras", "description": "Stop extras this resource is compatible with" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active", "description": "Is the resource active" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "timestamp_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp Updated", "description": "Timestamp of the last update of the resource" }, "resource_groups": { "items": { "$ref": "#/components/schemas/ResourceGroupOutput" }, "type": "array", "title": "Resource Groups", "description": "Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded." }, "tractor": { "anyOf": [ { "$ref": "#/components/schemas/TractorProperties-Output" }, { "type": "null" } ], "description": "Tractor specific properties" } }, "type": "object", "required": [ "row_id", "name" ], "title": "TractorResourceOutput" }, "Trailer": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the resource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Is the resource archived" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyOutput-Input" }, { "type": "null" } ], "description": "Subcontractor linked to the resource" }, "resource_type": { "anyOf": [ { "$ref": "#/components/schemas/ResourceTypeEnum" }, { "type": "null" } ], "description": "Type of the resource" }, "axle_configuration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the vehicle" }, "emission_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Emission Class", "description": "Emission class of the vehicle" }, "fuel_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fuel Type", "description": "Fuel type of the vehicle" }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the vehicle" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the vehicle" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the vehicle" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the vehicle" }, "roof_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Roof Type", "description": "Roof type of the vehicle" }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the vehicle" } }, "type": "object", "title": "Trailer" }, "TrailerProperties-Input": { "properties": { "capacity_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Capacity Pallet Spaces", "description": "Capacity of the trailer in pallet spaces", "examples": [ 10 ] }, "capacity_volume_m3": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Capacity Volume M3", "description": "Capacity of the trailer in cubic meters", "examples": [ 10 ] }, "capacity_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Capacity Weight Kg", "description": "Capacity of the trailer in kg", "examples": [ 10000 ] }, "tare_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Tare Weight Kg", "description": "Tare weight of the trailer in kg", "examples": [ 10000 ] }, "exterior_length_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Length M", "description": "Exterior length of the trailer in meter", "examples": [ 10 ] }, "exterior_width_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Width M", "description": "Exterior width of the trailer in meter", "examples": [ 5 ] }, "exterior_height_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Height M", "description": "Exterior height of the trailer in meter", "examples": [ 3 ] }, "gross_weight_vehicle_rating_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Gross Weight Vehicle Rating Weight Kg", "description": "Gross weight vehicle rating weight of the trailer in kg", "examples": [ 10 ] }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the trailer" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the trailer" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the trailer" }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the trailer" }, "axle_configuration": { "anyOf": [ { "type": "string", "enum": [ "AC_12_TRAILER", "AC_10_TRAILER", "AC_8_TRAILER", "AC_6_TRAILER", "AC_4_TRAILER", "AC_2_TRAILER" ] }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the trailer" } }, "type": "object", "title": "TrailerProperties" }, "TrailerProperties-Output": { "properties": { "capacity_pallet_spaces": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Pallet Spaces", "description": "Capacity of the trailer in pallet spaces", "examples": [ 10 ] }, "capacity_volume_m3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Volume M3", "description": "Capacity of the trailer in cubic meters", "examples": [ 10 ] }, "capacity_weight_kg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Weight Kg", "description": "Capacity of the trailer in kg", "examples": [ 10000 ] }, "tare_weight_kg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tare Weight Kg", "description": "Tare weight of the trailer in kg", "examples": [ 10000 ] }, "exterior_length_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Length M", "description": "Exterior length of the trailer in meter", "examples": [ 10 ] }, "exterior_width_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Width M", "description": "Exterior width of the trailer in meter", "examples": [ 5 ] }, "exterior_height_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Height M", "description": "Exterior height of the trailer in meter", "examples": [ 3 ] }, "gross_weight_vehicle_rating_weight_kg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gross Weight Vehicle Rating Weight Kg", "description": "Gross weight vehicle rating weight of the trailer in kg", "examples": [ 10 ] }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the trailer" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the trailer" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the trailer" }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the trailer" }, "axle_configuration": { "anyOf": [ { "type": "string", "enum": [ "AC_12_TRAILER", "AC_10_TRAILER", "AC_8_TRAILER", "AC_6_TRAILER", "AC_4_TRAILER", "AC_2_TRAILER" ] }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the trailer" } }, "type": "object", "title": "TrailerProperties" }, "TrailerResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "trailer": { "anyOf": [ { "$ref": "#/components/schemas/TrailerProperties-Input" }, { "type": "null" } ], "description": "Trailer specific properties" } }, "type": "object", "required": [ "name" ], "title": "TrailerResourceInput" }, "TrailerResourceOutput": { "properties": { "row_id": { "type": "string", "format": "uuid", "title": "Row Id", "description": "Identifier of the reference" }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "External identifier of the resource" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the resource" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntity" }, { "type": "null" } ], "description": "Billing entity associated with the resource" }, "extras": { "items": { "$ref": "#/components/schemas/ResourceExtraOutput" }, "type": "array", "title": "Extras", "description": "Stop extras this resource is compatible with" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active", "description": "Is the resource active" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "timestamp_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp Updated", "description": "Timestamp of the last update of the resource" }, "resource_groups": { "items": { "$ref": "#/components/schemas/ResourceGroupOutput" }, "type": "array", "title": "Resource Groups", "description": "Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded." }, "trailer": { "anyOf": [ { "$ref": "#/components/schemas/TrailerProperties-Output" }, { "type": "null" } ], "description": "Trailer specific properties" } }, "type": "object", "required": [ "row_id", "name" ], "title": "TrailerResourceOutput" }, "TransitDeclarationTypeEnum": { "type": "string", "enum": [ "T1", "T2" ], "title": "TransitDeclarationTypeEnum" }, "TransitOffice": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Customs office code" } }, "type": "object", "title": "TransitOffice" }, "TransporeonConsignmentExtraFields": { "properties": { "delivery_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery Id", "description": "Transporeon Delivery ID" } }, "type": "object", "title": "TransporeonConsignmentExtraFields" }, "TransporeonOrderExtraFields": { "properties": { "transport_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transport Id", "description": "Transporeon Transport ID" }, "transport_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transport Number", "description": "Transporeon Transport Number" } }, "type": "object", "title": "TransporeonOrderExtraFields" }, "TransportType": { "properties": { "driver_type": { "$ref": "#/components/schemas/DriverMode", "description": "Whether the transport is accompanied or unaccompanied." }, "number_of_drivers": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Number Of Drivers", "description": "Number of drivers required for the transport." } }, "type": "object", "required": [ "driver_type" ], "title": "TransportType" }, "TripCostsOutput": { "properties": { "charges": { "items": { "$ref": "#/components/schemas/ChargeOutput" }, "type": "array", "title": "Charges" } }, "type": "object", "required": [ "charges" ], "title": "TripCostsOutput" }, "TripImportInput": { "properties": { "trip_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trip Identifier", "description": "External identifier for the trip" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/TripImportStatus" }, { "type": "null" } ], "description": "Status of the trip import" }, "planned_stops": { "items": { "$ref": "#/components/schemas/TripImportStop" }, "type": "array", "title": "Planned Stops", "description": "List of planned stops in the trip" }, "start_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Timestamp", "description": "Start timestamp of the trip in UTC" }, "primary_resources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TripImportResource" }, "type": "array" }, { "type": "null" } ], "title": "Primary Resources", "description": "List of primary resources assigned to the trip" }, "unassigned_stops": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TripImportUnassignedStop" }, "type": "array" }, { "type": "null" } ], "title": "Unassigned Stops", "description": "List of stops that couldn't be assigned to any resource" }, "failure": { "anyOf": [ { "$ref": "#/components/schemas/ErrorStatus" }, { "type": "null" } ], "description": "Error details if the trip import failed upstream" } }, "type": "object", "required": [ "planned_stops" ], "title": "TripImportInput" }, "TripImportLocation": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the location in Qargo" } }, "type": "object", "title": "TripImportLocation" }, "TripImportResource": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the resource in Qargo" } }, "type": "object", "required": [ "id" ], "title": "TripImportResource" }, "TripImportResponse": { "properties": { "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorStatus" }, "type": "array" }, { "type": "null" } ], "title": "Errors", "description": "List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.", "examples": [ { "error_message": "The payload is invalid.", "error_type": "USER_INPUT_ERROR" }, { "error_message": "Not supported.", "error_type": "NOT_SUPPORTED" }, { "error_message": "Unknown error.", "error_type": "INTERNAL_ERROR" } ] } }, "type": "object", "title": "TripImportResponse" }, "TripImportStatus": { "type": "string", "enum": [ "CANCELLED" ], "title": "TripImportStatus" }, "TripImportStop": { "properties": { "sequence": { "type": "integer", "title": "Sequence", "description": "Sequence number determining the order of stops" }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the stop in Qargo" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/TripImportLocation" }, { "type": "null" } ], "description": "Location of the stop" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "Custom fields for the stop" }, "start_timestamp": { "type": "string", "format": "date-time", "title": "Start Timestamp", "description": "Start timestamp of the stop in UTC" }, "end_timestamp": { "type": "string", "format": "date-time", "title": "End Timestamp", "description": "End timestamp of the stop in UTC" }, "fixed_timestamp_type": { "anyOf": [ { "$ref": "#/components/schemas/FixedTimestampType" }, { "type": "null" } ], "description": "Type of fixed timestamp constraint on the stop" }, "question_answers": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Question Answers", "description": "Question answers, format to be defined between Qargo and external party" } }, "type": "object", "required": [ "sequence", "start_timestamp", "end_timestamp" ], "title": "TripImportStop" }, "TripImportUnassignedStop": { "properties": { "stop_id": { "type": "string", "format": "uuid", "title": "Stop Id", "description": "ID of the stop that couldn't be assigned" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason", "description": "Reason for not being able to assign the stop" } }, "type": "object", "required": [ "stop_id" ], "title": "TripImportUnassignedStop" }, "TripMatch": { "properties": { "name": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] } }, "type": "object", "title": "TripMatch" }, "TripMetrics": { "properties": { "co2e_tank_to_wheel_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Co2E Tank To Wheel Kg", "description": "CO2 equivalent emissions (tank-to-wheel) in kilograms" }, "co2e_well_to_tank_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Co2E Well To Tank Kg", "description": "CO2 equivalent emissions (well-to-tank) in kilograms" }, "co2e_well_to_wheel_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Co2E Well To Wheel Kg", "description": "CO2 equivalent emissions (well-to-wheel) in kilograms" }, "distance_total_km": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Distance Total Km", "description": "Total distance in kilometers" } }, "type": "object", "title": "TripMetrics" }, "TripOutput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the trip" }, "name": { "type": "string", "title": "Name", "description": "Name of the trip" }, "status": { "$ref": "#/components/schemas/TripStatusOutput", "description": "Status of the trip" }, "orders": { "items": { "$ref": "#/components/schemas/MinimalOrderOutput" }, "type": "array", "title": "Orders", "description": "List of orders associated with the trip" }, "resource_allocations": { "items": { "$ref": "#/components/schemas/ResourceAllocation-Output" }, "type": "array", "title": "Resource Allocations", "description": "List of resources allocated to the trip" }, "stops": { "items": { "$ref": "#/components/schemas/TripStopOutput" }, "type": "array", "title": "Stops", "description": "List of stops associated with the trip" }, "metrics": { "anyOf": [ { "$ref": "#/components/schemas/TripMetrics" }, { "type": "null" } ], "description": "Trip distance and emission metrics" }, "shipment_planning_group": { "anyOf": [ { "$ref": "#/components/schemas/PlanningGroup" }, { "type": "null" } ], "description": "Planning group linked to the trip" } }, "type": "object", "required": [ "id", "name", "status", "orders", "stops" ], "title": "TripOutput" }, "TripStatus": { "type": "string", "enum": [ "DRAFT", "TEMPLATE", "BLOCKED", "TO_PLAN", "PLANNED", "DISPATCHED", "IN_PROGRESS", "COMPLETED", "CANCELLED", "IGNORED" ], "title": "TripStatus" }, "TripStatusOutput": { "type": "string", "enum": [ "CREATED", "PLANNED", "COMPLETED" ], "title": "TripStatusOutput" }, "TripStopOutput": { "properties": { "activity_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Activity Label", "description": "Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional freeform data for this stop" }, "reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "stop reference number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number" }, "mobile_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mobile Number" }, "time_window": { "anyOf": [ { "$ref": "#/components/schemas/TimeWindow" }, { "type": "null" } ], "title": "time_window" }, "planning_instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Planning Instructions", "description": "Additional freeform instructions for the planner." }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StopExtra" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Additional services/options for stop" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Additional user defined fields to fill in" }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "Requested date of the stop, as shown in the planning UI. Empty for stops without a requested date (e.g. standalone stops).", "examples": [ "2024-12-31" ] }, "depot": { "anyOf": [ { "$ref": "#/components/schemas/StopDepotOutput" }, { "type": "null" } ], "description": "Depot information for the stop. Only relevant for location bookings (load building)." }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for stop" }, "location": { "$ref": "#/components/schemas/LocationWithTerminalOutput-Output", "description": "Location of the stop" }, "mileage_km": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mileage Km", "description": "Mileage in kilometers" }, "end_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Timestamp", "description": "End of stop. The value depends on the stop status: the estimated end time until the stop reaches status COMPLETED, after which it is the actual end time reported during execution. ISO 8601 format in UTC.", "examples": [ "2024-12-31T08:15:00Z" ] }, "start_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Timestamp", "description": "Start of stop. The value depends on the stop status: the estimated start time until the stop reaches status AT_STOP, after which it is the actual start time reported during execution. ISO 8601 format in UTC.", "examples": [ "2024-12-31T08:00:00Z" ] }, "incidents": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Incident" }, "type": "array" }, { "type": "null" } ], "title": "Incidents", "description": "List of incidents" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "description": "Status of the stop. One of: TEMPLATE, BLOCKED, TO_PLAN, PLANNED, DISPATCHED, ROUTE_TO_STOP, AT_STOP, COMPLETED, CANCELLED, IGNORED.", "examples": [ "PLANNED" ] }, "order": { "anyOf": [ { "$ref": "#/components/schemas/OrderReference" }, { "type": "null" } ], "description": "Reference to the Order linked to this stop" } }, "type": "object", "required": [ "id", "location" ], "title": "TripStopOutput" }, "TripUpdate": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "type": { "type": "string", "const": "Trip", "title": "Type" }, "status": { "$ref": "#/components/schemas/VisibilityTripStatus" } }, "type": "object", "required": [ "type", "status" ], "title": "TripUpdate", "description": "Send update event on trip status transitions." }, "TruckProperties-Input": { "properties": { "capacity_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Capacity Pallet Spaces", "description": "Capacity of the truck in pallet spaces", "examples": [ 10 ] }, "capacity_volume_m3": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Capacity Volume M3", "description": "Capacity of the truck in cubic meters", "examples": [ 10 ] }, "capacity_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Capacity Weight Kg", "description": "Capacity of the truck in kg", "examples": [ 10000 ] }, "tare_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Tare Weight Kg", "description": "Tare weight of the truck in kg", "examples": [ 10000 ] }, "exterior_length_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Length M", "description": "Exterior length of the truck in meter", "examples": [ 10 ] }, "exterior_width_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Width M", "description": "Exterior width of the truck in meter", "examples": [ 5 ] }, "exterior_height_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Height M", "description": "Exterior height of the truck in meter", "examples": [ 3 ] }, "gross_weight_vehicle_rating_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Gross Weight Vehicle Rating Weight Kg", "description": "Gross weight vehicle rating weight of the truck in kg", "examples": [ 10 ] }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the truck" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the truck" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the truck" }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the truck" }, "axle_configuration": { "anyOf": [ { "type": "string", "enum": [ "AC_4_X_2", "AC_4_X_4", "AC_6_X_2", "AC_6_X_4", "AC_6_X_6", "AC_8_X_2", "AC_8_X_4", "AC_8_X_6", "AC_10_X_4", "AC_12_X_4" ] }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the truck" }, "emission_class": { "anyOf": [ { "type": "string", "enum": [ "EURO_1", "EURO_2", "EURO_3", "EURO_4", "EURO_5", "EURO_6" ] }, { "type": "null" } ], "title": "Emission Class", "description": "Emission class of the truck" }, "fuel_type": { "anyOf": [ { "type": "string", "enum": [ "DIESEL", "BIOFUELS", "LPG", "ELECTRIC", "HYBRID_ELECTRIC" ] }, { "type": "null" } ], "title": "Fuel Type", "description": "Fuel type of the truck" }, "roof_type": { "anyOf": [ { "type": "string", "enum": [ "CLOSED", "OPEN", "FLATBED" ] }, { "type": "null" } ], "title": "Roof Type", "description": "Roof type of the truck" } }, "type": "object", "title": "TruckProperties" }, "TruckProperties-Output": { "properties": { "capacity_pallet_spaces": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Pallet Spaces", "description": "Capacity of the truck in pallet spaces", "examples": [ 10 ] }, "capacity_volume_m3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Volume M3", "description": "Capacity of the truck in cubic meters", "examples": [ 10 ] }, "capacity_weight_kg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Weight Kg", "description": "Capacity of the truck in kg", "examples": [ 10000 ] }, "tare_weight_kg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tare Weight Kg", "description": "Tare weight of the truck in kg", "examples": [ 10000 ] }, "exterior_length_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Length M", "description": "Exterior length of the truck in meter", "examples": [ 10 ] }, "exterior_width_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Width M", "description": "Exterior width of the truck in meter", "examples": [ 5 ] }, "exterior_height_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Height M", "description": "Exterior height of the truck in meter", "examples": [ 3 ] }, "gross_weight_vehicle_rating_weight_kg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gross Weight Vehicle Rating Weight Kg", "description": "Gross weight vehicle rating weight of the truck in kg", "examples": [ 10 ] }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the truck" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the truck" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the truck" }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the truck" }, "axle_configuration": { "anyOf": [ { "type": "string", "enum": [ "AC_4_X_2", "AC_4_X_4", "AC_6_X_2", "AC_6_X_4", "AC_6_X_6", "AC_8_X_2", "AC_8_X_4", "AC_8_X_6", "AC_10_X_4", "AC_12_X_4" ] }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the truck" }, "emission_class": { "anyOf": [ { "type": "string", "enum": [ "EURO_1", "EURO_2", "EURO_3", "EURO_4", "EURO_5", "EURO_6" ] }, { "type": "null" } ], "title": "Emission Class", "description": "Emission class of the truck" }, "fuel_type": { "anyOf": [ { "type": "string", "enum": [ "DIESEL", "BIOFUELS", "LPG", "ELECTRIC", "HYBRID_ELECTRIC" ] }, { "type": "null" } ], "title": "Fuel Type", "description": "Fuel type of the truck" }, "roof_type": { "anyOf": [ { "type": "string", "enum": [ "CLOSED", "OPEN", "FLATBED" ] }, { "type": "null" } ], "title": "Roof Type", "description": "Roof type of the truck" } }, "type": "object", "title": "TruckProperties" }, "TruckResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "truck": { "anyOf": [ { "$ref": "#/components/schemas/TruckProperties-Input" }, { "type": "null" } ], "description": "Truck specific properties" } }, "type": "object", "required": [ "name" ], "title": "TruckResourceInput" }, "TruckResourceOutput": { "properties": { "row_id": { "type": "string", "format": "uuid", "title": "Row Id", "description": "Identifier of the reference" }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "External identifier of the resource" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the resource" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntity" }, { "type": "null" } ], "description": "Billing entity associated with the resource" }, "extras": { "items": { "$ref": "#/components/schemas/ResourceExtraOutput" }, "type": "array", "title": "Extras", "description": "Stop extras this resource is compatible with" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active", "description": "Is the resource active" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "timestamp_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp Updated", "description": "Timestamp of the last update of the resource" }, "resource_groups": { "items": { "$ref": "#/components/schemas/ResourceGroupOutput" }, "type": "array", "title": "Resource Groups", "description": "Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded." }, "truck": { "anyOf": [ { "$ref": "#/components/schemas/TruckProperties-Output" }, { "type": "null" } ], "description": "Truck specific properties" } }, "type": "object", "required": [ "row_id", "name" ], "title": "TruckResourceOutput" }, "UnavailabilityReason": { "type": "string", "enum": [ "DRIVER_FUNERAL", "DRIVER_HOLIDAY", "DRIVER_JOB_APPLICATION_LEAVE", "DRIVER_LATE_START_EARLY_LEAVE", "DRIVER_MEDICAL_EXAM", "DRIVER_OFF_SHIFT_PATTERN", "DRIVER_OTHER", "DRIVER_PARENTAL_LEAVE", "DRIVER_PUBLIC_HOLIDAY", "DRIVER_RECUP", "DRIVER_REDUCED_WORKING_HOURS_SCHEME", "DRIVER_SHIFT_PATTERN", "DRIVER_SICKNESS", "DRIVER_SOCIAL_LEAVE", "DRIVER_TEMPORARY_UNEMPLOYMENT", "DRIVER_TRAINING", "DRIVER_UNAUTHORISED_ABSENCE", "DRIVER_UNION_LEAVE", "DRIVER_WORK_ACCIDENT", "VEHICLE_BRAKE_TEST", "VEHICLE_CLEANING", "VEHICLE_FRC_CERTIFICATE", "VEHICLE_HIRE", "VEHICLE_HYDRAULIC_INSPECTION", "VEHICLE_INSPECTION", "VEHICLE_LIFT_OPS_EQUIP_REGULATIONS", "VEHICLE_MAINTENANCE", "VEHICLE_MOT_TEST", "VEHICLE_OFF_ROAD", "VEHICLE_OTHER", "VEHICLE_PRESSURE_TEST", "VEHICLE_REPAIR", "VEHICLE_SERVICE", "VEHICLE_TACHOGRAPH_CALIBRATION", "SUBCONTRACTOR_HOLIDAY", "SUBCONTRACTOR_SICKNESS", "SUBCONTRACTOR_OTHER" ], "title": "UnavailabilityReason" }, "UpdateBarcodeInput": { "properties": { "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "source": { "type": "string", "const": "EXTERNAL", "title": "Source", "default": "EXTERNAL" } }, "type": "object", "title": "UpdateBarcodeInput" }, "UpdateDropCollectEmptyInput": { "properties": { "requested_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Requested Date" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/LocationInput" }, { "type": "null" } ] } }, "type": "object", "title": "UpdateDropCollectEmptyInput" }, "UpdateOperation": { "type": "string", "enum": [ "REPLACE", "CREATE", "UPDATE", "DELETE" ], "title": "UpdateOperation", "description": "Operation type for partial order structural updates." }, "UpdateOrderPricingInput": { "properties": { "requested_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Requested Price" } }, "type": "object", "title": "UpdateOrderPricingInput" }, "UploadStatus": { "type": "string", "enum": [ "TODO", "IN_PROGRESS", "READY_TO_UPSERT", "UPSERT_IN_PROGRESS", "COMPLETED", "ERROR", "SKIPPED", "DUPLICATE" ], "title": "UploadStatus" }, "UploadedCompanyDocumentWithValidity": { "properties": { "upload_id": { "type": "string", "format": "uuid", "title": "Upload Id", "description": "Unique identifier of the uploaded file" }, "document_type": { "anyOf": [ { "$ref": "#/components/schemas/CustomerDocumentTypeInput" }, { "$ref": "#/components/schemas/SubcontractorDocumentWithoutValidityTypeInput" }, { "$ref": "#/components/schemas/SubcontractorDocumentWithValidityTypeInput" }, { "$ref": "#/components/schemas/SubcontractorInsuranceDocumentTypeInput" } ], "title": "Document Type", "description": "Type of the document" }, "name": { "type": "string", "title": "Name", "description": "Name of the document" }, "validity": { "anyOf": [ { "$ref": "#/components/schemas/CompanyValidity" }, { "type": "null" } ], "description": "Validity information associated with the uploaded document." } }, "type": "object", "required": [ "upload_id", "document_type", "name" ], "title": "UploadedCompanyDocumentWithValidity" }, "UploadedDocumentBase_Union_ContainerDocumentTypes__DriverDocumentTypes__VehicleDocumentTypes__": { "properties": { "upload_id": { "type": "string", "format": "uuid", "title": "Upload Id", "description": "Unique identifier of the uploaded file" }, "document_type": { "anyOf": [ { "$ref": "#/components/schemas/ContainerDocumentTypes" }, { "$ref": "#/components/schemas/DriverDocumentTypes" }, { "$ref": "#/components/schemas/VehicleDocumentTypes" } ], "title": "Document Type", "description": "Type of the document" }, "name": { "type": "string", "title": "Name", "description": "Name of the document" } }, "type": "object", "required": [ "upload_id", "document_type", "name" ], "title": "UploadedDocumentBase[Union[ContainerDocumentTypes, DriverDocumentTypes, VehicleDocumentTypes]]" }, "UploadedDocumentBase_Union_SubcontractorDocumentWithValidityTypeInput__SubcontractorInsuranceDocumentTypeInput__": { "properties": { "upload_id": { "type": "string", "format": "uuid", "title": "Upload Id", "description": "Unique identifier of the uploaded file" }, "document_type": { "anyOf": [ { "$ref": "#/components/schemas/SubcontractorDocumentWithValidityTypeInput" }, { "$ref": "#/components/schemas/SubcontractorInsuranceDocumentTypeInput" } ], "title": "Document Type", "description": "Type of the document" }, "name": { "type": "string", "title": "Name", "description": "Name of the document" } }, "type": "object", "required": [ "upload_id", "document_type", "name" ], "title": "UploadedDocumentBase[Union[SubcontractorDocumentWithValidityTypeInput, SubcontractorInsuranceDocumentTypeInput]]" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "VanProperties-Input": { "properties": { "capacity_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Capacity Pallet Spaces", "description": "Capacity of the van in pallet spaces", "examples": [ 10 ] }, "capacity_volume_m3": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Capacity Volume M3", "description": "Capacity of the van in cubic meters", "examples": [ 10 ] }, "capacity_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Capacity Weight Kg", "description": "Capacity of the van in kg", "examples": [ 10000 ] }, "tare_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Tare Weight Kg", "description": "Tare weight of the van in kg", "examples": [ 10000 ] }, "exterior_length_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Length M", "description": "Exterior length of the van in meter", "examples": [ 10 ] }, "exterior_width_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Width M", "description": "Exterior width of the van in meter", "examples": [ 5 ] }, "exterior_height_m": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Exterior Height M", "description": "Exterior height of the van in meter", "examples": [ 3 ] }, "gross_weight_vehicle_rating_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "title": "Gross Weight Vehicle Rating Weight Kg", "description": "Gross weight vehicle rating weight of the van in kg", "examples": [ 10 ] }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the van" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the van" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the van" }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the van" }, "axle_configuration": { "anyOf": [ { "type": "string", "enum": [ "AC_4_X_2", "AC_4_X_4", "AC_6_X_2", "AC_6_X_4", "AC_6_X_6", "AC_8_X_2", "AC_8_X_4", "AC_8_X_6", "AC_10_X_4", "AC_12_X_4" ] }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the van" }, "emission_class": { "anyOf": [ { "type": "string", "enum": [ "EURO_1", "EURO_2", "EURO_3", "EURO_4", "EURO_5", "EURO_6" ] }, { "type": "null" } ], "title": "Emission Class", "description": "Emission class of the van" }, "fuel_type": { "anyOf": [ { "type": "string", "enum": [ "DIESEL", "BIOFUELS", "LPG", "ELECTRIC", "HYBRID_ELECTRIC" ] }, { "type": "null" } ], "title": "Fuel Type", "description": "Fuel type of the van" }, "roof_type": { "anyOf": [ { "type": "string", "enum": [ "CLOSED", "OPEN", "FLATBED" ] }, { "type": "null" } ], "title": "Roof Type", "description": "Roof type of the van" } }, "type": "object", "title": "VanProperties" }, "VanProperties-Output": { "properties": { "capacity_pallet_spaces": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Pallet Spaces", "description": "Capacity of the van in pallet spaces", "examples": [ 10 ] }, "capacity_volume_m3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Volume M3", "description": "Capacity of the van in cubic meters", "examples": [ 10 ] }, "capacity_weight_kg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Capacity Weight Kg", "description": "Capacity of the van in kg", "examples": [ 10000 ] }, "tare_weight_kg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tare Weight Kg", "description": "Tare weight of the van in kg", "examples": [ 10000 ] }, "exterior_length_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Length M", "description": "Exterior length of the van in meter", "examples": [ 10 ] }, "exterior_width_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Width M", "description": "Exterior width of the van in meter", "examples": [ 5 ] }, "exterior_height_m": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exterior Height M", "description": "Exterior height of the van in meter", "examples": [ 3 ] }, "gross_weight_vehicle_rating_weight_kg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gross Weight Vehicle Rating Weight Kg", "description": "Gross weight vehicle rating weight of the van in kg", "examples": [ 10 ] }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the van" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the van" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the van" }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the van" }, "axle_configuration": { "anyOf": [ { "type": "string", "enum": [ "AC_4_X_2", "AC_4_X_4", "AC_6_X_2", "AC_6_X_4", "AC_6_X_6", "AC_8_X_2", "AC_8_X_4", "AC_8_X_6", "AC_10_X_4", "AC_12_X_4" ] }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the van" }, "emission_class": { "anyOf": [ { "type": "string", "enum": [ "EURO_1", "EURO_2", "EURO_3", "EURO_4", "EURO_5", "EURO_6" ] }, { "type": "null" } ], "title": "Emission Class", "description": "Emission class of the van" }, "fuel_type": { "anyOf": [ { "type": "string", "enum": [ "DIESEL", "BIOFUELS", "LPG", "ELECTRIC", "HYBRID_ELECTRIC" ] }, { "type": "null" } ], "title": "Fuel Type", "description": "Fuel type of the van" }, "roof_type": { "anyOf": [ { "type": "string", "enum": [ "CLOSED", "OPEN", "FLATBED" ] }, { "type": "null" } ], "title": "Roof Type", "description": "Roof type of the van" } }, "type": "object", "title": "VanProperties" }, "VanResourceInput": { "properties": { "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Set to `false` to reactivate a previously archived resource, or `true` to archive it. Only takes effect when included in the request; omit it to leave the archive state unchanged." }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntityReference" }, { "type": "null" } ], "description": "Billing entity associated with the resource, defaults to default billing entity if not provided" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ResourceExtraInput" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Stop extras this resource is compatible with. Replaces the existing list when provided. Send an empty list to clear all compatible extras." }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "type": "string", "title": "External Id", "description": "External identifier of the resource", "default": "" }, "locale": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "type": "string", "title": "Note", "description": "Note about the resource", "default": "" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "van": { "anyOf": [ { "$ref": "#/components/schemas/VanProperties-Input" }, { "type": "null" } ], "description": "Van specific properties" } }, "type": "object", "required": [ "name" ], "title": "VanResourceInput" }, "VanResourceOutput": { "properties": { "row_id": { "type": "string", "format": "uuid", "title": "Row Id", "description": "Identifier of the reference" }, "name": { "type": "string", "title": "Name", "description": "Name of the resource" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id", "description": "External identifier of the resource" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Locale of the resource. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.", "examples": [ "en", "nl", "en-GB", "fr-BE" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the resource" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "User defined additional fields for this resource" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyReference" }, { "type": "null" } ], "description": "Company linked to the resource" }, "integrations": { "anyOf": [ { "additionalProperties": { "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Integrations", "description": "Related integrations for the resource. The key is the unique code of the integration in Qargo", "examples": [ { "addsecure1234": { "active": true, "object_id": "1234" } } ] }, "billing_entity": { "anyOf": [ { "$ref": "#/components/schemas/BillingEntity" }, { "type": "null" } ], "description": "Billing entity associated with the resource" }, "extras": { "items": { "$ref": "#/components/schemas/ResourceExtraOutput" }, "type": "array", "title": "Extras", "description": "Stop extras this resource is compatible with" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active", "description": "Is the resource active" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "timestamp_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp Updated", "description": "Timestamp of the last update of the resource" }, "resource_groups": { "items": { "$ref": "#/components/schemas/ResourceGroupOutput" }, "type": "array", "title": "Resource Groups", "description": "Resource groups this resource currently belongs to (deduplicated and sorted by name). A resource can belong to more than one group. Active allocations are included regardless of their validity window (scheduled, future, or expired); archived allocations are excluded." }, "van": { "anyOf": [ { "$ref": "#/components/schemas/VanProperties-Output" }, { "type": "null" } ], "description": "Van specific properties" } }, "type": "object", "required": [ "row_id", "name" ], "title": "VanResourceOutput" }, "Vehicle": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the resource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Is the resource archived" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyOutput-Input" }, { "type": "null" } ], "description": "Subcontractor linked to the resource" }, "resource_type": { "anyOf": [ { "$ref": "#/components/schemas/ResourceTypeEnum" }, { "type": "null" } ], "description": "Type of the resource" }, "axle_configuration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the vehicle" }, "emission_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Emission Class", "description": "Emission class of the vehicle" }, "fuel_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fuel Type", "description": "Fuel type of the vehicle" }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the vehicle" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the vehicle" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the vehicle" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the vehicle" }, "roof_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Roof Type", "description": "Roof type of the vehicle" }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the vehicle" } }, "type": "object", "title": "Vehicle" }, "VehicleCategory": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human readable identifier" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Machine readable identifier" }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" } }, "type": "object", "title": "VehicleCategory" }, "VehicleDocumentTypes": { "type": "string", "enum": [ "BRAKE_TEST_CERTIFICATE", "CERTIFICATE_OF_CONFORMITY", "CITERNE_CLEANING_CERTIFICATE", "COMMUNICATION_SUBCONTRACTOR", "CONTAINER_TANK_TEST_CERTIFICATE_2Y5", "CONTAINER_TANK_TEST_CERTIFICATE_5Y", "CONTAINER_TANK_TEST_CERTIFICATE", "EUROVIGNET", "EXCEPTIONAL_TRANSPORT_LICENSE", "FINE", "FUEL_CARD", "HEAVY_LOAD_BE", "HEAVY_LOAD_DE", "HEAVY_LOAD_FR", "OTHER", "OVERSIZE_WL_PERMIT", "ROADTAX", "TOLL_CARD", "VEHICLE_12_WEEKLY_CHECK", "VEHICLE_ADR_CERTIFICATE", "VEHICLE_ATP_CERTIFICATE", "VEHICLE_DAMAGE_REPORT", "VEHICLE_FIRE_EXTINGUISHER_SERVICE", "VEHICLE_FRC_CERTIFICATE", "VEHICLE_FRIDGE_MOTOR", "VEHICLE_GERMAN_SECURITY_INSPECTION", "VEHICLE_GERMAN_VEHICLE_INSPECTION", "VEHICLE_IDENTIFICATION_REPORT", "VEHICLE_INSURANCE_CERTIFICATE", "VEHICLE_MAINTENANCE_REPORT", "VEHICLE_MOT_TEST", "VEHICLE_REGISTRATION", "VEHICLE_REPAIR_REPORT", "VEHICLE_TACHO", "VEHICLE_TIR", "VEHICLE_TRANSPORT_LICENSE", "VEHICLE_UK_HGV_LEVY", "XL_CERTIFICATE" ], "title": "VehicleDocumentTypes" }, "VehicleMatchInput": { "properties": { "name": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "generic_id": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ] }, "integration_object_id": { "anyOf": [ { "$ref": "#/components/schemas/FieldMatchInput" }, { "type": "null" } ], "description": "The resource ID in the given context of your integration. " } }, "type": "object", "title": "VehicleMatchInput", "example": { "generic_id": { "matches_any": [ "VEH-001" ] } } }, "VehicleResource-Input": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the resource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Is the resource archived" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyOutput-Input" }, { "type": "null" } ], "description": "Subcontractor linked to the resource" }, "resource_type": { "anyOf": [ { "$ref": "#/components/schemas/ResourceTypeEnum" }, { "type": "null" } ], "description": "Type of the resource" }, "axle_configuration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the vehicle" }, "emission_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Emission Class", "description": "Emission class of the vehicle" }, "fuel_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fuel Type", "description": "Fuel type of the vehicle" }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the vehicle" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the vehicle" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the vehicle" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the vehicle" }, "roof_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Roof Type", "description": "Roof type of the vehicle" }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the vehicle" } }, "type": "object", "title": "VehicleResource" }, "VehicleResource-Output": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "ID of the resource" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the resource" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the resource" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived", "description": "Is the resource archived" }, "is_external_resource": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is External Resource", "description": "Read-only. True if this is a non-owned (subcontractor) resource. When this resource appears inside a trip, name / license_plate / container_number reflect the per-trip override value if one was set on the resource allocation; otherwise the resource master value is returned. `null` indicates the value is not yet projected — treat as internal for backwards compatibility.", "examples": [ true ] }, "custom_fields": { "type": "object", "title": "Custom Fields", "description": "Store values for user defined fields" }, "subcontractor": { "anyOf": [ { "$ref": "#/components/schemas/CompanyOutput-Output" }, { "type": "null" } ], "description": "Subcontractor linked to the resource" }, "resource_type": { "anyOf": [ { "$ref": "#/components/schemas/ResourceTypeEnum" }, { "type": "null" } ], "description": "Type of the resource" }, "axle_configuration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Axle Configuration", "description": "Axle configuration of the vehicle" }, "emission_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Emission Class", "description": "Emission class of the vehicle" }, "fuel_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fuel Type", "description": "Fuel type of the vehicle" }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate", "description": "License plate of the vehicle" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer", "description": "Manufacturer of the vehicle" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model", "description": "Model of the vehicle" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Note about the vehicle" }, "roof_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Roof Type", "description": "Roof type of the vehicle" }, "vin_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vin Number", "description": "VIN number of the vehicle" } }, "type": "object", "title": "VehicleResource" }, "VisibilityConsignment": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Consignment ID" }, "goods": { "items": { "$ref": "#/components/schemas/VisibilityGood" }, "type": "array", "title": "Goods", "description": "List of goods in this consignment" } }, "type": "object", "required": [ "id" ], "title": "VisibilityConsignment" }, "VisibilityConsignmentReference": { "properties": { "reference_number": { "type": "string", "title": "Reference Number" } }, "type": "object", "required": [ "reference_number" ], "title": "VisibilityConsignmentReference" }, "VisibilityCustomer": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Customer ID in Qargo" }, "name": { "type": "string", "title": "Name", "description": "Customer name" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "User defined additional fields." } }, "type": "object", "required": [ "name" ], "title": "VisibilityCustomer" }, "VisibilityDimensionByType": { "properties": { "actual": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Actual", "description": "Actual dimension of goods" }, "ordered": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ordered", "description": "Ordered dimension of goods" } }, "type": "object", "title": "VisibilityDimensionByType" }, "VisibilityDocument": { "properties": { "name": { "type": "string", "title": "Name", "description": "file name" }, "document_type": { "$ref": "#/components/schemas/VisibilityDocumentType" }, "document_content": { "anyOf": [ { "$ref": "#/components/schemas/RemoteDocument" }, { "$ref": "#/components/schemas/EmbeddedDocument" } ], "title": "Document Content" }, "subject": { "anyOf": [ { "$ref": "#/components/schemas/VisibilityOrderReference" }, { "$ref": "#/components/schemas/VisibilityConsignmentReference" }, { "$ref": "#/components/schemas/VisibilityStopReference" } ], "title": "Subject" } }, "type": "object", "required": [ "name", "document_type", "document_content", "subject" ], "title": "VisibilityDocument" }, "VisibilityDocumentStatus": { "type": "string", "enum": [ "CREATED" ], "title": "VisibilityDocumentStatus" }, "VisibilityDocumentType": { "type": "string", "enum": [ "CONSIGNEE_SIGNATURE", "CUSTOMER_PAPERWORK", "PHOTO_OF_GOODS_DELIVERY", "PROOF_OF_DELIVERY", "PROOF_OF_DELIVERY_SIGNED", "PALLET_LABEL", "PALLET_LABEL_EXTERNAL", "TEMPERATURE_REPORT" ], "title": "VisibilityDocumentType" }, "VisibilityEvent": { "properties": { "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp", "description": "Event timestamp in UTC. ISO 8601 format.", "examples": [ "2024-12-31T14:30:00Z" ] }, "update": { "anyOf": [ { "$ref": "#/components/schemas/OrderUpdate" }, { "$ref": "#/components/schemas/OrderImportUpdate" }, { "$ref": "#/components/schemas/StopUpdate" }, { "$ref": "#/components/schemas/EtaUpdate" }, { "$ref": "#/components/schemas/PositionUpdate" }, { "$ref": "#/components/schemas/DocumentUpdate" }, { "$ref": "#/components/schemas/TripUpdate" }, { "$ref": "#/components/schemas/ResourceUpdate" }, { "$ref": "#/components/schemas/HandlingUnitUpdate" } ], "title": "Update", "description": "Update payload" } }, "type": "object", "required": [ "timestamp", "update" ], "title": "VisibilityEvent" }, "VisibilityGood": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity" }, "total_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Loading Meters" }, "total_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Pallet Spaces" }, "total_volume_m3": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Volume M3" }, "total_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Weight Kg" }, "unit_height_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Height M" }, "unit_length_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Length M" }, "unit_loading_meters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Loading Meters" }, "unit_pallet_spaces": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Pallet Spaces" }, "unit_weight_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Weight Kg" }, "unit_width_m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Width M" }, "stackable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stackable" }, "packaged_items": { "items": { "$ref": "#/components/schemas/PackagedItemOutput-Input" }, "type": "array", "title": "List of packaged items" }, "adr_type": { "anyOf": [ { "$ref": "#/components/schemas/ADRType" }, { "type": "null" } ] }, "waste_category": { "anyOf": [ { "$ref": "#/components/schemas/WasteCategory" }, { "type": "null" } ] }, "absolute_min_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Min Temperature Degrees" }, "absolute_max_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Absolute Max Temperature Degrees" }, "ordered_transport_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ordered Transport Temperature Degrees" }, "specific_gravity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Specific Gravity" }, "product": { "anyOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ], "description": "Product information" }, "packaging_type": { "anyOf": [ { "$ref": "#/components/schemas/PackagingType" }, { "type": "null" } ], "description": "Packaging type, for example Pallet" }, "extras": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExtraField" }, "type": "array" }, { "type": "null" } ], "title": "Extras", "description": "Additional extra services/options for good" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "hs_codes": { "anyOf": [ { "$ref": "#/components/schemas/GoodHSCodesExtraFields" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for this good" }, "incidents": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Incident" }, "type": "array" }, { "type": "null" } ], "title": "Incidents", "description": "List of incidents" }, "handling_units": { "anyOf": [ { "items": { "$ref": "#/components/schemas/HandlingUnitOutput-Input" }, "type": "array" }, { "type": "null" } ], "title": "Handling Units", "description": "List of handling units. A handling unit is used to transport, store or handle goods" }, "actual_delivery_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Actual Delivery Temperature Degrees" }, "actual_pickup_temperature_degrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Actual Pickup Temperature Degrees" }, "quantity_by_type": { "anyOf": [ { "$ref": "#/components/schemas/VisibilityQuantityByType" }, { "type": "null" } ], "description": "Quantity of goods by type (actual and ordered)" }, "total_weight_kg_by_type": { "anyOf": [ { "$ref": "#/components/schemas/VisibilityDimensionByType" }, { "type": "null" } ], "description": "Total weight in kg by type (actual and ordered)" }, "total_volume_m3_by_type": { "anyOf": [ { "$ref": "#/components/schemas/VisibilityDimensionByType" }, { "type": "null" } ], "description": "Total volume in m3 by type (actual and ordered)" }, "total_loading_meters_by_type": { "anyOf": [ { "$ref": "#/components/schemas/VisibilityDimensionByType" }, { "type": "null" } ], "description": "Total loading meters by type (actual and ordered)" }, "total_pallet_spaces_by_type": { "anyOf": [ { "$ref": "#/components/schemas/VisibilityDimensionByType" }, { "type": "null" } ], "description": "Total pallet spaces by type (actual and ordered)" } }, "type": "object", "required": [ "id" ], "title": "VisibilityGood" }, "VisibilityHandlingUnitStatus": { "type": "string", "enum": [ "SCANNED_IN", "STORED", "SCANNED_OUT" ], "title": "VisibilityHandlingUnitStatus" }, "VisibilityLocation": { "properties": { "name": { "type": "string", "title": "Name", "default": "", "examples": [ "Qargo" ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "examples": [ "Gaston Crommenlaan 4" ] }, "address_second_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Second Line", "examples": [ "" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "examples": [ "Ghent" ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "examples": [ "" ] }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code", "examples": [ "BE" ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code", "examples": [ "9050" ] }, "position": { "anyOf": [ { "$ref": "#/components/schemas/Position" }, { "type": "null" } ] } }, "type": "object", "title": "VisibilityLocation" }, "VisibilityOrder": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Order ID in Qargo" }, "order_name": { "type": "string", "title": "Order Name", "description": "Order name in Qargo", "examples": [ "INV-7980" ] }, "customer_reference_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Reference Number", "description": "Customer reference" }, "customer": { "anyOf": [ { "$ref": "#/components/schemas/VisibilityCustomer" }, { "type": "null" } ], "description": "Customer details" }, "status": { "$ref": "#/components/schemas/VisibilityOrderStatus", "description": "Status of an order. We only send an update for the following status updates:\n- ACCEPTED\n- REJECTED\n- COMPLETED\n" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "stops": { "items": { "$ref": "#/components/schemas/VisibilityStop" }, "type": "array", "title": "Stops", "description": "Stops included in this order" }, "consignment": { "anyOf": [ { "$ref": "#/components/schemas/VisibilityConsignment" }, { "type": "null" } ], "description": "Consignment details for this order" } }, "type": "object", "required": [ "id", "order_name", "status", "stops" ], "title": "VisibilityOrder" }, "VisibilityOrderImportStatus": { "type": "string", "enum": [ "IGNORED" ], "title": "VisibilityOrderImportStatus" }, "VisibilityOrderReference": { "properties": { "customer_reference_number": { "type": "string", "title": "Customer Reference Number" } }, "type": "object", "required": [ "customer_reference_number" ], "title": "VisibilityOrderReference" }, "VisibilityOrderStatus": { "type": "string", "enum": [ "ACCEPTED", "REJECTED", "COMPLETED", "DRAFT", "QUOTE", "BLOCKED", "TO_PLAN", "PLANNED", "DEPARTED", "IN_TRANSIT", "INVOICE_READY", "DONT_INVOICE", "INVOICE_CREATED", "INVOICED", "INVOICE_POSTED", "CANCELLED" ], "title": "VisibilityOrderStatus" }, "VisibilityQuantityByType": { "properties": { "actual": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Actual", "description": "Actual quantity of goods" }, "ordered": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ordered", "description": "Ordered quantity of goods" } }, "type": "object", "title": "VisibilityQuantityByType" }, "VisibilityResource": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Resource ID in Qargo" }, "type": { "$ref": "#/components/schemas/ResourceType" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "license_plate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License Plate" }, "container_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Container Number" } }, "type": "object", "required": [ "type" ], "title": "VisibilityResource", "description": "Represents a resource: van, tractor, trailer and container." }, "VisibilityStop": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Stop ID in Qargo" }, "location": { "$ref": "#/components/schemas/VisibilityLocation" }, "resources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/VisibilityResource" }, "type": "array" }, { "type": "null" } ], "title": "Resources", "description": "Resources involved on this stop" }, "status": { "$ref": "#/components/schemas/VisibilityStopStatus" }, "stop_type": { "$ref": "#/components/schemas/VisibilityStopType" }, "eta_start_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Eta Start Time", "description": "Estimated arrival time (ETA) at the stop in UTC. ISO 8601 format.", "examples": [ "2024-12-31T14:30:00Z" ] }, "eta_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Eta End Time", "description": "Estimated departure time (ETD) from the stop in UTC. ISO 8601 format.", "examples": [ "2024-12-31T16:00:00Z" ] }, "actual_start_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Actual Start Timestamp", "description": "Actual arrival timestamp in UTC. ISO 8601 format.", "examples": [ "2024-12-31T14:45:00Z" ] }, "actual_end_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Actual End Timestamp", "description": "Actual departure timestamp in UTC. ISO 8601 format.", "examples": [ "2024-12-31T15:30:00Z" ] }, "stop_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stop Reference" }, "custom_fields": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Custom Fields", "description": "User-defined custom fields for the stop." } }, "type": "object", "required": [ "id", "location", "status", "stop_type" ], "title": "VisibilityStop" }, "VisibilityStopReference": { "properties": { "reference_number": { "type": "string", "title": "Reference Number" } }, "type": "object", "required": [ "reference_number" ], "title": "VisibilityStopReference" }, "VisibilityStopStatus": { "type": "string", "enum": [ "TO_PLAN", "DISPATCHED", "ROUTE_TO_STOP", "PLANNED", "TODO", "AT_STOP", "COMPLETED", "CANCELLED" ], "title": "VisibilityStopStatus" }, "VisibilityStopType": { "type": "string", "enum": [ "PICKUP", "DELIVERY", "CUSTOM" ], "title": "VisibilityStopType" }, "VisibilityTrip": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Trip ID in Qargo" }, "name": { "type": "string", "title": "Name", "description": "Trip name in Qargo" }, "orders": { "anyOf": [ { "items": { "$ref": "#/components/schemas/VisibilityOrder" }, "type": "array" }, { "type": "null" } ], "title": "Orders", "description": "Orders included in this trip. This field is not populated by default. Including it requires a custom webhook format configured by Qargo." }, "stops": { "items": { "$ref": "#/components/schemas/VisibilityStop" }, "type": "array", "title": "Stops", "description": "Stops included in this trip" } }, "type": "object", "required": [ "id", "name", "stops" ], "title": "VisibilityTrip" }, "VisibilityTripStatus": { "type": "string", "enum": [ "CREATED", "PLANNED", "COMPLETED" ], "title": "VisibilityTripStatus" }, "WasteCategory": { "type": "string", "enum": [ "WASTE", "DANGEROUS_WASTE" ], "title": "WasteCategory" }, "WasteConsistence": { "type": "string", "enum": [ "SOLID", "LIQUID", "GASEOUS", "DOUGHY" ], "title": "WasteConsistence" }, "WasteEmitterType": { "type": "string", "enum": [ "PRODUCER", "OTHER", "APPENDIX1", "APPENDIX1_PRODUCER", "APPENDIX2" ], "title": "WasteEmitterType" }, "WeekSchedule": { "properties": { "monday": { "anyOf": [ { "$ref": "#/components/schemas/DaySchedule" }, { "type": "null" } ], "description": "Opening hours for Monday." }, "tuesday": { "anyOf": [ { "$ref": "#/components/schemas/DaySchedule" }, { "type": "null" } ], "description": "Opening hours for Tuesday." }, "wednesday": { "anyOf": [ { "$ref": "#/components/schemas/DaySchedule" }, { "type": "null" } ], "description": "Opening hours for Wednesday." }, "thursday": { "anyOf": [ { "$ref": "#/components/schemas/DaySchedule" }, { "type": "null" } ], "description": "Opening hours for Thursday." }, "friday": { "anyOf": [ { "$ref": "#/components/schemas/DaySchedule" }, { "type": "null" } ], "description": "Opening hours for Friday." }, "saturday": { "anyOf": [ { "$ref": "#/components/schemas/DaySchedule" }, { "type": "null" } ], "description": "Opening hours for Saturday." }, "sunday": { "anyOf": [ { "$ref": "#/components/schemas/DaySchedule" }, { "type": "null" } ], "description": "Opening hours for Sunday." } }, "type": "object", "title": "WeekSchedule" }, "WeekScheduleInput": { "properties": { "monday": { "$ref": "#/components/schemas/DayScheduleInput", "description": "Opening hours for Monday." }, "tuesday": { "$ref": "#/components/schemas/DayScheduleInput", "description": "Opening hours for Tuesday." }, "wednesday": { "$ref": "#/components/schemas/DayScheduleInput", "description": "Opening hours for Wednesday." }, "thursday": { "$ref": "#/components/schemas/DayScheduleInput", "description": "Opening hours for Thursday." }, "friday": { "$ref": "#/components/schemas/DayScheduleInput", "description": "Opening hours for Friday." }, "saturday": { "$ref": "#/components/schemas/DayScheduleInput", "description": "Opening hours for Saturday." }, "sunday": { "$ref": "#/components/schemas/DayScheduleInput", "description": "Opening hours for Sunday." } }, "type": "object", "required": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "title": "WeekScheduleInput" }, "api__accounting__models__company__CompanyReferenceOutput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the company." }, "name": { "type": "string", "title": "Name", "description": "Name of the company.", "examples": [ "John Doe" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "External reference to this company record", "examples": [ "CUST-001" ] } }, "type": "object", "required": [ "id", "name" ], "title": "CompanyReferenceOutput" }, "api__accounting__models__invoice__TaxRate": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Unique identifier of the tax rate in Qargo." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the Tax rate in Qargo.", "examples": [ "21%" ] }, "percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Percentage", "examples": [ 21 ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the tax rate item in the accounting software.", "examples": [ "21% VAT" ] }, "tax_type": { "anyOf": [ { "$ref": "#/components/schemas/TaxRateType" }, { "type": "null" } ], "default": "VAT", "examples": [ "VAT" ] } }, "type": "object", "title": "TaxRate" }, "api__accounting__models__master_data__AccountInput": { "properties": { "code": { "type": "string", "title": "Code", "description": "Accounting code (GL / nominal code)." }, "name": { "type": "string", "title": "Name", "description": "Display name of the account." }, "billing_entity": { "$ref": "#/components/schemas/BillingEntityReference", "description": "Billing entity this account belongs to, referenced by code." }, "archived": { "type": "boolean", "title": "Archived", "description": "Whether this account is archived.", "default": false } }, "type": "object", "required": [ "code", "name", "billing_entity" ], "title": "AccountInput" }, "api__accounting__models__master_data__AccountOutput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier of the record in Qargo." }, "archived": { "type": "boolean", "title": "Archived", "description": "Whether this record has been archived." }, "code": { "type": "string", "title": "Code", "description": "Accounting code (GL / nominal code)." }, "name": { "type": "string", "title": "Name", "description": "Display name of the account." }, "billing_entity": { "$ref": "#/components/schemas/BillingEntity", "description": "Billing entity this account belongs to." } }, "type": "object", "required": [ "id", "archived", "code", "name", "billing_entity" ], "title": "AccountOutput" }, "api__order__models__charge__AccountInput": { "properties": { "code": { "type": "string", "title": "Code", "description": "Code of the general ledger in the accounting software linked to this charge line.", "examples": [ "200" ] } }, "type": "object", "required": [ "code" ], "title": "AccountInput" }, "api__order__models__charge__AccountOutput": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Accounting code" } }, "type": "object", "title": "AccountOutput" }, "api__order__models__charge__CompanyReferenceOutput": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "CompanyReferenceOutput" }, "api__order__models__charge__TaxRate": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "Code of the tax rate" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the tax rate" }, "percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Percentage", "description": "Percentage of the tax rate" }, "tax_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Type", "description": "Type of the tax rate" } }, "type": "object", "title": "TaxRate" }, "ValidationErrorDetail": { "properties": { "message": { "description": "Human-readable summary of this validation failure", "title": "Message", "type": "string" }, "field": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the field that failed validation, if known", "title": "Field" }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "JSON path to the field within the request payload (e.g. '$.consignor.address.country')", "title": "Path" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "object" }, { "type": "null" } ], "default": null, "description": "Additional structured context about the failure, if provided by the backend", "title": "Detail" } }, "required": [ "message" ], "title": "ValidationErrorDetail", "type": "object" }, "ValidationErrorResponse": { "properties": { "message": { "description": "Human-readable summary of the validation failure", "title": "Message", "type": "string" }, "errors": { "description": "One entry per validation failure. Always present and non-empty — a single failure yields a one-item array, so integrators can handle one and many the same way.", "items": { "$ref": "#/components/schemas/ValidationErrorDetail" }, "minItems": 1, "title": "Errors", "type": "array" } }, "required": [ "message", "errors" ], "title": "ValidationErrorResponse", "type": "object" } }, "securitySchemes": { "oAuth2ClientCredentials": { "type": "oauth2", "flows": { "clientCredentials": { "scopes": {}, "tokenUrl": "/v1/auth/token" } } }, "BasicAuthWebhookCredentials": { "type": "http", "scheme": "basic" } } }, "tags": [ { "name": "Use case / Customer portal", "description": "Required api role: `CUSTOMER`\n\nThis is the api equivalent of our customer portal functionality.\nCustomers can use this api to create/update/cancel orders, view charges and receive status updates.\n\n\n### Getting started\nSee [this section](/customer/docs/section/transport-order-creation-and-status) to get started.\n" }, { "name": "API / Authentication", "description": "" } ], "x-tagGroups": [ { "name": "Use cases", "tags": [ "Use case / Customer portal" ] }, { "name": "API", "tags": [ "API / Authentication" ] }, { "name": "", "tags": [] } ] }