openapi: 3.0.3
info:
  title: 'Phleetto Public API v2.9.9'
  description: |-
    The Phleetto API enables secure integration between the Phleetto freight collaboration platform and your ERP, TMS, CRM, WMS, accounting, or internal operational systems.

    The API provides access to operational workflows including:

    - routes and tenders
        
    - transport assignments
        
    - carriers and partners
        
    - vehicles and drivers
        
    - messages and activity logs
        
    - status updates and event notifications
        
    # About Phleetto 

    Phleetto is a freight collaboration platform developed for operational logistics workflows including transport procurement, carrier collaboration, fleet coordination and transport execution.

    To request access to the platform, contact our sales team at [https://phleetto.co.uk](https://phleetto.co.uk).

    Phleetto is developed by a Ukrainian team. We continue to support humanitarian initiatives in Ukraine: [https://u24.gov.ua/](https://u24.gov.ua/)

    ## Support

    Email: [office@phleetto.co.uk](https://mailto:office@phleetto.co.uk)  
    Phone number: +44(0)7555573310

    For incident reports, include endpoint, request, response, timestamp and error details where possible.

    ### Scheduled maintenance window

    The platform performs scheduled maintenance daily **between 02:00 and 03:00 Europe/London time**. Temporary API unavailability may occur during this period. Scheduled synchronisation and batch integrations should avoid this window where possible.

    # User types

    The following user types are supported.

    | Role | Description | API Coverage |
    | --- | --- | --- |
    | **Shipper** | Organisation that orders transport, creates routes and tenders. | ✅ Supported |
    | **Carrier** | Organisation that proposes vehicles, participates in tenders and executes transport operations. | ✅ Supported |
    | **Forwarder** | Oversight role operating above shipper and carrier workflows. | ⌛ Planned |
    | **Admin** | Internal administrative role. | Not supported |
    | **Accountant** | Limited operational role associated with shipper organisations. | Not supported |
    | **Warehouser** | Operational role responsible for warehouse and yard activities during vehicle arrival and departure. | Not supported |

    Role-based access control is planned for 2027.

    ## User Groups

    Users may belong to cross-account user groups configured by an administrator (see Account / Account Switching folder). User groups allow quick account switching between related operational contexts.

    Typical use case:

    - a company operating both as **shipper** and **carrier**
        
    - a shipper organisation operating its own fleet
        
    - shared operational management across multiple accounts
        
    # Getting started

    To access the API, you must:

    - have an active Phleetto account
        
    - have API access enabled for your organisation
        
    - obtain the required integration settings from: `Settings → API`
        
    ## Authentication

    API access uses standard Phleetto user authentication. Successful authentication returns an access token valid for **10 hours**, which must be supplied with subsequent API requests. Expired tokens require re-authentication.

    Additional integration parameters, including an integration token and a MAC signing key are available in: `Settings → API`.

    ### Session behaviour

    Successful authentication invalidates existing active sessions associated with the same user account.

    This applies across:

    - API sessions
        
    - Android app sessions
        
    - mobile web app sessions
        
    - classic web app sessions
        
    - V3 web app sessions
        
    Integrations should avoid sharing interactive user credentials across multiple concurrent systems where uninterrupted session continuity is required.

    To assign a manager or operational owner during creation, provide the user's email address in the `userclient_email` field when calling:

    - `POST createRoute`
        
    - `POST createTender`
        
    ## Base URLs

    Sandbox environment: `https://test.phleetto.co.uk`  
    Production environment: `https://phleetto.uk`

    ## Language support

    Primary platform languages: English (`en`) and Ukrainian (`ua`).

    Additional localisations are available for selected modules. Coverage and terminology consistency may vary.

    The `Language` request header is required throughout the API. By default, responses use the language configured for the authenticated platform user. The `Language` header acts as a fallback mechanism and is primarily used when user language information cannot be resolved, for example during authentication failures or invalid token scenarios.

    ## Rate limiting

    Authentication endpoints are protected against excessive request activity. Excessive authentication behaviour may result in IP address being blocked and following errors:

    | Code | Meaning |
    | --- | --- |
    | `429 Too Many Requests` | Request activity limit exceeded |
    | `403 Forbidden` | Access temporarily restricted or blocked |

    ## Typical shipper integration flow

    Here is an example of a typical tender procurement workflow:

    | Step | Operation | Endpoint |
    | --- | --- | --- |
    | 1 | Create tender | `POST createTender` |
    | 2 | Retrieve carrier bids | `GET getPricequotes` |
    | 3 | Select winning bid | `POST pickTenderWinner` |
    | 4 | Publish route for winning carrier | `POST publishTenderChild` |
    | 5 | Confirm carrier assignment | `POST ratifyOperator` |
    | 6 | Retrieve assigned driver and vehicle details | `GET getRouteFleet` |

    Winner selection, child route publication and assignment confirmation may alternatively be performed automatically via platform settings.

    # API status

    ⚠️ This API and this documentation are currently under active development. Minor inconsistencies between documentation and platform behaviour may exist during ongoing platform updates.

    ## API versioning and compatibility

    Phleetto API v2 follows a backwards-compatible versioning approach.

    Minor platform releases may introduce:

    - new endpoints
        
    - additional response fields
        
    - optional parameters
        
    - new event types
        
    - additional operational workflows
        
    Existing integrations are designed to continue operating without modification wherever possible. Breaking changes are avoided within the same major API version.

    # Webhooks

    Phleetto supports outbound webhook notifications for operational events within the platform. If permitted by your subscription configuration, webhook events can be delivered to a user-defined HTTPS endpoint.

    Webhook configuration is available in: `Settings → API` and `Settings → Notifications`.

    ## Webhook behaviour

    Webhook payloads notify your system that an event has occurred. Webhook payloads intentionally do not contain full operational content.

    For example:

    - if a new document is added, the webhook will notify your system that a new document exists
        
    - the actual document content must then be retrieved via the REST API
        
    This approach helps maintain predictable payload structures and reduces unnecessary data transfer.

    ## Example webhook payload

    ``` json
    {
      "body": {
        "moment": "2025-05-10 19:15:04",
        "event": 12,
        "message": "Attention! New message received in route #12345-05-25 (Ukraine -> Germany).",
        "route": {
          "periodic": "12345-05-25",
          "apicode": "880-19100-052025",
          "guiurl": "https://phleetto.uk/a/index.php?p=view&id=12345-05-25&m=shipping",
          "apiurl": "https://phleetto.uk/a/v2/rest/public/singleRoute?route=12345-05-25"
        }
      },
      "signature": "d0c80fc9279b63f93a5b03g1d8a833de719f5766b30aad718ac58a39bbfa63c7"
    }

     ```
    Payload fields:

    - `body.moment` Timestamp of the event in the application timezone. Default timezone: Europe/London.
        
    - `body.event` Internal identifier of the event type. See _Event reference_ below.
        
    - `body.message` Human-readable event description.
        
    - `body.route` Contains route or tender references associated with the event, including: platform route reference, external API identifier, web application URL, API endpoint for detailed retrieval
        
    - `signature` SHA-256 MAC signature generated from the entire `body` object using your MAC signing key. The signature should always be verified on your side to ensure: payload authenticity, payload integrity, and request source validation. Your MAC signing key is available in: `Settings → API`
        
    ## Event reference

    Events for shippers:

    | ID | Event |
    | --- | --- |
    | 2 | Transport proposal received |
    | 3 | Tender bid received |
    | 114 | Carrier accepted counteroffer |
    | 115 | Carrier declined counteroffer |
    | 107 | Tender ended |
    | 18 | Carrier confirmed assignment |
    | 8 | Selected carrier refused route execution |
    | 106 | Winning carrier refused transport execution |
    | 10 | Vehicle arrived at loading |
    | 19 | Warehouse confirmed loading |
    | 12 | Route updates requested |
    | 13 | New route message received |
    | 101 | Vehicle arrived at customs |
    | 102 | Vehicle cleared customs |
    | 103 | Vehicle arrived at the border |
    | 104 | Vehicle crossed the border |
    | 15 | Vehicle arrived at unloading |
    | 20 | Warehouse confirmed unloading |
    | 120 | Carrier confirmed unloading |
    | 25 | Partner uploaded a document to the route |
    | 113 | Delivery accepted with issues |

    Events for carriers:

    | ID | Event |
    | --- | --- |
    | 1 | New route available |
    | 29 | New private tender received |
    | 30 | New open tender received |
    | 108 | Tender scheduled |
    | 23 | New route available under your tender |
    | 26 | Route price updated |
    | 105 | New route published exclusively for you |
    | 4 | Another carrier placed a lower bid |
    | 5 | Customer selected your bid |
    | 6 | Customer approved your transport proposal |
    | 7 | Customer declined your transport proposal |
    | 9 | Time for loading |
    | 11 | Vehicle loaded |
    | 12 | Route updated |
    | 13 | New route message received |
    | 14 | Time for unloading |
    | 16 | Vehicle unloaded |
    | 109 | Customer extended the tender |
    | 121 | Tender starting bid updated |
    | 22 | Tender you won has been completed |
    | 25 | Partner uploaded a document to the route |
    | 110 | Customer approved vehicle replacement |
    | 111 | Driver delayed at unloading |
    | 112 | Driver confirmed route completion |
    | 113 | Delivery accepted with issues |

    # Response codes

    The API uses standard HTTP response codes to indicate the result of a request.

    ## Success responses

    | Code | Meaning |
    | --- | --- |
    | `200 OK` | Request completed successfully |
    | `201 Created` | Resource created successfully |
    | `202 Accepted` | Request accepted and awaiting further action |
    | `204 No Content` | Request completed successfully with no response body |

    ## Error responses

    | Code | Meaning |
    | --- | --- |
    | `400 Bad Request` | Invalid request data or validation failure |
    | `401 Unauthorized` | Missing or invalid authentication token |
    | `402 Payment Required` | An outstanding invoice is past due |
    | `403 Forbidden` | Access denied by scopes, ownership etc |
    | `406 Not Acceptable` | Request could not be processed in the requested format |
    | `424 Failed Dependency` | Upstream dependency or internal processing failure |
    | `429 Too Many Requests` | Request rate limit exceeded or too many login attempts |

    ### Error response format

    Error responses are returned in JSON format.

    ``` json
    {
      "status": "error",
      "message": "Invalid token"
    }

     ```
    ### Error response fields

    | Field | Type | Description |
    | --- | --- | --- |
    | `status` | string | Response status (`error`) |
    | `message` | string | Human-readable error description |

    ### `Data is corrupt` error

    `POST createRoute` and `POST createTender` may return `ERROR: Data is corrupt` when the MAC signature is calculated incorrectly. Verify MAC generation on your side, including correct handling of quotation marks, character escaping, whitespace and unexpected special characters.

    # Changelog

    | Version | Release Date | Highlights |
    | --- | --- | --- |
    | **v2.9.99123** | 14 May 2026 | Tender list refinements, timezone display fixes, targeted route updates, safer session handling |
    | **v2.9.99122** | 24 Apr 2026 | Route deletion compatibility, tender extension accuracy |
    | **v2.9.99121** | 17 Apr 2026 | Billing grace-period support, tender archive corrections, reference data consistency, customs data retention |
    | **v2.9.99120** | 7 Apr 2026 | Improved route time accuracy, blind tender bid counts, expanded location search, more reliable sorting |
    | **v2.9.99119** | 20 Mar 2026 | Stronger data validation, cleaner tender results, better winner chronology, expanded checkpoint details |
    | **v2.9.99118** | 12 Mar 2026 | Consistent timezone handling, message count visibility, better checkpoint tracking, blind tender note fixes |
    | **v2.9.99117** | 20 Feb 2026 | Miles-based distance support, more accurate route distance, safer token sessions, stronger tender privacy |
    | **v2.9.99116** | 9 Feb 2026 | Flexible profile settings, reliable document downloads, improved tender statuses, stronger access controls |
    | **v2.9.99115** | 25 Jan 2026 | Payment status visibility, smoother invite acceptance, more reliable uploads, more accurate route pricing |
    | **v2.9.99114** | 20 Jan 2026 | Payment request workflows, invoice and tariff tools, online payment support, profile and message updates |
    | **v2.9.99113** | 26 Dec 2025 | Webhook and notification controls, vehicle and geography tools, Telegram connection options, payment request exports |
    | **v2.9.99112** | 17 Dec 2025 | User and document setup, company profile controls, partner access management, feedback and service agreement |
    | **v2.9.99111** | 2 Dec 2025 | Partner discovery and invites, route and tender search, route change workflows, arrival estimate support |
    | **v2.9.99110** | 18 Nov 2025 | Application file downloads, partner workflow fixes, clearer award traceability, Sigfox integration |
    | **v2.9.99108** | 17 Oct 2025 | Proof-of-delivery support, open partner discovery, vehicle record updates, clearer route action labels |
    | **v2.9.99107** | 2 Oct 2025 | Accurate tender ownership, cleaner text presentation, improved opt-out handling |
    | **v2.9.99106** | 22 Sep 2025 | Stronger tender confidentiality, more reliable route lists, settings-driven behaviour, general stability improvements |
    | **v2.9.99105** | 12 Sep 2025 | Partner detail access, fleet management improvements, document add/remove support, customer-specific behaviour |
    | **v2.9.99104** | 29 Jul 2025 | Route detail enhancements, route action visibility, fleet endpoint expansion |
    | **v2.9.99103** | 21 Jul 2025 | Route grouping support, better workload organisation |
    | **v2.9.99102** | 1 Jul 2025 | Richer route detail views, more secure blind tenders, improved bookmarked tenders, better password recovery |
    | **v2.9.99101** | 16 Jun 2025 | Friendlier error messages, tender bookmarking, better bid history, token-based sign-in |
    | **v2.9.97** | 11 Jun 2025 | Current tender visibility, duplicate order prevention, tighter carrier privacy, more accurate pricing views |
    | **v2.9.99100** | 28 May 2025 | Updated tender groupings, richer route detail responses, tender deadline visibility, tender bookmarking |
    | **v2.9.99** | 12 May 2025 | New routing endpoints, distance detail visibility, better address handling, more reliable location logic |
    | **v2.9.98** | 21 Apr 2025 | Customs workflow improvements, surcharge and penalty support, clearer route deletion errors, sign-in response consistency |
    | **v2.9.96** | 28 Mar 2025 | Stronger order audit trail, safer shipment status handling |
    | **v2.9.95** | 29 Jan 2025 | Richer route list context, better booking visibility |
    | **v2.9.94** | 20 Jan 2025 | Correct tender contacts, cleaner partner communication |
    | **v2.9.93** | 13 Jan 2025 | Tender restart refinements, more accurate child budgets, legacy route creation fixes, vehicle type data support |
    | **v2.9.91** | 20 Nov 2024 | Expanded route chronology, lookup by API code |
    | **v2.9.52** | 11 Oct 2024 | Tender winner visibility, carrier details in results |
    | **v2.9.4** | 18 Sep 2024 | Recipient lookup support, simpler message addressing |
    | **v2.9.2** | 21 Aug 2024 | New companies in filters, better partner discoverability |
  version: v2.9.99122
  contact: []
  x-scalar-info-card:
    title: 'Quick Facts'
    description: |-
      | Item | Details |
      | --- | --- |
      | Base URL | `https://test.phleetto.co.uk` |
      | Authentication | JWT Bearer Token |
      | Primary Roles | Shipper, Carrier |
      | Supported Languages | EN, UA |
      | Support | [office@phleetto.co.uk](mailto:office@phleetto.co.uk) |
servers:
  -
    url: 'https://test.phleetto.co.uk'
    description: 'Test server'
  -
    url: 'https://phleetto.uk'
    description: 'Production server'
paths:
  /a/v2/rest/public/auth:
    post:
      tags:
        - Authorization
      summary: 'Authenticate User'
      description: |-
        Primary authentication endpoint.

        Authenticates a user and returns a JWT access token.

        Supply the same username/email address and password used to access the platform, together with a static API token available in the web application (`My Data → API`).

        - On success, the authentication token is returned in `data.token`.
            
        - On failure, an error response is returned in the language specified by the `Language` request header.
            
        The token is valid for **10 hours**. Integrations should reuse the active token and only request a new token when re-authentication is required.
      operationId: authenticateUser
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: http_origin
          in: header
          schema:
            type: string
            example: phleet.to
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{staticToken}'
          description: 'Static API token from the API section in the application.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                login:
                  description: 'your username or email from the app'
                  type: string
                  example: '{{username}}'
                password:
                  description: 'your password from the app'
                  type: string
                  example: '{{password}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { token: { type: string, example: '{{vault:json-web-token}}' } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { token: '{{vault:json-web-token}}' }, status: success }
        403:
          description: 'Incorrect user credentials / User blocked'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: ' Login failed. Login / email or password entered incorrectly.' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Incorrect user credentials':
                  value: { message: ' Login failed. Login / email or password entered incorrectly.', relogin: true, status: error }
                'User blocked':
                  value: { message: 'This user is blocked. Please contact the administrator (during business hours) to restore access: 044 394-85-04, office@phleetto.co.uk.', relogin: true, status: error }
  /a/v2/rest/public/requestPasswordReset:
    post:
      tags:
        - Authorization
      summary: 'Request Password Reset'
      description: |-
        Allows you to request a password reset, you will need your static token, email and phone number.

        Supply your email and phone number to get a recovery link at your email.

        - If successful, you will receive a temporary reset link to your email with a 1 time code
        - If unsuccessful, you will receive an error explaining the problem in the language you supplied with the header

        (!) NOTE: you can make a password reset request only once per 24 hours.
      operationId: requestPasswordReset
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{staticToken}'
          description: 'Static API token from the API section in the application.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                cellnum:
                  description: 'your phone number from the app'
                  type: string
                  example: '{{cellnum}}'
                email:
                  description: 'your email from the app'
                  type: string
                  example: '{{email}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { message: { type: string, example: 'A password reset link has been sent to your email address.' } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { message: 'A password reset link has been sent to your email address.' }, status: success }
        400:
          description: 'User not found'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'No such user found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'User not found':
                  value: { message: 'No such user found', relogin: false, status: error }
  /a/v2/rest/public/resetPassword:
    post:
      tags:
        - Authorization
      summary: 'Reset Password'
      description: |-
        Allows you to reset your password.

        (!) NOTE: values of `password1` and `password2` parameters must be exactly identical.

        - If successful, you will have reset your password and will be able to authenticate with it
        - If unsuccessful, you will receive an error explaining the problem in the language you supplied with the header
      operationId: resetPassword
      parameters:
        -
          name: token
          in: query
          schema:
            type: string
            example: '{{oneTimeCode}}'
          description: 'one-time code sent to your email'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{staticToken}'
          description: 'Static API token from the API section in the application.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                password1:
                  description: 'new password'
                  type: string
                  example: '{{newPassword}}'
                password2:
                  description: 'the same new password'
                  type: string
                  example: '{{newPassword}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { message: { type: string, example: 'The password has been changed successfully.' } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { message: 'The password has been changed successfully.' }, status: success }
        400:
          description: 'Something went wrong'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Data not found.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Something went wrong':
                  value: { message: 'Data not found.', relogin: false, status: error }
  /a/v2/rest/public/authValidateMfa:
    post:
      tags:
        - Authorization
      summary: 'Validate MFA'
      description: 'Validate MFA'
      operationId: validateMfa
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                code:
                  type: string
                  example: '811315'
            examples:
              'Validate MFA':
                value:
                  code: '811315'
      responses:
        200:
          description: ''
  /a/v2/rest/public/createTender:
    post:
      tags:
        - 'Routes & tenders / Shippers / Tenders'
      summary: 'Create Tender'
      description: |-
        With this endpoint you can add tenders into Phleetto from your systems one at a time or many at once.

        You will need to supply a MAC to ensure message integrity. The MAC is calculated as a SHA256 of the `post` string using the MAC key available in user profile, and must be sent as a separate param `signature`. Use this online tool to test your signature: [https://phleet.to/ooqwq](https://phleet.to/ooqwq)

        `post` parameter explanation:

        - request must be in JSON
            
        - _routes_ is the root element, that can contain one or more _route_ objects
            

        ### `route` object explanation:

        | param | required | type | explanation | valid example | invalid example |
        | --- | --- | --- | --- | --- | --- |
        | routeparts | yes | array of `routepart` objects | an array of points for the order/route, like loading, unloading, border, customs, etc | (see below) | empty |
        | tender | yes | bool | indicates tender flag | 1 |  |
        | blind_tender | no | bool | indicates whether the tender is blind or not | 1 | blind |
        | tender_terms | no | string | comment about the tender | only for authorized carriers |  |
        | total_count | yes | int | total amount of units that need to be delivered within the scope of the tender | 10, 5000 |  |
        | pricefor | yes | enum: tonn, km, ride, mcube | in what units the tender is measured, quantity of those units are indicated in `total_count` | tonn, ride, km, or mcube | 9 |
        | step | no | int | offer step restriction, forces carriers to diminish the price offer by the indicated step | 100, 50 |  |
        | max_quote | no | float | the maximum acceptable price, above which offers will not be allowed, expected based on the `pricefor` param | 15000, 31.5 |  |
        | publish_datetime | no | string YYYY-MM-DD HH:MM:SS | publishing date and time, allows to postpone the publishing | 2022-03-24 04:30:00 | tomorrow |
        | tender_deadline | yes | string YYYY-MM-DD HH:MM:SS | the deadline of the tender, after which no offers will be accepted | 2022-03-24 04:30:00 | in a week, 1 |
        | forallpartners | no | bool | whether to publish the tender for all partners or not1 | 1 |  |
        | route_apicode | yes | string (40) | an id of the order/route within your (external) system | DG-1982, 123221 | empty or duplicate |
        | draft |  | bool | whether to publish the route as draft or not | 1, true |  |
        | currency |  | string (3) | currency, default to national currency, valid values: USD, EUR | EUR | GBP |
        | nds |  | bool |  | 1 for value added tax included, 0 for no VAT included | 1 |
        | paymenttype |  | int (1) | according to internal mapping: 2 for bank transfer, 3 for cash, see [mapping](https://phleet.to/data-mapping) | 2 | 4 |
        | payorcode |  | string (30) | national ID of the legal entity to pay for the order/route, must match the settings within the UI | 40003782 | non matching id |
        | chargetype |  | array of ints | an array of accaptable charge types for the order/route, must match [the mapping](https://phleet.to/data-mapping) | \[1,3\] | non matching ids |
        | cartype |  | array of ints | an array of accaptable car types for the order/route, must match [the mapping](https://phleet.to/data-mapping) | \[1,2\] | non matching ids |
        | ferryproperty |  | array of ints | an array of additional desirable parameters for the order/route, must match [the mapping](https://phleet.to/data-mapping) | \[5,10,11\] | non matching ids |
        | ferryproperty_details |  | object of string values | key must be string in \[10,11,12\] as per ferryproperty, values must be strings (20) | {"11":"-5", "10":"32"} |  |
        | operators |  | array of strings | an array of carrier hashes, for whom the route shall be available, hashes can be found in GET getPartners endpoint | \["06991aab9ddafbc6faaa2429d4fa3de2","692ea987e30fffeef4803561327eaa39"\] | \["Перевізник, ТОВ",29812\] |
        | remark |  | string | the remark field is a free-form text string, it can accommodate various types of information, making it a versatile field for any notes that don’t fit into the structured fields already defined | "Urgent delivery required by 2024-08-27. Contact receiver before delivery." |  |
        | userclient_email |  | string | if the user responsible for the route is not the holder of the token, pass his/her email here | "validuser@ourcompany.com" | "John Doe" |

        ### `routepart` object explanation:

        | param | required | type | applicable workaction | explanation | valid example | invalid example |
        | --- | --- | --- | --- | --- | --- | --- |
        | workaction | yes | int (1) | all | type of action on the checkpoint, must be one of 1 (loading), 2 (unloading), 3 (customs) or 4 (border) | 1 | unload |
        | apicode | yes | string (10) | 1,2 | id of the point in your (external) system, for simplicity of geography integration |  |  |
        | category |  | int (5) | 1 | internal ID of the category, for order/route grouping, must match the mapping | 192 | non-matching id |
        | cargo | yes | string (255) | 1 | the payload being shipped | гн. швеллер и рельс |  |
        | weight | almost | decimal (13,3) | 1 | weight of cargo in tonns, either this or volume must be supplied for workaction 1 | 22.3 |  |
        | volume | almost | decimal (13,3) | 1 | volume of cargo in cubic meters, either this or weight must be supplied for workaction 1 | 70 |  |
        | length |  | decimal (13,3) | 1 | length of cargo in meters | 8 |  |
        | height |  | decimal (13,3) | 1 | height of cargo in meters | 0.2 |  |
        | width |  | decimal(13,3) | 1 | width of cargo in meters | 5.5 |  |
        | date1 |  | string (YYYY-MM-DD) | all | expected date of arrival to this point | 2020-06-20 | 30-12-2020 |
        | time1 |  | string (HH:MM:SS) | all | expected time of arrival to this point, in 24 hour format | 18:00:00 | 6 PM |
        | company_title | almost | string (255) | 1,2 | the name of the legal entity in the point, either this or company_natcomid is required | LLC "Phleetto", inc |  |
        | company_natcomid | almost | string (30) | 1,2 | the national code of the legal entity, either this or company_name is required | 40003782 |  |
        | contact_name | yes | string (255) | 1,2 | name of the person responsible for the work on the point | John Doe |  |
        | contact_cellnum | almost | string (40) | 1,2 | phone number of the responsible person, either this or email is required | 38 050 111 22 33 |  |
        | contact_email | almost | string (255) | 1,2 | email of the responsible person, either this or cellnum is required | [office@phleetto.co.uk](https://mailto:office@phleetto.co.uk) | invalid email |
        | geo_country_iso_num | yes | int (3) | 1,2 | county code according to [ISO standard](https://www.iso.org/standard/63545.html) | 380 | non existent code |
        | geo_region |  | string (255) | 1,2 | sublocality (administrative_area_level_1), region, state, oblast, or other administrative division | Киевская область |  |
        | geo_district |  | string (255) | 1,2 | county, district (administrative_area_level_2) or other smaller administrative division | Богуславский район |  |
        | geo_city | yes | string (255) | 1,2 | town, village, locality, city or other administrative division | Богуслав |  |
        | geo_address | yes | string (200) | 1,2 | street address | ул. Орджоникидзе 14 | наша машина, паспорт номер такойто, область, город |
        | geo_town_id |  | int (7) | 4 | internal town ID or border crossing |  |  |
        | geo_apicode |  | string (10) | 3 | your (external) point ID of the customs point |  |  |
        | malformed_full_address_prioritized |  | string (255) | 1,2,3 | address in whatever non-normalized form; we parse, normalize, and return `apicode`\* | "м.Одеса,вул.Аркадіївська алея, ТРЦ Аркадія Сіті, маг. Винчик"\* or "_Волинська обл.,м. Луцьк, вул. Карбишева, 2 ( част. буд.блоку скл. 'Е-2'"_ | 229 |
        | border_operator_select |  | int(1) | 4 | set to 1 if the carrier is expected to indicte the point of border crossing |  |  |

        Each route must start with a workaction=1 routepart and end with workaction=2 routepart.

        For additional property in `post` form data parameter `ferryproperty` you can use optional GET parameter `ferryproperty_as=object` then inbound ferryproperty parameter format can be like this

        ```
        "ferryproperty":
        [
          {
          "TrailerAttributesPhleettoId":"10",
          "Value":20
          },
          {
          "TrailerAttributesPhleettoId":"11",
          "Value":5
          },
        ]

         ```
      operationId: createTender
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                '':
                  type: string
                  example: ''
                post:
                  description: 'The main body of the request, the payload that contains the route/order details.'
                  type: string
                  example: |-
                    {
                       "routes":{
                          "route":{
                             "client_hash":"lalala",
                             "tender":1,
                             "tender_terms":"tututu",
                             "total_count":2,
                             "forallpartners":1,
                             "step":100,
                             "max_quote":10000,
                             "pricefor":"tonn",
                             "tender_deadline":"2022-04-17 13:50:00",
                             "publish_datetime":"2022-17-04 13:52:00",
                             "pricefor":"tonn",
                             "cartype":[
                                1,
                                2,
                                4
                             ],
                             "userclient_email":"",
                             "routeparts":[
                                {
                                   "apicode":"internalcode123",
                                   "contact_name":"Marina Niedzialkowska - экспорт менеджер",
                                   "geo_country_iso_num":616,
                                   "geo_region":"",
                                   "company_natcomid":"",
                                   "weight":1.47,
                                   "date1":"2022-03-18»,
                                   "contact_email":"noemail@email.com",
                                   "time1":"00:00:00",
                                   "contact_cellnum":"050 1 1 1 1 1 1 ",
                                   "company_title":"INSTAL PROJEKT Gawlowscy, Scierzynscy Spolka Jawna",
                                   "geo_district":"",
                                   "geo_address":"ul. some street, 12a",
                                   "workaction":"1",
                                   "geo_city":"kruszyn",
                                   "category":0,
                                   "cargo":"плитка\/сантехніка"
                                },
                                {
                                   "contact_name":"nocontact",
                                   "geo_country_iso_num":804,
                                   "geo_region":"київська",
                                   "company_natcomid":"",
                                   "weight":1.47,
                                   "date1":"2022-03-19",
                                   "contact_email":"noemail@email.com",
                                   "time1":"00:00:00",
                                   "contact_cellnum":"(044) 123123123 #$%^&*()_",
                                   "company_title":"Агросем",
                                   "geo_district":"",
                                   "geo_address":"вул. hrest, 17-А",
                                   "workaction":"2",
                                   "geo_city":"Київ",
                                   "cargo":"плитка\/сантехніка"
                                }
                             ],
                             "currency":"UAH",
                             "payorcode":"",
                             "chargetype":[
                                3,
                                2,
                                4
                             ],
                             "route_apicode":"unique-external-id-123",
                             "paymenttype":2,
                             "budget":20500.0
                          }
                       }
                    }18»
                signature:
                  description: 'A MAC must be supplied, which is a SHA256 hash product of the `post` parameter and the MAC key.'
                  type: string
                  example: '{{MAC}}'
      responses:
        201:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { periodic: { type: string, example: 651-04-22 }, url: { type: string, example: '/a/index.php?p=view&id=651-04-22&m=shipping' }, userroutenumber: { type: string, example: unique-external-id-123 } } }, example: [{ periodic: 651-04-22, url: '/a/index.php?p=view&id=651-04-22&m=shipping', userroutenumber: unique-external-id-123 }] }
                  status: { type: string, example: created }
              examples:
                Success:
                  value: { data: [{ periodic: 651-04-22, url: '/a/index.php?p=view&id=651-04-22&m=shipping', userroutenumber: unique-external-id-123 }], status: created }
        400:
          description: 'Invalid MAC supplied / Loading date is earlier than tender deadline / Publish date in the past / Invalid JSON (note routepart date quote)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'ERROR: Data is corrupt.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid JSON (note routepart date quote)':
                  value: { message: 'Json_decode error: Control character error, possibly incorrectly encoded', relogin: false, status: error }
                'Invalid MAC supplied':
                  value: { message: 'ERROR: Data is corrupt.', relogin: false, status: error }
                'Loading date is earlier than tender deadline':
                  value: { message: 'First routepart date must be later than tender deadline', relogin: false, status: error }
                'Publish date in the past':
                  value: { message: 'Publish datetime must be later than now', relogin: false, status: error }
  /a/v2/rest/public/oppositeOffer:
    post:
      tags:
        - 'Routes & tenders / Shippers / Tenders'
      summary: 'Submit Counteroffer'
      description: |-
        Allows shipper to bargain in tender.

        When the bid supplied by a carrier in tender is not fully acceptable, shippers can bargain using this endpoint. As a result, carriers will see the counter-offer and either accept or reject it.

        For example: you published a tender to do 800 deliveries, a carrier placed a bid suggesting 500 deliveries at 500$ rate, and using this endpoint you make a counter offer to that carrier to make it 400 deliveries at 485$ rate.

        *   If successful, you will receive the success message, the counter offer will be submitted to the carrier that made the supplied bid
        *   If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: submitCounteroffer
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                loadquote:
                  description: 'The new quantity of the counter offer. Int.'
                  type: string
                  example: '{{counterLoadQuote}}'
                pricequote:
                  description: 'The new price of the counter offer. Float.'
                  type: string
                  example: '{{counterPriceQuote}}'
                route:
                  description: 'Periodic of the target tender'
                  type: string
                  example: '{{singleRoute}}'
                routeresponse:
                  description: 'ID of the carrier bid (can be taken from `GET singleRoute` endpoint, `response` set)'
                  type: string
                  example: '{{routeResponseId}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Incorrect bid ID supplied / Incorrect route periodic supplied / Request by carrier'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Incorrect bid number.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Incorrect bid ID supplied':
                  value: { message: 'Incorrect bid number.', relogin: false, status: error }
                'Incorrect route periodic supplied':
                  value: { message: 'Incorrect route number.', relogin: false, status: error }
                'Request by carrier':
                  value: { message: 'This action is unavailable', relogin: false, status: error }
  /a/v2/rest/public/pickTenderWinner:
    post:
      tags:
        - 'Routes & tenders / Shippers / Tenders'
      summary: 'Select Tender Winner'
      description: |-
        Enables shipper to pick winner in a tender.

        - If successful, you will receive the success message, tender winner will be selected
            
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: selectTenderWinner
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                quote:
                  description: 'ID of the quote response id. Int. Required.'
                  type: string
                  example: '{{tendeQuoteResponseId}}'
                tenderPeriodic:
                  description: 'Periodic of the tender. String. Required.'
                  type: string
                  example: '{{tenderPeriodic}}'
                winner:
                  description: 'Company hash of the carrier company. String. Required.'
                  type: string
                  example: '{{tenderWinnerCompanyHash}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Not all params supplied'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Missing required parameters.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Not all params supplied':
                  value: { message: 'Missing required parameters.', relogin: false, status: error }
  /a/v2/rest/public/relaunchTender:
    post:
      tags:
        - 'Routes & tenders / Shippers / Tenders'
      summary: 'Relaunch Tender'
      description: |-
        Enables shipper to cancel winner pick in a tender and start the bidding over.

        - If successful, you will receive the success message, tender winner will be selected
            
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: relaunchTender
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                tenderPeriodic:
                  description: 'Periodic of the tender. String. Required.'
                  type: string
                  example: ''
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Not all params supplied'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Missing required parameters.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Not all params supplied':
                  value: { message: 'Missing required parameters.', relogin: false, status: error }
  /a/v2/rest/public/publishTenderChild:
    post:
      tags:
        - 'Routes & tenders / Shippers / Tenders'
      summary: 'Publish Route from Tender'
      description: |-
        Allows shipper to publish a route or a set of similar routes based on a tender.

        Example: you created a tender, collected bids, chose winner, and want to actually start implementing that tender, so you can publish the routes that are the derivatives ("children") of that tender using this endpoint.

        *   If successful, you will receive the success message with periodic numbers of the created routes that are published for the tender winner
        *   If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: publishRouteFromTender
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                quantity:
                  description: 'Quantity of routes to be published. Int'
                  type: string
                  example: '{{routeQuantity}}'
                tenderPeriodic:
                  description: 'Tender periodic, for which to publish routes'
                  type: string
                  example: '{{badTenderPeriodic}}'
      responses:
        201:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: string, example: 174-04-22 }, example: [174-04-22, 175-04-22] }
                  status: { type: string, example: created }
              examples:
                Success:
                  value: { data: [174-04-22, 175-04-22], status: created }
        400:
          description: 'Incorrect tender supplied'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Action forbidden' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Incorrect tender supplied':
                  value: { message: 'Action forbidden', relogin: false, status: error }
  /a/v2/rest/public/createStep2Tender:
    post:
      tags:
        - 'Routes & tenders / Shippers / Tenders'
      summary: 'Create Second-Stage Tender'
      description: 'An endpoint for a specific workflow. To activate the specific workflow one should activate the 2-step tenders setting. Once the 1-st step with the blind tender is done, shipper can create the second step tender using this endpoint.'
      operationId: createSecondStageTender
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                deadline:
                  type: string
                  example: '{{tenderDeadline}}'
                step1tender:
                  type: string
                  example: '{{step1tenderPeriodic}}'
                userclient_email:
                  type: string
                  example: '{{responsibleUserEmail}}'
            examples:
              'Create Second-Stage Tender':
                value:
                  deadline: '{{tenderDeadline}}'
                  step1tender: '{{step1tenderPeriodic}}'
                  userclient_email: '{{responsibleUserEmail}}'
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Fri, 14 Apr 2023 09:00:48 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: string, example: 111-04-23 }, example: [111-04-23] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [111-04-23], status: success }
        400:
          description: 'Invalid deadline supplied / Invalid step1 tender supplied / Create Second Step of tenders'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Mon, 01 May 2023 14:18:03 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Set-Cookie:
              schema:
                type: string
                example: 'XDEBUG_SESSION=netbeans-xdebug; expires=Mon, 01-May-2023 15:18:03 GMT; Max-Age=3600; path=/'
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Deadline cannot be earlier than now, cannot proceed' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Create Second Step of tenders':
                  value: { message: 'We couldn’t find a user with that email address.', relogin: false, status: error }
                'Invalid deadline supplied':
                  value: { message: 'Deadline cannot be earlier than now, cannot proceed', relogin: false, status: error }
                'Invalid step1 tender supplied':
                  value: { message: 'We couldn’t find such a route.', relogin: false, status: error }
  /a/v2/rest/public/createRoute:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Create Route'
      description: |-
        With this endpoint you can add routes/orders into Phleetto from your systems one at a time or many at once.

        You will need to supply a MAC to ensure message integrity. The MAC is calculated as a SHA256 of the `post` string using the MAC key available in user profile, and must be sent as a separate param `signature`. Use this online tool to test your signature: [https://phleet.to/ooqwq](https://phleet.to/ooqwq)

        `post` parameter explanation:

        - request must be in JSON
            
        - _routes_ is the root element, that can contain one or more _route_ objects
            

        ### `route` object explanation:

        | param | required | type | explanation | valid example | invalid example |
        | --- | --- | --- | --- | --- | --- |
        | routeparts | yes | array of `routepart` objects | an array of points for the order/route, like loading, unloading, border, customs, etc | (see below) | empty |
        | route_apicode | yes | string (40) | an id of the order/route within your (external) system | DG-1982, 123221 | empty or duplicate |
        | budget | yes | decimal (12,2) | order's price, in national currency if currency param is not provided | 1090.55 | _100,00_, one thousand |
        | draft |  | bool | whether to publish the route as draft or not | 1, true |  |
        | currency |  | string (3) | currency, default to national currency, valid values: USD, EUR | EUR | GBP |
        | nds |  | bool |  | 1 for value added tax included, 0 for no VAT included | 1 |
        | paymenttype |  | int (1) | according to internal mapping: 2 for bank transfer, 3 for cash, see [mapping](https://phleet.to/data-mapping) | 2 | 4 |
        | payorcode |  | string (30) | national ID of the legal entity to pay for the order/route, must match the settings within the UI | 40003782 | non matching id |
        | chargetype |  | array of ints | an array of accaptable charge types for the order/route, must match [the mapping](https://phleet.to/data-mapping) | \[1,3\] | non matching ids |
        | cartype |  | array of ints | an array of accaptable car types for the order/route, must match [the mapping](https://phleet.to/data-mapping) | \[1,2\] | non matching ids |
        | ferryproperty |  | array of ints | an array of additional desirable parameters for the order/route, must match [the mapping](https://phleet.to/data-mapping) | \[5,10,11\] | non matching ids |
        | ferryproperty_details |  | object of string values | key must be string in \[10,11,12\] as per ferryproperty, values must be strings (20) | {"11":"-5", "10":"32"} |  |
        | operators |  | array of strings | an array of carrier hashes, for whom the route shall be available, hashes can be found in GET getPartners endpoint | \["06991aab9ddafbc6faaa2429d4fa3de2","692ea987e30fffeef4803561327eaa39"\] | \["Перевізник, ТОВ",29812\] |
        | remark |  | string | the remark field is a free-form text string, it can accommodate various types of information, making it a versatile field for any notes that don’t fit into the structured fields already defined | "Urgent delivery required by 2024-08-27. Contact receiver before delivery." |  |
        | userclient_email |  | string | if the user responsible for the route is not the holder of the token, pass his/her email here | "validuser@ourcompany.com" | "John Doe" |

        ### `routepart` object explanation:

        | param | required | type | applicable workaction | explanation | valid example | invalid example |
        | --- | --- | --- | --- | --- | --- | --- |
        | workaction | yes | int (1) | all | type of action on the checkpoint, must be one of 1 (loading), 2 (unloading), 3 (customs) or 4 (border) | 1 | unload |
        | apicode | yes | string (10) | 1,2 | id of the point in your (external) system, for simplicity of geography integration |  |  |
        | category |  | int (5) | 1 | internal ID of the category, for order/route grouping, must match the mapping | 192 | non-matching id |
        | cargo | yes | string (255) | 1 | the payload being shipped | гн. швеллер и рельс |  |
        | weight | almost | decimal (13,3) | 1 | weight of cargo in tonns, either this or volume must be supplied for workaction 1 | 22.3 |  |
        | volume | almost | decimal (13,3) | 1 | volume of cargo in cubic meters, either this or weight must be supplied for workaction 1 | 70 |  |
        | length |  | decimal (13,3) | 1 | length of cargo in meters | 8 |  |
        | height |  | decimal (13,3) | 1 | height of cargo in meters | 0.2 |  |
        | width |  | decimal (13,3) | 1 | width of cargo in meters | 5.5 |  |
        | date1 |  | string (YYYY-MM-DD) | all | expected date of arrival to this point | 2020-06-20 | 30-12-2020 |
        | time1 |  | string (HH:MM:SS) | all | expected time of arrival to this point, in 24 hour format | 18:00:00 | 6 PM |
        | company_title | almost | string (255) | 1,2 | the name of the legal entity in the point, either this or company_natcomid is required | LLC "Phleetto", inc |  |
        | company_natcomid | almost | string (30) | 1,2 | the national code of the legal entity, either this or company_name is required | 40003782 |  |
        | contact_name | yes | string (255) | 1,2 | name of the person responsible for the work on the point | John Doe |  |
        | contact_cellnum | almost | string (40) | 1,2 | phone number of the responsible person, either this or email is required | 38 050 111 22 33 |  |
        | contact_email | almost | string (255) | 1,2 | email of the responsible person, either this or cellnum is required | [office@phleetto.co.uk](https://mailto:office@phleetto.co.uk) | invalid email |
        | geo_country_iso_num | yes | int (3) | 1,2 | county code according to [ISO standard](https://www.iso.org/standard/63545.html) | 380 | non existent code |
        | geo_region |  | string (255) | 1,2 | sublocality (administrative_area_level_1), region, state, oblast, or other administrative division | Киевская область |  |
        | geo_district |  | string (255) | 1,2 | county, district (administrative_area_level_2) or other smaller administrative division | Богуславский район |  |
        | geo_city | yes | string (255) | 1,2 | town, village, locality, city or other administrative division | Богуслав |  |
        | geo_address | yes | string (200) | 1,2 | street address | ул. Орджоникидзе 14 | наша машина, паспорт номер такойто, область, город |
        | geo_town_id |  | int (7) | 4 | internal town ID or border crossing |  |  |
        | geo_apicode |  | string (10) | 3 | your (external) point ID of the customs point |  |  |
        | malformed_full_address_prioritized |  | string (255) | 1,2,3 | address in whatever non-normalized form; we parse, normalize, and return `apicode` | \*"м.Одеса,вул.Аркадіївська алея, ТРЦ Аркадія Сіті, маг. Винчик"\* or "_Волинська обл.,м. Луцьк, вул. Карбишева, 2 ( част. буд.блоку скл. 'Е-2'"_ | 229 |
        | border_operator_select |  | int(1) | 4 | set to 1 if the carrier is expected to indicte the point of border crossing |  |  |

        Each route must start with a workaction=1 routepart and end with workaction=2 routepart.
      operationId: createRoute
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                '':
                  type: string
                  example: ''
                post:
                  description: 'The main body of the request, the payload that contains the route/order details.'
                  type: string
                  example: |-
                    {
                       "routes":{
                          "route":{
                             "cartype":[
                                1,
                                2,
                                4
                             ],
                             "routeparts":[
                                {
                                   "apicode":"internalcode123",
                                   "contact_name":"Marina Niedzialkowska - экспорт менеджер",
                                   "geo_country_iso_num":616,
                                   "geo_region":"",
                                   "company_natcomid":"",
                                   "weight":1.47,
                                   "date1":"2019-11-06",
                                   "contact_email":"noemail@email.com",
                                   "time1":"00:00:00",
                                   "contact_cellnum":"050 1 1 1 1 1 1 ",
                                   "company_title":"INSTAL PROJEKT Gawlowscy, Scierzynscy Spolka Jawna",
                                   "geo_district":"",
                                   "geo_address":"ul. some street, 12a",
                                   "workaction":"3",
                                   "geo_city":"kruszyn",
                                   "category":0,
                                   "cargo":"плитка\/сантехніка"
                                },
                                {
                                   "contact_name":"nocontact",
                                   "geo_country_iso_num":804,
                                   "geo_region":"київська",
                                   "company_natcomid":"",
                                   "weight":1.47,
                                   "date1":"2019-11-14",
                                   "contact_email":"noemail@email.com",
                                   "time1":"00:00:00",
                                   "contact_cellnum":"(044) 123123123 #$%^&*()_",
                                   "company_title":"Агросем",
                                   "geo_district":"",
                                   "geo_address":"вул. hrest, 17-А",
                                   "workaction":"2",
                                   "geo_city":"Київ",
                                   "cargo":"плитка\/сантехніка"
                                }
                             ],
                             "currency":"UAH",
                             "payorcode":"",
                             "chargetype":[
                                3,
                                2,
                                4
                             ],
                             "route_apicode":"unique-external-id-11212",
                             "paymenttype":2,
                             "budget":20500.0
                          }
                       }
                    }
                signature:
                  description: 'A MAC must be supplied, which is a SHA256 hash product of the `post` parameter and the MAC key.'
                  type: string
                  example: '{{MAC}}'
      responses:
        201:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { periodic: { type: string, example: 436-04-22 }, url: { type: string, example: '/a/index.php?p=view&id=436-04-22&m=shipping' }, userroutenumber: { type: string, example: unique-external-id-11212 } } }, example: [{ periodic: 436-04-22, url: '/a/index.php?p=view&id=436-04-22&m=shipping', userroutenumber: unique-external-id-11212 }] }
                  status: { type: string, example: created }
              examples:
                Success:
                  value: { data: [{ periodic: 436-04-22, url: '/a/index.php?p=view&id=436-04-22&m=shipping', userroutenumber: unique-external-id-11212 }], status: created }
        400:
          description: 'Request by carrier / Invalid MAC supplied / Missing params / Invalid routeparts order'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: '*'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Fri, 15 Apr 2022 12:33:07 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: 'nginx/1.18.0 (Ubuntu)'
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You can’t create routes.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid MAC supplied':
                  value: { message: 'ERROR: Data is corrupt.', relogin: false, status: error }
                'Invalid routeparts order':
                  value: { message: 'First routepart must be workaction 1 and last routepart must be workaction 2', relogin: false, status: error }
                'Missing params':
                  value: { message: 'ERROR: Request is invalid', relogin: false, status: error }
                'Request by carrier':
                  value: { message: 'You can’t create routes.', relogin: false, status: error }
  /a/v2/rest/public/changeBudget:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Update Budget'
      description: 'Update Budget'
      operationId: updateBudget
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                budget:
                  type: string
                  example: '123222'
                changebudget:
                  type: number
                  example: 1
                nds:
                  type: number
                  example: 1
                route:
                  type: string
                  example: '{{periodic}}'
            examples:
              'Update Budget':
                value:
                  budget: '123222'
                  changebudget: 1
                  nds: 1
                  route: '{{periodic}}'
      responses:
        200:
          description: ''
  /a/v2/rest/public/addAdjustment:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Create Payment Adjustment'
      description: |-
        Allows the shipper to add a budget correction, such as a premium (uplift) or a fine. Along with the uplift or the fine, a remark may be supplied for future reference.

        The budget of the route will be automatically recalculated in accordance with the passed values. For the "uplift" correction the budget will increase; for "fine" correction the budget will decrease respecively.

        (!) Important: setting #15 ( `premiumindicate`) must be turned on for the endpoint to work.

        _If successful_, you will receive the success message, and the route will be updated with the new budget correction.

        _If unsuccessful_, an error message will be provided to explain the issue in the language specified in the request header or the language set in the app.
      operationId: createPaymentAdjustment
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                fine:
                  type: string
                  example: '100'
                fineremark:
                  type: string
                  example: 'Штраф за запізнення'
                nds:
                  type: number
                  example: 1
                route:
                  type: string
                  example: 790-05-26
                setpremium:
                  type: number
                  example: 1
                uplift:
                  type: string
                  example: '500'
                upliftremark:
                  type: string
                  example: 'Надбавка за терміновість'
            examples:
              'Create Payment Adjustment':
                value:
                  fine: '100'
                  fineremark: 'Штраф за запізнення'
                  nds: 1
                  route: 790-05-26
                  setpremium: 1
                  uplift: '500'
                  upliftremark: 'Надбавка за терміновість'
      responses:
        200:
          description: ''
  /a/v2/rest/public/removeAdjustment:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Remove Payment Adjustment'
      description: 'Remove Payment Adjustment'
      operationId: removePaymentAdjustment
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                del:
                  type: string
                  example: Z2vzqHucmFjSEGRlQZ9L5fFLZOsAmPOtB30f%2Fv8bIRiD5OCNfqiY%3D
                route:
                  type: string
                  example: '{{periodic}}'
                setpremium:
                  type: number
                  example: 1
            examples:
              'Remove Payment Adjustment':
                value:
                  del: Z2vzqHucmFjSEGRlQZ9L5fFLZOsAmPOtB30f%2Fv8bIRiD5OCNfqiY%3D
                  route: '{{periodic}}'
                  setpremium: 1
      responses:
        200:
          description: ''
  /a/v2/rest/public/addBudgetCorrection:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Deprecated: Create Payment Adjustment'
      description: |-
        Allows the shipper to add a budget correction, such as a premium (uplift) or a fine. Along with the uplift or the fine, a remark may be supplied for future reference.

        The budget of the route will be automatically recalculated in accordance with the passed values. For the "uplift" correction the budget will increase; for "fine" correction the budget will decrease respecively.

        (!) Important: setting #15 ( `premiumindicate`) must be turned on for the endpoint to work.

        _If successful_, you will receive the success message, and the route will be updated with the new budget correction.

        _If unsuccessful_, an error message will be provided to explain the issue in the language specified in the request header or the language set in the app.
      operationId: deprecatedCreatePaymentAdjustment
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                absoluteSum:
                  description: 'Sum of the correction in the currency of the route. Must be positive. Decimal. Required.'
                  type: string
                  example: '-100'
                remark:
                  description: 'Remark for the correction. String. Optional.'
                  type: string
                  example: '{{correctionReason}}'
                route:
                  description: 'Periodic of the route. Required. String'
                  type: string
                  example: '{{routePeriodic}}'
                type:
                  description: 'One of "uplift" or "fine". String. Required.'
                  type: string
                  example: fine
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Wed, 16 Apr 2025 12:21:43 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.27.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
            X-Xdebug-Profile-Filename:
              schema:
                type: string
                example: /var/tmp/cachegrind.out.88611
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { budget: { type: number, example: 20200 }, currency: { type: string, example: uah }, route: { type: string, example: 18-02-25 } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { budget: 20200, currency: uah, route: 18-02-25 }, status: success }
        400:
          description: 'Bad correction type supplied / Bad sum supplied'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Wed, 16 Apr 2025 12:20:46 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.27.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
            X-Xdebug-Profile-Filename:
              schema:
                type: string
                example: /var/tmp/cachegrind.out.88620
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Type must be one of "uplift", "fine", but "premium" given' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Bad correction type supplied':
                  value: { message: 'Type must be one of "uplift", "fine", but "premium" given', relogin: false, status: error }
                'Bad sum supplied':
                  value: { message: 'Param absoluteSum must contain a positive decimal value', relogin: false, status: error }
  /a/v2/rest/public/ratifyOperator:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Approve Carrier Proposal'
      description: |-
        Allows shipper to confirm or ratify the carrier, that applied for the completion of the specified order.

        *   If successful, you will receive the success message and the carrier that applied will be assigned to the order
        *   If unsuccessful you will receive an error explaining  
            the problem in the language you supplied with the header or the language set in the app
      operationId: approveCarrierProposal
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'Route periodic. String. Required.'
                  type: string
                  example: '{{singleRoute}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Params not passed / Request by carrier'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: '*'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Tue, 12 Apr 2022 18:44:02 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: 'nginx/1.18.0 (Ubuntu)'
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'No parameters were provided.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Params not passed':
                  value: { message: 'No parameters were provided.', relogin: false, status: error }
                'Request by carrier':
                  value: { message: 'The action is not available.', relogin: false, status: error }
  /a/v2/rest/public/rejectOperator:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Reject Carrier Proposal'
      description: |-
        Allows shipper to decline the delivery offer.

        *   If successful, you will receive the success message, the carrier will be declined, the route will be vacant for offers again
        *   If unsuccessful you will receive an error explaining  
            the problem in the language you supplied with the header or the language set in the app
      operationId: rejectCarrierProposal
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'Periodic of the route. Required. String'
                  type: string
                  example: '{{routePeriodic}}'
                routeresponse:
                  description: 'ID of the response. Int. Required.'
                  type: string
                  example: '{{responseID}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Invalid params passed / Params not passed'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'This action is unavailable' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid params passed':
                  value: { message: 'This action is unavailable', relogin: false, status: error }
                'Params not passed':
                  value: { message: 'No parameters were provided.', relogin: false, status: error }
  /a/v2/rest/public/confirmCharge:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Confirm Loading'
      description: |-
        Confirms the loading by the shipper. 

        If the route only contains one loading point, then additional parameters might not come in handy. However, if there are several loading points, additional logic may be applied based on the passed parameters.

        If only the `route` parameter is supplied (without additional parameters) then the endpoint considers the first loading point as default one to confirm.

        You can indicate which exactly loading point you want to confirm my passing the `routepartId` int parameter. You can get the routepart id using the `GET singleRoute` endpoint.

        Additionally, target point to confirm may not be ready for shipper confirmation, for example in case the carrier had not yet arrived to the point, or had not yet completed the loading process. In such cases, when the target point is not yet ready, you will receive a corresponding error message. However, you can pass the `force` param in order to override those limiting conditions. Use that flag only when you are sure that the loading is truly complete and successful.

        (!) NOTE: when forcing confirmation of a particular non-first loading on a complex route, all preceding points will be automatically set as complete.

        - If successful, you will receive the success message, the loading will be set as confirmed, and the route will get transitioned to the next corresponding status
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: confirmLoading
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                force:
                  description: 'optional flag (0|1), if passed together with routepartId forces the completion of the charge point regardless of whether the carrier arrived/completed or not'
                  type: string
                  example: '{{forceFlag}}'
                route:
                  description: 'route periodic'
                  type: string
                  example: '{{singleRoute}}'
                routepart:
                  description: 'optional (int), but required if force flag is supplied, indicates which exactly point to confirm'
                  type: string
                  example: '{{routepartID}}'
      responses:
        200:
          description: 'Success (no additional params) / Success (with additional params)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                'Success (no additional params)':
                  value: { data: [], status: success }
                'Success (with additional params)':
                  value: { data: [], status: success }
        400:
          description: 'Route in such status that loading confirmation is unavailable / Point passed is in such status that confirmation is unavailable'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'The route status doesn’t allow confirming loading.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Point passed is in such status that confirmation is unavailable':
                  value: { message: 'The stop is incorrect.', relogin: false, status: error }
                'Route in such status that loading confirmation is unavailable':
                  value: { message: 'The route status doesn’t allow confirming loading.', relogin: false, status: error }
  /a/v2/rest/public/confirmUncharge:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Confirm Unloading'
      description: |-
        Confirms the unloading by the shipper.

        If the route only contains one unloading point, then additional parameters might not come in handy. However, if there are several unloading points, additional logic may be applied based on the passed parameters.

        If only the `route` parameter is supplied (without additional parameters) then the endpoint considers the first unloading point as default one to confirm.

        You can indicate which exactly unloading point you want to confirm my passing the `routepartId` int parameter. You can get the routepart id using the `GET singleRoute` endpoint.

        Additionally, target point to confirm may not be ready for shipper confirmation, for example in case the carrier had not yet arrived to the point, or had not yet completed the loading process. In such cases, when the target point is not yet ready, you will receive a corresponding error message. However, you can pass the `force` param in order to override those limiting conditions. Use that flag only when you are sure that the unloading is truly complete and successful.

        (!) NOTE: when forcing confirmation of a particular non-first unloading on a complex route, all preceding points will be automatically set as complete.

        *   If successful, you will receive the success message, the unloading will be set as confirmed, and the route will get transitioned to the next corresponding status
        *   If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: confirmUnloading
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                force:
                  description: 'optional flag (0|1), if passed together with routepartId forces the completion of the loading point regardless of whether the carrier arrived/completed or not'
                  type: string
                  example: '{{forceFlag}}'
                route:
                  description: 'route periodic'
                  type: string
                  example: '{{invalidRoute}}'
                routepart:
                  description: 'optional (int), but required if force flag is supplied, indicates which exactly point to confirm'
                  type: string
                  example: '{{routepartID}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Request by carrier / Route not ready for unloading / Invalid route periodic passed'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Action not available' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid route periodic passed':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
                'Request by carrier':
                  value: { message: 'Action not available', relogin: false, status: error }
                'Route not ready for unloading':
                  value: { message: 'The route status doesn’t allow confirming unloading.', relogin: false, status: error }
  /a/v2/rest/public/requestChangeCheckpoints:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Request Stop Changes'
      description: |-
        This endpoint allows users to request changes to the checkpoints for a specified routepart. The request includes the route periodic, the routepart identifier, and the new checkpoint contact data.

        **Request Body**  
        The request body must be in JSON format and contain the following fields:

        - **periodic**: route periodic number, string, required
        - **routepart**: the identifier for the specific part of the route, int, required
        - **newChekpointcontactdata**: the new contact data for the checkpoint, int, required
            
        **Response**  
        The response will indicate the success or failure of the request to change the checkpoints.

        Ensure that the _periodic_ is correct. _routepart_ must be a valid identifier for an existing route part. _newChekpointcontactdata_ should be the updated contact information for the checkpoint. This endpoint is used by clients who need to update checkpoint information.
      operationId: requestStopChanges
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                newChekpointcontactdata:
                  type: number
                  example: 24247
                periodic:
                  type: string
                  example: 3-01-21
                routepart:
                  type: number
                  example: 112264261
            examples:
              'Request Stop Changes':
                value:
                  newChekpointcontactdata: 24247
                  periodic: 3-01-21
                  routepart: 112264261
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  routechange: { type: number, example: 152650 }
              examples:
                Success:
                  value: { routechange: 152650 }
        400:
          description: 'Invalid checkpoint contact data'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Given chekpointcontactdata is not valid' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid checkpoint contact data':
                  value: { message: 'Given chekpointcontactdata is not valid', relogin: false, status: error }
        403:
          description: 'Missing token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'token is required' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Missing token':
                  value: { message: 'token is required', relogin: true, status: error }
  /a/v2/rest/public/finishRoute:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Force Complete Route'
      description: |-
        Marks the route complete and all checkpoints within it.

        - if successful you will mark complete the route and all checkpoints within it
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app 

        (!) NOTE: Can be only used by shippers
      operationId: forceCompleteRoute
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: '{{singleRoute}}'
          description: 'Required, string. Single route periodic'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Route not ready to be forced as complete / Request from carrier'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'This action is not allowed for this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Request from carrier':
                  value: { message: 'The action is not available.', relogin: false, status: error }
                'Route not ready to be forced as complete':
                  value: { message: 'This action is not allowed for this route.', relogin: false, status: error }
  /a/v2/rest/public/forceVacantizeRoute:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Cancel Route and Reopen for Carrier Pool'
      description: |-
        This endpoint allows users to cancel a route that is currently in progress and move it to the vacant list. The request requires authorization and the specification of the periodic for the route.

        The request body must be in JSON format and contain the following field:

        - **periodic:** the periodic of the route to be canceled, string, required
            
        The response will indicate the success or failure of the request to cancel the route and move it to the vacant list.

        - if success you will change route status and route will become available.
            
        This endpoint is typically used by clients who need to manage route statuses dynamically, allowing them to cancel ongoing routes and reassign them as needed.
      operationId: cancelRouteAndReopenForCarrierPool
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                periodic:
                  type: string
                  example: 18-07-21
            examples:
              'Cancel Route and Reopen for Carrier Pool':
                value:
                  periodic: 18-07-21
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status: { type: boolean, example: true }
              examples:
                Success:
                  value: { status: true }
        400:
          description: 'Route In Tender State Error / Invalid route number'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: "The route musn't be tender" }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid route number':
                  value: { message: 'Incorrect route number.', relogin: false, status: error }
                'Route In Tender State Error':
                  value: { message: "The route musn't be tender", relogin: false, status: error }
  /a/v2/rest/public/removeFreeRoute:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Remove Open Route'
      description: 'Remove Open Route'
      operationId: removeOpenRoute
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                route:
                  type: string
                  example: 738-04-26
            examples:
              'Remove Open Route':
                value:
                  route: 738-04-26
      responses:
        200:
          description: ''
  /a/v2/rest/public/reviveRoute:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Reopen Route'
      description: 'Reopen Route'
      operationId: reopenRoute
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                route:
                  type: string
                  example: 738-04-26
            examples:
              'Reopen Route':
                value:
                  route: 738-04-26
      responses:
        200:
          description: ''
  /a/v2/rest/public/createOrder:
    post:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Create Route Order'
      description: |-
        This endpoint allows you to create a new order by providing the necessary details about the route, order number, pallet plans, and product details.

        - if successful response will confirm the creation of the order and provide details about the order.
            
        **Body:**

        The request body should be in raw JSON format containing the order details.

        - **route:** (string) required  
            Description: Identifier of the route.

            
        - **number:** (string) required  
            Description: Order number

            
        - **palletbases_plan:** (integer) required  
            Description: Planned number of pallet bases.

            
        - **palletplaces_plan:** (integer) required  
            Description: Planned number of pallet places.

            
        - **aux:** (string) optional  
            Description: Additional technical data.

            
        - **products: (array of objects)** required  
            Description: List of products in the order. See below.

            
        - **checkunique**: (bool) this is an optional parameter which checks, whether there already is an order with such number. If it happens to be the case, the duplicate order is rejected with an error.
            
        Additional fields required for eCMR (eTTN):

        - **customer_order_number**: String. Optional. Order number of the buyer of the goods.
            
        - **customer_order_date:** Date YYYY-MM-DD. Optional. Order date of the buyer of the goods.
            
        - **customer_gln:** String. Optional. GLN of the buyer of the goods.
            
        - **output_date:** Date YYYY-MM-DD. Optional. Loading date
            
        - **planned_delivery_date.** Date YYYY-MM-DD. Optional. Planned unloading date
            
        - **contract_date:** String. Optional. Contract date.
            
        - **contract_number:** String. Optional. Contract number.
            
        - **deliveryplace_gln:** String. Optional. GLN of the destination point.
            
        - **deliveryplace_zip:** String. Optional. Post code of the destination point.
            
        Products objects parameters:

        - **position:** String. Optional. Periodic position number in order.
            
        - **sku:** String. Required. SKU of the product.
            
        - **title:** String. Required. Description or name of the product.
            
        - **quantity:** Decimal. Optional. Quantity of the item in the order, in whatever units.
            
        - **measure_unit:** String. Optional. Measure unit, in whatever form needed. Example: BX, box.
            
        - **weight:** Decimal. Optional. Weight in metric tonns.
            
        - **volume:** Decimal. Optional. Volumne in cubic meters.
            
        - **unit_price:** Decimal. Optional. Price for a single unit.
            
        - **total_price:** Decimal. Optional. Price for all the units.
            
        - **vat:** Decimal. Optional. VAT of all the units.
            
        - **barcode:** String. Optional. Bar code of the item.
            
        - **customer_code:** String. Optional. Customer product code.
            
        - **class:** String. Optional. Category of goods.
      operationId: createRouteOrder
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                aux:
                  type: string
                  example: 'some technical data'
                checkunique:
                  type: boolean
                  example: true
                number:
                  type: string
                  example: '0987689987'
                palletbases_plan:
                  type: number
                  example: 10
                palletplaces_plan:
                  type: number
                  example: 20
                products:
                  type: array
                  items: { type: object, properties: { extra1: { type: number, example: 10.111 }, extra2: { type: number, example: 200002.22222 }, extra3: { type: number, example: 339999333.33333 }, measure_unit: { type: string, example: короб }, position: { type: number, example: 1 }, quantity: { type: number, example: 9 }, sku: { type: string, example: '12312223' }, title: { type: string, example: smittles }, total_price: { type: number, example: 2901.55 }, unit_price: { type: number, example: 10.66 }, vat: { type: number, example: 60 }, volume: { type: number, example: 0.4089 }, weight: { type: number, example: 0.212 } } }
                  example: [{ extra1: 10.111, extra2: 200002.22222, extra3: 339999333.33333, measure_unit: короб, position: 1, quantity: 9, sku: '12312223', title: smittles, total_price: 2901.55, unit_price: 10.66, vat: 60, volume: 0.4089, weight: 0.212 }, { extra1: 1.111, extra2: 2222222.22222, extra3: 3333333333.3333, measure_unit: шт, position: 2, quantity: 223, sku: m112323, title: wiskas, total_price: 600, unit_price: 19.89, vat: 125, volume: 8.0289, weight: 0.933 }]
                route:
                  type: string
                  example: 2-09-24
            examples:
              'Create Route Order':
                value:
                  aux: 'some technical data'
                  checkunique: true
                  number: '0987689987'
                  palletbases_plan: 10
                  palletplaces_plan: 20
                  products: [{ extra1: 10.111, extra2: 200002.22222, extra3: 339999333.33333, measure_unit: короб, position: 1, quantity: 9, sku: '12312223', title: smittles, total_price: 2901.55, unit_price: 10.66, vat: 60, volume: 0.4089, weight: 0.212 }, { extra1: 1.111, extra2: 2222222.22222, extra3: 3333333333.3333, measure_unit: шт, position: 2, quantity: 223, sku: m112323, title: wiskas, total_price: 600, unit_price: 19.89, vat: 125, volume: 8.0289, weight: 0.933 }]
                  route: 2-09-24
          text/plain:
            examples:
              'Create Route Order':
                value: |-
                  {
                      "route":"6165-05-24",
                      "number":"0987
                      "palletplaces_plan":20,
                      "aux":"some technical data",
                      "products":[
                          {
                              "position":1,
                              "sku":"12312223",
                              "title":"smittles",
                              "quantity":9,
                              "measure_unit":"короб",
                              "weight":0.212,
                              "volume":0.4089,
                              "unit_price":10.66,
                              "total_price":2901.55,
                              "vat":60,
                              "extra1": 10.111,
                              "extra2": 200002.22222,
                              "extra3": 339999333.333333
                              },
                          {
                              "position":2,
                              "sku":"m112323",
                              "title":"wiskas",
                              "quantity":223,
                              "measure_unit":"шт",
                              "weight":0.933,
                              "volume":8.0289,
                              "unit_price":19.89,
                              "total_price":600,
                              "vat":125,
                              "extra1": 1.111,
                              "extra2": 2222222.22222,
                              "extra3": 3333333333.333333
                          }
                      ]

                  }
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { id: { type: number, example: 1111 }, number: { type: string, example: '0500000000' }, route: { type: string, example: -27106704000 } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { id: 1111, number: '0500000000', route: -27106704000 }, status: success }
        400:
          description: 'Bad request / Duplicate order'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Unsupported operand types' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Bad request':
                  value: { message: 'Unsupported operand types', relogin: false, status: error }
                'Duplicate order':
                  value: { message: 'Вже є таке замовлення в цьому маршруті', relogin: false, status: error }
        403:
          description: 'No token supplied'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is required' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'No token supplied':
                  value: { message: 'Token is required', relogin: true, status: error }
  '/a/v2/rest/public/deleteOrders/{singleRoute}':
    delete:
      tags:
        - 'Routes & tenders / Shippers / Routes'
      summary: 'Delete Route Orders'
      description: 'Delete Route Orders'
      operationId: deleteRouteOrders
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { deleted: { type: array, items: { type: string, example: 'order number 2' }, example: ['order number 2'] } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { deleted: ['order number 2'] }, status: success }
    parameters:
      -
        name: singleRoute
        in: path
        required: true
        schema:
          type: string
  /a/v2/rest/public/getCargo:
    get:
      tags:
        - 'Routes & tenders / Shippers / Shared Operations'
      summary: 'Get Freight Descriptions'
      description: |-
        Returns the list of freight descriptions available in the app, specified by the `q` search query. The list starts from freight descriptions that your company has used.

        - if successful you will receive a list of freight descriptions 
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Returns no more than 50 entries. Can be used only by shipper
      operationId: getFreightDescriptions
      parameters:
        -
          name: q
          in: query
          schema:
            type: string
            example: '{{cargoQuery}}'
          description: 'Required. Freight description search string'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: string, example: Aggregates }, example: [Aggregates, 'Aggregated materials'] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [Aggregates, 'Aggregated materials'], status: success }
        400:
          description: 'No Query Parameter'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Search query not passed' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'No Query Parameter':
                  value: { message: 'Search query not passed', relogin: false, status: error }
  '/a/v2/rest/public/route/{singleRoute}':
    put:
      tags:
        - 'Routes & tenders / Shippers / Shared Operations'
      summary: 'Update Visibility'
      description: |-
        Allows you to update the route/tender, and change the carriers who would be allowed to work on the route.

        - if successful you will have your route/tender moved to the bin
            
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        (!)NOTE: Only for shippers

        **singleRoute** URL must be a periodic of the route or tender, in form 123-12-12.

        **operators** param must contain the array of clientHash strings of the carriers, can be found in GET getPartners
      operationId: updateVisibility
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                operators:
                  type: array
                  items: { type: string, example: d08dbfc74eff5853073aa49e174af6e2 }
                  example: [d08dbfc74eff5853073aa49e174af6e2, ec2b30b1d99dadf7ce87a6236c439464]
            examples:
              'Update Visibility':
                value:
                  operators: [d08dbfc74eff5853073aa49e174af6e2, ec2b30b1d99dadf7ce87a6236c439464]
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { operators: { type: array, items: { type: string, example: d08dbfc74eff5853073aa49e174af6e2 }, example: [d08dbfc74eff5853073aa49e174af6e2, ec2b30b1d99dadf7ce87a6236c439464] }, route: { type: string, example: 96-04-25 } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { operators: [d08dbfc74eff5853073aa49e174af6e2, ec2b30b1d99dadf7ce87a6236c439464], route: 96-04-25 }, status: success }
        400:
          description: 'Route is booked error'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Mon, 28 Apr 2025 11:23:30 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.27.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
            X-Xdebug-Profile-Filename:
              schema:
                type: string
                example: /var/tmp/cachegrind.out.99663
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'The route is reserved for a carrier and cannot be edited.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Route is booked error':
                  value: { message: 'The route is reserved for a carrier and cannot be edited.', relogin: false, status: error }
    delete:
      tags:
        - 'Routes & tenders / Shippers / Shared Operations'
      summary: 'Delete Route or Tender'
      description: |-
        Allows you to delete the route/tender, i.e. move it to the trash bin. Routes in the trash bin aren't available for the carriers.

        - if successful you will have your route/tender moved to the bin
            
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        (!)NOTE: Only for shippers

        **singleRoute** URL must be a periodic of the route or tender, in form 123-12-12.
      operationId: deleteRouteOrTender
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { deleted: { type: string, example: -22033123200 } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { deleted: -22033123200 }, status: success }
        400:
          description: 'Invalid route periodic'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Route not found.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid route periodic':
                  value: { message: 'Route not found.', relogin: false, status: error }
    parameters:
      -
        name: singleRoute
        in: path
        required: true
        schema:
          type: string
  /a/v2/rest/public/updateApiCode:
    post:
      tags:
        - 'Routes & tenders / Shippers / Shared Operations'
      summary: 'Update API Code'
      description: 'Update API Code'
      operationId: updateApiCode
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                route:
                  type: string
                  example: '{{periodic}}'
                userroutenumber:
                  type: string
                  example: '{{userroutenumber}}'
            examples:
              'Update API Code':
                value:
                  route: '{{periodic}}'
                  userroutenumber: '{{userroutenumber}}'
      responses:
        200:
          description: ''
  /a/v2/rest/public/updatePayor:
    post:
      tags:
        - 'Routes & tenders / Shippers / Shared Operations'
      summary: 'Update Billing Entity'
      description: 'Update Billing Entity'
      operationId: updateBillingEntity
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payor:
                  type: string
                  example: Z2vzqHucmY5JrETMhcv9bcI6oiGM859RLjn3vBB99BbWZNRgycoE%3D
                route:
                  type: string
                  example: 738-04-26
            examples:
              'Update Billing Entity':
                value:
                  payor: Z2vzqHucmY5JrETMhcv9bcI6oiGM859RLjn3vBB99BbWZNRgycoE%3D
                  route: 738-04-26
      responses:
        200:
          description: ''
  /a/v2/rest/public/updateLoadingDates:
    post:
      tags:
        - 'Routes & tenders / Shippers / Shared Operations'
      summary: 'Update Loading Schedule'
      description: 'Update Loading Schedule'
      operationId: updateLoadingSchedule
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                date1:
                  type: string
                  example: 18.04.2026
                factarrivaldate:
                  type: string
                  example: 17.04.2026
                factarrivaltime:
                  type: string
                  example: '00:00:00'
                route:
                  type: string
                  example: 738-04-26
                routepart:
                  type: number
                  example: 123456
                time1:
                  type: string
                  example: '00:00:01'
                workcompletedate:
                  type: string
                  example: 19.04.2026
                workcompletetime:
                  type: string
                  example: '00:00:00'
                workstartdate:
                  type: string
                  example: 18.04.2026
                workstarttime:
                  type: string
                  example: '00:00:00'
            examples:
              'Update Loading Schedule':
                value:
                  date1: 18.04.2026
                  factarrivaldate: 17.04.2026
                  factarrivaltime: '00:00:00'
                  route: 738-04-26
                  routepart: 123456
                  time1: '00:00:01'
                  workcompletedate: 19.04.2026
                  workcompletetime: '00:00:00'
                  workstartdate: 18.04.2026
                  workstarttime: '00:00:00'
      responses:
        200:
          description: ''
  /a/v2/rest/public/updateLoadingMetrics:
    post:
      tags:
        - 'Routes & tenders / Shippers / Shared Operations'
      summary: 'Update Cargo Specifications'
      description: 'Update Cargo Specifications'
      operationId: updateCargoSpecifications
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                dalvolume:
                  type: string
                  example: '2'
                height:
                  type: string
                  example: '0'
                length:
                  type: string
                  example: '0'
                palletplaces:
                  type: string
                  example: '2'
                route:
                  type: string
                  example: 790-05-26
                routepart:
                  type: number
                  example: 115697883
                unit:
                  type: number
                  example: 12881
                unitquantity:
                  type: string
                  example: '0'
                volume:
                  type: string
                  example: '2'
                weight:
                  type: string
                  example: '128.000'
                width:
                  type: string
                  example: '0'
            examples:
              'Update Cargo Specifications':
                value:
                  dalvolume: '2'
                  height: '0'
                  length: '0'
                  palletplaces: '2'
                  route: 790-05-26
                  routepart: 115697883
                  unit: 12881
                  unitquantity: '0'
                  volume: '2'
                  weight: '128.000'
                  width: '0'
      responses:
        200:
          description: ''
  /a/v2/rest/public/routeTemplates:
    get:
      tags:
        - 'Routes & tenders / Shippers / Templates'
      summary: 'Get Templates'
      description: 'Get Templates'
      operationId: getTemplates
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/createRouteTemplates:
    post:
      tags:
        - 'Routes & tenders / Shippers / Templates'
      summary: 'Сreate Template'
      description: 'Сreate Template'
      operationId: reateTemplate
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  example: 'новий темплейт опис'
                periodic:
                  type: string
                  example: -27105753600
                title:
                  type: string
                  example: 'Новий темплейт'
            examples:
              'Сreate Template':
                value:
                  description: 'новий темплейт опис'
                  periodic: -27105753600
                  title: 'Новий темплейт'
      responses:
        200:
          description: ''
  /a/v2/rest/public/updateRouteTemplates:
    post:
      tags:
        - 'Routes & tenders / Shippers / Templates'
      summary: 'Update Template'
      description: 'Update Template'
      operationId: updateTemplate
      parameters:
        -
          name: id
          in: query
          schema:
            type: string
            example: ''
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  example: 'Route template updated'
                id:
                  type: string
                  example: Z2vzqH
                periodic:
                  type: string
                  example: 49-03-26
                title:
                  type: string
                  example: 'Route template updated'
            examples:
              'Update Template':
                value:
                  description: 'Route template updated'
                  id: Z2vzqH
                  periodic: 49-03-26
                  title: 'Route template updated'
      responses:
        200:
          description: ''
  /a/v2/rest/public/deleteRouteTemplates:
    post:
      tags:
        - 'Routes & tenders / Shippers / Templates'
      summary: 'Delete Template'
      description: 'Delete Template'
      operationId: deleteTemplate
      parameters:
        -
          name: id
          in: query
          schema:
            type: string
            example: ''
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            examples:
              'Delete Template':
                value: ''
      responses:
        200:
          description: ''
  /a/v2/rest/public/getCheckpoint:
    get:
      tags:
        - 'Routes & tenders / Shippers / Stops'
      summary: 'Get Stops'
      description: |-
        Returns the list of loading, unloading or customs checkpoints of the current company, depending on the passed parameters.

        - if successful you will receive list of loading, unloading or customs checkpoints, depending on the passed parameters

        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Only for shippers. At least 1 parameter must be passed.
      operationId: getStops
      parameters:
        -
          name: byCompany
          in: query
          schema:
            type: string
            example: '{{checkpointsByCheckpointCompany}}'
          description: 'Optional int. Id of the company that owns the loading, unloading or customs checkpoints. Returns the list of checkpoints of passed company.'
        -
          name: byTown
          in: query
          schema:
            type: string
            example: '{{checkpointsByCheckpointTown}}'
          description: 'Optional int. Id of the town with loading, unloading or customs checkpoints. Returns the list of checkpoints in the passed town. '
        -
          name: customs
          in: query
          schema:
            type: string
            example: '{{checkpointsCustomsFlag}}'
          description: 'Optional bool. True: Returns the list of customs checkpoints. False (default): ignores the parameter, returns loading and unloading checkpoints.'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: 'Success (byCompany parameter passed) / Success (byTown parameter passed) / Success (customs parameter passed)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { address: { type: string, example: '1 High Street' }, id: { type: number, example: 44 }, latit: { type: string, example: '50.412020000000000' }, longit: { type: string, example: '30.572705000000000' }, town: { type: number, example: 9657 }, zip: { nullable: true, example: null } } }, example: [{ address: '1 High Street', id: 44, latit: '50.412020000000000', longit: '30.572705000000000', town: 9657, zip: null }] }
                  status: { type: string, example: success }
              examples:
                'Success (byCompany parameter passed)':
                  value: { data: [{ address: '1 High Street', id: 44, latit: '50.412020000000000', longit: '30.572705000000000', town: 9657, zip: null }], status: success }
                'Success (byTown parameter passed)':
                  value: { data: [{ address: '1 Example Street', id: 44, latit: '50.412020000000000', longit: '30.572705000000000', town: 9657, zip: null }, { address: '1B Sample Avenue', id: 792, latit: '50.417186000000000', longit: '30.636010000000000', town: 9657, zip: null }, { address: '3 Demo Road', id: 823, latit: '50.441728000000000', longit: '30.520585000000000', town: 9657, zip: null }, { address: '5 Placeholder Lane', id: 824, latit: '50.435394000000000', longit: '30.301297000000000', town: 9657, zip: null }, { address: '51 Test Street', id: 835, latit: '50.448669000000000', longit: '30.493555000000000', town: 9657, zip: null }, { address: '5 Mock Street', id: 863, latit: '50.435394000000000', longit: '30.301297000000000', town: 9657, zip: null }, { address: '15 Example Boulevard', id: 5219, latit: '50.418356700000000', longit: '30.407155100000000', town: 9657, zip: null }, { address: '62 Sample Prospect', id: 6260, latit: '50.504741000000000', longit: '30.435863800000000', town: 9657, zip: null }, { address: '154A Demo Street', id: 6365, latit: '50.447056100000000', longit: '30.444482100000000', town: 9657, zip: null }, { address: '53 Placeholder Street', id: 6366, latit: '50.420434000000000', longit: '30.444538000000000', town: 9657, zip: null }, { address: '78 Sample Prospect', id: 6374, latit: '50.506856900000000', longit: '30.424080000000000', town: 9657, zip: null }, { address: '323 Test Road', id: 6380, latit: '0.000000000000000', longit: '0.000000000000000', town: 9657, zip: null }, { address: '154A Demo Street', id: 6382, latit: '50.445036942455836', longit: '30.443912592065430', town: 9657, zip: null }, { address: 'Sechenova Street (no house number)', id: 6385, latit: '50.391261729917495', longit: '30.491989052392570', town: 9657, zip: null }, { address: '15 Example Way', id: 6387, latit: '50.459357318950445', longit: '30.491656041139210', town: 9657, zip: null }, { address: '1 Sample Drive', id: 6427, latit: '50.510001499999990', longit: '30.482296899999938', town: 9657, zip: null }, { address: '96 Demo Avenue, Apt 32', id: 6458, latit: '0.000000000000000', longit: '0.000000000000000', town: 9657, zip: null }, { address: '5 Placeholder Street', id: 6547, latit: '50.392027500000000', longit: '30.474394100000040', town: 9657, zip: null }, { address: '56 Test Avenue', id: 6569, latit: '50.446604400000000', longit: '30.496839200000068', town: 9657, zip: null }, { address: '13 Sample Street', id: 6595, latit: '50.401897299999990', longit: '30.377944299999967', town: 9657, zip: null }, { address: '22 Mock Lane', id: 6596, latit: '50.450100000000000', longit: '30.523400000000038', town: 9657, zip: null }, { address: 'Unnamed Alley (no number)', id: 6597, latit: '50.524092200000000', longit: '30.242687199999978', town: 9657, zip: null }], status: success }
                'Success (customs parameter passed)':
                  value: { data: [{ address: '15 Example Customs Street', id: 2188, latit: '50.254680000000000', longit: '28.658755000000000', town: 5712, zip: null }, { address: '45 Sample Industrial Road', id: 2190, latit: '50.835077000000000', longit: '12.914818000000000', town: 224189, zip: 2421 }, { address: '2 Demo Street', id: 2628, latit: '50.928870900000010', longit: '25.246889000000000', town: 1929, zip: null }, { address: '62 Sample Avenue', id: 6260, latit: '50.504741000000000', longit: '30.435863800000000', town: 9657, zip: null }, { address: '10 Placeholder Boulevard', id: 6405, latit: '45.337569700000000', longit: '28.834245800000000', town: 16577, zip: null }, { address: '5 Test Landing Street', id: 6473, latit: '45.025077100000000', longit: '35.386058000000000', town: 2874, zip: null }, { address: '3 Example Avenue', id: 6474, latit: '50.699461900000000', longit: '5.616116899999952', town: 297289, zip: null }, { address: '15 Mock Street', id: 6496, latit: '48.125244000000000', longit: '37.853301999999985', town: 5243, zip: null }, { address: '5 Sample Central Street', id: 6542, latit: '0.000000000000000', longit: '0.000000000000000', town: 2138335, zip: null }, { address: '5 Demo Road', id: 6543, latit: '47.843611000000000', longit: '28.405277999999953', town: 2225782, zip: null }, { address: '1 Example Harbor Street', id: 16177, latit: '46.436114957539720', longit: '30.710214387499980', town: 2402040, zip: 123602 }, { address: '1 Example Harbor Street', id: 16178, latit: '45.458357700000000', longit: '28.293222200000000', town: 2402040, zip: 123602 }, { address: '63 Unity Street', id: 16501, latit: '48.930697000000000', longit: '24.733548000000000', town: 2402054, zip: null }, { address: '63 Unity Street', id: 16502, latit: '48.930697000000000', longit: '24.733548000000000', town: 2402054, zip: null }, { address: '63 Unity Street', id: 16504, latit: '48.930697000000000', longit: '24.733548000000000', town: 2402054, zip: null }, { address: '63 Unity Street', id: 16505, latit: '48.930697000000000', longit: '24.733548000000000', town: 2402054, zip: null }, { address: '63 Unity Street', id: 16506, latit: '48.930697000000000', longit: '24.733548000000000', town: 2402054, zip: null }, { address: '63 Unity Street', id: 16507, latit: '48.930697000000000', longit: '24.733548000000000', town: 2402054, zip: null }, { address: '63 Unity Street', id: 16509, latit: '48.930697000000000', longit: '24.733548000000000', town: 2402054, zip: null }], status: success }
        400:
          description: 'No parameters passed'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Missing parameters' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'No parameters passed':
                  value: { message: 'Missing parameters', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getCountry:
    get:
      tags:
        - 'Routes & tenders / Shippers / Stops'
      summary: 'Get Stop Countries'
      description: |-
        Returns the list of countries, depending on the passed parameters.

        - if successful you will receive list of countries, depending of the list parameters
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Only for shippers
      operationId: getStopCountries
      parameters:
        -
          name: byCheckpoint
          in: query
          schema:
            type: string
            example: '{{countriesByCheckpoint}}'
          description: 'Optional bool. False (default): returns the list of all countries. True: returns the list of countries in which loading/unloading checkpoints of current user company are present'
        -
          name: byCompany
          in: query
          schema:
            type: string
            example: '{{countriesByCheckpointCompany}}'
          description: 'Optional int. Id of the company that owns the loading/unloading checkpoint . Returns the list of counties in which loading/unloading checkpoints of passed company are present. `byCheckpoint` parameter must be on'
        -
          name: byTown
          in: query
          schema:
            type: string
            example: '{{countriesByCheckpointTown}}'
          description: 'Optional int. Id of the town with loading/unloading checkpoints. Returns the list of countries in which there are loading/unloading checkpoints in the passed town. `byCheckpoint` parameter must be on'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: []
      responses:
        200:
          description: 'Success (No parameters passed) / Success (byCheckpoint passed) / Success (byTown passed) / Success (byCompany passed) / Success with all parameters passed'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { id: { type: number, example: 1 }, isoNum: { type: number, example: 36 }, title: { type: string, example: Австралия }, titleLatin: { type: string, example: Australia } } }, example: [{ id: 1, isoNum: 36, title: Австралия, titleLatin: Australia }, { id: 2, isoNum: 40, title: Австрия, titleLatin: Austria }, { id: 3, isoNum: 31, title: Азербайджан, titleLatin: Azerbaijan }, { id: 4, isoNum: 8, title: Албания, titleLatin: Albania }, { id: 5, isoNum: 12, title: Алжир, titleLatin: Algeria }, { id: 6, isoNum: 16, title: 'Американское Самоа', titleLatin: 'American Samoa' }, { id: 7, isoNum: 660, title: Ангилья, titleLatin: Anguilla }, { id: 8, isoNum: 24, title: Ангола, titleLatin: Angola }, { id: 9, isoNum: 20, title: Андорра, titleLatin: Andorra }, { id: 10, isoNum: 10, title: Антарктида, titleLatin: Antarctica }, { id: 11, isoNum: 28, title: 'Антигуа и Барбуда', titleLatin: 'Antigua and Barbuda' }, { id: 12, isoNum: 32, title: Аргентина, titleLatin: Argentina }, { id: 13, isoNum: 51, title: Армения, titleLatin: Armenia }, { id: 14, isoNum: 533, title: Аруба, titleLatin: Aruba }, { id: 15, isoNum: 4, title: Афганистан, titleLatin: Afghanistan }, { id: 16, isoNum: 44, title: Багамы, titleLatin: 'Bahamas, The' }, { id: 17, isoNum: 50, title: Бангладеш, titleLatin: Bangladesh }, { id: 18, isoNum: 52, title: Барбадос, titleLatin: Barbados }, { id: 19, isoNum: 48, title: Бахрейн, titleLatin: Bahrain }, { id: 20, isoNum: 112, title: Беларусь, titleLatin: Belarus }, { id: 21, isoNum: 84, title: Белиз, titleLatin: Belize }, { id: 22, isoNum: 56, title: Бельгия, titleLatin: Belgium }, { id: 23, isoNum: 204, title: Бенин, titleLatin: Benin }, { id: 24, isoNum: 60, title: Бермуды, titleLatin: Bermuda }, { id: 25, isoNum: 100, title: Болгария, titleLatin: Bulgaria }, { id: 26, isoNum: 68, title: Боливия, titleLatin: Bolivia }, { id: 27, isoNum: 70, title: 'Босния и Герцеговина', titleLatin: 'Bosnia and Herzegovina' }, { id: 28, isoNum: 72, title: Ботсвана, titleLatin: Botswana }, { id: 29, isoNum: 76, title: Бразилия, titleLatin: Brazil }, { id: 30, isoNum: 86, title: 'Британская территория в Индийском океане', titleLatin: 'British Indian Ocean Territory' }, { id: 31, isoNum: 96, title: Бруней-Даруссалам, titleLatin: Brunei }, { id: 32, isoNum: 854, title: Буркина-Фасо, titleLatin: 'Burkina Faso' }, { id: 33, isoNum: 108, title: Бурунди, titleLatin: Burundi }, { id: 34, isoNum: 64, title: Бутан, titleLatin: Bhutan }, { id: 35, isoNum: 548, title: Вануату, titleLatin: Vanuatu }, { id: 36, isoNum: 348, title: Венгрия, titleLatin: Hungary }, { id: 37, isoNum: 862, title: Венесуэла, titleLatin: Venezuela }, { id: 38, isoNum: 92, title: 'Виргинские острова, Британские', titleLatin: 'British Virgin Islands' }, { id: 39, isoNum: 850, title: 'Виргинские острова, США', titleLatin: 'Virgin Islands' }, { id: 40, isoNum: 704, title: Вьетнам, titleLatin: Vietnam }, { id: 41, isoNum: 266, title: Габон, titleLatin: Gabon }, { id: 42, isoNum: 332, title: Гаити, titleLatin: Haiti }, { id: 43, isoNum: 328, title: Гайана, titleLatin: Guyana }, { id: 44, isoNum: 270, title: Гамбия, titleLatin: 'Gambia, The' }, { id: 45, isoNum: 288, title: Гана, titleLatin: Ghana }, { id: 46, isoNum: 312, title: Гваделупа, titleLatin: Guadeloupe }, { id: 47, isoNum: 320, title: Гватемала, titleLatin: Guatemala }, { id: 48, isoNum: 324, title: Гвинея, titleLatin: Guinea }, { id: 49, isoNum: 624, title: Гвинея-Бисау, titleLatin: Guinea-Bissau }, { id: 50, isoNum: 276, title: Германия, titleLatin: Germany }, { id: 51, isoNum: 831, title: Гернси, titleLatin: Guernsey }, { id: 52, isoNum: 292, title: Гибралтар, titleLatin: Gibraltar }, { id: 53, isoNum: 340, title: Гондурас, titleLatin: Honduras }, { id: 54, isoNum: 344, title: Гонконг, titleLatin: 'Hong Kong' }, { id: 55, isoNum: 308, title: Гренада, titleLatin: Grenada }, { id: 56, isoNum: 304, title: Гренландия, titleLatin: Greenland }, { id: 57, isoNum: 300, title: Греция, titleLatin: Greece }, { id: 58, isoNum: 268, title: Грузия, titleLatin: Georgia }, { id: 59, isoNum: 316, title: Гуам, titleLatin: Guam }, { id: 60, isoNum: 208, title: Дания, titleLatin: Denmark }, { id: 61, isoNum: 832, title: Джерси, titleLatin: Jersey }, { id: 62, isoNum: 262, title: Джибути, titleLatin: Djibouti }, { id: 63, isoNum: 212, title: Доминика, titleLatin: Dominica }, { id: 64, isoNum: 214, title: 'Доминиканская Республика', titleLatin: 'Dominican Republic' }, { id: 65, isoNum: 818, title: Египет, titleLatin: Egypt }, { id: 66, isoNum: 894, title: Замбия, titleLatin: Zambia }, { id: 67, isoNum: 732, title: 'Западная Сахара', titleLatin: 'Western Sahara' }, { id: 68, isoNum: 716, title: Зимбабве, titleLatin: Zimbabwe }, { id: 69, isoNum: 376, title: Израиль, titleLatin: Israel }, { id: 70, isoNum: 356, title: Индия, titleLatin: India }, { id: 71, isoNum: 360, title: Индонезия, titleLatin: Indonesia }, { id: 72, isoNum: 400, title: Иордания, titleLatin: Jordan }, { id: 73, isoNum: 368, title: Ирак, titleLatin: Iraq }, { id: 74, isoNum: 364, title: 'Иран, Исламская Республика', titleLatin: Iran }, { id: 75, isoNum: 372, title: Ирландия, titleLatin: Ireland }, { id: 76, isoNum: 352, title: Исландия, titleLatin: Iceland }, { id: 77, isoNum: 724, title: Испания, titleLatin: Spain }, { id: 78, isoNum: 380, title: Италия, titleLatin: Italy }, { id: 79, isoNum: 887, title: Йемен, titleLatin: Yemen }, { id: 80, isoNum: 132, title: Кабо-Верде, titleLatin: 'Cape Verde' }, { id: 81, isoNum: 398, title: Казахстан, titleLatin: Kazakhstan }, { id: 82, isoNum: 116, title: Камбоджа, titleLatin: Cambodia }, { id: 83, isoNum: 120, title: Камерун, titleLatin: Cameroon }, { id: 84, isoNum: 124, title: Канада, titleLatin: Canada }, { id: 85, isoNum: 634, title: Катар, titleLatin: Qatar }, { id: 86, isoNum: 404, title: Кения, titleLatin: Kenya }, { id: 87, isoNum: 196, title: Кипр, titleLatin: Cyprus }, { id: 88, isoNum: 417, title: Киргизия, titleLatin: Kyrgyzstan }, { id: 89, isoNum: 296, title: Кирибати, titleLatin: Kiribati }, { id: 90, isoNum: 156, title: Китай, titleLatin: China }, { id: 91, isoNum: 166, title: 'Кокосовые (Килинг) острова', titleLatin: 'Cocos (Keeling) Islands' }, { id: 92, isoNum: 170, title: Колумбия, titleLatin: Colombia }, { id: 93, isoNum: 174, title: Коморы, titleLatin: Comoros }, { id: 94, isoNum: 178, title: Конго, titleLatin: 'Congo, Republic of the' }, { id: 95, isoNum: 180, title: 'Конго, Демократическая Республика', titleLatin: 'Congo, Democratic Republic of the' }, { id: 96, isoNum: 688, title: Косово, titleLatin: Kosovo }, { id: 97, isoNum: 188, title: Коста-Рика, titleLatin: 'Costa Rica' }, { id: 98, isoNum: 384, title: "Кот д'Ивуар", titleLatin: "Cote d'Ivoire" }, { id: 99, isoNum: 192, title: Куба, titleLatin: Cuba }, { id: 100, isoNum: 414, title: Кувейт, titleLatin: Kuwait }, { id: 101, isoNum: 418, title: Лаос, titleLatin: Laos }, { id: 102, isoNum: 428, title: Латвия, titleLatin: Latvia }, { id: 103, isoNum: 426, title: Лесото, titleLatin: Lesotho }, { id: 104, isoNum: 422, title: Ливан, titleLatin: Lebanon }, { id: 105, isoNum: 434, title: 'Ливийская Арабская Джамахирия', titleLatin: Libya }, { id: 106, isoNum: 430, title: Либерия, titleLatin: Liberia }, { id: 107, isoNum: 438, title: Лихтенштейн, titleLatin: Liechtenstein }, { id: 108, isoNum: 440, title: Литва, titleLatin: Lithuania }, { id: 109, isoNum: 442, title: Люксембург, titleLatin: Luxembourg }, { id: 110, isoNum: 480, title: Маврикий, titleLatin: Mauritius }, { id: 111, isoNum: 478, title: Мавритания, titleLatin: Mauritania }, { id: 112, isoNum: 450, title: Мадагаскар, titleLatin: Madagascar }, { id: 113, isoNum: 175, title: Майотта, titleLatin: Mayotte }, { id: 114, isoNum: 446, title: Макао, titleLatin: Macau }, { id: 115, isoNum: 454, title: Малави, titleLatin: Malawi }, { id: 116, isoNum: 458, title: Малайзия, titleLatin: Malaysia }, { id: 117, isoNum: 466, title: Мали, titleLatin: Mali }, { id: 118, isoNum: 581, title: 'Малые Тихоокеанские отдаленные острова Соединенных', titleLatin: 'United States Pacific Island Wildlife Refuges' }, { id: 119, isoNum: 462, title: Мальдивы, titleLatin: Maldives }, { id: 120, isoNum: 470, title: Мальта, titleLatin: Malta }, { id: 121, isoNum: 504, title: Марокко, titleLatin: Morocco }, { id: 122, isoNum: 474, title: Мартиника, titleLatin: Martinique }, { id: 123, isoNum: 584, title: 'Маршалловы острова', titleLatin: 'Marshall Islands' }, { id: 124, isoNum: 484, title: Мексика, titleLatin: Mexico }, { id: 125, isoNum: 583, title: 'Микронезия, Федеративные Штаты', titleLatin: 'Micronesia, Federated States of' }, { id: 126, isoNum: 508, title: Мозамбик, titleLatin: Mozambique }, { id: 127, isoNum: 498, title: 'Молдова, Республика', titleLatin: Moldova }, { id: 128, isoNum: 492, title: Монако, titleLatin: Monaco }, { id: 129, isoNum: 496, title: Монголия, titleLatin: Mongolia }, { id: 130, isoNum: 500, title: Монтсеррат, titleLatin: Montserrat }, { id: 131, isoNum: 104, title: Мьянма, titleLatin: Burma }, { id: 132, isoNum: 516, title: Намибия, titleLatin: Namibia }, { id: 133, isoNum: 520, title: Науру, titleLatin: Nauru }, { id: 134, isoNum: 524, title: Непал, titleLatin: Nepal }, { id: 135, isoNum: 562, title: Нигер, titleLatin: Niger }, { id: 136, isoNum: 566, title: Нигерия, titleLatin: Nigeria }, { id: 137, isoNum: 530, title: 'Нидерландские Антилы', titleLatin: 'Netherlands Antilles' }, { id: 138, isoNum: 528, title: Нидерланды, titleLatin: Netherlands }, { id: 139, isoNum: 558, title: Никарагуа, titleLatin: Nicaragua }, { id: 140, isoNum: 570, title: Ниуэ, titleLatin: Niue }, { id: 141, isoNum: 554, title: 'Новая Зеландия', titleLatin: 'New Zealand' }, { id: 142, isoNum: 540, title: 'Новая Каледония', titleLatin: 'New Caledonia' }, { id: 143, isoNum: 578, title: Норвегия, titleLatin: Norway }, { id: 144, isoNum: 784, title: 'Объединенные Арабские Эмираты', titleLatin: 'United Arab Emirates' }, { id: 145, isoNum: 512, title: Оман, titleLatin: Oman }, { id: 146, isoNum: 74, title: 'Остров Буве', titleLatin: 'Bouvet Island' }, { id: 147, isoNum: 0, title: 'Остров Клиппертон', titleLatin: 'Clipperton Island' }, { id: 148, isoNum: 833, title: 'Остров Мэн', titleLatin: 'Isle of Man' }, { id: 149, isoNum: 574, title: 'Остров Норфолк', titleLatin: 'Norfolk Island' }, { id: 150, isoNum: 162, title: 'Остров Рождества', titleLatin: 'Christmas Island' }, { id: 151, isoNum: 663, title: 'Остров Святого Мартина', titleLatin: 'Saint Martin' }, { id: 152, isoNum: 334, title: 'Остров Херд и острова Макдональд', titleLatin: 'Heard Island and McDonald Islands' }, { id: 153, isoNum: 136, title: 'Острова Кайман', titleLatin: 'Cayman Islands' }, { id: 154, isoNum: 184, title: 'Острова Кука', titleLatin: 'Cook Islands' }, { id: 155, isoNum: 796, title: 'Острова Теркс и Кайкос', titleLatin: 'Turks and Caicos Islands' }, { id: 156, isoNum: 586, title: Пакистан, titleLatin: Pakistan }, { id: 157, isoNum: 585, title: Палау, titleLatin: Palau }, { id: 158, isoNum: 275, title: 'Палестинская территория, оккупированная', titleLatin: 'Palestinian Territory, Occupied' }, { id: 159, isoNum: 591, title: Панама, titleLatin: Panama }, { id: 160, isoNum: 336, title: 'Папский Престол (Государство — город Ватикан)', titleLatin: 'Holy See (Vatican City)' }, { id: 161, isoNum: 598, title: 'Папуа-Новая Гвинея', titleLatin: 'Papua New Guinea' }, { id: 162, isoNum: 600, title: Парагвай, titleLatin: Paraguay }, { id: 163, isoNum: 604, title: Перу, titleLatin: Peru }, { id: 164, isoNum: 612, title: Питкерн, titleLatin: Pitcairn }, { id: 165, isoNum: 616, title: Польша, titleLatin: Poland }, { id: 166, isoNum: 620, title: Португалия, titleLatin: Portugal }, { id: 167, isoNum: 630, title: Пуэрто-Рико, titleLatin: 'Puerto Rico' }, { id: 168, isoNum: 807, title: 'Республика Македония', titleLatin: Macedonia }, { id: 169, isoNum: 638, title: Реюньон, titleLatin: Reunion }, { id: 170, isoNum: 643, title: Россия, titleLatin: Russia }, { id: 171, isoNum: 646, title: Руанда, titleLatin: Rwanda }, { id: 172, isoNum: 642, title: Румыния, titleLatin: Romania }, { id: 173, isoNum: 882, title: Самоа, titleLatin: Samoa }, { id: 174, isoNum: 674, title: Сан-Марино, titleLatin: 'San Marino' }, { id: 175, isoNum: 678, title: 'Сан-Томе и Принсипи', titleLatin: 'Sao Tome and Principe' }, { id: 176, isoNum: 682, title: 'Саудовская Аравия', titleLatin: 'Saudi Arabia' }, { id: 177, isoNum: 748, title: Свазиленд, titleLatin: Swaziland }, { id: 178, isoNum: 654, title: 'Святая Елена', titleLatin: 'Saint Helena' }, { id: 179, isoNum: 408, title: 'Северная Корея', titleLatin: 'Korea, North' }, { id: 180, isoNum: 580, title: 'Северные Марианские острова', titleLatin: 'Northern Mariana Islands' }, { id: 181, isoNum: 652, title: Сен-Бартельми, titleLatin: 'Saint Barthélemy' }, { id: 182, isoNum: 666, title: 'Сен-Пьер и Микелон', titleLatin: 'Saint Pierre and Miquelon' }, { id: 183, isoNum: 686, title: Сенегал, titleLatin: Senegal }, { id: 184, isoNum: 670, title: 'Сент-Винсент и Гренадины', titleLatin: 'Saint Vincent and the Grenadines' }, { id: 185, isoNum: 662, title: Сент-Люсия, titleLatin: 'Saint Lucia' }, { id: 186, isoNum: 659, title: 'Сент-Китс и Невис', titleLatin: 'Saint Kitts and Nevis' }, { id: 187, isoNum: 688, title: Сербия, titleLatin: Serbia }, { id: 188, isoNum: 690, title: Сейшелы, titleLatin: Seychelles }, { id: 189, isoNum: 702, title: Сингапур, titleLatin: Singapore }, { id: 190, isoNum: 760, title: 'Сирийская Арабская Республика', titleLatin: Syria }, { id: 191, isoNum: 703, title: Словакия, titleLatin: Slovakia }, { id: 192, isoNum: 705, title: Словения, titleLatin: Slovenia }, { id: 193, isoNum: 826, title: Великобритания, titleLatin: 'United Kingdom' }, { id: 194, isoNum: 840, title: 'Соединенные Штаты', titleLatin: 'United States' }, { id: 195, isoNum: 90, title: 'Соломоновы острова', titleLatin: 'Solomon Islands' }, { id: 196, isoNum: 706, title: Сомали, titleLatin: Somalia }, { id: 197, isoNum: 736, title: Судан, titleLatin: Sudan }, { id: 198, isoNum: 740, title: Суринам, titleLatin: Suriname }, { id: 199, isoNum: 694, title: Сьерра-Леоне, titleLatin: 'Sierra Leone' }, { id: 200, isoNum: 762, title: Таджикистан, titleLatin: Tajikistan }, { id: 201, isoNum: 764, title: Таиланд, titleLatin: Thailand }, { id: 202, isoNum: 834, title: 'Танзания, Объединенная Республика', titleLatin: Tanzania }, { id: 203, isoNum: 158, title: 'Тайвань (Китай)', titleLatin: Taiwan }, { id: 204, isoNum: 626, title: Тимор-Лесте, titleLatin: Timor-Leste }, { id: 205, isoNum: 768, title: Того, titleLatin: Togo }, { id: 206, isoNum: 772, title: Токелау, titleLatin: Tokelau }, { id: 207, isoNum: 776, title: Тонга, titleLatin: Tonga }, { id: 208, isoNum: 780, title: 'Тринидад и Тобаго', titleLatin: 'Trinidad and Tobago' }, { id: 209, isoNum: 798, title: Тувалу, titleLatin: Tuvalu }, { id: 210, isoNum: 788, title: Тунис, titleLatin: Tunisia }, { id: 211, isoNum: 795, title: Туркмения, titleLatin: Turkmenistan }, { id: 212, isoNum: 792, title: Турция, titleLatin: Turkey }, { id: 213, isoNum: 800, title: Уганда, titleLatin: Uganda }, { id: 214, isoNum: 860, title: Узбекистан, titleLatin: Uzbekistan }, { id: 215, isoNum: 804, title: Украина, titleLatin: Ukraine }, { id: 216, isoNum: 876, title: 'Уоллис и Футуна', titleLatin: 'Wallis and Futuna' }, { id: 217, isoNum: 858, title: Уругвай, titleLatin: Uruguay }, { id: 218, isoNum: 234, title: 'Фарерские острова', titleLatin: 'Faroe Islands' }, { id: 219, isoNum: 242, title: Фиджи, titleLatin: Fiji }, { id: 220, isoNum: 608, title: Филиппины, titleLatin: Philippines }, { id: 221, isoNum: 246, title: Финляндия, titleLatin: Finland }, { id: 222, isoNum: 238, title: 'Фолклендские острова (Мальвинские)', titleLatin: 'Falkland Islands (Islas Malvinas)' }, { id: 223, isoNum: 250, title: Франция, titleLatin: France }, { id: 224, isoNum: 254, title: 'Французская Гвиана', titleLatin: 'French Guiana' }, { id: 225, isoNum: 258, title: 'Французская Полинезия', titleLatin: 'French Polynesia' }, { id: 226, isoNum: 260, title: 'Французские Южные территории', titleLatin: 'French Southern Lands' }, { id: 227, isoNum: 191, title: Хорватия, titleLatin: Croatia }, { id: 228, isoNum: 140, title: 'Центрально-Африканская Республика', titleLatin: 'Central African Republic' }, { id: 229, isoNum: 148, title: Чад, titleLatin: Chad }, { id: 230, isoNum: 499, title: Черногория, titleLatin: Montenegro }, { id: 231, isoNum: 203, title: 'Чешская Республика', titleLatin: 'Czech Republic' }, { id: 232, isoNum: 152, title: Чили, titleLatin: Chile }, { id: 233, isoNum: 756, title: Швейцария, titleLatin: Switzerland }, { id: 234, isoNum: 752, title: Швеция, titleLatin: Sweden }, { id: 235, isoNum: 744, title: 'Шпицберген и Ян Майен', titleLatin: 'Svalbard and Jan Mayen' }, { id: 236, isoNum: 144, title: Шри-Ланка, titleLatin: 'Sri Lanka' }, { id: 237, isoNum: 218, title: Эквадор, titleLatin: Ecuador }, { id: 238, isoNum: 226, title: 'Экваториальная Гвинея', titleLatin: 'Equatorial Guinea' }, { id: 239, isoNum: 248, title: 'Эландские острова', titleLatin: 'Åland Islands' }, { id: 240, isoNum: 222, title: Эль-Сальвадор, titleLatin: 'El Salvador' }, { id: 241, isoNum: 232, title: Эритрея, titleLatin: Eritrea }, { id: 242, isoNum: 233, title: Эстония, titleLatin: Estonia }, { id: 243, isoNum: 231, title: Эфиопия, titleLatin: Ethiopia }, { id: 244, isoNum: 710, title: 'Южная Африка', titleLatin: 'South Africa' }, { id: 245, isoNum: 239, title: 'Южная Джорджия и Южные Сандвичевы острова', titleLatin: 'South Georgia and the South Sandwich Islands' }, { id: 246, isoNum: 410, title: 'Южная Корея', titleLatin: 'Korea, South' }, { id: 247, isoNum: 388, title: Ямайка, titleLatin: Jamaica }, { id: 248, isoNum: 392, title: Япония, titleLatin: Japan }, { id: 249, isoNum: 203, title: '', titleLatin: 'Czech Republic' }, { id: 250, isoNum: 498, title: Україна, titleLatin: 'Republic of Moldova' }, { id: 251, isoNum: 807, title: Україна, titleLatin: 'North Macedonia' }, { id: 252, isoNum: 0, title: Україна, titleLatin: '' }, { id: 253, isoNum: 0, title: Україна, titleLatin: '' }, { id: 254, isoNum: 0, title: Україна, titleLatin: '' }, { id: 255, isoNum: 0, title: Іспанія, titleLatin: '' }] }
                  status: { type: string, example: success }
              examples:
                'Success (No parameters passed)':
                  value: { data: [{ id: 1, isoNum: 36, title: Австралия, titleLatin: Australia }, { id: 2, isoNum: 40, title: Австрия, titleLatin: Austria }, { id: 3, isoNum: 31, title: Азербайджан, titleLatin: Azerbaijan }, { id: 4, isoNum: 8, title: Албания, titleLatin: Albania }, { id: 5, isoNum: 12, title: Алжир, titleLatin: Algeria }, { id: 6, isoNum: 16, title: 'Американское Самоа', titleLatin: 'American Samoa' }, { id: 7, isoNum: 660, title: Ангилья, titleLatin: Anguilla }, { id: 8, isoNum: 24, title: Ангола, titleLatin: Angola }, { id: 9, isoNum: 20, title: Андорра, titleLatin: Andorra }, { id: 10, isoNum: 10, title: Антарктида, titleLatin: Antarctica }, { id: 11, isoNum: 28, title: 'Антигуа и Барбуда', titleLatin: 'Antigua and Barbuda' }, { id: 12, isoNum: 32, title: Аргентина, titleLatin: Argentina }, { id: 13, isoNum: 51, title: Армения, titleLatin: Armenia }, { id: 14, isoNum: 533, title: Аруба, titleLatin: Aruba }, { id: 15, isoNum: 4, title: Афганистан, titleLatin: Afghanistan }, { id: 16, isoNum: 44, title: Багамы, titleLatin: 'Bahamas, The' }, { id: 17, isoNum: 50, title: Бангладеш, titleLatin: Bangladesh }, { id: 18, isoNum: 52, title: Барбадос, titleLatin: Barbados }, { id: 19, isoNum: 48, title: Бахрейн, titleLatin: Bahrain }, { id: 20, isoNum: 112, title: Беларусь, titleLatin: Belarus }, { id: 21, isoNum: 84, title: Белиз, titleLatin: Belize }, { id: 22, isoNum: 56, title: Бельгия, titleLatin: Belgium }, { id: 23, isoNum: 204, title: Бенин, titleLatin: Benin }, { id: 24, isoNum: 60, title: Бермуды, titleLatin: Bermuda }, { id: 25, isoNum: 100, title: Болгария, titleLatin: Bulgaria }, { id: 26, isoNum: 68, title: Боливия, titleLatin: Bolivia }, { id: 27, isoNum: 70, title: 'Босния и Герцеговина', titleLatin: 'Bosnia and Herzegovina' }, { id: 28, isoNum: 72, title: Ботсвана, titleLatin: Botswana }, { id: 29, isoNum: 76, title: Бразилия, titleLatin: Brazil }, { id: 30, isoNum: 86, title: 'Британская территория в Индийском океане', titleLatin: 'British Indian Ocean Territory' }, { id: 31, isoNum: 96, title: Бруней-Даруссалам, titleLatin: Brunei }, { id: 32, isoNum: 854, title: Буркина-Фасо, titleLatin: 'Burkina Faso' }, { id: 33, isoNum: 108, title: Бурунди, titleLatin: Burundi }, { id: 34, isoNum: 64, title: Бутан, titleLatin: Bhutan }, { id: 35, isoNum: 548, title: Вануату, titleLatin: Vanuatu }, { id: 36, isoNum: 348, title: Венгрия, titleLatin: Hungary }, { id: 37, isoNum: 862, title: Венесуэла, titleLatin: Venezuela }, { id: 38, isoNum: 92, title: 'Виргинские острова, Британские', titleLatin: 'British Virgin Islands' }, { id: 39, isoNum: 850, title: 'Виргинские острова, США', titleLatin: 'Virgin Islands' }, { id: 40, isoNum: 704, title: Вьетнам, titleLatin: Vietnam }, { id: 41, isoNum: 266, title: Габон, titleLatin: Gabon }, { id: 42, isoNum: 332, title: Гаити, titleLatin: Haiti }, { id: 43, isoNum: 328, title: Гайана, titleLatin: Guyana }, { id: 44, isoNum: 270, title: Гамбия, titleLatin: 'Gambia, The' }, { id: 45, isoNum: 288, title: Гана, titleLatin: Ghana }, { id: 46, isoNum: 312, title: Гваделупа, titleLatin: Guadeloupe }, { id: 47, isoNum: 320, title: Гватемала, titleLatin: Guatemala }, { id: 48, isoNum: 324, title: Гвинея, titleLatin: Guinea }, { id: 49, isoNum: 624, title: Гвинея-Бисау, titleLatin: Guinea-Bissau }, { id: 50, isoNum: 276, title: Германия, titleLatin: Germany }, { id: 51, isoNum: 831, title: Гернси, titleLatin: Guernsey }, { id: 52, isoNum: 292, title: Гибралтар, titleLatin: Gibraltar }, { id: 53, isoNum: 340, title: Гондурас, titleLatin: Honduras }, { id: 54, isoNum: 344, title: Гонконг, titleLatin: 'Hong Kong' }, { id: 55, isoNum: 308, title: Гренада, titleLatin: Grenada }, { id: 56, isoNum: 304, title: Гренландия, titleLatin: Greenland }, { id: 57, isoNum: 300, title: Греция, titleLatin: Greece }, { id: 58, isoNum: 268, title: Грузия, titleLatin: Georgia }, { id: 59, isoNum: 316, title: Гуам, titleLatin: Guam }, { id: 60, isoNum: 208, title: Дания, titleLatin: Denmark }, { id: 61, isoNum: 832, title: Джерси, titleLatin: Jersey }, { id: 62, isoNum: 262, title: Джибути, titleLatin: Djibouti }, { id: 63, isoNum: 212, title: Доминика, titleLatin: Dominica }, { id: 64, isoNum: 214, title: 'Доминиканская Республика', titleLatin: 'Dominican Republic' }, { id: 65, isoNum: 818, title: Египет, titleLatin: Egypt }, { id: 66, isoNum: 894, title: Замбия, titleLatin: Zambia }, { id: 67, isoNum: 732, title: 'Западная Сахара', titleLatin: 'Western Sahara' }, { id: 68, isoNum: 716, title: Зимбабве, titleLatin: Zimbabwe }, { id: 69, isoNum: 376, title: Израиль, titleLatin: Israel }, { id: 70, isoNum: 356, title: Индия, titleLatin: India }, { id: 71, isoNum: 360, title: Индонезия, titleLatin: Indonesia }, { id: 72, isoNum: 400, title: Иордания, titleLatin: Jordan }, { id: 73, isoNum: 368, title: Ирак, titleLatin: Iraq }, { id: 74, isoNum: 364, title: 'Иран, Исламская Республика', titleLatin: Iran }, { id: 75, isoNum: 372, title: Ирландия, titleLatin: Ireland }, { id: 76, isoNum: 352, title: Исландия, titleLatin: Iceland }, { id: 77, isoNum: 724, title: Испания, titleLatin: Spain }, { id: 78, isoNum: 380, title: Италия, titleLatin: Italy }, { id: 79, isoNum: 887, title: Йемен, titleLatin: Yemen }, { id: 80, isoNum: 132, title: Кабо-Верде, titleLatin: 'Cape Verde' }, { id: 81, isoNum: 398, title: Казахстан, titleLatin: Kazakhstan }, { id: 82, isoNum: 116, title: Камбоджа, titleLatin: Cambodia }, { id: 83, isoNum: 120, title: Камерун, titleLatin: Cameroon }, { id: 84, isoNum: 124, title: Канада, titleLatin: Canada }, { id: 85, isoNum: 634, title: Катар, titleLatin: Qatar }, { id: 86, isoNum: 404, title: Кения, titleLatin: Kenya }, { id: 87, isoNum: 196, title: Кипр, titleLatin: Cyprus }, { id: 88, isoNum: 417, title: Киргизия, titleLatin: Kyrgyzstan }, { id: 89, isoNum: 296, title: Кирибати, titleLatin: Kiribati }, { id: 90, isoNum: 156, title: Китай, titleLatin: China }, { id: 91, isoNum: 166, title: 'Кокосовые (Килинг) острова', titleLatin: 'Cocos (Keeling) Islands' }, { id: 92, isoNum: 170, title: Колумбия, titleLatin: Colombia }, { id: 93, isoNum: 174, title: Коморы, titleLatin: Comoros }, { id: 94, isoNum: 178, title: Конго, titleLatin: 'Congo, Republic of the' }, { id: 95, isoNum: 180, title: 'Конго, Демократическая Республика', titleLatin: 'Congo, Democratic Republic of the' }, { id: 96, isoNum: 688, title: Косово, titleLatin: Kosovo }, { id: 97, isoNum: 188, title: Коста-Рика, titleLatin: 'Costa Rica' }, { id: 98, isoNum: 384, title: "Кот д'Ивуар", titleLatin: "Cote d'Ivoire" }, { id: 99, isoNum: 192, title: Куба, titleLatin: Cuba }, { id: 100, isoNum: 414, title: Кувейт, titleLatin: Kuwait }, { id: 101, isoNum: 418, title: Лаос, titleLatin: Laos }, { id: 102, isoNum: 428, title: Латвия, titleLatin: Latvia }, { id: 103, isoNum: 426, title: Лесото, titleLatin: Lesotho }, { id: 104, isoNum: 422, title: Ливан, titleLatin: Lebanon }, { id: 105, isoNum: 434, title: 'Ливийская Арабская Джамахирия', titleLatin: Libya }, { id: 106, isoNum: 430, title: Либерия, titleLatin: Liberia }, { id: 107, isoNum: 438, title: Лихтенштейн, titleLatin: Liechtenstein }, { id: 108, isoNum: 440, title: Литва, titleLatin: Lithuania }, { id: 109, isoNum: 442, title: Люксембург, titleLatin: Luxembourg }, { id: 110, isoNum: 480, title: Маврикий, titleLatin: Mauritius }, { id: 111, isoNum: 478, title: Мавритания, titleLatin: Mauritania }, { id: 112, isoNum: 450, title: Мадагаскар, titleLatin: Madagascar }, { id: 113, isoNum: 175, title: Майотта, titleLatin: Mayotte }, { id: 114, isoNum: 446, title: Макао, titleLatin: Macau }, { id: 115, isoNum: 454, title: Малави, titleLatin: Malawi }, { id: 116, isoNum: 458, title: Малайзия, titleLatin: Malaysia }, { id: 117, isoNum: 466, title: Мали, titleLatin: Mali }, { id: 118, isoNum: 581, title: 'Малые Тихоокеанские отдаленные острова Соединенных', titleLatin: 'United States Pacific Island Wildlife Refuges' }, { id: 119, isoNum: 462, title: Мальдивы, titleLatin: Maldives }, { id: 120, isoNum: 470, title: Мальта, titleLatin: Malta }, { id: 121, isoNum: 504, title: Марокко, titleLatin: Morocco }, { id: 122, isoNum: 474, title: Мартиника, titleLatin: Martinique }, { id: 123, isoNum: 584, title: 'Маршалловы острова', titleLatin: 'Marshall Islands' }, { id: 124, isoNum: 484, title: Мексика, titleLatin: Mexico }, { id: 125, isoNum: 583, title: 'Микронезия, Федеративные Штаты', titleLatin: 'Micronesia, Federated States of' }, { id: 126, isoNum: 508, title: Мозамбик, titleLatin: Mozambique }, { id: 127, isoNum: 498, title: 'Молдова, Республика', titleLatin: Moldova }, { id: 128, isoNum: 492, title: Монако, titleLatin: Monaco }, { id: 129, isoNum: 496, title: Монголия, titleLatin: Mongolia }, { id: 130, isoNum: 500, title: Монтсеррат, titleLatin: Montserrat }, { id: 131, isoNum: 104, title: Мьянма, titleLatin: Burma }, { id: 132, isoNum: 516, title: Намибия, titleLatin: Namibia }, { id: 133, isoNum: 520, title: Науру, titleLatin: Nauru }, { id: 134, isoNum: 524, title: Непал, titleLatin: Nepal }, { id: 135, isoNum: 562, title: Нигер, titleLatin: Niger }, { id: 136, isoNum: 566, title: Нигерия, titleLatin: Nigeria }, { id: 137, isoNum: 530, title: 'Нидерландские Антилы', titleLatin: 'Netherlands Antilles' }, { id: 138, isoNum: 528, title: Нидерланды, titleLatin: Netherlands }, { id: 139, isoNum: 558, title: Никарагуа, titleLatin: Nicaragua }, { id: 140, isoNum: 570, title: Ниуэ, titleLatin: Niue }, { id: 141, isoNum: 554, title: 'Новая Зеландия', titleLatin: 'New Zealand' }, { id: 142, isoNum: 540, title: 'Новая Каледония', titleLatin: 'New Caledonia' }, { id: 143, isoNum: 578, title: Норвегия, titleLatin: Norway }, { id: 144, isoNum: 784, title: 'Объединенные Арабские Эмираты', titleLatin: 'United Arab Emirates' }, { id: 145, isoNum: 512, title: Оман, titleLatin: Oman }, { id: 146, isoNum: 74, title: 'Остров Буве', titleLatin: 'Bouvet Island' }, { id: 147, isoNum: 0, title: 'Остров Клиппертон', titleLatin: 'Clipperton Island' }, { id: 148, isoNum: 833, title: 'Остров Мэн', titleLatin: 'Isle of Man' }, { id: 149, isoNum: 574, title: 'Остров Норфолк', titleLatin: 'Norfolk Island' }, { id: 150, isoNum: 162, title: 'Остров Рождества', titleLatin: 'Christmas Island' }, { id: 151, isoNum: 663, title: 'Остров Святого Мартина', titleLatin: 'Saint Martin' }, { id: 152, isoNum: 334, title: 'Остров Херд и острова Макдональд', titleLatin: 'Heard Island and McDonald Islands' }, { id: 153, isoNum: 136, title: 'Острова Кайман', titleLatin: 'Cayman Islands' }, { id: 154, isoNum: 184, title: 'Острова Кука', titleLatin: 'Cook Islands' }, { id: 155, isoNum: 796, title: 'Острова Теркс и Кайкос', titleLatin: 'Turks and Caicos Islands' }, { id: 156, isoNum: 586, title: Пакистан, titleLatin: Pakistan }, { id: 157, isoNum: 585, title: Палау, titleLatin: Palau }, { id: 158, isoNum: 275, title: 'Палестинская территория, оккупированная', titleLatin: 'Palestinian Territory, Occupied' }, { id: 159, isoNum: 591, title: Панама, titleLatin: Panama }, { id: 160, isoNum: 336, title: 'Папский Престол (Государство — город Ватикан)', titleLatin: 'Holy See (Vatican City)' }, { id: 161, isoNum: 598, title: 'Папуа-Новая Гвинея', titleLatin: 'Papua New Guinea' }, { id: 162, isoNum: 600, title: Парагвай, titleLatin: Paraguay }, { id: 163, isoNum: 604, title: Перу, titleLatin: Peru }, { id: 164, isoNum: 612, title: Питкерн, titleLatin: Pitcairn }, { id: 165, isoNum: 616, title: Польша, titleLatin: Poland }, { id: 166, isoNum: 620, title: Португалия, titleLatin: Portugal }, { id: 167, isoNum: 630, title: Пуэрто-Рико, titleLatin: 'Puerto Rico' }, { id: 168, isoNum: 807, title: 'Республика Македония', titleLatin: Macedonia }, { id: 169, isoNum: 638, title: Реюньон, titleLatin: Reunion }, { id: 170, isoNum: 643, title: Россия, titleLatin: Russia }, { id: 171, isoNum: 646, title: Руанда, titleLatin: Rwanda }, { id: 172, isoNum: 642, title: Румыния, titleLatin: Romania }, { id: 173, isoNum: 882, title: Самоа, titleLatin: Samoa }, { id: 174, isoNum: 674, title: Сан-Марино, titleLatin: 'San Marino' }, { id: 175, isoNum: 678, title: 'Сан-Томе и Принсипи', titleLatin: 'Sao Tome and Principe' }, { id: 176, isoNum: 682, title: 'Саудовская Аравия', titleLatin: 'Saudi Arabia' }, { id: 177, isoNum: 748, title: Свазиленд, titleLatin: Swaziland }, { id: 178, isoNum: 654, title: 'Святая Елена', titleLatin: 'Saint Helena' }, { id: 179, isoNum: 408, title: 'Северная Корея', titleLatin: 'Korea, North' }, { id: 180, isoNum: 580, title: 'Северные Марианские острова', titleLatin: 'Northern Mariana Islands' }, { id: 181, isoNum: 652, title: Сен-Бартельми, titleLatin: 'Saint Barthélemy' }, { id: 182, isoNum: 666, title: 'Сен-Пьер и Микелон', titleLatin: 'Saint Pierre and Miquelon' }, { id: 183, isoNum: 686, title: Сенегал, titleLatin: Senegal }, { id: 184, isoNum: 670, title: 'Сент-Винсент и Гренадины', titleLatin: 'Saint Vincent and the Grenadines' }, { id: 185, isoNum: 662, title: Сент-Люсия, titleLatin: 'Saint Lucia' }, { id: 186, isoNum: 659, title: 'Сент-Китс и Невис', titleLatin: 'Saint Kitts and Nevis' }, { id: 187, isoNum: 688, title: Сербия, titleLatin: Serbia }, { id: 188, isoNum: 690, title: Сейшелы, titleLatin: Seychelles }, { id: 189, isoNum: 702, title: Сингапур, titleLatin: Singapore }, { id: 190, isoNum: 760, title: 'Сирийская Арабская Республика', titleLatin: Syria }, { id: 191, isoNum: 703, title: Словакия, titleLatin: Slovakia }, { id: 192, isoNum: 705, title: Словения, titleLatin: Slovenia }, { id: 193, isoNum: 826, title: Великобритания, titleLatin: 'United Kingdom' }, { id: 194, isoNum: 840, title: 'Соединенные Штаты', titleLatin: 'United States' }, { id: 195, isoNum: 90, title: 'Соломоновы острова', titleLatin: 'Solomon Islands' }, { id: 196, isoNum: 706, title: Сомали, titleLatin: Somalia }, { id: 197, isoNum: 736, title: Судан, titleLatin: Sudan }, { id: 198, isoNum: 740, title: Суринам, titleLatin: Suriname }, { id: 199, isoNum: 694, title: Сьерра-Леоне, titleLatin: 'Sierra Leone' }, { id: 200, isoNum: 762, title: Таджикистан, titleLatin: Tajikistan }, { id: 201, isoNum: 764, title: Таиланд, titleLatin: Thailand }, { id: 202, isoNum: 834, title: 'Танзания, Объединенная Республика', titleLatin: Tanzania }, { id: 203, isoNum: 158, title: 'Тайвань (Китай)', titleLatin: Taiwan }, { id: 204, isoNum: 626, title: Тимор-Лесте, titleLatin: Timor-Leste }, { id: 205, isoNum: 768, title: Того, titleLatin: Togo }, { id: 206, isoNum: 772, title: Токелау, titleLatin: Tokelau }, { id: 207, isoNum: 776, title: Тонга, titleLatin: Tonga }, { id: 208, isoNum: 780, title: 'Тринидад и Тобаго', titleLatin: 'Trinidad and Tobago' }, { id: 209, isoNum: 798, title: Тувалу, titleLatin: Tuvalu }, { id: 210, isoNum: 788, title: Тунис, titleLatin: Tunisia }, { id: 211, isoNum: 795, title: Туркмения, titleLatin: Turkmenistan }, { id: 212, isoNum: 792, title: Турция, titleLatin: Turkey }, { id: 213, isoNum: 800, title: Уганда, titleLatin: Uganda }, { id: 214, isoNum: 860, title: Узбекистан, titleLatin: Uzbekistan }, { id: 215, isoNum: 804, title: Украина, titleLatin: Ukraine }, { id: 216, isoNum: 876, title: 'Уоллис и Футуна', titleLatin: 'Wallis and Futuna' }, { id: 217, isoNum: 858, title: Уругвай, titleLatin: Uruguay }, { id: 218, isoNum: 234, title: 'Фарерские острова', titleLatin: 'Faroe Islands' }, { id: 219, isoNum: 242, title: Фиджи, titleLatin: Fiji }, { id: 220, isoNum: 608, title: Филиппины, titleLatin: Philippines }, { id: 221, isoNum: 246, title: Финляндия, titleLatin: Finland }, { id: 222, isoNum: 238, title: 'Фолклендские острова (Мальвинские)', titleLatin: 'Falkland Islands (Islas Malvinas)' }, { id: 223, isoNum: 250, title: Франция, titleLatin: France }, { id: 224, isoNum: 254, title: 'Французская Гвиана', titleLatin: 'French Guiana' }, { id: 225, isoNum: 258, title: 'Французская Полинезия', titleLatin: 'French Polynesia' }, { id: 226, isoNum: 260, title: 'Французские Южные территории', titleLatin: 'French Southern Lands' }, { id: 227, isoNum: 191, title: Хорватия, titleLatin: Croatia }, { id: 228, isoNum: 140, title: 'Центрально-Африканская Республика', titleLatin: 'Central African Republic' }, { id: 229, isoNum: 148, title: Чад, titleLatin: Chad }, { id: 230, isoNum: 499, title: Черногория, titleLatin: Montenegro }, { id: 231, isoNum: 203, title: 'Чешская Республика', titleLatin: 'Czech Republic' }, { id: 232, isoNum: 152, title: Чили, titleLatin: Chile }, { id: 233, isoNum: 756, title: Швейцария, titleLatin: Switzerland }, { id: 234, isoNum: 752, title: Швеция, titleLatin: Sweden }, { id: 235, isoNum: 744, title: 'Шпицберген и Ян Майен', titleLatin: 'Svalbard and Jan Mayen' }, { id: 236, isoNum: 144, title: Шри-Ланка, titleLatin: 'Sri Lanka' }, { id: 237, isoNum: 218, title: Эквадор, titleLatin: Ecuador }, { id: 238, isoNum: 226, title: 'Экваториальная Гвинея', titleLatin: 'Equatorial Guinea' }, { id: 239, isoNum: 248, title: 'Эландские острова', titleLatin: 'Åland Islands' }, { id: 240, isoNum: 222, title: Эль-Сальвадор, titleLatin: 'El Salvador' }, { id: 241, isoNum: 232, title: Эритрея, titleLatin: Eritrea }, { id: 242, isoNum: 233, title: Эстония, titleLatin: Estonia }, { id: 243, isoNum: 231, title: Эфиопия, titleLatin: Ethiopia }, { id: 244, isoNum: 710, title: 'Южная Африка', titleLatin: 'South Africa' }, { id: 245, isoNum: 239, title: 'Южная Джорджия и Южные Сандвичевы острова', titleLatin: 'South Georgia and the South Sandwich Islands' }, { id: 246, isoNum: 410, title: 'Южная Корея', titleLatin: 'Korea, South' }, { id: 247, isoNum: 388, title: Ямайка, titleLatin: Jamaica }, { id: 248, isoNum: 392, title: Япония, titleLatin: Japan }, { id: 249, isoNum: 203, title: '', titleLatin: 'Czech Republic' }, { id: 250, isoNum: 498, title: Україна, titleLatin: 'Republic of Moldova' }, { id: 251, isoNum: 807, title: Україна, titleLatin: 'North Macedonia' }, { id: 252, isoNum: 0, title: Україна, titleLatin: '' }, { id: 253, isoNum: 0, title: Україна, titleLatin: '' }, { id: 254, isoNum: 0, title: Україна, titleLatin: '' }, { id: 255, isoNum: 0, title: Іспанія, titleLatin: '' }], status: success }
                'Success (byCheckpoint passed)':
                  value: { data: [{ id: 215, isoNum: 804, title: Украина, titleLatin: Ukraine }, { id: 170, isoNum: 643, title: Россия, titleLatin: Russia }, { id: 50, isoNum: 276, title: Германия, titleLatin: Germany }, { id: 25, isoNum: 100, title: Болгария, titleLatin: Bulgaria }, { id: 193, isoNum: 826, title: Великобритания, titleLatin: 'United Kingdom' }, { id: 138, isoNum: 528, title: Нидерланды, titleLatin: Netherlands }, { id: 127, isoNum: 498, title: 'Молдова, Республика', titleLatin: Moldova }, { id: 4, isoNum: 8, title: Албания, titleLatin: Albania }, { id: 2, isoNum: 40, title: Австрия, titleLatin: Austria }, { id: 22, isoNum: 56, title: Бельгия, titleLatin: Belgium }, { id: 36, isoNum: 348, title: Венгрия, titleLatin: Hungary }, { id: 221, isoNum: 246, title: Финляндия, titleLatin: Finland }, { id: 76, isoNum: 352, title: Исландия, titleLatin: Iceland }, { id: 194, isoNum: 840, title: 'Соединенные Штаты', titleLatin: 'United States' }, { id: 84, isoNum: 124, title: Канада, titleLatin: Canada }, { id: 96, isoNum: 688, title: Косово, titleLatin: Kosovo }, { id: 223, isoNum: 250, title: Франция, titleLatin: France }, { id: 233, isoNum: 756, title: Швейцария, titleLatin: Switzerland }, { id: 94, isoNum: 178, title: Конго, titleLatin: 'Congo, Republic of the' }, { id: 82, isoNum: 116, title: Камбоджа, titleLatin: Cambodia }, { id: 165, isoNum: 616, title: Польша, titleLatin: Poland }, { id: 78, isoNum: 380, title: Италия, titleLatin: Italy }, { id: 242, isoNum: 233, title: Эстония, titleLatin: Estonia }, { id: 81, isoNum: 398, title: Казахстан, titleLatin: Kazakhstan }], status: success }
                'Success (byCompany passed)':
                  value: { data: [{ id: 215, isoNum: 804, title: Украина, titleLatin: Ukraine }, { id: 170, isoNum: 643, title: Россия, titleLatin: Russia }, { id: 50, isoNum: 276, title: Германия, titleLatin: Germany }, { id: 25, isoNum: 100, title: Болгария, titleLatin: Bulgaria }, { id: 193, isoNum: 826, title: Великобритания, titleLatin: 'United Kingdom' }, { id: 138, isoNum: 528, title: Нидерланды, titleLatin: Netherlands }, { id: 127, isoNum: 498, title: 'Молдова, Республика', titleLatin: Moldova }, { id: 4, isoNum: 8, title: Албания, titleLatin: Albania }, { id: 2, isoNum: 40, title: Австрия, titleLatin: Austria }, { id: 22, isoNum: 56, title: Бельгия, titleLatin: Belgium }, { id: 36, isoNum: 348, title: Венгрия, titleLatin: Hungary }, { id: 221, isoNum: 246, title: Финляндия, titleLatin: Finland }, { id: 76, isoNum: 352, title: Исландия, titleLatin: Iceland }, { id: 194, isoNum: 840, title: 'Соединенные Штаты', titleLatin: 'United States' }, { id: 84, isoNum: 124, title: Канада, titleLatin: Canada }, { id: 96, isoNum: 688, title: Косово, titleLatin: Kosovo }, { id: 223, isoNum: 250, title: Франция, titleLatin: France }, { id: 233, isoNum: 756, title: Швейцария, titleLatin: Switzerland }, { id: 94, isoNum: 178, title: Конго, titleLatin: 'Congo, Republic of the' }, { id: 82, isoNum: 116, title: Камбоджа, titleLatin: Cambodia }, { id: 165, isoNum: 616, title: Польша, titleLatin: Poland }, { id: 78, isoNum: 380, title: Италия, titleLatin: Italy }, { id: 242, isoNum: 233, title: Эстония, titleLatin: Estonia }, { id: 81, isoNum: 398, title: Казахстан, titleLatin: Kazakhstan }], status: success }
                'Success (byTown passed)':
                  value: { data: [{ id: 215, isoNum: 804, title: Украина, titleLatin: Ukraine }, { id: 170, isoNum: 643, title: Россия, titleLatin: Russia }, { id: 50, isoNum: 276, title: Германия, titleLatin: Germany }, { id: 25, isoNum: 100, title: Болгария, titleLatin: Bulgaria }, { id: 193, isoNum: 826, title: Великобритания, titleLatin: 'United Kingdom' }, { id: 138, isoNum: 528, title: Нидерланды, titleLatin: Netherlands }, { id: 127, isoNum: 498, title: 'Молдова, Республика', titleLatin: Moldova }, { id: 4, isoNum: 8, title: Албания, titleLatin: Albania }, { id: 2, isoNum: 40, title: Австрия, titleLatin: Austria }, { id: 22, isoNum: 56, title: Бельгия, titleLatin: Belgium }, { id: 36, isoNum: 348, title: Венгрия, titleLatin: Hungary }, { id: 221, isoNum: 246, title: Финляндия, titleLatin: Finland }, { id: 76, isoNum: 352, title: Исландия, titleLatin: Iceland }, { id: 194, isoNum: 840, title: 'Соединенные Штаты', titleLatin: 'United States' }, { id: 84, isoNum: 124, title: Канада, titleLatin: Canada }, { id: 96, isoNum: 688, title: Косово, titleLatin: Kosovo }, { id: 223, isoNum: 250, title: Франция, titleLatin: France }, { id: 233, isoNum: 756, title: Швейцария, titleLatin: Switzerland }, { id: 94, isoNum: 178, title: Конго, titleLatin: 'Congo, Republic of the' }, { id: 82, isoNum: 116, title: Камбоджа, titleLatin: Cambodia }, { id: 165, isoNum: 616, title: Польша, titleLatin: Poland }, { id: 78, isoNum: 380, title: Италия, titleLatin: Italy }, { id: 242, isoNum: 233, title: Эстония, titleLatin: Estonia }, { id: 81, isoNum: 398, title: Казахстан, titleLatin: Kazakhstan }], status: success }
                'Success with all parameters passed':
                  value: { data: [{ id: 215, isoNum: 804, title: Украина, titleLatin: Ukraine }, { id: 170, isoNum: 643, title: Россия, titleLatin: Russia }, { id: 50, isoNum: 276, title: Германия, titleLatin: Germany }, { id: 25, isoNum: 100, title: Болгария, titleLatin: Bulgaria }, { id: 193, isoNum: 826, title: Великобритания, titleLatin: 'United Kingdom' }, { id: 138, isoNum: 528, title: Нидерланды, titleLatin: Netherlands }, { id: 127, isoNum: 498, title: 'Молдова, Республика', titleLatin: Moldova }, { id: 4, isoNum: 8, title: Албания, titleLatin: Albania }, { id: 2, isoNum: 40, title: Австрия, titleLatin: Austria }, { id: 22, isoNum: 56, title: Бельгия, titleLatin: Belgium }, { id: 36, isoNum: 348, title: Венгрия, titleLatin: Hungary }, { id: 221, isoNum: 246, title: Финляндия, titleLatin: Finland }, { id: 76, isoNum: 352, title: Исландия, titleLatin: Iceland }, { id: 194, isoNum: 840, title: 'Соединенные Штаты', titleLatin: 'United States' }, { id: 84, isoNum: 124, title: Канада, titleLatin: Canada }, { id: 96, isoNum: 688, title: Косово, titleLatin: Kosovo }, { id: 223, isoNum: 250, title: Франция, titleLatin: France }, { id: 233, isoNum: 756, title: Швейцария, titleLatin: Switzerland }, { id: 94, isoNum: 178, title: Конго, titleLatin: 'Congo, Republic of the' }, { id: 82, isoNum: 116, title: Камбоджа, titleLatin: Cambodia }, { id: 165, isoNum: 616, title: Польша, titleLatin: Poland }, { id: 78, isoNum: 380, title: Италия, titleLatin: Italy }, { id: 242, isoNum: 233, title: Эстония, titleLatin: Estonia }, { id: 81, isoNum: 398, title: Казахстан, titleLatin: Kazakhstan }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getCompanies:
    get:
      tags:
        - 'Routes & tenders / Shippers / Stops'
      summary: 'Get Stop Companies'
      description: |-
        Returns the list of companies, depending on the passed parameters.

        - if successful you will receive list of companies, depending of the passed parameters
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Only for shippers
      operationId: getStopCompanies
      parameters:
        -
          name: byCheckpoint
          in: query
          schema:
            type: string
            example: 'true'
          description: 'Required bool. True: Returns the list of companies who own loading/unloading checkpoint in your account. False: not allowed'
        -
          name: byCountry
          in: query
          schema:
            type: string
            example: '{{companiesByCheckpointCountry}}'
          description: 'Optional int. Id of the country. Returns the list of companies with loading/unloading checkpoints in a given country. `byCheckpoint` parameter must be on'
        -
          name: byRegion
          in: query
          schema:
            type: string
            example: '{{companiesByCheckpointRegion}}'
          description: 'Optional int. Id of the region. Returns the list of companies with loading/unloading checkpoints in a given region. `byCheckpoint` parameter must be on'
        -
          name: byTown
          in: query
          schema:
            type: string
            example: '{{companiesByCheckpointTown}}'
          description: 'Optional int. Id of the town. Returns the list of companies with loading/unloading checkpoints in a given town. `byCheckpoint` parameter must be on'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: 'Success (byCheckpoint passed) / Success (byCountry passed) / Success (byRegion passed) / Success (byTown passed) / Success with all parameters'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { id: { type: number, example: 60 }, natcomid: { type: string, nullable: true, example: '360587991' }, title: { type: string, example: Company }, titleFull: { type: string, example: 'Company full name' } } }, example: [{ id: 60, natcomid: '360587991', title: Company, titleFull: 'Company full name' }, { id: 572, natcomid: '1231l2knk 123', title: 'testing, LLC', titleFull: 'testing, limited liability company' }, { id: 781, natcomid: '10029029', title: SOME, titleFull: 'SOME full name' }, { id: 3, natcomid: '39028162', title: 'Phleetto, LTD', titleFull: 'Phleetto Limited' }, { id: 828, natcomid: '', title: 'Стартап.уа, LTD', titleFull: 'Стартап.уа, Общество с ограниченной ответственностью' }, { id: 839, natcomid: '', title: 'LTD Траверсы', titleFull: '' }, { id: 857, natcomid: '2232323', title: 'ДБО, LTD', titleFull: '' }, { id: 1815, natcomid: '1258756489', title: 'Зеланд, ЧП', titleFull: '' }, { id: 1855, natcomid: '', title: 'Брендсорс, LTD', titleFull: '' }, { id: 1857, natcomid: '', title: 'Лорейн, ДП', titleFull: '' }, { id: 1858, natcomid: '', title: 'Ремкомплект, LTD', titleFull: '' }, { id: 1865, natcomid: '', title: 'Отправка, LTD', titleFull: '' }, { id: 1941, natcomid: '', title: 'Таможня 1', titleFull: '' }, { id: 1942, natcomid: '', title: 'Floha Logistic', titleFull: '' }, { id: 1943, natcomid: '', title: 'Немецкая таможня', titleFull: '' }, { id: 1945, natcomid: '', title: 'Склад, LTD', titleFull: '' }, { id: 1946, natcomid: '', title: 'Пчелкин, СП', titleFull: '' }, { id: 2207, natcomid: '', title: 'Укринвестрой, ГП', titleFull: '' }, { id: 2288, natcomid: '', title: КремСофтСервис, titleFull: '' }, { id: 2429, natcomid: '', title: 'RAILWAY-CARRIAGE REPAIR WORKS-99 S.A.', titleFull: '' }, { id: 2461, natcomid: '', title: 'Свинтус, МЧП', titleFull: '' }, { id: 2936, natcomid: '', title: 'Sherlock Inc', titleFull: '' }, { id: 2937, natcomid: '', title: 'Bureau of Investigation', titleFull: '' }, { id: 3544, natcomid: rey, title: eary, titleFull: '' }, { id: 3545, natcomid: rstu, title: rstu, titleFull: '' }, { id: 4041, natcomid: '245145322', title: 'Вентус, LTD', titleFull: '' }, { id: 852, natcomid: '12345678', title: 'Ужгород Импекс Стар, ЧП', titleFull: '' }, { id: 4454, natcomid: '', title: 'Рубероид, LTD', titleFull: '' }, { id: 4455, natcomid: '', title: 'Дунай, LTD', titleFull: '' }, { id: 4458, natcomid: '', title: Рафинад, titleFull: '' }, { id: 1944, natcomid: '', title: 'Киевская таможня', titleFull: '' }, { id: 5365, natcomid: '01010110', title: 'Империал групп Украина, LTD', titleFull: '' }, { id: 5372, natcomid: 'Компания some  ЕГРПОУ', title: 'Компания some', titleFull: '' }, { id: 5377, natcomid: '23232', title: '23323', titleFull: '' }, { id: 5378, natcomid: '8857678', title: 'Совтес, LTD', titleFull: '' }, { id: 4469, natcomid: '', title: Киев, titleFull: '' }, { id: 5379, natcomid: '', title: 'лукоц, LTD', titleFull: '' }, { id: 2688, natcomid: '12', title: 'Марс, ФОП', titleFull: '' }, { id: 50, natcomid: '1', title: 'Либра Транс, LTD', titleFull: ', Общество с ограниченной ответственностью)' }, { id: 5380, natcomid: '123456789', title: 'Лісова пісня, ЧП', titleFull: '' }, { id: 5381, natcomid: '000000', title: Супермены, titleFull: '' }, { id: 5382, natcomid: '000000', title: Москалики, titleFull: '' }, { id: 5383, natcomid: '62896254', title: Кит, titleFull: '' }, { id: 5384, natcomid: '36372232', title: Ресторанчик, titleFull: '' }, { id: 5388, natcomid: '14708458', title: 'Бэби, ЧАО', titleFull: '' }, { id: 5389, natcomid: '00411938', title: 'Монстры, Корп', titleFull: '' }, { id: 5390, natcomid: '38155194', title: Главпочтамт, titleFull: '' }, { id: 5392, natcomid: '36913534', title: 'Таможенка, ЧАО', titleFull: '' }, { id: 5423, natcomid: '02174626', title: 'Компания без формы', titleFull: '' }, { id: 5424, natcomid: '', title: Зверинец, titleFull: '' }, { id: 5431, natcomid: '', title: 'Оболонь, ПАО', titleFull: '' }, { id: 5436, natcomid: '1234567890', title: Rj, titleFull: '' }, { id: 5437, natcomid: '0369258147', title: ьи, titleFull: '' }, { id: 5444, natcomid: '', title: 'Днепропетровский таможенный пост, ЧЛ', titleFull: '' }, { id: 3001, natcomid: '', title: 'Z.I.des Hauts Sarts', titleFull: '' }, { id: 3000, natcomid: '', title: 'Arcelor Mittal Ringmill Zoning Industriel CMI,', titleFull: '' }, { id: 5453, natcomid: '', title: Кожушок, titleFull: '' }, { id: 5454, natcomid: '', title: а, titleFull: '' }, { id: 5366, natcomid: '', title: Компания, titleFull: '' }, { id: 5455, natcomid: '', title: Таможенка, titleFull: '' }, { id: 5465, natcomid: '7744556622', title: тат, titleFull: '' }, { id: 5466, natcomid: '9966330022', title: бма, titleFull: '' }, { id: 5467, natcomid: '0033115588', title: 'Таможня в Маяках', titleFull: '' }, { id: 5468, natcomid: '9955117700', title: 'Тирас (Маяки, Паланка)', titleFull: '' }, { id: 5469, natcomid: '', title: 'Частное лицо, ЧЛ', titleFull: '' }, { id: 17656, natcomid: '', title: 'Цирк, ЧЛ', titleFull: '' }, { id: 19335, natcomid: '0369852014', title: Company, titleFull: '' }, { id: 19336, natcomid: '3698520147', title: 'Svb tr', titleFull: '' }, { id: 19339, natcomid: '0000001123', title: Rk, titleFull: '' }, { id: 19340, natcomid: '0011447788', title: Е, titleFull: '' }, { id: 19341, natcomid: '0033669988', title: 'Компанийка в Одессочке', titleFull: '' }, { id: 19342, natcomid: '', title: 'Корпорация, Корп', titleFull: '' }, { id: 19343, natcomid: '', title: 'Ка, Корп', titleFull: '' }, { id: 19344, natcomid: '', title: ', ДП', titleFull: '' }, { id: 19364, natcomid: '', title: 'Жучок, ЧЛ', titleFull: '' }, { id: 19381, natcomid: '', title: 'Soumen katu, ЧЛ', titleFull: '' }, { id: 19382, natcomid: '', title: 'Ислашка, ЧЛ', titleFull: '' }, { id: 19383, natcomid: '', title: 'Мизури!, ЧЛ', titleFull: '' }, { id: 19384, natcomid: '', title: 'Oesterreich, ЧЛ', titleFull: '' }, { id: 19386, natcomid: '', title: 'Калгари Тауэр, ЧЛ', titleFull: '' }, { id: 5430, natcomid: '39469994', title: Киев, titleFull: '' }, { id: 2452, natcomid: '3568803982', title: '1', titleFull: '' }, { id: 19388, natcomid: '', title: '..., ЧЛ', titleFull: '' }, { id: 19389, natcomid: '', title: 'Кисса, ЧЛ', titleFull: '' }, { id: 19390, natcomid: '', title: 'КОшак, ЧЛ', titleFull: '' }, { id: 19391, natcomid: '', title: 'Жванык, ЧЛ', titleFull: '' }, { id: 19392, natcomid: '', title: 'Жашка, ЧЛ', titleFull: '' }, { id: 19393, natcomid: '', title: 'ячвчц у, ЧЛ', titleFull: '' }, { id: 19394, natcomid: '', title: 'счвв, ЧЛ', titleFull: '' }, { id: 19395, natcomid: '', title: 'Мняфге, ЧЛ', titleFull: '' }, { id: 19396, natcomid: '', title: 'Няшка, ЧЛ', titleFull: '' }, { id: 19397, natcomid: '', title: 'Ketu, ЧЛ', titleFull: '' }, { id: 19398, natcomid: '', title: 'Домик, ЧЛ', titleFull: '' }, { id: 19399, natcomid: '', title: 'Зорька, ЧЛ', titleFull: '' }, { id: 19376, natcomid: '', title: 'Тестик, ЧЛ', titleFull: 'Тестик, Частное лицо' }, { id: 19400, natcomid: '', title: 'Общажка, ЧЛ', titleFull: '' }, { id: 19401, natcomid: '', title: 'Котик-бегемотик, ЧЛ', titleFull: '' }, { id: 19402, natcomid: '', title: 'Бяка, ЧЛ', titleFull: '' }, { id: 19373, natcomid: '', title: 'согласно заявке', titleFull: '' }, { id: 571, natcomid: 899фывоиирфоыв, title: 'тестовая, АО', titleFull: 'тестовая, Частное акционерное общество' }, { id: 19403, natcomid: '', title: 'Нячго, ЧЛ', titleFull: '' }, { id: 19404, natcomid: '', title: 'Морько, ЧЛ', titleFull: '' }, { id: 19405, natcomid: '876543215', title: 'Котик, ЧЛ', titleFull: '' }, { id: 19406, natcomid: '', title: авфыа, titleFull: '' }, { id: 19407, natcomid: '', title: афвы, titleFull: '' }, { id: 19409, natcomid: '', title: ло, titleFull: '' }, { id: 19410, natcomid: '', title: 'Манька, ЧЛ', titleFull: '' }, { id: 19411, natcomid: '', title: Ванька, titleFull: '' }, { id: 19424, natcomid: '', title: 'Компашкес, ЧЛ', titleFull: '' }, { id: 19425, natcomid: '', title: 'Тустаньчик, ЧЛ', titleFull: '' }, { id: 19443, natcomid: '', title: 'Ремонтик, ЧЛ', titleFull: '' }, { id: 19447, natcomid: '', title: 'Кошка, ЧЛ', titleFull: '' }, { id: 19458, natcomid: '', title: 'Котичек, ЧЛ', titleFull: '' }, { id: 19459, natcomid: '', title: 'Мимими, ЧЛ', titleFull: '' }, { id: 19462, natcomid: '', title: 'Волынянка, ЧЛ', titleFull: '' }, { id: 19463, natcomid: '', title: 'Ня, ЧЛ', titleFull: '' }, { id: 19464, natcomid: '', title: 'Креведго, ЧЛ', titleFull: '' }, { id: 19467, natcomid: '', title: 'Няняня, ЧЛ', titleFull: '' }, { id: 19468, natcomid: '', title: 'Саф, ЧЛ', titleFull: '' }, { id: 5435, natcomid: '', title: 'Парам, ЧЛ', titleFull: '' }, { id: 19470, natcomid: '', title: 'Изба, ЧЛ', titleFull: '' }, { id: 19472, natcomid: '', title: 'Офис, ТОВ', titleFull: '' }, { id: 19473, natcomid: '', title: 'алкомаркет, ТОВ', titleFull: '' }, { id: 19486, natcomid: '', title: 'Равиолька, ЧЛ', titleFull: '' }, { id: 19487, natcomid: '', title: 'Кротик, ЧЛ', titleFull: '' }, { id: 19489, natcomid: '', title: 'Предприятие Кавычка, ЧЛ', titleFull: '' }, { id: 19502, natcomid: '', title: 'Рассейка, LTD', titleFull: '' }, { id: 19504, natcomid: '', title: ВВЛ, titleFull: '' }, { id: 19505, natcomid: '', title: 'Винницкая птицефабрика', titleFull: '' }, { id: 19506, natcomid: '', title: МПФРЛЦекспорт, titleFull: '' }, { id: 19507, natcomid: '', title: PFL, titleFull: '' }, { id: 19575, natcomid: '', title: 'Ровно тест', titleFull: '' }, { id: 19591, natcomid: '', title: Юнит, titleFull: '' }, { id: 19615, natcomid: '', title: 'Студия Лебедева', titleFull: '' }, { id: 19616, natcomid: '', title: тут, titleFull: '' }, { id: 678720, natcomid: '', title: Ровноснаб, titleFull: '' }, { id: 678787, natcomid: '', title: 'около, тест', titleFull: '' }, { id: 2974, natcomid: '', title: МХП, titleFull: '' }, { id: 678881, natcomid: '', title: СОХ, titleFull: '' }, { id: 678884, natcomid: '', title: 'Sukano AG', titleFull: '' }, { id: 19587, natcomid: '12345', title: 'ТОВ Надя', titleFull: '' }, { id: 678958, natcomid: '', title: '123456', titleFull: '' }, { id: 679136, natcomid: '', title: Жлоб, titleFull: '' }, { id: 679137, natcomid: '', title: 'Моряк, LTD', titleFull: '' }, { id: 5432, natcomid: '', title: Совтес, titleFull: '' }, { id: 679161, natcomid: '', title: Раб, titleFull: '' }, { id: 679412, natcomid: '', title: Кафе, titleFull: '' }, { id: 19449, natcomid: '', title: Школа, titleFull: '' }, { id: 679413, natcomid: '', title: Кавярня, titleFull: '' }, { id: 679414, natcomid: '', title: Книгарня, titleFull: '' }, { id: 679415, natcomid: '', title: Спа-салон, titleFull: '' }, { id: 679872, natcomid: '', title: Моряк, titleFull: '' }, { id: 679746, natcomid: '', title: Бугай, titleFull: '' }, { id: 680697, natcomid: '22334455', title: 'Контора, LTD', titleFull: '' }, { id: 680698, natcomid: '', title: Совтек, titleFull: '' }, { id: 405, natcomid: '37534432', title: 'Енотик, ЧЛ', titleFull: Енотичек }, { id: 402, natcomid: '3053508595', title: 'ОТО, ПАО', titleFull: 'ОТО, Публичное акционерное общество' }, { id: 681410, natcomid: '3227002595', title: Бугай, titleFull: '' }, { id: 681434, natcomid: '41444125', title: олдіідідід, titleFull: '' }, { id: 681433, natcomid: '31826484', title: татата, titleFull: '' }, { id: 682023, natcomid: '3294211325', title: 'ТОВ РУШ 32007740', titleFull: '' }, { id: 17895, natcomid: '36071694', title: ТРАНС-АТЛАС, titleFull: '' }, { id: 2073, natcomid: '35917412', title: 'Транс-Логiстик, ТОВ', titleFull: 'Транс-Логiстик, Товариство з Обмеженою Відповідальностю' }, { id: 682382, natcomid: '397400637', title: Моряк, titleFull: '' }, { id: 682763, natcomid: '434554324', title: Моряк, titleFull: '' }, { id: 1482, natcomid: '21496904', title: 'Агротеп, LTD', titleFull: 'Агротеп, Общество с ограниченной ответственностью' }, { id: 682782, natcomid: '3753443244', title: Моряк, titleFull: '' }, { id: 682803, natcomid: '12345546236', title: 'Тестер Кладовщик', titleFull: '' }, { id: 682832, natcomid: 45реввпр566уу4, title: Моряк, titleFull: '' }, { id: 679768, natcomid: '', title: 'INSTAL PROJEKT  Gawlowscy, Scierzynscy Spolka Jawna', titleFull: '' }, { id: 682750, natcomid: '', title: Агросем, titleFull: '' }, { id: 682957, natcomid: '37534432768678', title: Тест, titleFull: '' }, { id: 682968, natcomid: 5е3е34е634е, title: Моряк, titleFull: '' }, { id: 682969, natcomid: '3591741265564', title: Бугай, titleFull: '' }, { id: 682970, natcomid: 34н45гц4гн4, title: Жлоб, titleFull: '' }, { id: 682981, natcomid: '546789876543', title: Моряк, titleFull: '' }, { id: 682982, natcomid: п7ап47цп73, title: мотор, titleFull: '' }, { id: 678728, natcomid: '', title: Агромат, titleFull: '' }, { id: 683005, natcomid: '', title: '"Агромат" м. Львів,Дуля І,Покупець,САЛОН АРХІТЕКТУРА БУДІВНИЦТВО ДИЗАЙН ТОВ,Пелешко Л.З. ФОП,Коваль О.,Кончікова Т.М. ФОП', titleFull: '' }, { id: 683055, natcomid: '', title: 'дом Колотушкина', titleFull: '' }, { id: 683056, natcomid: '', title: 'дом культуры', titleFull: '' }, { id: 683261, natcomid: '', title: 'Vinicola CASTELLO DI LOZZOLO dei Fratelli Berteletti s.r.l.', titleFull: '' }, { id: 683275, natcomid: 5щ4групу, title: Моряк, titleFull: '' }, { id: 829448, natcomid: iuygbno987tgnko9876tg, title: 'unit mega city "quote"', titleFull: '' }, { id: 829450, natcomid: 1234567890йцукен, title: Бадрак, titleFull: '' }, { id: 829451, natcomid: 3g753g44j32, title: 'Одна и та же', titleFull: '' }, { id: 829452, natcomid: 36071694ат, title: 'Одна и та же', titleFull: '' }, { id: 829453, natcomid: 36474рукр, title: Моряк, titleFull: '' }, { id: 829454, natcomid: 34е3п3, title: Моряк, titleFull: '' }, { id: 19461, natcomid: '', title: 'Мняг!, ЧЛ', titleFull: '' }, { id: 1299, natcomid: '30487219', title: 'АТБ-Маркет, ТОВ', titleFull: '' }, { id: 834776, natcomid: null, title: 'Noyon Uul Erdene” LLC', titleFull: '' }, { id: 834777, natcomid: '39195657', title: 'ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ ЄВРО-АЗІАТСЬКА ЛОГІСТИЧНА КОМПАНІЯ', titleFull: '' }, { id: 834787, natcomid: null, title: 'Noyon Uul Erdene LLC', titleFull: '' }, { id: 835254, natcomid: null, title: 'INSTAL PROJEKT Gawlowscy, Scierzynscy Spolka Jawna', titleFull: '' }, { id: 679004, natcomid: '81926763', title: 'МонтажЛифтТекстильЛизинг, LTD', titleFull: '' }, { id: 679002, natcomid: '24026833', title: 'МеталРос, LTD', titleFull: '' }, { id: 679005, natcomid: '70121803', title: 'Восток, Корп', titleFull: '' }, { id: 679003, natcomid: '25272710', title: 'Мотор, ПАО', titleFull: '' }, { id: 679006, natcomid: '80759553', title: 'ОблПив, ТОВ', titleFull: '' }] }
                  status: { type: string, example: success }
              examples:
                'Success (byCheckpoint passed)':
                  value: { data: [{ id: 60, natcomid: '360587991', title: Company, titleFull: 'Company full name' }, { id: 572, natcomid: '1231l2knk 123', title: 'testing, LLC', titleFull: 'testing, limited liability company' }, { id: 781, natcomid: '10029029', title: SOME, titleFull: 'SOME full name' }, { id: 3, natcomid: '39028162', title: 'Phleetto, LTD', titleFull: 'Phleetto Limited' }, { id: 828, natcomid: '', title: 'Стартап.уа, LTD', titleFull: 'Стартап.уа, Общество с ограниченной ответственностью' }, { id: 839, natcomid: '', title: 'LTD Траверсы', titleFull: '' }, { id: 857, natcomid: '2232323', title: 'ДБО, LTD', titleFull: '' }, { id: 1815, natcomid: '1258756489', title: 'Зеланд, ЧП', titleFull: '' }, { id: 1855, natcomid: '', title: 'Брендсорс, LTD', titleFull: '' }, { id: 1857, natcomid: '', title: 'Лорейн, ДП', titleFull: '' }, { id: 1858, natcomid: '', title: 'Ремкомплект, LTD', titleFull: '' }, { id: 1865, natcomid: '', title: 'Отправка, LTD', titleFull: '' }, { id: 1941, natcomid: '', title: 'Таможня 1', titleFull: '' }, { id: 1942, natcomid: '', title: 'Floha Logistic', titleFull: '' }, { id: 1943, natcomid: '', title: 'Немецкая таможня', titleFull: '' }, { id: 1945, natcomid: '', title: 'Склад, LTD', titleFull: '' }, { id: 1946, natcomid: '', title: 'Пчелкин, СП', titleFull: '' }, { id: 2207, natcomid: '', title: 'Укринвестрой, ГП', titleFull: '' }, { id: 2288, natcomid: '', title: КремСофтСервис, titleFull: '' }, { id: 2429, natcomid: '', title: 'RAILWAY-CARRIAGE REPAIR WORKS-99 S.A.', titleFull: '' }, { id: 2461, natcomid: '', title: 'Свинтус, МЧП', titleFull: '' }, { id: 2936, natcomid: '', title: 'Sherlock Inc', titleFull: '' }, { id: 2937, natcomid: '', title: 'Bureau of Investigation', titleFull: '' }, { id: 3544, natcomid: rey, title: eary, titleFull: '' }, { id: 3545, natcomid: rstu, title: rstu, titleFull: '' }, { id: 4041, natcomid: '245145322', title: 'Вентус, LTD', titleFull: '' }, { id: 852, natcomid: '12345678', title: 'Ужгород Импекс Стар, ЧП', titleFull: '' }, { id: 4454, natcomid: '', title: 'Рубероид, LTD', titleFull: '' }, { id: 4455, natcomid: '', title: 'Дунай, LTD', titleFull: '' }, { id: 4458, natcomid: '', title: Рафинад, titleFull: '' }, { id: 1944, natcomid: '', title: 'Киевская таможня', titleFull: '' }, { id: 5365, natcomid: '01010110', title: 'Империал групп Украина, LTD', titleFull: '' }, { id: 5372, natcomid: 'Компания some  ЕГРПОУ', title: 'Компания some', titleFull: '' }, { id: 5377, natcomid: '23232', title: '23323', titleFull: '' }, { id: 5378, natcomid: '8857678', title: 'Совтес, LTD', titleFull: '' }, { id: 4469, natcomid: '', title: Киев, titleFull: '' }, { id: 5379, natcomid: '', title: 'лукоц, LTD', titleFull: '' }, { id: 2688, natcomid: '12', title: 'Марс, ФОП', titleFull: '' }, { id: 50, natcomid: '1', title: 'Либра Транс, LTD', titleFull: ', Общество с ограниченной ответственностью)' }, { id: 5380, natcomid: '123456789', title: 'Лісова пісня, ЧП', titleFull: '' }, { id: 5381, natcomid: '000000', title: Супермены, titleFull: '' }, { id: 5382, natcomid: '000000', title: Москалики, titleFull: '' }, { id: 5383, natcomid: '62896254', title: Кит, titleFull: '' }, { id: 5384, natcomid: '36372232', title: Ресторанчик, titleFull: '' }, { id: 5388, natcomid: '14708458', title: 'Бэби, ЧАО', titleFull: '' }, { id: 5389, natcomid: '00411938', title: 'Монстры, Корп', titleFull: '' }, { id: 5390, natcomid: '38155194', title: Главпочтамт, titleFull: '' }, { id: 5392, natcomid: '36913534', title: 'Таможенка, ЧАО', titleFull: '' }, { id: 5423, natcomid: '02174626', title: 'Компания без формы', titleFull: '' }, { id: 5424, natcomid: '', title: Зверинец, titleFull: '' }, { id: 5431, natcomid: '', title: 'Оболонь, ПАО', titleFull: '' }, { id: 5436, natcomid: '1234567890', title: Rj, titleFull: '' }, { id: 5437, natcomid: '0369258147', title: ьи, titleFull: '' }, { id: 5444, natcomid: '', title: 'Днепропетровский таможенный пост, ЧЛ', titleFull: '' }, { id: 3001, natcomid: '', title: 'Z.I.des Hauts Sarts', titleFull: '' }, { id: 3000, natcomid: '', title: 'Arcelor Mittal Ringmill Zoning Industriel CMI,', titleFull: '' }, { id: 5453, natcomid: '', title: Кожушок, titleFull: '' }, { id: 5454, natcomid: '', title: а, titleFull: '' }, { id: 5366, natcomid: '', title: Компания, titleFull: '' }, { id: 5455, natcomid: '', title: Таможенка, titleFull: '' }, { id: 5465, natcomid: '7744556622', title: тат, titleFull: '' }, { id: 5466, natcomid: '9966330022', title: бма, titleFull: '' }, { id: 5467, natcomid: '0033115588', title: 'Таможня в Маяках', titleFull: '' }, { id: 5468, natcomid: '9955117700', title: 'Тирас (Маяки, Паланка)', titleFull: '' }, { id: 5469, natcomid: '', title: 'Частное лицо, ЧЛ', titleFull: '' }, { id: 17656, natcomid: '', title: 'Цирк, ЧЛ', titleFull: '' }, { id: 19335, natcomid: '0369852014', title: Company, titleFull: '' }, { id: 19336, natcomid: '3698520147', title: 'Svb tr', titleFull: '' }, { id: 19339, natcomid: '0000001123', title: Rk, titleFull: '' }, { id: 19340, natcomid: '0011447788', title: Е, titleFull: '' }, { id: 19341, natcomid: '0033669988', title: 'Компанийка в Одессочке', titleFull: '' }, { id: 19342, natcomid: '', title: 'Корпорация, Корп', titleFull: '' }, { id: 19343, natcomid: '', title: 'Ка, Корп', titleFull: '' }, { id: 19344, natcomid: '', title: ', ДП', titleFull: '' }, { id: 19364, natcomid: '', title: 'Жучок, ЧЛ', titleFull: '' }, { id: 19381, natcomid: '', title: 'Soumen katu, ЧЛ', titleFull: '' }, { id: 19382, natcomid: '', title: 'Ислашка, ЧЛ', titleFull: '' }, { id: 19383, natcomid: '', title: 'Мизури!, ЧЛ', titleFull: '' }, { id: 19384, natcomid: '', title: 'Oesterreich, ЧЛ', titleFull: '' }, { id: 19386, natcomid: '', title: 'Калгари Тауэр, ЧЛ', titleFull: '' }, { id: 5430, natcomid: '39469994', title: Киев, titleFull: '' }, { id: 2452, natcomid: '3568803982', title: '1', titleFull: '' }, { id: 19388, natcomid: '', title: '..., ЧЛ', titleFull: '' }, { id: 19389, natcomid: '', title: 'Кисса, ЧЛ', titleFull: '' }, { id: 19390, natcomid: '', title: 'КОшак, ЧЛ', titleFull: '' }, { id: 19391, natcomid: '', title: 'Жванык, ЧЛ', titleFull: '' }, { id: 19392, natcomid: '', title: 'Жашка, ЧЛ', titleFull: '' }, { id: 19393, natcomid: '', title: 'ячвчц у, ЧЛ', titleFull: '' }, { id: 19394, natcomid: '', title: 'счвв, ЧЛ', titleFull: '' }, { id: 19395, natcomid: '', title: 'Мняфге, ЧЛ', titleFull: '' }, { id: 19396, natcomid: '', title: 'Няшка, ЧЛ', titleFull: '' }, { id: 19397, natcomid: '', title: 'Ketu, ЧЛ', titleFull: '' }, { id: 19398, natcomid: '', title: 'Домик, ЧЛ', titleFull: '' }, { id: 19399, natcomid: '', title: 'Зорька, ЧЛ', titleFull: '' }, { id: 19376, natcomid: '', title: 'Тестик, ЧЛ', titleFull: 'Тестик, Частное лицо' }, { id: 19400, natcomid: '', title: 'Общажка, ЧЛ', titleFull: '' }, { id: 19401, natcomid: '', title: 'Котик-бегемотик, ЧЛ', titleFull: '' }, { id: 19402, natcomid: '', title: 'Бяка, ЧЛ', titleFull: '' }, { id: 19373, natcomid: '', title: 'согласно заявке', titleFull: '' }, { id: 571, natcomid: 899фывоиирфоыв, title: 'тестовая, АО', titleFull: 'тестовая, Частное акционерное общество' }, { id: 19403, natcomid: '', title: 'Нячго, ЧЛ', titleFull: '' }, { id: 19404, natcomid: '', title: 'Морько, ЧЛ', titleFull: '' }, { id: 19405, natcomid: '876543215', title: 'Котик, ЧЛ', titleFull: '' }, { id: 19406, natcomid: '', title: авфыа, titleFull: '' }, { id: 19407, natcomid: '', title: афвы, titleFull: '' }, { id: 19409, natcomid: '', title: ло, titleFull: '' }, { id: 19410, natcomid: '', title: 'Манька, ЧЛ', titleFull: '' }, { id: 19411, natcomid: '', title: Ванька, titleFull: '' }, { id: 19424, natcomid: '', title: 'Компашкес, ЧЛ', titleFull: '' }, { id: 19425, natcomid: '', title: 'Тустаньчик, ЧЛ', titleFull: '' }, { id: 19443, natcomid: '', title: 'Ремонтик, ЧЛ', titleFull: '' }, { id: 19447, natcomid: '', title: 'Кошка, ЧЛ', titleFull: '' }, { id: 19458, natcomid: '', title: 'Котичек, ЧЛ', titleFull: '' }, { id: 19459, natcomid: '', title: 'Мимими, ЧЛ', titleFull: '' }, { id: 19462, natcomid: '', title: 'Волынянка, ЧЛ', titleFull: '' }, { id: 19463, natcomid: '', title: 'Ня, ЧЛ', titleFull: '' }, { id: 19464, natcomid: '', title: 'Креведго, ЧЛ', titleFull: '' }, { id: 19467, natcomid: '', title: 'Няняня, ЧЛ', titleFull: '' }, { id: 19468, natcomid: '', title: 'Саф, ЧЛ', titleFull: '' }, { id: 5435, natcomid: '', title: 'Парам, ЧЛ', titleFull: '' }, { id: 19470, natcomid: '', title: 'Изба, ЧЛ', titleFull: '' }, { id: 19472, natcomid: '', title: 'Офис, ТОВ', titleFull: '' }, { id: 19473, natcomid: '', title: 'алкомаркет, ТОВ', titleFull: '' }, { id: 19486, natcomid: '', title: 'Равиолька, ЧЛ', titleFull: '' }, { id: 19487, natcomid: '', title: 'Кротик, ЧЛ', titleFull: '' }, { id: 19489, natcomid: '', title: 'Предприятие Кавычка, ЧЛ', titleFull: '' }, { id: 19502, natcomid: '', title: 'Рассейка, LTD', titleFull: '' }, { id: 19504, natcomid: '', title: ВВЛ, titleFull: '' }, { id: 19505, natcomid: '', title: 'Винницкая птицефабрика', titleFull: '' }, { id: 19506, natcomid: '', title: МПФРЛЦекспорт, titleFull: '' }, { id: 19507, natcomid: '', title: PFL, titleFull: '' }, { id: 19575, natcomid: '', title: 'Ровно тест', titleFull: '' }, { id: 19591, natcomid: '', title: Юнит, titleFull: '' }, { id: 19615, natcomid: '', title: 'Студия Лебедева', titleFull: '' }, { id: 19616, natcomid: '', title: тут, titleFull: '' }, { id: 678720, natcomid: '', title: Ровноснаб, titleFull: '' }, { id: 678787, natcomid: '', title: 'около, тест', titleFull: '' }, { id: 2974, natcomid: '', title: МХП, titleFull: '' }, { id: 678881, natcomid: '', title: СОХ, titleFull: '' }, { id: 678884, natcomid: '', title: 'Sukano AG', titleFull: '' }, { id: 19587, natcomid: '12345', title: 'ТОВ Надя', titleFull: '' }, { id: 678958, natcomid: '', title: '123456', titleFull: '' }, { id: 679136, natcomid: '', title: Жлоб, titleFull: '' }, { id: 679137, natcomid: '', title: 'Моряк, LTD', titleFull: '' }, { id: 5432, natcomid: '', title: Совтес, titleFull: '' }, { id: 679161, natcomid: '', title: Раб, titleFull: '' }, { id: 679412, natcomid: '', title: Кафе, titleFull: '' }, { id: 19449, natcomid: '', title: Школа, titleFull: '' }, { id: 679413, natcomid: '', title: Кавярня, titleFull: '' }, { id: 679414, natcomid: '', title: Книгарня, titleFull: '' }, { id: 679415, natcomid: '', title: Спа-салон, titleFull: '' }, { id: 679872, natcomid: '', title: Моряк, titleFull: '' }, { id: 679746, natcomid: '', title: Бугай, titleFull: '' }, { id: 680697, natcomid: '22334455', title: 'Контора, LTD', titleFull: '' }, { id: 680698, natcomid: '', title: Совтек, titleFull: '' }, { id: 405, natcomid: '37534432', title: 'Енотик, ЧЛ', titleFull: Енотичек }, { id: 402, natcomid: '3053508595', title: 'ОТО, ПАО', titleFull: 'ОТО, Публичное акционерное общество' }, { id: 681410, natcomid: '3227002595', title: Бугай, titleFull: '' }, { id: 681434, natcomid: '41444125', title: олдіідідід, titleFull: '' }, { id: 681433, natcomid: '31826484', title: татата, titleFull: '' }, { id: 682023, natcomid: '3294211325', title: 'ТОВ РУШ 32007740', titleFull: '' }, { id: 17895, natcomid: '36071694', title: ТРАНС-АТЛАС, titleFull: '' }, { id: 2073, natcomid: '35917412', title: 'Транс-Логiстик, ТОВ', titleFull: 'Транс-Логiстик, Товариство з Обмеженою Відповідальностю' }, { id: 682382, natcomid: '397400637', title: Моряк, titleFull: '' }, { id: 682763, natcomid: '434554324', title: Моряк, titleFull: '' }, { id: 1482, natcomid: '21496904', title: 'Агротеп, LTD', titleFull: 'Агротеп, Общество с ограниченной ответственностью' }, { id: 682782, natcomid: '3753443244', title: Моряк, titleFull: '' }, { id: 682803, natcomid: '12345546236', title: 'Тестер Кладовщик', titleFull: '' }, { id: 682832, natcomid: 45реввпр566уу4, title: Моряк, titleFull: '' }, { id: 679768, natcomid: '', title: 'INSTAL PROJEKT  Gawlowscy, Scierzynscy Spolka Jawna', titleFull: '' }, { id: 682750, natcomid: '', title: Агросем, titleFull: '' }, { id: 682957, natcomid: '37534432768678', title: Тест, titleFull: '' }, { id: 682968, natcomid: 5е3е34е634е, title: Моряк, titleFull: '' }, { id: 682969, natcomid: '3591741265564', title: Бугай, titleFull: '' }, { id: 682970, natcomid: 34н45гц4гн4, title: Жлоб, titleFull: '' }, { id: 682981, natcomid: '546789876543', title: Моряк, titleFull: '' }, { id: 682982, natcomid: п7ап47цп73, title: мотор, titleFull: '' }, { id: 678728, natcomid: '', title: Агромат, titleFull: '' }, { id: 683005, natcomid: '', title: '"Агромат" м. Львів,Дуля І,Покупець,САЛОН АРХІТЕКТУРА БУДІВНИЦТВО ДИЗАЙН ТОВ,Пелешко Л.З. ФОП,Коваль О.,Кончікова Т.М. ФОП', titleFull: '' }, { id: 683055, natcomid: '', title: 'дом Колотушкина', titleFull: '' }, { id: 683056, natcomid: '', title: 'дом культуры', titleFull: '' }, { id: 683261, natcomid: '', title: 'Vinicola CASTELLO DI LOZZOLO dei Fratelli Berteletti s.r.l.', titleFull: '' }, { id: 683275, natcomid: 5щ4групу, title: Моряк, titleFull: '' }, { id: 829448, natcomid: iuygbno987tgnko9876tg, title: 'unit mega city "quote"', titleFull: '' }, { id: 829450, natcomid: 1234567890йцукен, title: Бадрак, titleFull: '' }, { id: 829451, natcomid: 3g753g44j32, title: 'Одна и та же', titleFull: '' }, { id: 829452, natcomid: 36071694ат, title: 'Одна и та же', titleFull: '' }, { id: 829453, natcomid: 36474рукр, title: Моряк, titleFull: '' }, { id: 829454, natcomid: 34е3п3, title: Моряк, titleFull: '' }, { id: 19461, natcomid: '', title: 'Мняг!, ЧЛ', titleFull: '' }, { id: 1299, natcomid: '30487219', title: 'АТБ-Маркет, ТОВ', titleFull: '' }, { id: 834776, natcomid: null, title: 'Noyon Uul Erdene” LLC', titleFull: '' }, { id: 834777, natcomid: '39195657', title: 'ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ ЄВРО-АЗІАТСЬКА ЛОГІСТИЧНА КОМПАНІЯ', titleFull: '' }, { id: 834787, natcomid: null, title: 'Noyon Uul Erdene LLC', titleFull: '' }, { id: 835254, natcomid: null, title: 'INSTAL PROJEKT Gawlowscy, Scierzynscy Spolka Jawna', titleFull: '' }, { id: 679004, natcomid: '81926763', title: 'МонтажЛифтТекстильЛизинг, LTD', titleFull: '' }, { id: 679002, natcomid: '24026833', title: 'МеталРос, LTD', titleFull: '' }, { id: 679005, natcomid: '70121803', title: 'Восток, Корп', titleFull: '' }, { id: 679003, natcomid: '25272710', title: 'Мотор, ПАО', titleFull: '' }, { id: 679006, natcomid: '80759553', title: 'ОблПив, ТОВ', titleFull: '' }], status: success }
                'Success (byCountry passed)':
                  value: { data: [{ id: 1855, natcomid: '', title: 'Брендсорс, LTD', titleFull: '' }, { id: 1857, natcomid: '', title: 'Лорейн, ДП', titleFull: '' }, { id: 1858, natcomid: '', title: 'Ремкомплект, LTD', titleFull: '' }, { id: 1865, natcomid: '', title: 'Отправка, LTD', titleFull: '' }, { id: 5382, natcomid: '000000', title: Москалики, titleFull: '' }, { id: 5383, natcomid: '62896254', title: Кит, titleFull: '' }, { id: 5388, natcomid: '14708458', title: 'Бэби, ЧАО', titleFull: '' }, { id: 19615, natcomid: '', title: 'Slava Ukraini', titleFull: '' }, { id: 19616, natcomid: '', title: тут, titleFull: '' }, { id: 679746, natcomid: '', title: Бугай, titleFull: '' }, { id: 682957, natcomid: '37534432768678', title: Тест, titleFull: '' }, { id: 679004, natcomid: '81926763', title: 'МонтажЛифтТекстильЛизинг, LTD', titleFull: '' }, { id: 679002, natcomid: '24026833', title: 'МеталРос, LTD', titleFull: '' }, { id: 679005, natcomid: '70121803', title: 'Восток, Корп', titleFull: '' }, { id: 679003, natcomid: '25272710', title: 'Мотор, ПАО', titleFull: '' }, { id: 679006, natcomid: '80759553', title: 'ОблПив, ТОВ', titleFull: '' }], status: success }
                'Success (byRegion passed)':
                  value: { data: [{ id: 572, natcomid: '1231l2knk 123', title: 'testing, АО', titleFull: 'testing, Частное акционерное общество' }, { id: 2207, natcomid: '', title: 'Укринвестрой, ГП', titleFull: '' }, { id: 2461, natcomid: '', title: 'Свинтус, МЧП', titleFull: '' }, { id: 3, natcomid: '39028162', title: 'ТОВ СОВТЕС', titleFull: 'ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ СОВТЕС' }, { id: 50, natcomid: '1', title: 'Либра Транс, ТОВ', titleFull: 'Либра Транс, ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ' }, { id: 852, natcomid: '12345678', title: 'Ужгород Импекс Стар, ЧП', titleFull: '' }, { id: 5389, natcomid: '00411938', title: 'Монстры, Корп', titleFull: '' }, { id: 5423, natcomid: '02174626', title: 'Компания без формы', titleFull: '' }, { id: 5453, natcomid: '', title: Кожушок, titleFull: '' }, { id: 5366, natcomid: '', title: Компания, titleFull: '' }, { id: 5466, natcomid: '9966330022', title: бма, titleFull: '' }, { id: 19340, natcomid: '0011447788', title: Е, titleFull: '' }, { id: 19463, natcomid: '', title: 'Ня, ЧЛ', titleFull: '' }, { id: 19505, natcomid: '', title: 'Винницкая птицефабрика', titleFull: '' }, { id: 405, natcomid: '37534432', title: 'Енотик, ЧЛ', titleFull: Енотичек }], status: success }
                'Success (byTown passed)':
                  value: { data: [{ id: 60, natcomid: '36058799', title: 'Киевский РФ, ПП', titleFull: 'Киевский РФ, ПП' }, { id: 781, natcomid: '10029029', title: 'Берг, LTD', titleFull: 'Берг, limited' }, { id: 3, natcomid: '39028162', title: 'ТОВ СОВТЕС', titleFull: 'ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ СОВТЕС' }, { id: 828, natcomid: '', title: 'Стартап.уа, ТОВ', titleFull: 'Стартап.уа, ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ' }, { id: 857, natcomid: '2232323', title: 'ДБО, LTD', titleFull: '' }, { id: 4454, natcomid: '', title: 'Рубероид, LTD', titleFull: '' }, { id: 1944, natcomid: '', title: 'Киевская таможня', titleFull: '' }, { id: 5365, natcomid: '01010110', title: 'Империал групп Украина, LTD', titleFull: '' }, { id: 5372, natcomid: 'Компания Правды  ЕГРПОУ', title: 'Компания Правды', titleFull: '' }, { id: 5377, natcomid: '23232', title: '23323', titleFull: '' }, { id: 5378, natcomid: '8857678', title: 'Совтес, LTD', titleFull: '' }, { id: 4469, natcomid: '', title: Киев, titleFull: '' }, { id: 5379, natcomid: '', title: 'лукоц, LTD', titleFull: '' }, { id: 5431, natcomid: '', title: 'Оболонь, ПАО', titleFull: '' }, { id: 5437, natcomid: '0369258147', title: ьи, titleFull: '' }, { id: 5469, natcomid: '', title: 'Частное лицо, ЧЛ', titleFull: '' }, { id: 17656, natcomid: '', title: 'Цирк, ЧЛ', titleFull: '' }, { id: 19342, natcomid: '', title: 'Корпорация, Корп', titleFull: '' }, { id: 19343, natcomid: '', title: 'Ка, Корп', titleFull: '' }, { id: 19344, natcomid: '', title: ', ДП', titleFull: '' }], status: success }
                'Success with all parameters':
                  value: { data: [{ id: 60, natcomid: '36058799', title: 'УГМК Киевский РФ, АО', titleFull: 'УГМК Киевский РФ, limitd' }, { id: 572, natcomid: '1231l2knk 123', title: 'testing, АО', titleFull: 'testing, limitd' }, { id: 781, natcomid: '10029029', title: 'Берг, ПАО', titleFull: 'Берг, limited' }, { id: 3, natcomid: '39028162', title: 'ТОВ СОВТЕС', titleFull: 'ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ СОВТЕС' }, { id: 828, natcomid: '', title: 'Стартап.уа, ltd', titleFull: 'Стартап.уа, limited' }, { id: 839, natcomid: '', title: 'ООО Траверсы', titleFull: '' }, { id: 857, natcomid: '2232323', title: 'ДБО, ООО', titleFull: '' }, { id: 1815, natcomid: '1258756489', title: 'Зеланд, ЧП', titleFull: '' }, { id: 1855, natcomid: '', title: 'Брендсорс, ООО', titleFull: '' }, { id: 1857, natcomid: '', title: 'Лорейн, ДП', titleFull: '' }, { id: 1858, natcomid: '', title: 'Ремкомплект, ЗАО', titleFull: '' }, { id: 1865, natcomid: '', title: 'Отправка, ООО', titleFull: '' }, { id: 1941, natcomid: '', title: 'Таможня 1', titleFull: '' }, { id: 1942, natcomid: '', title: 'Floha Logistic', titleFull: '' }, { id: 1943, natcomid: '', title: 'Немецкая таможня', titleFull: '' }, { id: 1945, natcomid: '', title: 'Склад, ООО', titleFull: '' }, { id: 1946, natcomid: '', title: 'Пчелкин, СП', titleFull: '' }, { id: 2207, natcomid: '', title: 'Укринвестрой, ГП', titleFull: '' }, { id: 2288, natcomid: '', title: КремСофтСервис, titleFull: '' }, { id: 2429, natcomid: '', title: 'RAILWAY-CARRIAGE REPAIR WORKS-99 S.A.', titleFull: '' }, { id: 2461, natcomid: '', title: 'Свинтус, МЧП', titleFull: '' }, { id: 2936, natcomid: '', title: 'Sherlock Inc', titleFull: '' }, { id: 2937, natcomid: '', title: 'Bureau of Investigation', titleFull: '' }, { id: 3544, natcomid: rey, title: eary, titleFull: '' }, { id: 3545, natcomid: rstu, title: rstu, titleFull: '' }, { id: 4041, natcomid: '245145322', title: 'Вентус, ЗАО', titleFull: '' }, { id: 852, natcomid: '12345678', title: 'Ужгород Импекс Стар, ЧП', titleFull: '' }, { id: 4454, natcomid: '', title: 'Рубероид, ООО', titleFull: '' }, { id: 4455, natcomid: '', title: 'Дунай, ООО', titleFull: '' }, { id: 4458, natcomid: '', title: Рафинад, titleFull: '' }, { id: 1944, natcomid: '', title: 'Киевская таможня', titleFull: '' }, { id: 5365, natcomid: '01010110', title: 'Империал групп Украина, ООО', titleFull: '' }, { id: 5372, natcomid: 'Компания Правды  ЕГРПОУ', title: 'Компания Правды', titleFull: '' }, { id: 5377, natcomid: '23232', title: '23323', titleFull: '' }, { id: 5378, natcomid: '8857678', title: 'Совтес, ООО', titleFull: '' }, { id: 4469, natcomid: '', title: Киев, titleFull: '' }, { id: 5379, natcomid: '', title: 'лукоц, ООО', titleFull: '' }, { id: 2688, natcomid: '12', title: 'Марс, ФОП', titleFull: '' }, { id: 50, natcomid: '1', title: 'Либра Транс, ООО', titleFull: ', Общество с ограниченной ответственностью)' }, { id: 5380, natcomid: '123456789', title: 'Лісова пісня, ЧП', titleFull: '' }, { id: 5381, natcomid: '000000', title: Супермены, titleFull: '' }, { id: 5382, natcomid: '000000', title: Москалики, titleFull: '' }, { id: 5383, natcomid: '62896254', title: Кит, titleFull: '' }, { id: 5384, natcomid: '36372232', title: Ресторанчик, titleFull: '' }, { id: 5388, natcomid: '14708458', title: 'Бэби, ЧАО', titleFull: '' }, { id: 5389, natcomid: '00411938', title: 'Монстры, Корп', titleFull: '' }, { id: 5390, natcomid: '38155194', title: Главпочтамт, titleFull: '' }, { id: 5392, natcomid: '36913534', title: 'Таможенка, ЧАО', titleFull: '' }, { id: 5423, natcomid: '02174626', title: 'Компания без формы', titleFull: '' }, { id: 5424, natcomid: '', title: Зверинец, titleFull: '' }, { id: 5431, natcomid: '', title: 'Оболонь, ПАО', titleFull: '' }, { id: 5436, natcomid: '1234567890', title: Rj, titleFull: '' }, { id: 5437, natcomid: '0369258147', title: ьи, titleFull: '' }, { id: 5444, natcomid: '', title: 'Днепропетровский таможенный пост, ЧЛ', titleFull: '' }, { id: 3001, natcomid: '', title: 'Z.I.des Hauts Sarts', titleFull: '' }, { id: 3000, natcomid: '', title: 'Arcelor Mittal Ringmill Zoning Industriel CMI,', titleFull: '' }, { id: 5453, natcomid: '', title: Кожушок, titleFull: '' }, { id: 5454, natcomid: '', title: а, titleFull: '' }, { id: 5366, natcomid: '', title: Компания, titleFull: '' }, { id: 5455, natcomid: '', title: Таможенка, titleFull: '' }, { id: 5465, natcomid: '7744556622', title: тат, titleFull: '' }, { id: 5466, natcomid: '9966330022', title: бма, titleFull: '' }, { id: 5467, natcomid: '0033115588', title: 'Таможня в Маяках', titleFull: '' }, { id: 5468, natcomid: '9955117700', title: 'Тирас (Маяки, Паланка)', titleFull: '' }, { id: 5469, natcomid: '', title: 'Частное лицо, ЧЛ', titleFull: '' }, { id: 17656, natcomid: '', title: 'Цирк, ЧЛ', titleFull: '' }, { id: 19335, natcomid: '0369852014', title: Company, titleFull: '' }, { id: 19336, natcomid: '3698520147', title: 'Svb tr', titleFull: '' }, { id: 19339, natcomid: '0000001123', title: Rk, titleFull: '' }, { id: 19340, natcomid: '0011447788', title: Е, titleFull: '' }, { id: 19341, natcomid: '0033669988', title: 'Компанийка в Одессочке', titleFull: '' }, { id: 19342, natcomid: '', title: 'Корпорация, Корп', titleFull: '' }, { id: 19343, natcomid: '', title: 'Ка, Корп', titleFull: '' }, { id: 19344, natcomid: '', title: ', ДП', titleFull: '' }, { id: 19364, natcomid: '', title: 'Жучок, ЧЛ', titleFull: '' }, { id: 19381, natcomid: '', title: 'Soumen katu, ЧЛ', titleFull: '' }, { id: 19382, natcomid: '', title: 'Ислашка, ЧЛ', titleFull: '' }, { id: 19383, natcomid: '', title: 'Мизури!, ЧЛ', titleFull: '' }, { id: 19384, natcomid: '', title: 'Oesterreich, ЧЛ', titleFull: '' }, { id: 19386, natcomid: '', title: 'Калгари Тауэр, ЧЛ', titleFull: '' }, { id: 5430, natcomid: '39469994', title: Киев, titleFull: '' }, { id: 2452, natcomid: '3568803982', title: '1', titleFull: '' }, { id: 19388, natcomid: '', title: '..., ЧЛ', titleFull: '' }, { id: 19389, natcomid: '', title: 'Кисса, ЧЛ', titleFull: '' }, { id: 19390, natcomid: '', title: 'КОшак, ЧЛ', titleFull: '' }, { id: 19391, natcomid: '', title: 'Жванык, ЧЛ', titleFull: '' }, { id: 19392, natcomid: '', title: 'Жашка, ЧЛ', titleFull: '' }, { id: 19393, natcomid: '', title: 'ячвчц у, ЧЛ', titleFull: '' }, { id: 19394, natcomid: '', title: 'счвв, ЧЛ', titleFull: '' }, { id: 19395, natcomid: '', title: 'Мняфге, ЧЛ', titleFull: '' }, { id: 19396, natcomid: '', title: 'Няшка, ЧЛ', titleFull: '' }, { id: 19397, natcomid: '', title: 'Ketu, ЧЛ', titleFull: '' }, { id: 19398, natcomid: '', title: 'Домик, ЧЛ', titleFull: '' }, { id: 19399, natcomid: '', title: 'Зорька, ЧЛ', titleFull: '' }, { id: 19376, natcomid: '', title: 'Тестик, ЧЛ', titleFull: 'Тестик, Частное лицо' }, { id: 19400, natcomid: '', title: 'Общажка, ЧЛ', titleFull: '' }, { id: 19401, natcomid: '', title: 'Котик-бегемотик, ЧЛ', titleFull: '' }, { id: 19402, natcomid: '', title: 'Бяка, ЧЛ', titleFull: '' }, { id: 19373, natcomid: '', title: 'согласно заявке', titleFull: '' }, { id: 571, natcomid: 899фывоиирфоыв, title: 'тестовая, АО', titleFull: 'тестовая, limitd' }, { id: 19403, natcomid: '', title: 'Нячго, ЧЛ', titleFull: '' }, { id: 19404, natcomid: '', title: 'Морько, ЧЛ', titleFull: '' }, { id: 19405, natcomid: '876543215', title: 'Котик, ЧЛ', titleFull: '' }, { id: 19406, natcomid: '', title: авфыа, titleFull: '' }, { id: 19407, natcomid: '', title: афвы, titleFull: '' }, { id: 19409, natcomid: '', title: ло, titleFull: '' }, { id: 19410, natcomid: '', title: 'Манька, ЧЛ', titleFull: '' }, { id: 19411, natcomid: '', title: Ванька, titleFull: '' }, { id: 19424, natcomid: '', title: 'Компашкес, ЧЛ', titleFull: '' }, { id: 19425, natcomid: '', title: 'Тустаньчик, ЧЛ', titleFull: '' }, { id: 19443, natcomid: '', title: 'Ремонтик, ЧЛ', titleFull: '' }, { id: 19447, natcomid: '', title: 'Кошка, ЧЛ', titleFull: '' }, { id: 19458, natcomid: '', title: 'Котичек, ЧЛ', titleFull: '' }, { id: 19459, natcomid: '', title: 'Мимими, ЧЛ', titleFull: '' }, { id: 19462, natcomid: '', title: 'Волынянка, ЧЛ', titleFull: '' }, { id: 19463, natcomid: '', title: 'Ня, ЧЛ', titleFull: '' }, { id: 19464, natcomid: '', title: 'Креведго, ЧЛ', titleFull: '' }, { id: 19467, natcomid: '', title: 'Няняня, ЧЛ', titleFull: '' }, { id: 19468, natcomid: '', title: 'Саф, ЧЛ', titleFull: '' }, { id: 5435, natcomid: '', title: 'Парам, ЧЛ', titleFull: '' }, { id: 19470, natcomid: '', title: 'Изба, ЧЛ', titleFull: '' }, { id: 19472, natcomid: '', title: 'Офис, ТОВ', titleFull: '' }, { id: 19473, natcomid: '', title: 'алкомаркет, ТОВ', titleFull: '' }, { id: 19486, natcomid: '', title: 'Равиолька, ЧЛ', titleFull: '' }, { id: 19487, natcomid: '', title: 'Кротик, ЧЛ', titleFull: '' }, { id: 19489, natcomid: '', title: 'Предприятие Кавычка, ЧЛ', titleFull: '' }, { id: 19502, natcomid: '', title: 'Рассейка, ЗАО', titleFull: '' }, { id: 19504, natcomid: '', title: ВВЛ, titleFull: '' }, { id: 19505, natcomid: '', title: 'Винницкая птицефабрика', titleFull: '' }, { id: 19506, natcomid: '', title: МПФРЛЦекспорт, titleFull: '' }, { id: 19507, natcomid: '', title: PFL, titleFull: '' }, { id: 19575, natcomid: '', title: 'Ровно тест', titleFull: '' }, { id: 19591, natcomid: '', title: Юнит, titleFull: '' }, { id: 19615, natcomid: '', title: 'Студия Лебедева', titleFull: '' }, { id: 19616, natcomid: '', title: тут, titleFull: '' }, { id: 678720, natcomid: '', title: Ровноснаб, titleFull: '' }, { id: 678787, natcomid: '', title: 'около, тест', titleFull: '' }, { id: 2974, natcomid: '', title: МХП, titleFull: '' }, { id: 678881, natcomid: '', title: СОХ, titleFull: '' }, { id: 678884, natcomid: '', title: 'Sukano AG', titleFull: '' }, { id: 19587, natcomid: '12345', title: 'ТОВ Надя', titleFull: '' }, { id: 678958, natcomid: '', title: '123456', titleFull: '' }, { id: 679136, natcomid: '', title: Жлоб, titleFull: '' }, { id: 679137, natcomid: '', title: 'Моряк, ЗАО', titleFull: '' }, { id: 5432, natcomid: '', title: Совтес, titleFull: '' }, { id: 679161, natcomid: '', title: Раб, titleFull: '' }, { id: 679412, natcomid: '', title: Кафе, titleFull: '' }, { id: 19449, natcomid: '', title: Школа, titleFull: '' }, { id: 679413, natcomid: '', title: Кавярня, titleFull: '' }, { id: 679414, natcomid: '', title: Книгарня, titleFull: '' }, { id: 679415, natcomid: '', title: Спа-салон, titleFull: '' }, { id: 679872, natcomid: '', title: Моряк, titleFull: '' }, { id: 679746, natcomid: '', title: Бугай, titleFull: '' }, { id: 680697, natcomid: '22334455', title: 'Контора, ЗАО', titleFull: '' }, { id: 680698, natcomid: '', title: Совтек, titleFull: '' }, { id: 405, natcomid: '37534432', title: 'Енотик, ЧЛ', titleFull: Енотичек }, { id: 402, natcomid: '3053508595', title: 'ОТО, ПАО', titleFull: 'ОТО, limited' }, { id: 681410, natcomid: '3227002595', title: Бугай, titleFull: '' }, { id: 681434, natcomid: '41444125', title: олдіідідід, titleFull: '' }, { id: 681433, natcomid: '31826484', title: татата, titleFull: '' }, { id: 682023, natcomid: '3294211325', title: 'ТОВ РУШ 32007740', titleFull: '' }, { id: 17895, natcomid: '36071694', title: ТРАНС-АТЛАС, titleFull: '' }, { id: 2073, natcomid: '35917412', title: 'Транс-Логiстик, ТОВ', titleFull: 'Транс-Логiстик, Товариство з Обмеженою Відповідальностю' }, { id: 682382, natcomid: '397400637', title: Моряк, titleFull: '' }, { id: 682763, natcomid: '434554324', title: Моряк, titleFull: '' }, { id: 1482, natcomid: '21496904', title: 'Агротеп, ООО', titleFull: 'Агротеп, Общество с ограниченной ответственностью' }, { id: 682782, natcomid: '3753443244', title: Моряк, titleFull: '' }, { id: 682803, natcomid: '12345546236', title: 'Тестер Кладовщик', titleFull: '' }, { id: 682832, natcomid: 45реввпр566уу4, title: Моряк, titleFull: '' }, { id: 679768, natcomid: '', title: 'INSTAL PROJEKT  Gawlowscy, Scierzynscy Spolka Jawna', titleFull: '' }, { id: 682750, natcomid: '', title: Агросем, titleFull: '' }, { id: 682957, natcomid: '37534432768678', title: Тест, titleFull: '' }, { id: 682968, natcomid: 5е3е34е634е, title: Моряк, titleFull: '' }, { id: 682969, natcomid: '3591741265564', title: Бугай, titleFull: '' }, { id: 682970, natcomid: 34н45гц4гн4, title: Жлоб, titleFull: '' }, { id: 682981, natcomid: '546789876543', title: Моряк, titleFull: '' }, { id: 682982, natcomid: п7ап47цп73, title: мотор, titleFull: '' }, { id: 678728, natcomid: '', title: Агромат, titleFull: '' }, { id: 683005, natcomid: '', title: '"Агромат" м. Львів,Дуля І,Покупець,САЛОН АРХІТЕКТУРА БУДІВНИЦТВО ДИЗАЙН ТОВ,Пелешко Л.З. ФОП,Коваль О.,Кончікова Т.М. ФОП', titleFull: '' }, { id: 683055, natcomid: '', title: 'дом Колотушкина', titleFull: '' }, { id: 683056, natcomid: '', title: 'дом культуры', titleFull: '' }, { id: 683261, natcomid: '', title: 'Vinicola CASTELLO DI LOZZOLO dei Fratelli Berteletti s.r.l.', titleFull: '' }, { id: 683275, natcomid: 5щ4групу, title: Моряк, titleFull: '' }, { id: 829448, natcomid: iuygbno987tgnko9876tg, title: 'unit mega city "quote"', titleFull: '' }, { id: 829450, natcomid: 1234567890йцукен, title: Бадрак, titleFull: '' }, { id: 829451, natcomid: 3g753g44j32, title: 'Одна и та же', titleFull: '' }, { id: 829452, natcomid: 36071694ат, title: 'Одна и та же', titleFull: '' }, { id: 829453, natcomid: 36474рукр, title: Моряк, titleFull: '' }, { id: 829454, natcomid: 34е3п3, title: Моряк, titleFull: '' }, { id: 19461, natcomid: '', title: 'Мняг!, ЧЛ', titleFull: '' }, { id: 1299, natcomid: '30487219', title: 'АТБ-Маркет, ТОВ', titleFull: '' }, { id: 834776, natcomid: null, title: 'Noyon Uul Erdene” LLC', titleFull: '' }, { id: 834777, natcomid: '39195657', title: 'ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ ЄВРО-АЗІАТСЬКА ЛОГІСТИЧНА КОМПАНІЯ', titleFull: '' }, { id: 834787, natcomid: null, title: 'Noyon Uul Erdene LLC', titleFull: '' }, { id: 835254, natcomid: null, title: 'INSTAL PROJEKT Gawlowscy, Scierzynscy Spolka Jawna', titleFull: '' }, { id: 679004, natcomid: '81926763', title: 'МонтажЛифтТекстильЛизинг, ООО', titleFull: '' }, { id: 679002, natcomid: '24026833', title: 'МеталРос, ООО', titleFull: '' }, { id: 679005, natcomid: '70121803', title: 'Восток, Корп', titleFull: '' }, { id: 679003, natcomid: '25272710', title: 'Мотор, ПАО', titleFull: '' }, { id: 679006, natcomid: '80759553', title: 'ОблПив, ТОВ', titleFull: '' }], status: success }
        400:
          description: 'No parameters passed'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Parameters missing' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'No parameters passed':
                  value: { message: 'Parameters missing', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/addCheckpoint:
    post:
      tags:
        - 'Routes & tenders / Shippers / Stops'
      summary: 'Create Stop'
      description: 'Create Stop'
      operationId: createStop
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            examples:
              'Create Stop':
                value: |-
                  {
                    "town-string": "Запоріжжя",
                    "town": "69061* Запоріжжя, Запорізька область",
                    "company": "Test company",
                    "address": "Бородинская, 221",

                  //optional
                    "longit": "35.0691465",
                    "latit": "47.8892067",
                    "googleplaceid": "ChIJA7uF-j1n3EARSj9NB9lcZ34",
                    "country-code": "UA",
                    "customs": "1",
                    "natcomid": "123444",
                    "apicode": "11234",
                    "cellnum": "+380501234567",
                    "flag": "1"
                  }
      responses:
        200:
          description: ''
  /a/v2/rest/public/updateCheckpoint:
    post:
      tags:
        - 'Routes & tenders / Shippers / Stops'
      summary: 'Update Stop'
      description: 'Update Stop'
      operationId: updateStop
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                address:
                  type: string
                  example: 'ул. Промышленная, 32'
                apicode:
                  type: string
                  example: '584622'
                id:
                  type: number
                  example: 36535
                latit:
                  type: string
                  example: '48.471820100000000'
                longit:
                  type: string
                  example: '34.017777500000000'
                radius_km:
                  type: string
                  example: '0.5'
                technote:
                  type: string
                  example: '1111'
            examples:
              'Update Stop':
                value:
                  address: 'ул. Промышленная, 32'
                  apicode: '584622'
                  id: 36535
                  latit: '48.471820100000000'
                  longit: '34.017777500000000'
                  radius_km: '0.5'
                  technote: '1111'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getCheckpointContactData:
    get:
      tags:
        - 'Routes & tenders / Shippers / Stops'
      summary: 'Get Stop Contacts'
      description: |-
        Returns the contact data of the single loading, unloading or customs checkpoint.

        - if successful you will receive contact data of the single loading, unloading or customs checkpoint
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Only for Shippers
      operationId: getStopContacts
      parameters:
        -
          name: checkpoint
          in: query
          schema:
            type: string
            example: '{{checkpoint}}'
          description: 'Required int. id of the loading, unloading or customs checkpoint'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { cellnum: { type: string, example: '' }, checkpoint: { type: number, example: 44 }, contactperson: { type: string, example: 'John Smith' }, email: { type: string, example: john.smith@example.com }, faxnum: { type: string, example: '02070000002' }, id: { type: number, example: 44 }, remark: { type: string, example: '' }, telnum: { type: string, example: '02070000001' } } }, example: [{ cellnum: '', checkpoint: 44, contactperson: 'John Smith', email: john.smith@example.com, faxnum: '02070000002', id: 44, remark: '', telnum: '02070000001' }, { cellnum: '447700000000', checkpoint: 44, contactperson: 'Alice Johnson', email: alice.johnson@example.com, faxnum: '447700000002', id: 641, remark: '', telnum: '447700000001' }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ cellnum: '', checkpoint: 44, contactperson: 'John Smith', email: john.smith@example.com, faxnum: '02070000002', id: 44, remark: '', telnum: '02070000001' }, { cellnum: '447700000000', checkpoint: 44, contactperson: 'Alice Johnson', email: alice.johnson@example.com, faxnum: '447700000002', id: 641, remark: '', telnum: '447700000001' }], status: success }
        400:
          description: 'Request by carrier'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Action not available' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Request by carrier':
                  value: { message: 'Action not available', relogin: false, status: error }
  /a/v2/rest/public/addCheckpointcontactdata:
    post:
      tags:
        - 'Routes & tenders / Shippers / Stops'
      summary: 'Create Stop Contact'
      description: 'Create Stop Contact'
      operationId: createStopContact
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cellnum:
                  type: string
                  example: '+380501234567'
                checkpoint:
                  type: number
                  example: 36535
                contactperson:
                  type: string
                  example: 'Contact person name'
                email:
                  type: string
                  example: test@example.com
                faxnum:
                  type: string
                  example: '+380501234567'
                remark:
                  type: string
                  example: 'Remark text'
                telnum:
                  type: string
                  example: '+380501234567'
            examples:
              'Create Stop Contact':
                value:
                  cellnum: '+380501234567'
                  checkpoint: 36535
                  contactperson: 'Contact person name'
                  email: test@example.com
                  faxnum: '+380501234567'
                  remark: 'Remark text'
                  telnum: '+380501234567'
      responses:
        200:
          description: ''
  /a/v2/rest/public/softDeleteCheckpointcontactdata:
    post:
      tags:
        - 'Routes & tenders / Shippers / Stops'
      summary: 'Delete Stop Contact'
      description: 'Delete Stop Contact'
      operationId: deleteStopContact
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: number
                  example: 197774
            examples:
              'Delete Stop Contact':
                value:
                  id: 197774
      responses:
        200:
          description: ''
  /a/v2/rest/public/pricequote:
    post:
      tags:
        - 'Routes & tenders / Carriers / Tenders'
      summary: 'Submit Tender Bid'
      description: |-
        This endpoint is used to submit a price quote for a tender. It allows users to provide pricing information for a specific route.

          
        Upon receiving the request, the system generates a price quote based on the provided details.

        - Upon successful submission of the price quote, the system processes the request and generates the corresponding price quote.
        - If any required parameter is missing or invalid, the system returns an error response indicating the specific issue.
        - In case of no response, clients should verify their network connectivity and resend the request if necessary. Additionally, they may contact the service provider for further assistance.
      operationId: submitTenderBid
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                loadquote:
                  description: 'String. Required. The loadquote.'
                  type: string
                  example: '1'
                pricequote:
                  description: 'String. Required. The pricequote.'
                  type: string
                  example: '3000'
                route:
                  description: 'String. Required. The identifier of the route.'
                  type: string
                  example: '{{singleRoute}}'
      responses:
        200:
          description: Succeess
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Succeess:
                  value: { data: [], status: success }
        400:
          description: 'Missing pricequote'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'The bid is empty.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Missing pricequote':
                  value: { message: 'The bid is empty.', relogin: false, status: error }
        403:
          description: 'Missing token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is required' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Missing token':
                  value: { message: 'Token is required', relogin: true, status: error }
  /a/v2/rest/public/cancelPricequote:
    post:
      tags:
        - 'Routes & tenders / Carriers / Tenders'
      summary: 'Cancel Sealed Bid'
      description: |-
        This endpoint is used to cancel a price quote previously made in a single shot tender (blind tender).

        Cancelled bids cannot be chosen as winning. Cancelled bids can be later revived.
      operationId: cancelSealedBid
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                loadquote:
                  description: 'String. Required. The loadquote.'
                  type: string
                  example: '1'
                pricequote:
                  description: 'String. Required. The pricequote.'
                  type: string
                  example: '3000'
                route:
                  description: 'String. Required. The identifier of the route.'
                  type: string
                  example: '{{singleRoute}}'
      responses:
        200:
          description: Succeess
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Succeess:
                  value: { data: [], status: success }
        400:
          description: 'Missing pricequote'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'The bid is empty.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Missing pricequote':
                  value: { message: 'The bid is empty.', relogin: false, status: error }
        403:
          description: 'Missing token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is required' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Missing token':
                  value: { message: 'Token is required', relogin: true, status: error }
  /a/v2/rest/public/revivePricequote:
    post:
      tags:
        - 'Routes & tenders / Carriers / Tenders'
      summary: 'Reopen Sealed Bid'
      description: 'This endpoint is used to revive the cancelled price quote previously made in a single shot tender (blind tender).'
      operationId: reopenSealedBid
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                loadquote:
                  description: 'String. Required. The loadquote.'
                  type: string
                  example: '1'
                pricequote:
                  description: 'String. Required. The pricequote.'
                  type: string
                  example: '3000'
                route:
                  description: 'String. Required. The identifier of the route.'
                  type: string
                  example: '{{singleRoute}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Missing pricequote'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'The bid is empty.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Missing pricequote':
                  value: { message: 'The bid is empty.', relogin: false, status: error }
        403:
          description: 'Missing token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is required' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Missing token':
                  value: { message: 'Token is required', relogin: true, status: error }
  /a/v2/rest/public/oppositeOfferDecision:
    post:
      tags:
        - 'Routes & tenders / Carriers / Tenders'
      summary: 'Respond to Counteroffer'
      description: |-
        Allows carriers to confirm or decline an opposite offer in tender. Once the shipper issues a counter offer, carriers can decide whether to accept it or not and trigger this endpoint when the decision is made.

        Opposite offer ID can be found in the GET getPriceQuotes.
      operationId: respondToCounteroffer
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                decision:
                  description: 'yes / no'
                  type: string
                  example: 'yes'
                oppositeoffer:
                  description: 'String. Required. Opposite offer id.'
                  type: string
                  example: ''
                route:
                  description: 'Required int. Periodic of the tender'
                  type: string
                  example: '{{singleRoute}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Missing route number/opposite offer id/decision'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'No arguments were provided.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Missing route number/opposite offer id/decision':
                  value: { message: 'No arguments were provided.', relogin: false, status: error }
  /a/v2/rest/public/bookRoute:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Book Route'
      description: |-
        With this endpoint you can book a route. Default period of booking is one hour, but may vary depending on shipper preferences. When route is booked, other carriers don't have access to it

        - if successful you will book a single route
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        (!) NOTE: Can be only used by carriers,  
        only routes with status 2 (vacant) can be booked
      operationId: bookRoute
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'Required string. Id of the tender.'
                  type: string
                  example: '{{singleRoute}}'
      responses:
        202:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success: { type: string, example: 'true' }
              examples:
                Success:
                  value: { success: 'true' }
        400:
          description: 'Not allowed to book a route'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Not allowed to book a route':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/cancelBook:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Cancel Booking'
      description: |-
        With this endpoint you can cancel route booking, which was done in POST bookRoute endpoint.

        - if successful you will cancel the booking and make the route available to other carriers
            
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        (!) NOTE: Can be only used by carriers on routes that were previously booked via POST bookRoute endpoint or other UI.
      operationId: cancelBooking
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'Required string. Id of the tender.'
                  type: string
                  example: '{{singleRoute}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'No such route / Reques from shipper'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Route not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'No such route':
                  value: { message: 'Route not found', relogin: false, status: error }
                'Reques from shipper':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
  /a/v2/rest/public/offerAuto:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Propose Vehicle Assignment'
      description: |-
        This important endpoint progresses the main workflow for routes by enabling carriers to offer a truck for a specific route. Carriers can use this to propose their vehicle for a particular route.

        The availability dates for different parts of the route, along with details of the car, driver, and trailer, should be provided in the request.

        The car, driver and trailer ID's can be found in the GET getMyDrivers, GET getMyTrailers and GET getMyCars endpoints. RoutepartsDates object keys are the routepart ID's, which can found in the GET singleRoute.

        - if success you will offer an auto for a route
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        Once the vehicle is offered for the order, the shipper will receive notification and will be enabled to either accept or decline your offer.

        #### Request Body

        The request body must be in JSON format and contain the following fields:

        - **route** (string): The identifier for the specific route.
        - **routepartsDates** (object): An object where keys are route part IDs and values are the availability dates for those parts.
        - **car** (int): The ID of the car being offered.
            
        - **driver** (int): The ID of the driver being proposed.
            
        - **trailer** (int): The ID of the trailer being used.
      operationId: proposeVehicleAssignment
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                car:
                  type: string
                  example: '41068'
                driver:
                  type: string
                  example: '40034'
                route:
                  type: string
                  example: 113549040000
                routepartsDates:
                  type: object
                  properties: { 111376785: { type: string, example: 1734480000 }, 111376786: { type: string, example: 1734566400 } }
                trailer:
                  type: string
                  example: '38962'
            examples:
              'Propose Vehicle Assignment':
                value:
                  car: '41068'
                  driver: '40034'
                  route: 113549040000
                  routepartsDates: { 111376785: 1734480000, 111376786: 1734566400 }
                  trailer: '38962'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Invalid route number / Invalid driver / Invalid trailer / Changes occurred, retry needed'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Wed, 27 Mar 2024 10:15:41 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: 'nginx/1.18.0 (Ubuntu)'
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'We couldn’t find such a route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Changes occurred, retry needed':
                  value: { message: 'Changes have been made to the route—please refresh the page.', relogin: false, status: error }
                'Invalid driver':
                  value: { message: 'Driver not found.', relogin: false, status: error }
                'Invalid route number':
                  value: { message: 'We couldn’t find such a route.', relogin: false, status: error }
                'Invalid trailer':
                  value: { message: 'Trailer not found.', relogin: false, status: error }
  /a/v2/rest/public/confirmWorkOnRoute:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Confirm Assignment'
      description: |-
        This endpoint enables carriers to confirm scheduled work on a specific route, digitally sign the obligation to do the job, so to speak. Carriers can utilize this endpoint to acknowledge and confirm their commitment to completing assigned tasks for a particular route at a specified date and time.

        *   if success you will confirm your commitment to do the delivery
        *   if unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        The *routepartsDates* and *routepartsTimes* parameters hold the loading routepart ID's and can be used to indicate the estimated date and time of the arrival. Routepart ID's can be found in the GET singleRoute endpoint.

        #### Request Body

        The request body must be in JSON format and contain the following fields:

        *   **route** (string): The identifier for the specific route.
        *   **routepartsDates** (object): An object where keys are route part IDs and values are the estimated dates of arrival.
        *   **routepartsTimes** (object): An object where keys are route part IDs and values are the estimated times of arrival.
      operationId: confirmAssignment
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                route:
                  type: string
                  example: '{{singleRoute}}'
                routepartsDates:
                  type: object
                  properties: { 111381491: { type: string, example: 1609545600 } }
                routepartsTimes:
                  type: object
                  properties: { 111381491: { type: string, example: '12:00' } }
            examples:
              'Confirm Assignment':
                value:
                  route: '{{singleRoute}}'
                  routepartsDates: { 111381491: 1609545600 }
                  routepartsTimes: { 111381491: '12:00' }
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Not allowed to work on this route'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Not allowed to work on this route':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
  /a/v2/rest/public/arrivedAtCharge:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Arrived at Loading Point'
      description: |-
        Allows carriers to confirm arrival at loading.

        (!) IMPORTANT: although this endpoint is intended for carriers, shippers can also use it.

        If the car has the GPS tracker, the event is triggered automatically upon arrival.

        By default, if no routepart ID is passed, the first non-complete loading is taken as object to work on, meaning that if no routepart ID is passed, the endpoint will trigger arrival at exactly next non-complete loading.

        If routepart ID is passed, the endpoint will mark all preceding routeparts as complete and trigger change in the passed one.

        - If successful, you will receive the success message, state of the route will change, loading will be marked as "started"
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        The routepart ID can be found in GET singleRoute
      operationId: arrivedAtLoadingPoint
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'Periodic of the route. Required. String'
                  type: string
                  example: '{{singleRoute}}'
                routepart:
                  description: 'ID of the routepart. Optional. Int'
                  type: string
                  example: '{{badRoutePartId}}'
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Mon, 26 Jun 2023 14:52:39 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Bad route passed / Route is not in proper state to confirm loading / Bad routepart ID passed'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Mon, 26 Jun 2023 14:51:16 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Bad route passed':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
                'Bad routepart ID passed':
                  value: { message: 'Invalid action.', relogin: false, status: error }
                'Route is not in proper state to confirm loading':
                  value: { message: 'The route status doesn’t allow this action.', relogin: false, status: error }
  /a/v2/rest/public/forceChangeVehicle:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Force Vehicle Reassignment'
      description: 'Force Vehicle Reassignment'
      operationId: forceVehicleReassignment
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                car:
                  type: number
                  example: 111
                driver:
                  type: number
                  example: 111
                driver2:
                  type: number
                  example: 111
                periodic:
                  type: string
                  example: 1-12-23
                reason:
                  type: string
                  example: reason
                trailer:
                  type: number
                  example: 111
            examples:
              'Force Vehicle Reassignment':
                value:
                  car: 111
                  driver: 111
                  driver2: 111
                  periodic: 1-12-23
                  reason: reason
                  trailer: 111
      responses:
        200:
          description: ''
  /a/v2/rest/public/denyRoute:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Withdraw from Route'
      description: 'Withdraw from Route'
      operationId: withdrawFromRoute
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                periodic:
                  type: string
                  example: -27105321600
            examples:
              'Withdraw from Route':
                value:
                  periodic: -27105321600
      responses:
        200:
          description: ''
  /a/v2/rest/public/changeBorderCrossingTown:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Update Border Crossing Point'
      description: |-
        Allows carriers to change the border crossing points for international routes.

        Routepart ID's can be found in the GET singleRoute and the town ID's can be found in GET getTown

        *   if successful you will have successfully changed the border crossings
        *   If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        #### Request Body

        The request body must be in form-data format and contain the following fields:

        *   **route** (string): The identifier of the route. (Required)
        *   **borders** (array of objects): An array of objects where each object contains a `routepartId` and a `townId`. (Required)
      operationId: updateBorderCrossingPoint
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                borders:
                  description: 'Required. Object.'
                  type: string
                  example: |-
                    [
                       {
                          "routepartId":111384004,
                          "townId":7
                       },
                       {
                          "routepartId":111384006,
                          "townId":9
                      }
                    ]
                route:
                  description: 'String. Required. The identifier of the route.'
                  type: string
                  example: '{{singleRoute}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Route in wrong status'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'The route status doesn’t allow specifying a border crossing.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Route in wrong status':
                  value: { message: 'The route status doesn’t allow specifying a border crossing.', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
  /a/v2/rest/public/requestChangeFleet:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Request Assignment Change'
      description: 'Request Assignment Change'
      operationId: requestAssignmentChange
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                car:
                  type: number
                  example: 111
                driver:
                  type: number
                  example: 111
                driver2:
                  type: number
                  example: 111
                periodic:
                  type: string
                  example: 1-12-23
                reason:
                  type: string
                  example: reason
                trailer:
                  type: number
                  example: 111
            examples:
              'Request Assignment Change':
                value:
                  car: 111
                  driver: 111
                  driver2: 111
                  periodic: 1-12-23
                  reason: reason
                  trailer: 111
      responses:
        200:
          description: ''
  /a/v2/rest/public/arrivedAtBorder:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Arrived at Border'
      description: |-
        This endpoint is used to notify the system when a vehicle has arrived at the border checkpoint. Upon receiving this notification, the system updates the status of the shipment accordingly.

        *   if success you will update route status and confirm that the vehicle arrived at the border
        *   if unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: arrivedAtBorder
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'String. Required. The identifier of the route.'
                  type: string
                  example: '{{singleRoute}}'
                routepart:
                  description: 'Int. Optional. Specific routepart of type "border" (3).'
                  type: string
                  example: '{{routepartId}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Invalid route number'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid route number':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
  /a/v2/rest/public/borderComplete:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Border Crossing Complete'
      description: |-
        This endpoint is used to notify the system when a vehicle has passed the border checkpoint. Upon receiving this event, the system updates the status of the shipment accordingly.

        - if success you will update route status and confirm that the vehicle passed the border checkpoint
        - if unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        The routepart ID can be found in GET singleRoute
      operationId: borderCrossingComplete
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'String. Required. The identifier of the route.'
                  type: string
                  example: '{{singleRoute}}'
                routepart:
                  description: 'Int. Optional. Specific routepart of type "border" (3).'
                  type: string
                  example: '{{routepartId}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Invalid route number'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid route number':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/arrivedAtCustoms:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Arrived at Customs'
      description: |-
        This endpoint is utilized to notify the system when a shipment has arrived at customs. It is crucial for tracking and logistics management purposes. Upon receiving this notification, the system will update the status of the shipment accordingly and trigger proper auxiliary events.

        *   if successful you will confirm that the vehicle arrived at customs
        *   If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        Upon successful receipt of the notification, the system will update the status of the shipment accordingly. If the required 'route' parameter is missing, the system will return an error response indicating the missing parameter.
      operationId: arrivedAtCustoms
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'String. Required. The identifier of the route.'
                  type: string
                  example: '{{singleRoute}}'
                routepart:
                  description: 'Int. Optional. Specific routepart of type "customs" (3).'
                  type: string
                  example: '{{routepartId}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        403:
          description: 'Invalid token / Token not supplied'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Mon, 18 Mar 2024 10:38:17 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: 'nginx/1.18.0 (Ubuntu)'
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
                'Token not supplied':
                  value: { message: 'Token is required', relogin: true, status: error }
  /a/v2/rest/public/customsComplete:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Customs Clearance Complete'
      description: |-
        This endpoint is utilized to notify the system when a shipment has passed the customs. It is crucial for tracking and logistics management purposes. Upon receiving this notification, the system will update the status of the shipment accordingly and trigger proper auxiliary events.

        *   if successful you will confirm that the vehicle is passed the customs
        *   If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        Upon successful receipt of the notification, the system will update the status of the shipment accordingly. If the required 'route' parameter is missing, the system will return an error response indicating the missing parameter.
      operationId: customsClearanceComplete
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'String. Required. The identifier of the route.'
                  type: string
                  example: '{{singleRoute}}'
                routepart:
                  description: 'Int. Optional. Specific routepart of type "customs" (3).'
                  type: string
                  example: '{{routepartId}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Invalid route number'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid route number':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
  /a/v2/rest/public/arrivedAtUncharge:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Arrived at Unloading Point'
      description: |-
        Allows carriers to confirm arrival at unloading.

        (!) IMPORTANT: although this endpoint is intended for carriers, shippers can also use it.

        If the car has the GPS tracker, the event is triggered automatically upon arrival.

        By default, if no routepart ID is passed, the first non-complete unloading is taken as object to work on, meaning that if no routepart ID is passed, the endpoint will trigger arrival at exactly next non-complete unloading.

        If routepart ID is passed, the endpoint will mark all preceding routeparts as complete and trigger change in the passed one.

        - If successful, you will receive the success message, state of the route will change, unloading will be marked as "started"
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        The routepart ID can be found in GET singleRoute.
      operationId: arrivedAtUnloadingPoint
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'Periodic of the route. Required. String'
                  type: string
                  example: '{{singleRoute}}'
                routepart:
                  description: 'ID of the unloading routepart. Optional. Int '
                  type: string
                  example: '{{routePartId}}'
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Tue, 27 Jun 2023 15:03:46 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Not allowed to update this route / Route is not in propert state / Bad routepart ID passed'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Tue, 27 Jun 2023 15:05:26 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Bad routepart ID passed':
                  value: { message: 'Point not found', relogin: false, status: error }
                'Not allowed to update this route':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
                'Route is not in propert state':
                  value: { message: 'The route status doesn’t allow this operaction.', relogin: false, status: error }
  /a/v2/rest/public/confirmUnchargePOD:
    post:
      tags:
        - 'Routes & tenders / Carriers / Routes'
      summary: 'Confirm POD'
      description: |-
        This endpoint is utilized to notify the system when a shipment has passed the customs. It is crucial for tracking and logistics management purposes. Upon receiving this notification, the system will update the status of the shipment accordingly and trigger proper auxiliary events.

        *   if successful you will confirm that the vehicle is passed the customs
        *   If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        Upon successful receipt of the notification, the system will update the status of the shipment accordingly. If the required 'route' parameter is missing, the system will return an error response indicating the missing parameter.
      operationId: confirmPod
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  example: 'Cum sint cum commodi sunt excepturi ut.'
                lateness:
                  type: string
                  example: '0013'
                products:
                  type: array
                  items: { type: object, properties: { order: { type: string, example: '0987689984' }, product: { type: number, example: 196 }, quantity: { type: number, example: 12 }, variance: { type: string, example: A009 } } }
                  example: [{ order: '0987689984', product: 196, quantity: 12, variance: A009 }, { order: '0987689984', product: 197, quantity: 2.2, variance: A009 }]
                route:
                  type: string
                  example: 117-01-25
                routepart:
                  type: number
                  example: 111391782
            examples:
              'Confirm POD':
                value:
                  comment: 'Cum sint cum commodi sunt excepturi ut.'
                  lateness: '0013'
                  products: [{ order: '0987689984', product: 196, quantity: 12, variance: A009 }, { order: '0987689984', product: 197, quantity: 2.2, variance: A009 }]
                  route: 117-01-25
                  routepart: 111391782
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'String. Required. The identifier of the route.'
                  type: string
                  example: '{{singleRoute}}'
                routepart:
                  description: 'Int. Optional. Specific routepart of type "customs" (3).'
                  type: string
                  example: '{{routepartId}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Invalid route number'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid route number':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
  /a/v2/rest/public/notInterested:
    post:
      tags:
        - 'Routes & tenders / Carriers / Shared Operations'
      summary: 'Mark as Not Interested'
      description: |-
        This endpoint marks the route so the route will no longer appear in vacant routes. This endpoint can be used only with routes with status 2.

        *   if successful you won't see the passed route in vacant routes
        *   If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        (!) NOTE: Can be only used by carriers
      operationId: markAsNotInterested
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'Required string. Id of the tender.'
                  type: string
                  example: '{{singleRoute}}'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'No such route / Request from shipper'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Route not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'No such route':
                  value: { message: 'Route not found', relogin: false, status: error }
                'Request from shipper':
                  value: { message: 'Action not available', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
  /a/v2/rest/public/bookmark:
    post:
      tags:
        - 'Routes & tenders / Carriers / Shared Operations'
      summary: 'Bookmark Route or Tender'
      description: |-
        This endpoint marks the tender so the tender will appear in live tenders section and playing section. This endpoint can be used only with routes with status 2.

        - if successful you won't see the passed route in vacant routes
            
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        (!) NOTE: Can be only used by carriers
      operationId: bookmarkRouteOrTender
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                route:
                  description: 'Required string. Id of the tender.'
                  type: string
                  example: '{{singleRoute}}'
      responses:
        200:
          description: 'Success (mark set) / Success (mark unset)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { bookmarkSet: { type: boolean, example: true }, route: { type: string, example: 38795932800 } } }
                  status: { type: string, example: success }
              examples:
                'Success (mark set)':
                  value: { data: { bookmarkSet: true, route: 38795932800 }, status: success }
                'Success (mark unset)':
                  value: { data: { bookmarkSet: false, route: 38795932800 }, status: success }
        400:
          description: 'No such route / Request from shipper'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Route not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'No such route':
                  value: { message: 'Route not found', relogin: false, status: error }
                'Request from shipper':
                  value: { message: 'Action not available', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getPricequotes:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Tenders'
      summary: 'Get Quotes'
      description: |-
        Returns the list of price quotes of carriers

        - if successful you will receive all carrier price offers
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: If requested by carrier, authors of other quotes will be hidden
      operationId: getQuotes
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: '{{singleTender}}'
          description: 'Required int. Periodic of the tender'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: 'Success (shipper) / Success (carrier)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { cancelled: { type: boolean, example: false }, id: { type: number, example: 660531 }, isMine: { type: boolean, example: false }, loadqoute: { type: number, example: 1 }, moment: { type: string, example: 1626180931 }, operatorHash: { type: string, example: 4a61c8e0a19190120128f998b4d42582 }, operatorNatcomid: { type: string, example: '8888888888' }, operatorTitle: { type: string, example: 'Бюро Логистики' }, oppositeoffer: { nullable: true, example: null }, pricefor: { type: string, example: ride }, pricequote: { type: number, example: 100 }, remark: { nullable: true, example: null } } }, example: [{ cancelled: false, id: 660531, isMine: false, loadqoute: 1, moment: 1626180931, operatorHash: 4a61c8e0a19190120128f998b4d42582, operatorNatcomid: '8888888888', operatorTitle: 'Бюро Логистики', oppositeoffer: null, pricefor: ride, pricequote: 100, remark: null }] }
                  status: { type: string, example: success }
              examples:
                'Success (carrier)':
                  value: { data: [{ cancelled: false, id: 657728, isMine: true, loadqoute: 1, moment: 1625584292, oppositeoffer: null, pricefor: ride, pricequote: 15000, remark: null }], status: success }
                'Success (shipper)':
                  value: { data: [{ cancelled: false, id: 660531, isMine: false, loadqoute: 1, moment: 1626180931, operatorHash: 4a61c8e0a19190120128f998b4d42582, operatorNatcomid: '8888888888', operatorTitle: 'Бюро Логистики', oppositeoffer: null, pricefor: ride, pricequote: 100, remark: null }], status: success }
        400:
          description: "Not allowed (carrier did not participate, or shipper requested other company's tender)"
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                "Not allowed (carrier did not participate, or shipper requested other company's tender)":
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
  /a/v2/rest/public/getTenderSteps:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Tenders'
      summary: 'Get Available Bid Values'
      description: |-
        Returns the list of prices that can be offered by the carrier

        - if successful you will receive all prices that can be offered by the shipper
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Endpoint works only on tenders with fixed price quote decrement set by the shipper
      operationId: getAvailableBidValues
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: '{{tenderPeriodic}}'
          description: 'Required int. Periodic of the tender'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: number, example: 100000 }, example: [100000, 99000, 98000, 97000, 96000, 95000, 94000, 93000, 92000, 91000, 90000, 89000, 88000, 87000, 86000, 85000, 84000, 83000, 82000, 81000, 80000, 79000, 78000, 77000, 76000, 75000, 74000, 73000, 72000, 71000, 70000, 69000, 68000, 67000, 66000, 65000, 64000, 63000, 62000, 61000, 60000, 59000, 58000, 57000, 56000, 55000, 54000, 53000, 52000, 51000, 50000, 49000, 48000, 47000, 46000, 45000, 44000, 43000, 42000, 41000, 40000, 39000, 38000, 37000, 36000, 35000, 34000, 33000, 32000, 31000, 30000, 29000, 28000, 27000, 26000, 25000, 24000, 23000, 22000, 21000, 20000, 19000, 18000, 17000, 16000, 15000, 14000, 13000, 12000, 11000, 10000, 9000, 8000, 7000, 6000, 5000, 4000, 3000, 2000, 1000] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [100000, 99000, 98000, 97000, 96000, 95000, 94000, 93000, 92000, 91000, 90000, 89000, 88000, 87000, 86000, 85000, 84000, 83000, 82000, 81000, 80000, 79000, 78000, 77000, 76000, 75000, 74000, 73000, 72000, 71000, 70000, 69000, 68000, 67000, 66000, 65000, 64000, 63000, 62000, 61000, 60000, 59000, 58000, 57000, 56000, 55000, 54000, 53000, 52000, 51000, 50000, 49000, 48000, 47000, 46000, 45000, 44000, 43000, 42000, 41000, 40000, 39000, 38000, 37000, 36000, 35000, 34000, 33000, 32000, 31000, 30000, 29000, 28000, 27000, 26000, 25000, 24000, 23000, 22000, 21000, 20000, 19000, 18000, 17000, 16000, 15000, 14000, 13000, 12000, 11000, 10000, 9000, 8000, 7000, 6000, 5000, 4000, 3000, 2000, 1000], status: success }
        400:
          description: 'Not allowed to view the route'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Not allowed to view the route':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is required' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is required', relogin: true, status: error }
  /a/v2/rest/public/getTenderChildren:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Tenders'
      summary: 'Get Tender Routes'
      description: |-
        Returns the list of routes of the single tender

        - if successful you will receive all routes of the single tender
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getTenderRoutes
      parameters:
        -
          name: tenderPeriodic
          in: query
          schema:
            type: string
            example: '{{tenderPeriodic}}'
          description: 'Required int. Periodic of the tender'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { id: { type: number, example: 649656 }, needAttention: { type: boolean, example: true }, periodic: { type: string, example: 69881961600 }, routestatus: { type: number, example: 2 } } }, example: [{ id: 649656, needAttention: true, periodic: 69881961600, routestatus: 2 }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ id: 649656, needAttention: true, periodic: 69881961600, routestatus: 2 }], status: success }
        400:
          description: 'Invalid tender passed'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Route not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid tender passed':
                  value: { message: 'Route not found', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
  /a/v2/rest/public/getTenderResults:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Tenders'
      summary: 'Get Tender Results'
      description: |-
        Returns the results of the tender. Results include bids, winner, etc.

        (!) NOTE: If you are a carrier you won't see names of other carriers but you will see their bids.

        - if successful you will receive all the results of the tender
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getTenderResults
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: '{{singleRoute}}'
          description: 'Single tender periodic'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: 'Success (by carrier) / Success (by shipper)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { allQuotes: { type: array, items: { type: object, properties: { datetime: { type: string, example: 1471561931 }, loadquote: { type: string, example: '3 rides' }, periodic: { type: number, example: 1 }, pricequote: { type: string, example: '3450.00 UAH' }, provider: { type: string, example: '' } } }, example: [{ datetime: 1471561931, loadquote: '3 rides', periodic: 1, pricequote: '3450.00 UAH', provider: '' }, { datetime: 1471561931, loadquote: '5 rides', periodic: 2, pricequote: '3300.00 UAH', provider: 'Super carrier' }, { datetime: 1471561931, loadquote: '5 rides', periodic: 3, pricequote: '3250.00 UAH', provider: '' }] }, bargainResults: { type: array, items: { type: object, properties: { contractdate: { type: string, example: 1343779200 }, contractnumber: { type: string, example: 556-1/ZA5% }, periodic: { type: number, example: 1 }, pricequote: { type: string, example: '3250.00' }, provider: { type: string, example: '' }, winnerquote: { type: string, example: '5 rides' } } }, example: [{ contractdate: 1343779200, contractnumber: 556-1/ZA5%, periodic: 1, pricequote: '3250.00', provider: '', winnerquote: '5 rides' }, { contractdate: 1471478400, contractnumber: 336/1, periodic: 2, pricequote: '3300.00', provider: 'Super carrier', winnerquote: '5 rides' }] }, tenderData: { type: object, properties: { complete: { type: string, example: '0' }, currency: { type: string, example: € }, nds: { type: string, example: '1' }, numWinners: { type: number, example: 1 }, paymenttype: { type: string, example: Cash }, periodic: { type: string, example: 31-10-24 }, startPrice: { type: string, example: '0.00' }, tender_deadline: { type: string, example: 1728432000 }, totalCount: { type: string, example: '3.00' } } } } }
                  status: { type: string, example: success }
              examples:
                'Success (by carrier)':
                  value: { data: { allQuotes: [{ datetime: 1471561931, loadquote: '3 rides', periodic: 1, pricequote: '3450.00 UAH', provider: '' }, { datetime: 1471561931, loadquote: '5 rides', periodic: 2, pricequote: '3300.00 UAH', provider: 'Super carrier' }, { datetime: 1471561931, loadquote: '5 rides', periodic: 3, pricequote: '3250.00 UAH', provider: '' }], bargainResults: [{ contractdate: 1343779200, contractnumber: 556-1/ZA5%, periodic: 1, pricequote: '3250.00', provider: '', winnerquote: '5 rides' }, { contractdate: 1471478400, contractnumber: 336/1, periodic: 2, pricequote: '3300.00', provider: 'Super carrier', winnerquote: '5 rides' }] }, status: success }
                'Success (by shipper)':
                  value: { data: { allQuotes: [{ datetime: 1728392596, loadquote: '3 rides', periodic: 1, pricequote: '1000.00 €', provider: 'Seifert Sp.Z.o.p' }], bargainResults: [{ contractdate: 1722470400, contractnumber: '1112', paymenttype: Cash, periodic: 1, pricequote: '1000.00', provider: 'Seifert Sp.Z.o.p', providerHash: 316f03860bf020ffa01c50dceaaf7ba2, providerNatcomid: '6700356984', winnerquote: '3 rides' }], tenderData: { complete: '0', currency: €, nds: '1', numWinners: 1, paymenttype: Cash, periodic: 31-10-24, startPrice: '0.00', tender_deadline: 1728432000, totalCount: '3.00' } }, status: success }
        400:
          description: 'Not allowed to view the results of the tender'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Not allowed to view the results of the tender':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
  /a/v2/rest/public/getRouteFleet:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Routes'
      summary: 'Get Assigned Fleet'
      description: |-
        Returns the information about the confirmed carrier, truck, drivers and trailer for the specified route.

        - If successful you will receive information about the vehicle and the drivers on the route
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getAssignedFleet
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: '{{singleRoute}}'
          description: 'Single route periodic'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { car: { type: object, properties: { actual_provider_natcomid: { nullable: true, example: null }, actual_provider_title: { nullable: true, example: null }, availabledatetime: { type: string, example: 1669248000 }, axes: { type: number, example: 0 }, body_type: { type: string, example: 'Tractor unit (semi-truck)' }, body_type_unique_id: { type: number, example: 113 }, carstyle: { type: string, example: forcesplitcarstyle }, cartype: { type: string, example: тягач }, cellnum: { type: string, example: '' }, gpsid: { nullable: true, example: null }, height: { type: string, example: '3.500' }, insuredTil: { type: string, example: -62169984000 }, length: { type: string, example: '5.000' }, loadcapacity: { type: string, example: '0.000' }, make: { type: string, example: Iveco }, model: { type: string, example: STRALIS }, number: { type: string, example: CС9147EЕ }, total_weight: { type: string, example: '20.500' }, vin: { type: string, example: WJMM1VTH904984751 }, volume: { type: string, example: '0.000' }, weight: { type: string, example: '7.870' }, width: { type: string, example: '2.500' }, year_of_manufact: { type: number, example: 2011 } } }, driver: { type: object, properties: { demographicid: { type: string, example: '123123123' }, driverlicensenumber: { type: string, example: '673329' }, driverlicenseserial: { type: string, example: GGG }, firstname: { type: string, example: Walter }, inblacklist: { type: number, example: 0 }, lastname: { type: string, example: White }, maincellphone: { nullable: true, example: null }, passportnumber: { type: string, example: '' }, passportserial: { type: string, example: '' }, patronymic: { type: string, example: '' } } }, driver2: { nullable: true, example: null }, operator: { type: string, example: 'Carrier LTD' }, operatorContractDate: { type: string, example: -62169984000 }, operatorContractNumber: { type: string, example: '' }, operatorNatcomid: { type: string, example: '6722356984' }, operatorhash: { type: string, example: a919ffa2c7a3be99212d75a631a46d4c }, trailer: { type: object, properties: { axes: { type: number, example: 0 }, body_type: { type: string, example: 'Flatbed truck with a tarpaulin (curtain-sided)' }, body_type_unique_id: { type: number, example: 213 }, cartype: { type: string, example: тент }, height: { type: string, example: '2.750' }, length: { type: string, example: '13.000' }, loadcapacity: { type: string, example: '23.000' }, make: { type: string, example: Kogel }, model: { type: string, example: sn24 }, number: { type: string, example: ВВ1789ХА }, total_weight: { type: string, example: '35.000' }, vin: { type: string, example: wk0s0001401796987 }, volume: { type: string, example: '0.000' }, weight: { type: string, example: '7.000' }, width: { type: string, example: '2.000' }, year_of_manufact: { type: number, example: 2008 } } }, useroperator: { type: object, properties: { cellnum: { type: string, example: '+380692675706' }, email: { type: string, example: ktsom@some.com }, name: { type: string, example: 'Carrier Manager' } } } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { car: { actual_provider_natcomid: null, actual_provider_title: null, availabledatetime: 1669248000, axes: 0, body_type: 'Tractor unit (semi-truck)', body_type_unique_id: 113, carstyle: forcesplitcarstyle, cartype: тягач, cellnum: '', gpsid: null, height: '3.500', insuredTil: -62169984000, length: '5.000', loadcapacity: '0.000', make: Iveco, model: STRALIS, number: CС9147EЕ, total_weight: '20.500', vin: WJMM1VTH904984751, volume: '0.000', weight: '7.870', width: '2.500', year_of_manufact: 2011 }, driver: { demographicid: '123123123', driverlicensenumber: '673329', driverlicenseserial: GGG, firstname: Walter, inblacklist: 0, lastname: White, maincellphone: null, passportnumber: '', passportserial: '', patronymic: '' }, driver2: null, operator: 'Carrier LTD', operatorContractDate: -62169984000, operatorContractNumber: '', operatorNatcomid: '6722356984', operatorhash: a919ffa2c7a3be99212d75a631a46d4c, trailer: { axes: 0, body_type: 'Flatbed truck with a tarpaulin (curtain-sided)', body_type_unique_id: 213, cartype: тент, height: '2.750', length: '13.000', loadcapacity: '23.000', make: Kogel, model: sn24, number: ВВ1789ХА, total_weight: '35.000', vin: wk0s0001401796987, volume: '0.000', weight: '7.000', width: '2.000', year_of_manufact: 2008 }, useroperator: { cellnum: '+380692675706', email: ktsom@some.com, name: 'Carrier Manager' } }, status: success }
        400:
          description: 'Not allowed to view route'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Not allowed to view route':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
  /a/v2/rest/public/getOrders:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Routes'
      summary: 'Get Route Orders'
      description: |-
        This endpoint retrieves all orders associated with a specific route.

        *   if successful response will return a list of orders associated with the specified route. Each order will include detailed information such as order ID, route, order number, pallet plans, product details, etc.
      operationId: getRouteOrders
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: '{{routePeriodic}}'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          text/plain:
            examples:
              'Get Route Orders':
                value: ''
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { orders: { type: array, items: { type: object, properties: { aux: { type: string, example: 'some technical data' }, number: { type: string, example: '0987689987' }, products: { type: array, items: { type: object, properties: { aux: { nullable: true, example: null }, extra1: { type: string, example: '9.000000' }, extra2: { type: string, example: '2901.550000' }, extra3: { type: string, example: '0.212000' }, extra4: { type: string, example: '0.000000' }, measure_unit: { type: string, example: box }, order: { type: number, example: 31 }, position: { type: string, example: '1' }, product: { type: number, example: 3 }, product_relation: { type: object, properties: { aux: { nullable: true, example: null }, code: { type: string, example: '12312223' }, id: { type: number, example: 3 }, title: { type: string, example: smittles } } }, quantity: { type: string, example: '9.000000' }, total_price: { type: string, example: '2901.550000' }, unit_price: { type: string, example: '10.660000' }, vat: { type: string, example: '60.000000' }, volume: { type: string, example: '0.408900' }, weight: { type: string, example: '0.212009' } } }, example: [{ aux: null, extra1: '9.000000', extra2: '2901.550000', extra3: '0.212000', extra4: '0.000000', measure_unit: box, order: 31, position: '1', product: 3, product_relation: { aux: null, code: '12312223', id: 3, title: smittles }, quantity: '9.000000', total_price: '2901.550000', unit_price: '10.660000', vat: '60.000000', volume: '0.408900', weight: '0.212009' }, { aux: null, extra1: '223.000000', extra2: '600.000000', extra3: '0.933000', extra4: '0.000000', measure_unit: pcs, order: 31, position: '2', product: 4, product_relation: { aux: null, code: m112323, id: 4, title: wiskas }, quantity: '223.000009', total_price: '600.000009', unit_price: '19.890000', vat: '125.000000', volume: '8.028900', weight: '0.933009' }] }, total_weight: { type: string, example: '1.145000' } } }, example: [{ aux: 'some technical data', number: '0987689987', products: [{ aux: null, extra1: '9.000000', extra2: '2901.550000', extra3: '0.212000', extra4: '0.000000', measure_unit: box, order: 31, position: '1', product: 3, product_relation: { aux: null, code: '12312223', id: 3, title: smittles }, quantity: '9.000000', total_price: '2901.550000', unit_price: '10.660000', vat: '60.000000', volume: '0.408900', weight: '0.212009' }, { aux: null, extra1: '223.000000', extra2: '600.000000', extra3: '0.933000', extra4: '0.000000', measure_unit: pcs, order: 31, position: '2', product: 4, product_relation: { aux: null, code: m112323, id: 4, title: wiskas }, quantity: '223.000009', total_price: '600.000009', unit_price: '19.890000', vat: '125.000000', volume: '8.028900', weight: '0.933009' }], total_weight: '1.145000' }] }, route: { type: string, example: -25480656000 } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { orders: [{ aux: 'some technical data', number: '0987689987', products: [{ aux: null, extra1: '9.000000', extra2: '2901.550000', extra3: '0.212000', extra4: '0.000000', measure_unit: box, order: 31, position: '1', product: 3, product_relation: { aux: null, code: '12312223', id: 3, title: smittles }, quantity: '9.000000', total_price: '2901.550000', unit_price: '10.660000', vat: '60.000000', volume: '0.408900', weight: '0.212009' }, { aux: null, extra1: '223.000000', extra2: '600.000000', extra3: '0.933000', extra4: '0.000000', measure_unit: pcs, order: 31, position: '2', product: 4, product_relation: { aux: null, code: m112323, id: 4, title: wiskas }, quantity: '223.000009', total_price: '600.000009', unit_price: '19.890000', vat: '125.000000', volume: '8.028900', weight: '0.933009' }], total_weight: '1.145000' }], route: -25480656000 }, status: success }
        400:
          description: 'Invalid route number'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Route not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid route number':
                  value: { message: 'Route not found', relogin: false, status: error }
  /a/v2/rest/public/getVarianceLatenessReasons:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Routes'
      summary: 'Get Route Delay Reasons'
      description: |-
        This endpoint retrieves all variance or lateness reasons associated with a specific route.

        - if successful response will return a list of variance or lateness reasons associated with the specified route. Each order will include detailed information such as order ID, route, order number, pallet plans, product details, etc.
      operationId: getRouteDelayReasons
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: 117-01-25
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          text/plain:
            examples:
              'Get Route Delay Reasons':
                value: ''
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, PUT, DELETE, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Fri, 12 Sep 2025 10:48:05 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.27.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
            X-Xdebug-Profile-Filename:
              schema:
                type: string
                example: /var/tmp/cachegrind.out.26634
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: array, items: { type: object, properties: { code: { type: string, example: A }, title: { type: string, example: 'Late delivery' }, type: { type: string, example: variance } } }, example: [{ code: A, title: 'Late delivery', type: variance }, { code: B, title: 'Bad delivery date', type: variance }, { code: C, title: 'Stop failed', type: lateness }, { code: D, title: 'Weather conditions -- ', type: lateness }] }, example: [[{ code: A, title: 'Late delivery', type: variance }, { code: B, title: 'Bad delivery date', type: variance }, { code: C, title: 'Stop failed', type: lateness }, { code: D, title: 'Weather conditions -- ', type: lateness }]] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [[{ code: A, title: 'Late delivery', type: variance }, { code: B, title: 'Bad delivery date', type: variance }, { code: C, title: 'Stop failed', type: lateness }, { code: D, title: 'Weather conditions -- ', type: lateness }]], status: success }
        400:
          description: 'Invalid route number'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Route not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid route number':
                  value: { message: 'Route not found', relogin: false, status: error }
  /a/v2/rest/public/getArrivalEstimate:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Routes'
      summary: 'Get Arrival Estimate'
      description: 'Get Arrival Estimate'
      operationId: getArrivalEstimate
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: ''
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/requestDriverLocation:
    post:
      tags:
        - 'Routes & tenders / Common Operations / Routes'
      summary: 'Request Driver Location'
      description: 'Request Driver Location'
      operationId: requestDriverLocation
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                route:
                  type: string
                  example: 33226243200
            examples:
              'Request Driver Location':
                value:
                  route: 33226243200
      responses:
        200:
          description: ''
  /a/v2/rest/public/confirmRouteChanges:
    post:
      tags:
        - 'Routes & tenders / Common Operations / Routes'
      summary: 'Approve Route Change Request'
      description: |-
        Allows shippers to react to change requests issued by the shipper. Only after the ratification within this endpoint the changes requested by the other party take affect and actually change the state.

        Requested changes can be viewed via the `getRouteMessageGroups` endpoint.

        - if successful you will have successfully ratified or declined the change request
        - if unsuccessful you will receive an error explaining the problem in the language you supplied with the header, or in the language set within the app
            
        Params:

        - `verdict` : string, required. Supports only "yes" and "no". Indicates whether you ratify the requested changes or not.
        - `periodic` : string, required. The unique periodic of the route/order in question.
        - `routechange` : int, requried. The ID of the routechange, i.e. entity that corresponds to the change request.
      operationId: approveRouteChangeRequest
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                periodic:
                  type: string
                  example: 12-01-24
                routechange:
                  type: number
                  example: 26842
                verdict:
                  type: string
                  example: 'yes'
            examples:
              'Approve Route Change Request':
                value:
                  periodic: 12-01-24
                  routechange: 26842
                  verdict: 'yes'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status: { type: boolean, example: true }
              examples:
                Success:
                  value: { status: true }
        400:
          description: 'Bad routechange id supplied'
          content:
            application/json:
              schema:
                type: object
                properties:
                  routechange: { type: string, example: 'The following value must be valid routechange id initiated by provider' }
              examples:
                'Bad routechange id supplied':
                  value: { routechange: 'The following value must be valid routechange id initiated by provider' }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
  /a/v2/rest/public/requestChangeDates:
    post:
      tags:
        - 'Routes & tenders / Common Operations / Routes'
      summary: 'Request Schedule Change'
      description: |-
        Allows shippers to request a change of dates for a given routepart of a given route.

        - if successful, the carrier will receive a notification about the date change request with details
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        NOTE: the request to change dates does not change the date. In order for the change to become active, the carrier of the route must confirm those changes.

        Params:

        - `periodic`: string, required
        - `routepart`: int, required
        - `newDate`: string, date format expected: YYYY-MM-DD
            
        Returns the ID of the routechange entity, which the carrier is expected to react upon.
      operationId: requestScheduleChange
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                newDate:
                  type: string
                  example: 1728518400
                periodic:
                  type: string
                  example: 353-10-22
                routepart:
                  type: number
                  example: 111551294
            examples:
              'Request Schedule Change':
                value: |-
                  { 
                      "periodic": "{{routePeriodic}}", 
                      "routepart": {{routepartId}},
                      "newDate": "{{newDate}}"
                  }
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Fri, 14 Apr 2023 08:42:16 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  routechange: { type: number, example: 115568 }
              examples:
                Success:
                  value: { routechange: 115568 }
        400:
          description: 'Bad routepart supplied'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Fri, 14 Apr 2023 08:41:01 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Wrong routepart number' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Bad routepart supplied':
                  value: { message: 'Wrong routepart number', relogin: false, status: error }
        403:
          description: 'invalid token supplied'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Thu, 06 Apr 2023 12:19:03 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Set-Cookie:
              schema:
                type: string
                example: 'sovtes-session=umfjvu0d9aae0mf5qfjifvqo89; expires=Thu, 06-Apr-2023 20:19:03 GMT; Max-Age=28800; path=/'
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'invalid token supplied':
                  value: { message: 'Token is invalid', relogin: true, status: error }
  /a/v2/rest/public/requestVacantizeRoute:
    post:
      tags:
        - 'Routes & tenders / Common Operations / Routes'
      summary: 'Request Reopening of Route'
      description: 'Request Reopening of Route'
      operationId: requestReopeningOfRoute
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                periodic:
                  type: string
                  example: '{{singleRoute}}'
                reason:
                  type: string
                  example: reason
            examples:
              'Request Reopening of Route':
                value:
                  periodic: '{{singleRoute}}'
                  reason: reason
      responses:
        200:
          description: ''
  /a/v2/rest/public/requestGenericChanges:
    post:
      tags:
        - 'Routes & tenders / Common Operations / Routes'
      summary: 'Request General Changes'
      description: 'Request General Changes'
      operationId: requestGeneralChanges
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                periodic:
                  type: string
                  example: 1-11-11
                reason:
                  type: string
                  example: 'Some reason'
            examples:
              'Request General Changes':
                value:
                  periodic: 1-11-11
                  reason: 'Some reason'
      responses:
        200:
          description: ''
  /a/v2/rest/public/requestCancel:
    post:
      tags:
        - 'Routes & tenders / Common Operations / Routes'
      summary: 'Request Cancellation'
      description: 'Request Cancellation'
      operationId: requestCancellation
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                periodic:
                  type: string
                  example: 11-11-11
                reason:
                  type: string
                  example: 'Some reason'
            examples:
              'Request Cancellation':
                value:
                  periodic: 11-11-11
                  reason: 'Some reason'
      responses:
        200:
          description: ''
  /a/v2/rest/public/singleRoute:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Routes & Tenders'
      summary: 'Get Route or Tender Details'
      description: |-
        Shows all the available details of a single route or tender. The response includes all the necessary and available information about the route/tender, much more than the data returned in the method `getBasicDetailsOfRoutes`.

        - if successful you will receive the details of the route or tender
        - if unsuccessful you will receive an error explaining the problem in the language you supplied with the header or in the language set within the app
      operationId: getRouteOrTenderDetails
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: '{{singleRoute}}'
          description: 'Single route/tender periodic'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties: []
            examples:
              'Get Route or Tender Details':
                value: []
      responses:
        200:
          description: 'Success / Success (tender)'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, PUT, DELETE, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Thu, 09 Oct 2025 12:58:48 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.27.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
            X-Xdebug-Profile-Filename:
              schema:
                type: string
                example: /var/tmp/cachegrind.out.51724
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { route: { type: object, properties: { autosubscribe: { type: boolean, example: false }, blindtender: { type: boolean, example: false }, bookedbyme: { type: boolean, example: false }, bookedsince: { type: string, example: 1575638584 }, bookedtill: { type: string, example: -62169984000 }, booktime: { type: number, example: 30 }, budget: { type: number, example: 15230 }, budgetcomment: { type: string, example: 'tenderгрн Terms tender-genetiveYour-offer-was-selected. ' }, cartype: { nullable: true, example: null }, chargetype: { nullable: true, example: null }, clientSettings: { type: object, properties: { allowOperatorIndicateRoutepartOrder: { type: string, example: '1' }, allowRemarkPricequote: { type: string, example: '1' }, detailedLoadInfo: { type: string, example: '1' }, forceBorderInput: { type: string, example: '1' }, forceOperatorUnloadConfirm: { type: string, example: '1' }, forcemaxquote: { type: string, example: '1' }, forcestepquotes: { type: string, example: '1' }, routeresponseLimitHours: { type: string, example: '3' }, showLoadSummary: { type: string, example: '1' }, warehouserForceLoadingArrival: { type: string, example: '0' } } }, clientdata: { type: object, properties: { hash: { type: string, example: 3c5e448b11f15293807d9cfdedf21582 } } }, companydata: { type: object, properties: { natcomid: { type: string, example: '1231231231231' }, title_ru: { type: string, example: 'ОрджМеталлПромИнweightт, АО' } } }, complete: { type: boolean, example: false }, context: { type: object, properties: { iconTitle: { nullable: true, example: null }, title: { nullable: true, example: null } } }, currentMinQuote: { type: number, example: 1000 }, defaultcurrency: { nullable: true, example: null }, deleted: { type: boolean, example: false }, distance: { type: number, example: 47 }, fastwinprice: { type: number, example: 0 }, ferryproperty: { type: array, items: { type: string, example: 'Pallets 15 pcs' }, example: ['Pallets 15 pcs', 'Temperature 0 ° C', 'Belts 5 pcs'] }, freeforall: { type: boolean, example: false }, id: { type: number, example: 104105 }, istender: { type: boolean, example: false }, kmprice: { type: number, example: 0 }, maxquote: { type: number, example: 0 }, maxquotewithcommission: { type: number, example: 0 }, mcubeprice: { type: number, example: 0 }, nds: { type: boolean, example: false }, newMessages: { type: number, example: 0 }, operatordata: { type: object, properties: { contract_date: { type: string, example: 1722470400 }, contract_number: { type: string, example: CSW-11 }, hash: { type: string, example: 77f085a461d24c90296abcd5ff4cf62f }, natcomid: { type: string, example: '88888888' }, title_ru: { type: string, example: 'Carrier 1, LTD' } } }, paymenttype: { type: object, properties: { id: { type: number, example: 3 }, title: { type: string, example: Cash } } }, payorcompany: { type: object, properties: { id: { type: number, example: 0 }, natcomid: { nullable: true, example: null }, title: { nullable: true, example: null } } }, periodic: { type: string, example: 243-06-16 }, pricefor: { type: string, example: ride }, remark: { type: string, example: '' }, response: { type: object, properties: { 73702: { type: object, properties: { cancelled: { type: string, example: '0' }, car: { type: object, properties: { actual_provider_natcomid: { type: string, example: '37534432' }, actual_provider_title: { type: string, example: 'Phleetto, LTD' }, axes: { type: number, example: 0 }, body_type: { type: string, example: TIPPER }, body_type_unique_id: { type: number, example: 113 }, carstyle: { type: string, example: singlecarstyle }, cartype: { type: number, example: 10 }, cellnum: { type: string, example: '' }, height: { type: number, example: 0 }, id: { type: number, example: 15677 }, insuredTil: { type: string, example: -62169984000 }, length: { type: number, example: 0.999 }, loadcapacity: { type: string, example: '0.000' }, make: { type: object, properties: { id: { type: number, example: 6 }, title_ru: { type: string, example: Citroen } } }, model: { nullable: true, example: null }, number: { type: string, example: '123' }, remark: { type: string, example: '' }, total_weight: { type: string, example: '20.500' }, trailer: { type: number, example: 180256 }, vehicleclass: { nullable: true, example: null }, vin: { type: string, example: '' }, volume: { type: number, example: 0.999 }, weight: { type: number, example: 0 }, width: { type: number, example: 0 } } }, checkedtender: { type: string, example: '0' }, companytitle: { nullable: true, example: null }, companytitlewing: { nullable: true, example: null }, driver: { type: object, properties: { car: { type: number, example: 15677 }, demographicid: { type: string, example: 123123123123-123123123 }, driverlicenseissued: { type: string, example: '123' }, driverlicenseissuedby: { nullable: true, example: null }, driverlicensenumber: { nullable: true, example: null }, driverlicenseserial: { type: string, example: /0 }, firstname: { type: string, example: '123' }, id: { type: number, example: 14793 }, inblacklist: { type: string, example: '0' }, lastname: { type: string, example: /0 }, maincellphone: { type: string, example: '123' }, passportserial: { type: string, example: '' }, patronymic: { type: string, example: '' }, taxid: { type: string, example: '' } } }, driver2: { nullable: true, example: null }, id: { type: number, example: 73702 }, isMine: { type: boolean, example: true }, loadquote: { nullable: true, example: null }, moment: { type: string, example: 1466096342 }, operator: { type: number, example: 180 }, operatorispartnerwithclient: { type: string, example: '0' }, operatorsupervisorid: { nullable: true, example: null }, orderlist: { nullable: true, example: null }, paymenttype: { type: string, example: '0' }, pricequote: { type: number, example: 0 }, pricequoteavailableuntil: { type: string, example: '' }, pricequoteavailableuntilmoment: { type: string, example: -62169984000 }, pricequotewing: { nullable: true, example: null }, pricequotewithcommission: { nullable: true, example: null }, remark: { type: string, example: '' }, route: { type: number, example: 94352 }, selected: { type: string, example: '0' }, status: { type: string, example: '' }, trailer: { type: object, properties: { axes: { type: string, example: '0' }, body_type: { type: string, example: 11-TIPPER }, body_type_unique_id: { type: number, example: 213 }, height: { type: string, example: '4.000' }, id: { type: string, example: '180256' }, length: { type: string, example: '13.000' }, loadcapacity: { type: string, example: '0.000' }, make: { type: string, example: KRONE }, model: { type: string, example: 'SDR 27' }, number: { type: string, example: АА0000РІ }, total_weight: { type: string, example: '35.000' }, volume: { type: string, example: '0.000' }, weight: { type: string, example: '10.540' }, width: { type: string, example: '2.000' } } }, user: { type: number, example: 269 } } }, 76393: { type: object, properties: { cancelled: { type: string, example: '0' }, car: { type: object, properties: { actual_provider_natcomid: { nullable: true, example: null }, actual_provider_title: { nullable: true, example: null }, axes: { type: number, example: 0 }, body_type: { nullable: true, example: null }, body_type_unique_id: { nullable: true, example: null }, carstyle: { nullable: true, example: null }, cartype: { type: number, example: 0 }, cellnum: { nullable: true, example: null }, height: { type: number, example: 0 }, id: { type: number, example: 0 }, insuredTil: { nullable: true, example: null }, latit: { nullable: true, example: null }, length: { type: number, example: 0 }, loadcapacity: { nullable: true, example: null }, longit: { nullable: true, example: null }, make: { type: object, properties: { id: { type: number, example: 0 } } }, model: { nullable: true, example: null }, number: { nullable: true, example: null }, remark: { nullable: true, example: null }, total_weight: { nullable: true, example: null }, trailer: { nullable: true, example: null }, vehicleclass: { nullable: true, example: null }, vin: { nullable: true, example: null }, volume: { type: number, example: 0 }, weight: { type: number, example: 0 }, width: { type: number, example: 0 }, year_of_manufact: { type: number, example: 0 } } }, checkedtender: { type: string, example: '0' }, classic_price_strategy: { type: string, example: '0' }, companytitle: { nullable: true, example: null }, companytitlewing: { nullable: true, example: null }, driver: { nullable: true, example: null }, driver2: { nullable: true, example: null }, id: { type: number, example: 76393 }, isMine: { type: boolean, example: true }, loadquote: { type: string, example: '2.00' }, moment: { type: string, example: 1753360328 }, nullified: { type: string, example: '0' }, operator: { type: number, example: 538 }, operatorispartnerwithclient: { type: string, example: '1' }, operatorsupervisorid: { type: string, example: '278' }, orderlist: { nullable: true, example: null }, paymenttype: { nullable: true, example: null }, pricequote: { type: number, example: 1000 }, pricequoteavailableuntil: { type: string, example: '' }, pricequoteavailableuntilmoment: { type: string, example: -62169984000 }, pricequotewing: { nullable: true, example: null }, pricequotewithcommission: { type: string, example: '1000.00' }, remark: { type: string, example: '' }, route: { type: number, example: 104105 }, selected: { type: string, example: '0' }, status: { type: string, example: '' }, trailer: { nullable: true, example: null }, user: { type: number, example: 921 }, vat: { type: string, example: '0.00' } } } } }, routeparts: { type: array, items: { type: object, properties: { bordercrossforoperator: { type: boolean, example: false }, cargo: { type: string, example: Pallets }, checkpoint: { type: object, properties: { address: { type: string, example: '1, High Street' }, apicode: { type: string, example: '3941' }, badcoords: { type: string, example: '0' }, classic: { type: string, example: '1' }, client: { type: string, example: '760' }, company: { type: object, properties: { actsonbaseof: { type: string, example: '' }, apikeyNP: { type: string, example: '' }, bankaccount: { type: string, example: '' }, bankname: { type: string, example: '' }, cardholdercode: { type: string, example: '' }, cardholdername: { type: string, example: '' }, cardnum: { type: string, example: '' }, country: { type: string, example: '215' }, director: { type: string, example: '' }, director_case: { type: string, example: '' }, directorfirstname: { type: string, example: '' }, directorpatronymic: { type: string, example: '' }, email: { type: string, example: '' }, factaddress: { type: string, example: '' }, faxnum: { type: string, example: '' }, id: { type: string, example: '3463' }, ifoid: { type: string, example: '' }, korraccount: { type: string, example: '' }, legaladdress: { type: string, example: '' }, logisticsratified: { type: string, example: '0' }, logisticsratifiedbyuser: { type: string, example: '0' }, logisticsratifiedmoment: { type: string, example: -62169984000 }, natcomid: { type: string, example: '' }, othercontactinfo: { type: string, example: '' }, ownership: { type: string, example: '' }, registryvalidated: { nullable: true, example: null }, signer: { type: string, example: '' }, signer_case: { type: string, example: '' }, swift: { nullable: true, example: null }, taxid: { type: string, example: '' }, telnum: { type: string, example: '' }, title_full_ru: { type: string, example: '' }, title_ru: { type: string, example: 'Loader, LTD' }, vatid: { type: string, example: '' }, website: { type: string, example: '' } } }, customs: { type: string, example: '0' }, duration: { type: string, example: '120' }, end-workinghours: { type: string, example: '' }, googleplaceid: { type: string, example: '' }, harbor: { nullable: true, example: null }, id: { type: string, example: '3941' }, json: { type: string, example: '' }, latit: { type: string, example: '46.762989000000000' }, longit: { type: string, example: '36.793458000000000' }, radius_km: { type: string, example: '0.5' }, remark: { type: string, example: '' }, service: { type: string, example: '0' }, start-workinghours: { type: string, example: '' }, technote: { nullable: true, example: null }, town: { type: object, properties: { borderswith: { type: string, example: '0' }, country: { type: object, properties: { continent: { type: string, example: Europe }, currency: { type: string, example: грн }, currencycode: { type: string, example: uah }, domainname: { type: string, example: UA }, id: { type: string, example: '215' }, iso_code: { type: string, example: UKR }, iso_num: { type: string, example: '804' }, subcontinent: { type: string, example: 'East Europe' }, timezone: { type: string, example: '+2' }, title_alphabeta: { type: string, example: Ukraine }, title_en: { type: string, example: Ukraine }, title_full_ru: { type: string, example: ' ' }, title_ru: { type: string, example: Ukraine }, title_ua: { type: string, example: Ukraine }, vat: { type: string, example: '20' }, webdomain: { type: string, example: phleetto.uk } } }, district: { type: string, example: '' }, googleplaceid: { type: string, example: '' }, id: { type: string, example: '7556' }, latit: { type: string, example: '46.7636100000' }, longit: { type: string, example: '36.7986100000' }, nationalid: { type: string, example: '2310400000' }, nationaltitle: { type: string, example: Berdiansk }, region: { type: object, properties: { country: { type: string, example: '215' }, id: { type: string, example: '7' }, timezone: { type: string, example: '' }, title_ru: { type: string, example: 'Zaporizhzha oblast' }, title_ua: { type: string, example: 'Zaporizhzha oblast' } } }, title_ru: { type: string, example: Berdiansk }, title_ua: { type: string, example: Berdiansk } } }, townstring: { type: string, example: '' }, zip: { nullable: true, example: null } } }, checkpointcontacts: { type: object, properties: { cellnum: { type: string, example: '' }, contactperson: { type: string, example: '3067' }, id: { type: number, example: 1111 }, remark: { type: string, example: '' } } }, complete: { type: boolean, example: false }, date1: { type: string, example: 1466035200 }, date2: { type: string, example: 1466467200 }, dimensions: { type: array, items: { type: object, properties: { title: { type: string, nullable: true, example: 't weight' }, value: { type: number, example: 45 } } }, example: [{ title: 't weight', value: 45 }, { title: 'mcub volume', value: 0 }, { title: 'm length', value: 0 }, { title: 'm width', value: 0 }, { title: 'm height', value: 0 }, { title: null, value: 0 }] }, factarrivaldate: { type: string, example: -62169984000 }, factarrivaltime: { type: string, example: '00:00:00' }, id: { type: number, example: 111365645 }, plannedarrivaldate: { type: string, example: -62169984000 }, plannedarrivaltime: { type: string, example: '00:00:00' }, suggestedOrder: { nullable: true, example: null }, time1: { type: string, example: '08:30:00' }, time2: { type: string, example: '14:00:00' }, triggered: { type: boolean, example: true }, workaction: { type: number, example: 1 }, workaction_data: { type: object, properties: { classic: { type: string, example: '1' }, doer_ru: { type: string, example: shipper }, id: { type: string, example: '1' }, instance_accus_case: { type: string, example: 'point of loading' }, title: { type: string, example: charge }, title_ru: { type: string, example: loading }, title_ru_accus_case: { type: string, example: loading }, title_ru_rod_case: { type: string, example: loading }, title_ua: { type: string, example: loading }, title_ua_rod_case: { type: string, example: loading } } }, workcompletedate: { type: string, example: -62169984000 }, workcompletetime: { type: string, example: '00:00:00' }, workstartdate: { type: string, example: -62169984000 }, workstarttime: { type: string, example: '00:00:00' } } }, example: [{ bordercrossforoperator: false, cargo: Pallets, checkpoint: { address: '1, High Street', apicode: '3941', badcoords: '0', classic: '1', client: '760', company: { actsonbaseof: '', apikeyNP: '', bankaccount: '', bankname: '', cardholdercode: '', cardholdername: '', cardnum: '', country: '215', director: '', director_case: '', directorfirstname: '', directorpatronymic: '', email: '', factaddress: '', faxnum: '', id: '3463', ifoid: '', korraccount: '', legaladdress: '', logisticsratified: '0', logisticsratifiedbyuser: '0', logisticsratifiedmoment: -62169984000, natcomid: '', othercontactinfo: '', ownership: '', registryvalidated: null, signer: '', signer_case: '', swift: null, taxid: '', telnum: '', title_full_ru: '', title_ru: 'Loader, LTD', vatid: '', website: '' }, customs: '0', duration: '120', end-workinghours: '', googleplaceid: '', harbor: null, id: '3941', json: '', latit: '46.762989000000000', longit: '36.793458000000000', radius_km: '0.5', remark: '', service: '0', start-workinghours: '', technote: null, town: { borderswith: '0', country: { continent: Europe, currency: грн, currencycode: uah, domainname: UA, id: '215', iso_code: UKR, iso_num: '804', subcontinent: 'East Europe', timezone: '+2', title_alphabeta: Ukraine, title_en: Ukraine, title_full_ru: ' ', title_ru: Ukraine, title_ua: Ukraine, vat: '20', webdomain: phleetto.uk }, district: '', googleplaceid: '', id: '7556', latit: '46.7636100000', longit: '36.7986100000', nationalid: '2310400000', nationaltitle: Berdiansk, region: { country: '215', id: '7', timezone: '', title_ru: 'Zaporizhzha oblast', title_ua: 'Zaporizhzha oblast' }, title_ru: Berdiansk, title_ua: Berdiansk }, townstring: '', zip: null }, checkpointcontacts: { cellnum: '', contactperson: '3067', id: 1111, remark: '' }, complete: false, date1: 1466035200, date2: 1466467200, dimensions: [{ title: 't weight', value: 45 }, { title: 'mcub volume', value: 0 }, { title: 'm length', value: 0 }, { title: 'm width', value: 0 }, { title: 'm height', value: 0 }, { title: null, value: 0 }], factarrivaldate: -62169984000, factarrivaltime: '00:00:00', id: 111365645, plannedarrivaldate: -62169984000, plannedarrivaltime: '00:00:00', suggestedOrder: null, time1: '08:30:00', time2: '14:00:00', triggered: true, workaction: 1, workaction_data: { classic: '1', doer_ru: shipper, id: '1', instance_accus_case: 'point of loading', title: charge, title_ru: loading, title_ru_accus_case: loading, title_ru_rod_case: loading, title_ua: loading, title_ua_rod_case: loading }, workcompletedate: -62169984000, workcompletetime: '00:00:00', workstartdate: -62169984000, workstarttime: '00:00:00' }, { bordercrossforoperator: false, cargo: А, checkpoint: { address: '1, Low Street', apicode: '4518', badcoords: '0', classic: '1', client: '760', company: { actsonbaseof: '', apikeyNP: '', bankaccount: '', bankname: '', cardholdercode: '', cardholdername: '', cardnum: '', country: '215', director: '', director_case: '', directorfirstname: '', directorpatronymic: '', email: '', factaddress: '', faxnum: '', id: '170', ifoid: '', korraccount: '', legaladdress: '', logisticsratified: '0', logisticsratifiedbyuser: '0', logisticsratifiedmoment: -62169984000, natcomid: '', othercontactinfo: '', ownership: '', registryvalidated: null, signer: '', signer_case: '', swift: null, taxid: '', telnum: '', title_full_ru: '', title_ru: ооо, vatid: '', website: '' }, customs: '0', duration: '120', end-workinghours: '', googleplaceid: '', harbor: null, id: '4518', json: '', latit: '50.550696000000000', longit: '30.225138000000000', radius_km: '0.5', remark: '', service: '0', start-workinghours: '', technote: null, town: { borderswith: '0', country: { continent: Europe, currency: грн, currencycode: uah, domainname: UA, id: '215', iso_code: UKR, iso_num: '804', subcontinent: 'East Europe', timezone: '+2', title_alphabeta: Ukraine, title_en: Ukraine, title_full_ru: ' ', title_ru: Ukraine, title_ua: Ukraine, vat: '20', webdomain: phleetto.uk }, district: Irpin, googleplaceid: '', id: '9327', latit: '50.4461100000', longit: '30.0652800000', nationalid: '3222480802', nationaltitle: Bucha, region: { country: '215', id: '9', timezone: '', title_ru: 'Kyiv region', title_ua: 'Kyiv region' }, title_ru: Bucha, title_ua: Bucha }, townstring: '', zip: null }, checkpointcontacts: { cellnum: '0676227670', contactperson: Jenny, id: 1111, remark: '' }, complete: false, date1: 1466467200, date2: -62169984000, dimensions: [{ title: 't weight', value: 1 }, { title: 'mcub volume', value: 0 }, { title: 'm length', value: 0 }, { title: 'm width', value: 0 }, { title: 'm height', value: 0 }, { title: null, value: 0 }], factarrivaldate: -62169984000, factarrivaltime: '00:00:00', id: 111365646, plannedarrivaldate: -62169984000, plannedarrivaltime: '00:00:00', suggestedOrder: null, time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 1, workaction_data: { classic: '1', doer_ru: shipper, id: '1', instance_accus_case: 'point of loading', title: charge, title_ru: loading, title_ru_accus_case: loading, title_ru_rod_case: loading, title_ua: loading, title_ua_rod_case: loading }, workcompletedate: -62169984000, workcompletetime: '00:00:00', workstartdate: -62169984000, workstarttime: '00:00:00' }, { bordercrossforoperator: false, cargo: '', checkpoint: { address: '1, Low Street', apicode: '4518', badcoords: '0', classic: '1', client: '760', company: { actsonbaseof: '', apikeyNP: '', bankaccount: '', bankname: '', cardholdercode: '', cardholdername: '', cardnum: '', country: '215', director: '', director_case: '', directorfirstname: '', directorpatronymic: '', email: '', factaddress: '', faxnum: '', id: '170', ifoid: '', korraccount: '', legaladdress: '', logisticsratified: '0', logisticsratifiedbyuser: '0', logisticsratifiedmoment: -62169984000, natcomid: '', othercontactinfo: '', ownership: '', registryvalidated: null, signer: '', signer_case: '', swift: null, taxid: '', telnum: '', title_full_ru: '', title_ru: ооо, vatid: '', website: '' }, customs: '0', duration: '120', end-workinghours: '', googleplaceid: '', harbor: null, id: '4518', json: '', latit: '50.550696000000000', longit: '30.225138000000000', radius_km: '0.5', remark: '', service: '0', start-workinghours: '', technote: null, town: { borderswith: '0', country: { continent: Europe, currency: грн, currencycode: uah, domainname: UA, id: '215', iso_code: UKR, iso_num: '804', subcontinent: 'East Europe', timezone: '+2', title_alphabeta: Ukraine, title_en: Ukraine, title_full_ru: ' ', title_ru: Ukraine, title_ua: Ukraine, vat: '20', webdomain: phleetto.uk }, district: Irpin, googleplaceid: '', id: '9327', latit: '50.4461100000', longit: '30.0652800000', nationalid: '3222480802', nationaltitle: Bucha, region: { country: '215', id: '9', timezone: '', title_ru: 'Kyiv region', title_ua: 'Kyiv region' }, title_ru: Bucha, title_ua: Bucha }, townstring: '', zip: null }, checkpointcontacts: { cellnum: '0676227670', contactperson: Jenny, id: 1111, remark: '' }, complete: false, date1: 1467244800, date2: 1466640000, dimensions: [{ title: 't weight', value: 0 }, { title: 'mcub volume', value: 0 }, { title: 'm length', value: 0 }, { title: 'm width', value: 0 }, { title: 'm height', value: 0 }, { title: null, value: 0 }], id: 111365647, plannedarrivaldate: -62169984000, plannedarrivaltime: '00:00:00', time1: '08:30:00', time2: '22:00:00', triggered: false, workaction: 2, workaction_data: { classic: '1', doer_ru: consignee, id: '2', instance_accus_case: 'point of unloading', title: uncharge, title_ru: Unloading, title_ru_accus_case: unloading, title_ru_rod_case: unloading, title_ua: unloading, title_ua_rod_case: unloading } }] }, routeresponse: { type: number, example: 73702 }, routestatus: { type: number, example: 6 }, routetender: { type: object, properties: { tenderstatus: { type: number, example: 1 }, winnerstatus: { type: number, example: 2 } } }, step: { type: number, example: 0 }, tenderavailableunillmoment: { type: string, example: 1753395720 }, tenderterms: { nullable: true, example: null }, tendertimetobepublished: { type: string, example: 1753360312 }, tonnprice: { type: number, example: 331.09 }, totalcount: { type: number, example: 2 }, totalweight: { type: number, example: 46 }, unitPrices: { type: array, items: { type: object, properties: { title: { type: string, example: UAH/tonn }, value: { type: string, example: '331.09' } } }, example: [{ title: UAH/tonn, value: '331.09' }, { title: UAH/mcub, value: '0.00' }, { title: UAH/km, value: '0.00' }] }, userclientdata: { type: object, properties: { cellnum: { type: string, example: '+380991231212' }, email: { type: string, example: email@gmail.com }, name: { type: string, example: John } } }, usermark: { type: object, properties: { clientLevel: { nullable: true, example: null }, userLevel: { nullable: true, example: null } } }, useroperatordata: { type: object, properties: { cellnum: { type: string, nullable: true, example: '0671231212' }, email: { type: string, nullable: true, example: email@gmail.com }, name: { type: string, example: 'Josh Potter' } } }, userroutenumber: { type: string, example: asd } } } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { route: { autosubscribe: false, blindtender: false, bookedbyme: false, bookedsince: 1575638584, bookedtill: -62169984000, booktime: 30, budget: 15230, cartype: null, chargetype: null, clientdata: { hash: 3c5e448b11f15293807d9cfdedf21582 }, companydata: { natcomid: '1231231231231', title_ru: 'ОрджМеталлПромИнweightт, АО' }, complete: false, context: { iconTitle: null, title: null }, defaultcurrency: null, deleted: false, distance: 47, ferryproperty: ['Pallets 15 pcs', 'Temperature 0 ° C', 'Belts 5 pcs'], istender: false, kmprice: 0, maxquotewithcommission: 0, mcubeprice: 0, nds: false, newMessages: 0, operatordata: { contract_date: 1722470400, contract_number: CSW-11, hash: 77f085a461d24c90296abcd5ff4cf62f, natcomid: '88888888', title_ru: 'Carrier 1, LTD' }, paymenttype: { id: 3, title: Cash }, payorcompany: { id: 0, natcomid: null, title: null }, periodic: 243-06-16, remark: '', response: { 73702: { cancelled: '0', car: { actual_provider_natcomid: '37534432', actual_provider_title: 'Phleetto, LTD', axes: 0, body_type: TIPPER, body_type_unique_id: 113, carstyle: singlecarstyle, cartype: 10, cellnum: '', height: 0, id: 15677, insuredTil: -62169984000, length: 0.999, loadcapacity: '0.000', make: { id: 6, title_ru: Citroen }, model: null, number: '123', remark: '', total_weight: '20.500', trailer: 180256, vehicleclass: null, vin: '', volume: 0.999, weight: 0, width: 0 }, checkedtender: '0', companytitle: null, companytitlewing: null, driver: { car: 15677, demographicid: 123123123123-123123123, driverlicenseissued: '123', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: /0, firstname: '123', id: 14793, inblacklist: '0', lastname: /0, maincellphone: '123', passportserial: '', patronymic: '', taxid: '' }, driver2: null, id: 73702, isMine: true, loadquote: null, moment: 1466096342, operator: 180, operatorispartnerwithclient: '0', operatorsupervisorid: null, orderlist: null, paymenttype: '0', pricequote: 0, pricequoteavailableuntil: '', pricequoteavailableuntilmoment: -62169984000, pricequotewing: null, pricequotewithcommission: null, remark: '', route: 94352, selected: '0', status: '', trailer: { axes: '0', body_type: 11-TIPPER, body_type_unique_id: 213, height: '4.000', id: '180256', length: '13.000', loadcapacity: '0.000', make: KRONE, model: 'SDR 27', number: АА0000РІ, total_weight: '35.000', volume: '0.000', weight: '10.540', width: '2.000' }, user: 269 } }, routeparts: [{ bordercrossforoperator: false, cargo: Pallets, checkpoint: { address: '1, High Street', apicode: '3941', badcoords: '0', classic: '1', client: '760', company: { actsonbaseof: '', apikeyNP: '', bankaccount: '', bankname: '', cardholdercode: '', cardholdername: '', cardnum: '', country: '215', director: '', director_case: '', directorfirstname: '', directorpatronymic: '', email: '', factaddress: '', faxnum: '', id: '3463', ifoid: '', korraccount: '', legaladdress: '', logisticsratified: '0', logisticsratifiedbyuser: '0', logisticsratifiedmoment: -62169984000, natcomid: '', othercontactinfo: '', ownership: '', registryvalidated: null, signer: '', signer_case: '', swift: null, taxid: '', telnum: '', title_full_ru: '', title_ru: 'Loader, LTD', vatid: '', website: '' }, customs: '0', duration: '120', end-workinghours: '', googleplaceid: '', harbor: null, id: '3941', json: '', latit: '46.762989000000000', longit: '36.793458000000000', radius_km: '0.5', remark: '', service: '0', start-workinghours: '', technote: null, town: { borderswith: '0', country: { continent: Europe, currency: грн, currencycode: uah, domainname: UA, id: '215', iso_code: UKR, iso_num: '804', subcontinent: 'East Europe', timezone: '+2', title_alphabeta: Ukraine, title_en: Ukraine, title_full_ru: ' ', title_ru: Ukraine, title_ua: Ukraine, vat: '20', webdomain: phleetto.uk }, district: '', googleplaceid: '', id: '7556', latit: '46.7636100000', longit: '36.7986100000', nationalid: '2310400000', nationaltitle: Berdiansk, region: { country: '215', id: '7', timezone: '', title_ru: 'Zaporizhzha oblast', title_ua: 'Zaporizhzha oblast' }, title_ru: Berdiansk, title_ua: Berdiansk }, townstring: '', zip: null }, checkpointcontacts: { cellnum: '', contactperson: '3067', id: 1111, remark: '' }, complete: false, date1: 1466035200, date2: 1466467200, dimensions: [{ title: 't weight', value: 45 }, { title: 'mcub volume', value: 0 }, { title: 'm length', value: 0 }, { title: 'm width', value: 0 }, { title: 'm height', value: 0 }, { title: null, value: 0 }], factarrivaldate: -62169984000, factarrivaltime: '00:00:00', id: 111365645, plannedarrivaldate: -62169984000, plannedarrivaltime: '00:00:00', suggestedOrder: null, time1: '08:30:00', time2: '14:00:00', triggered: true, workaction: 1, workaction_data: { classic: '1', doer_ru: shipper, id: '1', instance_accus_case: 'point of loading', title: charge, title_ru: loading, title_ru_accus_case: loading, title_ru_rod_case: loading, title_ua: loading, title_ua_rod_case: loading }, workcompletedate: -62169984000, workcompletetime: '00:00:00', workstartdate: -62169984000, workstarttime: '00:00:00' }, { bordercrossforoperator: false, cargo: А, checkpoint: { address: '1, Low Street', apicode: '4518', badcoords: '0', classic: '1', client: '760', company: { actsonbaseof: '', apikeyNP: '', bankaccount: '', bankname: '', cardholdercode: '', cardholdername: '', cardnum: '', country: '215', director: '', director_case: '', directorfirstname: '', directorpatronymic: '', email: '', factaddress: '', faxnum: '', id: '170', ifoid: '', korraccount: '', legaladdress: '', logisticsratified: '0', logisticsratifiedbyuser: '0', logisticsratifiedmoment: -62169984000, natcomid: '', othercontactinfo: '', ownership: '', registryvalidated: null, signer: '', signer_case: '', swift: null, taxid: '', telnum: '', title_full_ru: '', title_ru: ооо, vatid: '', website: '' }, customs: '0', duration: '120', end-workinghours: '', googleplaceid: '', harbor: null, id: '4518', json: '', latit: '50.550696000000000', longit: '30.225138000000000', radius_km: '0.5', remark: '', service: '0', start-workinghours: '', technote: null, town: { borderswith: '0', country: { continent: Europe, currency: грн, currencycode: uah, domainname: UA, id: '215', iso_code: UKR, iso_num: '804', subcontinent: 'East Europe', timezone: '+2', title_alphabeta: Ukraine, title_en: Ukraine, title_full_ru: ' ', title_ru: Ukraine, title_ua: Ukraine, vat: '20', webdomain: phleetto.uk }, district: Irpin, googleplaceid: '', id: '9327', latit: '50.4461100000', longit: '30.0652800000', nationalid: '3222480802', nationaltitle: Bucha, region: { country: '215', id: '9', timezone: '', title_ru: 'Kyiv region', title_ua: 'Kyiv region' }, title_ru: Bucha, title_ua: Bucha }, townstring: '', zip: null }, checkpointcontacts: { cellnum: '0676227670', contactperson: Jenny, id: 1111, remark: '' }, complete: false, date1: 1466467200, date2: -62169984000, dimensions: [{ title: 't weight', value: 1 }, { title: 'mcub volume', value: 0 }, { title: 'm length', value: 0 }, { title: 'm width', value: 0 }, { title: 'm height', value: 0 }, { title: null, value: 0 }], factarrivaldate: -62169984000, factarrivaltime: '00:00:00', id: 111365646, plannedarrivaldate: -62169984000, plannedarrivaltime: '00:00:00', suggestedOrder: null, time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 1, workaction_data: { classic: '1', doer_ru: shipper, id: '1', instance_accus_case: 'point of loading', title: charge, title_ru: loading, title_ru_accus_case: loading, title_ru_rod_case: loading, title_ua: loading, title_ua_rod_case: loading }, workcompletedate: -62169984000, workcompletetime: '00:00:00', workstartdate: -62169984000, workstarttime: '00:00:00' }, { bordercrossforoperator: false, cargo: '', checkpoint: { address: '1, Low Street', apicode: '4518', badcoords: '0', classic: '1', client: '760', company: { actsonbaseof: '', apikeyNP: '', bankaccount: '', bankname: '', cardholdercode: '', cardholdername: '', cardnum: '', country: '215', director: '', director_case: '', directorfirstname: '', directorpatronymic: '', email: '', factaddress: '', faxnum: '', id: '170', ifoid: '', korraccount: '', legaladdress: '', logisticsratified: '0', logisticsratifiedbyuser: '0', logisticsratifiedmoment: -62169984000, natcomid: '', othercontactinfo: '', ownership: '', registryvalidated: null, signer: '', signer_case: '', swift: null, taxid: '', telnum: '', title_full_ru: '', title_ru: ооо, vatid: '', website: '' }, customs: '0', duration: '120', end-workinghours: '', googleplaceid: '', harbor: null, id: '4518', json: '', latit: '50.550696000000000', longit: '30.225138000000000', radius_km: '0.5', remark: '', service: '0', start-workinghours: '', technote: null, town: { borderswith: '0', country: { continent: Europe, currency: грн, currencycode: uah, domainname: UA, id: '215', iso_code: UKR, iso_num: '804', subcontinent: 'East Europe', timezone: '+2', title_alphabeta: Ukraine, title_en: Ukraine, title_full_ru: ' ', title_ru: Ukraine, title_ua: Ukraine, vat: '20', webdomain: phleetto.uk }, district: Irpin, googleplaceid: '', id: '9327', latit: '50.4461100000', longit: '30.0652800000', nationalid: '3222480802', nationaltitle: Bucha, region: { country: '215', id: '9', timezone: '', title_ru: 'Kyiv region', title_ua: 'Kyiv region' }, title_ru: Bucha, title_ua: Bucha }, townstring: '', zip: null }, checkpointcontacts: { cellnum: '0676227670', contactperson: Jenny, id: 1111, remark: '' }, complete: false, date1: 1467244800, date2: 1466640000, dimensions: [{ title: 't weight', value: 0 }, { title: 'mcub volume', value: 0 }, { title: 'm length', value: 0 }, { title: 'm width', value: 0 }, { title: 'm height', value: 0 }, { title: null, value: 0 }], id: 111365647, plannedarrivaldate: -62169984000, plannedarrivaltime: '00:00:00', time1: '08:30:00', time2: '22:00:00', triggered: false, workaction: 2, workaction_data: { classic: '1', doer_ru: consignee, id: '2', instance_accus_case: 'point of unloading', title: uncharge, title_ru: Unloading, title_ru_accus_case: unloading, title_ru_rod_case: unloading, title_ua: unloading, title_ua_rod_case: unloading } }], routeresponse: 73702, routestatus: 6, tonnprice: 331.09, totalweight: 46, unitPrices: [{ title: UAH/tonn, value: '331.09' }, { title: UAH/mcub, value: '0.00' }, { title: UAH/km, value: '0.00' }], userclientdata: { cellnum: '+380991231212', email: email@gmail.com, name: John }, useroperatordata: { cellnum: '0671231212', email: email@gmail.com, name: 'Josh Potter' } } }, status: success }
                'Success (tender)':
                  value: { data: { route: { autosubscribe: false, blindtender: false, bookedbyme: false, bookedsince: -62169984000, bookedtill: -62169984000, booktime: 60, budget: 0, budgetcomment: 'tenderгрн Terms tender-genetiveYour-offer-was-selected. ', cartype: null, chargetype: null, clientSettings: { allowOperatorIndicateRoutepartOrder: '1', allowRemarkPricequote: '1', detailedLoadInfo: '1', forceBorderInput: '1', forceOperatorUnloadConfirm: '1', forcemaxquote: '1', forcestepquotes: '1', routeresponseLimitHours: '3', showLoadSummary: '1', warehouserForceLoadingArrival: '0' }, clientdata: { hash: 3c5e448b11f15293807d9cfdedf21582 }, companydata: { natcomid: '1231231231231', title_ru: 'Client, LTD' }, complete: false, context: { iconTitle: null, title: null }, currentMinQuote: 1000, defaultcurrency: null, deleted: false, distance: 1761.75, fastwinprice: 0, ferryproperty: [], freeforall: false, id: 104105, istender: true, kmprice: 0.57, maxquote: 0, maxquotewithcommission: 0, mcubeprice: 0, nds: true, newMessages: 0, operatordata: { contract_date: -62169984000, contract_number: '', hash: 316f03860bf020ffa01c50dceaaf7ba2, natcomid: '6722356984', title_ru: 'Carrier 1, LTD' }, paymenttype: { id: 2, title: 'Bank transfer' }, periodic: 163-07-25, pricefor: ride, remark: 'Quo qui perferendis modi placeat porro.', response: { 76393: { cancelled: '0', car: { actual_provider_natcomid: null, actual_provider_title: null, axes: 0, body_type: null, body_type_unique_id: null, carstyle: null, cartype: 0, cellnum: null, height: 0, id: 0, insuredTil: null, latit: null, length: 0, loadcapacity: null, longit: null, make: { id: 0 }, model: null, number: null, remark: null, total_weight: null, trailer: null, vehicleclass: null, vin: null, volume: 0, weight: 0, width: 0, year_of_manufact: 0 }, checkedtender: '0', classic_price_strategy: '0', companytitle: null, companytitlewing: null, driver: null, driver2: null, id: 76393, isMine: true, loadquote: '2.00', moment: 1753360328, nullified: '0', operator: 538, operatorispartnerwithclient: '1', operatorsupervisorid: '278', orderlist: null, paymenttype: null, pricequote: 1000, pricequoteavailableuntil: '', pricequoteavailableuntilmoment: -62169984000, pricequotewing: null, pricequotewithcommission: '1000.00', remark: '', route: 104105, selected: '0', status: '', trailer: null, user: 921, vat: '0.00' } }, routeparts: [{ bordercrossforoperator: false, cargo: 'Cargo 412506000', chargeparams: [[{ title: 'Esport declaration', value: exportDeclarationFromSupplier }, { title: 'Temperature requirements', value: ' ˚C' }]], checkpoint: { address: 'Bartley Park', apicode: '', badcoords: '0', classic: '1', client: '279', customs: '0', end-workinghours: '', googleplaceid: ChIJY3fauPyJc0gRKO3dNsgzN-A, harbor: null, id: '10875', json: '0', latit: '50.910540100000000', longit: '-1.508143800000000', radius_km: '0.5', remark: '', service: '0', start-workinghours: '', technote: null, town: { borderswith: null, country: { continent: Europe, currency: GBP, currencycode: gbp, domainname: GB, id: '193', iso_code: GBR, iso_num: '826', subcontinent: 'Northern Europe', timezone: '+0', title_alphabeta: 'United Kingdom', title_en: 'United Kingdom', title_full_ru: 'The United Kingdom of Great Britain and Northern Ireland', title_ru: 'Great Britain', title_ua: 'Great Britain', vat: '20', webdomain: .co.uk }, district: Hampshire, googleplaceid: ChIJY3fauPyJc0gRKO3dNsgzN-A, id: '2402083', latit: '50.9141239000', longit: '-1.4985934000', nationalid: null, nationaltitle: null, region: { country: '193', id: '3391', timezone: '', title_ru: England, title_ua: '' }, title_ru: Southampton, title_ua: '' }, townstring: '', zip: null }, checkpointcontacts: null, complete: false, date1: 1753920000, date2: -62169984000, dimensions: [{ dimension: weight, measureunit: tonn-abbr, title: 'tonn-abbr weight', value: 42 }, { dimension: volume, measureunit: mcube-abbr, title: 'mcube-abbr volume', value: 0 }, { dimension: length, measureunit: meter-abbr, title: 'meter-abbr length', value: 0 }, { dimension: width, measureunit: meter-abbr, title: 'meter-abbr width', value: 0 }, { dimension: height, measureunit: meter-abbr, title: 'meter-abbr height', value: 0 }, { dimension: dalvolume, measureunit: '', title: ' dalvolume', value: 0 }, { dimension: palletplaces, measureunit: '', title: ' palletplaces', value: 0 }], factarrivaldate: -62169984000, factarrivaltime: '00:00:00', id: 111391427, plannedarrivaldate: -62169984000, plannedarrivaltime: '00:00:00', suggestedOrder: '0', time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 1, workaction_data: { classic: '1', doer_ru: shipper, id: '1', instance_accus_case: 'point of Loading', title: charge, title_ru: Loading, title_ru_accus_case: loading, title_ru_rod_case: Loading, title_ua: Loading, title_ua_rod_case: Loading }, workcompletedate: -62169984000, workcompletetime: '00:00:00', workstartdate: -62169984000, workstarttime: '00:00:00' }, { bordercrossforoperator: false, cargo: null, chargeparams: [[{ title: 'Esport declaration', value: exportDeclarationFromSupplier }, { title: 'Temperature requirements', value: ' ˚C' }]], checkpoint: { address: 'ul. some street, 12a', apicode: '', badcoords: '0', classic: '1', client: '279', customs: '0', end-workinghours: '', googleplaceid: '', harbor: null, id: '10871', json: '0', latit: '52.225118800000000', longit: '21.012047400000000', radius_km: '0.5', remark: '', service: '0', start-workinghours: '', technote: null, town: { borderswith: null, country: { continent: Europe, currency: '', currencycode: '', domainname: PL, id: '165', iso_code: POL, iso_num: '616', subcontinent: 'East Europe', timezone: '', title_alphabeta: Poland, title_en: Poland, title_full_ru: 'Republic of Poland', title_ru: Poland, title_ua: Poland, vat: '0', webdomain: '' }, district: '', googleplaceid: '', id: '2402077', latit: '0.0000000000', longit: '0.0000000000', nationalid: null, nationaltitle: null, region: { country: '165', id: '3386', timezone: '', title_ru: '', title_ua: '' }, title_ru: Warsaw, title_ua: '' }, townstring: '', zip: null }, checkpointcontacts: null, complete: false, date1: 1753920000, date2: -62169984000, dimensions: [{ dimension: weight, measureunit: tonn-abbr, title: 'tonn-abbr weight', value: 42 }, { dimension: volume, measureunit: mcube-abbr, title: 'mcube-abbr volume', value: 0 }, { dimension: length, measureunit: meter-abbr, title: 'meter-abbr length', value: 0 }, { dimension: width, measureunit: meter-abbr, title: 'meter-abbr width', value: 0 }, { dimension: height, measureunit: meter-abbr, title: 'meter-abbr height', value: 0 }, { dimension: dalvolume, measureunit: '', title: ' dalvolume', value: 0 }, { dimension: palletplaces, measureunit: '', title: ' palletplaces', value: 0 }], factarrivaldate: -62169984000, factarrivaltime: '00:00:00', id: 111391428, plannedarrivaldate: -62169984000, plannedarrivaltime: '00:00:00', suggestedOrder: '0', time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 2, workaction_data: { classic: '1', doer_ru: consignee, id: '2', instance_accus_case: 'point of unloading', title: uncharge, title_ru: unloading, title_ru_accus_case: unloading, title_ru_rod_case: unloading, title_ua: unloading, title_ua_rod_case: unloading }, workcompletedate: -62169984000, workcompletetime: '00:00:00', workstartdate: -62169984000, workstarttime: '00:00:00' }], routeresponse: 76393, routestatus: -1, routetender: { tenderstatus: 1, winnerstatus: 2 }, step: 0, tenderavailableunillmoment: 1753395720, tenderterms: null, tendertimetobepublished: 1753360312, tonnprice: 23.81, totalcount: 2, totalweight: 42, unitPrices: [{ title: UAH/tonn, value: '23.81' }, { title: UAH/mcub, value: '0.00' }, { title: UAH/km, value: '0.57' }, { title: UAH/decaliter, value: '0.00' }, { title: UAH/pallet, value: '0.00' }], userclientdata: { cellnum: '+380673453456', email: email@email.com, name: 'John Specialist' }, usermark: { clientLevel: null, userLevel: null }, useroperatordata: { cellnum: null, email: null, name: '' }, userroutenumber: asd } }, status: success }
        400:
          description: 'Missing route number'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'We couldn’t find such a route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Missing route number':
                  value: { message: 'We couldn’t find such a route.', relogin: false, status: error }
        403:
          description: 'Missing token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is required' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Missing token':
                  value: { message: 'Token is required', relogin: true, status: error }
  /a/v2/rest/public/getRouteMessageGroups:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Routes & Tenders'
      summary: 'Get Conversation Groups'
      description: |-
        The method returns groups of messages for a given route/tender. Groups are grouped by collocutor, with last message included.

        If a certain collocutor company passed as `collocutor` param, then _all_ messages from that collocutor are listed.

        - if successful you will receive message groups or all messages of a collocutor
        - if unsuccessful you will receive an error explaining the problem in the language you supplied with the header, or in the language set within the app if the route is unavailable
      operationId: getConversationGroups
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: '{{periodic}}'
          description: 'Periodic of route/tender'
        -
          name: collocutor
          in: query
          schema:
            type: string
            example: '{{companyHash}}'
          description: 'Optional. If passed, shows all messages from the passed collocutor within the passed route/tender.'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: 'Two companies (collocutors) in route/tender / All messages from one company (collocutor) in route/tender / No messages for you in route/tender'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { example: [{ clientHash: 4901c7a773bcc4c5d124302482b88fbe, clientNatcomid: '6722356984', companyTitle: 'Partner LTD', haveNewMessages: true, lastMessageDate: 1630270872, lastMessageShort: 'first message', userAvatar: '' }, { clientHash: 302482b88fbe4901c7a773bcc4c5d124, clientNatcomid: '6721356984', companyTitle: 'Another Partner, LTD', haveNewMessages: true, lastMessageDate: 1630270847, lastMessageShort: 'second message', userAvatar: null }], anyOf: [{ type: array, items: { type: object, properties: { clientHash: { type: string, example: 4901c7a773bcc4c5d124302482b88fbe }, clientNatcomid: { type: string, example: '6722356984' }, companyTitle: { type: string, example: 'Partner LTD' }, haveNewMessages: { type: boolean, example: true }, lastMessageDate: { type: string, example: 1630270872 }, lastMessageShort: { type: string, example: 'first message' }, userAvatar: { type: string, nullable: true, example: '' } } }, example: [{ clientHash: 4901c7a773bcc4c5d124302482b88fbe, clientNatcomid: '6722356984', companyTitle: 'Partner LTD', haveNewMessages: true, lastMessageDate: 1630270872, lastMessageShort: 'first message', userAvatar: '' }, { clientHash: 302482b88fbe4901c7a773bcc4c5d124, clientNatcomid: '6721356984', companyTitle: 'Another Partner, LTD', haveNewMessages: true, lastMessageDate: 1630270847, lastMessageShort: 'second message', userAvatar: null }] }, { type: object, properties: { 158030: { type: object, properties: { authorCompanyTitle: { type: string, example: 'Partner, LTD' }, authorHash: { type: string, example: a88a8888aaa8d88aa8a8d8a888a8aa88 }, authorName: { type: string, example: Sender }, authorNatcomid: { type: string, example: '6722356984' }, content: { type: string, example: 'Please inform us in advance about the vehicle’s arrival.' }, content_plaintext: { type: string, example: content }, moment: { type: string, example: 1630270847 }, new: { type: boolean, example: true }, priority: { type: string, example: normal }, userAvatar: { type: string, example: '' } } }, 158032: { type: object, properties: { authorCompanyTitle: { type: string, example: 'Partner, LTD' }, authorHash: { type: string, example: a88a8888aaa8d88aa8a8d8a888a8aa88 }, authorName: { type: string, example: Sender }, authorNatcomid: { type: string, example: '6712356984' }, content: { type: string, example: 'second message' }, content_plaintext: { type: string, example: content }, moment: { type: string, example: 1630271072 }, new: { type: boolean, example: true }, priority: { type: string, example: normal }, userAvatar: { type: string, example: '' } } } } }, { type: array, items: [], example: [] }] }
                  status: { type: string, example: success }
              examples:
                'All messages from one company (collocutor) in route/tender':
                  value: { data: { 158030: { authorCompanyTitle: 'Partner, LTD', authorHash: a88a8888aaa8d88aa8a8d8a888a8aa88, authorName: Sender, authorNatcomid: '6722356984', content: 'Please inform us in advance about the vehicle’s arrival.', content_plaintext: content, moment: 1630270847, new: true, priority: normal, userAvatar: '' }, 158032: { authorCompanyTitle: 'Partner, LTD', authorHash: a88a8888aaa8d88aa8a8d8a888a8aa88, authorName: Sender, authorNatcomid: '6712356984', content: 'second message', content_plaintext: content, moment: 1630271072, new: true, priority: normal, userAvatar: '' } }, status: success }
                'No messages for you in route/tender':
                  value: { data: [], status: success }
                'Two companies (collocutors) in route/tender':
                  value: { data: [{ clientHash: 4901c7a773bcc4c5d124302482b88fbe, clientNatcomid: '6722356984', companyTitle: 'Partner LTD', haveNewMessages: true, lastMessageDate: 1630270872, lastMessageShort: 'first message', userAvatar: '' }, { clientHash: 302482b88fbe4901c7a773bcc4c5d124, clientNatcomid: '6721356984', companyTitle: 'Another Partner, LTD', haveNewMessages: true, lastMessageDate: 1630270847, lastMessageShort: 'second message', userAvatar: null }], status: success }
        400:
          description: 'Invalid collocutor for valid route/tender / Route not found / No permission to view route/tender'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Company not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid collocutor for valid route/tender':
                  value: { message: 'Company not found', relogin: false, status: error }
                'No permission to view route/tender':
                  value: { message: 'You dont have permission to view this route', relogin: false, status: error }
                'Route not found':
                  value: { message: 'Route not found', relogin: false, status: error }
  /a/v2/rest/public/getRouteMessageRecepients:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Routes & Tenders'
      summary: 'Get Available Message Recipients'
      description: |-
        This endpoint retrieves a list of potential message recipients for a specified route or tender. It requires a valid JWT token for authentication and allows specifying a preferred language for the feedback messages. The endpoint is particularly useful for obtaining relevant contacts for communication related to specific routes or tenders.

        *   if success response will include a list of potential message recipients
      operationId: getAvailableMessageRecipients
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: '{{singleRoute}}'
          description: 'Periodic of route/tender'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Wed, 20 Dec 2023 14:12:51 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.25.1
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { recepientCompany: { type: string, example: 'Shipper LTD' }, recepientHash: { type: string, example: da9cc741ae2ca7e4adf596b773a7b187 }, recepientNatcomid: { type: string, example: '37534432223' } } }, example: [{ recepientCompany: 'Shipper LTD', recepientHash: da9cc741ae2ca7e4adf596b773a7b187, recepientNatcomid: '37534432223' }, { recepientCompany: 'Shipper 2 LTD', recepientHash: 316f03860bf020ffa01c50dceaaf7ba2, recepientNatcomid: '47534432223' }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ recepientCompany: 'Shipper LTD', recepientHash: da9cc741ae2ca7e4adf596b773a7b187, recepientNatcomid: '37534432223' }, { recepientCompany: 'Shipper 2 LTD', recepientHash: 316f03860bf020ffa01c50dceaaf7ba2, recepientNatcomid: '47534432223' }], status: success }
        400:
          description: 'Route not found / No permission to view route/tender'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Route not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'No permission to view route/tender':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
                'Route not found':
                  value: { message: 'Route not found', relogin: false, status: error }
  /a/v2/rest/public/sendMessage:
    post:
      tags:
        - 'Routes & tenders / Common Operations / Routes & Tenders'
      summary: 'Send Message'
      description: |-
        Allows shipper to send a plain text message to the carrier that pertains to a particular route.

        Params:

        - **periodic**: string, required, periodic of the route in question
        - **recepient**: string, requried, hash of the carrier
        - **message**: string, required, plain text message
      operationId: sendMessage
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  type: string
                  example: 'test message https://phleet.to'
                periodic:
                  type: string
                  example: 18-07-21
                recipient:
                  type: string
                  example: 316f03860bf020ffa01c50dceaaf7ba2
            examples:
              'Send Message':
                value:
                  message: 'test message https://phleet.to'
                  periodic: 18-07-21
                  recipient: 316f03860bf020ffa01c50dceaaf7ba2
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Wed, 06 Dec 2023 17:06:43 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.25.1
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  status: { type: boolean, example: true }
              examples:
                Success:
                  value: { status: true }
        403:
          description: 'Token not supplied'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Mon, 01 May 2023 14:28:17 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'token is required' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Token not supplied':
                  value: { message: 'token is required', relogin: true, status: error }
  /a/v2/rest/public/routeChronology:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Routes & Tenders'
      summary: 'Get Activity Log'
      description: |-
        Returns the list of actions (changes) performed with a single route/tender.
        - if successful you will receive your route chronology 
        - if unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: If requested by a shipper account the endpoint returns all information. If requested by a carrier account, some limitations apply.
      operationId: getActivityLog
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: '{{singleRoute}}'
          description: 'Single route periodic'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { action: { type: string, example: 'Route published' }, author: { type: string, example: 'John Doe' }, date: { type: string, example: 1579478400 }, isMyCompany: { type: boolean, example: true }, time: { type: string, example: '10:16' } } }, example: [{ action: 'Route published', author: 'John Doe', date: 1579478400, isMyCompany: true, time: '10:16' }, { action: 'The carrier proposed a vehicle.', author: '', date: 1579478400, isMyCompany: false, time: '10:17' }, { action: 'The customer approved the proposal.', author: '', date: 1579478400, isMyCompany: false, time: '10:17' }, { action: 'The carrier confirmed the work on the route.', author: '', date: 1579478400, isMyCompany: false, time: '10:17' }, { action: 'The vehicle arrived for loading.', author: '', date: 1579478400, isMyCompany: false, time: '10:17' }, { action: 'Loading confirmed successfully.', author: '', date: 1579478400, isMyCompany: false, time: '10:17' }, { action: 'The vehicle arrived at customs.', author: '', date: 1579478400, isMyCompany: false, time: '10:17' }, { action: 'The vehicle is back on the road.', author: '', date: 1579478400, isMyCompany: false, time: '10:18' }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ action: 'Route published', author: 'John Doe', date: 1579478400, isMyCompany: true, time: '10:16' }, { action: 'The carrier proposed a vehicle.', author: '', date: 1579478400, isMyCompany: false, time: '10:17' }, { action: 'The customer approved the proposal.', author: '', date: 1579478400, isMyCompany: false, time: '10:17' }, { action: 'The carrier confirmed the work on the route.', author: '', date: 1579478400, isMyCompany: false, time: '10:17' }, { action: 'The vehicle arrived for loading.', author: '', date: 1579478400, isMyCompany: false, time: '10:17' }, { action: 'Loading confirmed successfully.', author: '', date: 1579478400, isMyCompany: false, time: '10:17' }, { action: 'The vehicle arrived at customs.', author: '', date: 1579478400, isMyCompany: false, time: '10:17' }, { action: 'The vehicle is back on the road.', author: '', date: 1579478400, isMyCompany: false, time: '10:18' }], status: success }
        400:
          description: 'Not allowed to view route'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Not allowed to view route':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
  /a/v2/rest/public/getRouteDistance:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Routes & Tenders'
      summary: 'Get Distance'
      description: |-
        Returns the information about the total route distance, as well as the distance to border, and the detailed distance between all points.

        - If successful you will receive information about the vehicle and the drivers on the route
            
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getDistance
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: '{{singleRoute}}'
          description: 'Single route periodic'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Fri, 25 Apr 2025 16:29:29 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.27.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
            X-Xdebug-Profile-Filename:
              schema:
                type: string
                example: /var/tmp/cachegrind.out.82151
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { distance: { type: number, example: 3575.65 }, distanceAfterBorder: { type: number, example: 2815.49 }, distanceToBorder: { type: number, example: 760.16 }, legs: { type: array, items: { type: object, properties: { 0: { type: object, properties: { country: { type: string, example: UKR }, country_iso: { type: string, example: '804' }, latit: { type: number, example: 50.4167119 }, longit: { type: number, example: 30.539385 }, title: { type: string, example: Kyiv } } }, 1: { type: object, properties: { country: { type: string, example: UKR }, country_iso: { type: string, example: '804' }, latit: { type: number, example: 50.4449244 }, longit: { type: number, example: 30.5069196 }, title: { type: string, example: Kyiv } } }, distance: { type: number, example: 5.7 } } }, example: [{ 0: { country: UKR, country_iso: '804', latit: 50.4167119, longit: 30.539385, title: Kyiv }, 1: { country: UKR, country_iso: '804', latit: 50.4449244, longit: 30.5069196, title: Kyiv }, distance: 5.7 }, { 0: { country: UKR, country_iso: '804', latit: 50.4449244, longit: 30.5069196, title: Kyiv }, 1: { country: UKR, country_iso: '804', latit: 45.46056, longit: 28.28611, title: Reni }, distance: 754.46 }, { 0: { country: UKR, country_iso: '804', latit: 45.46056, longit: 28.28611, title: Reni }, 1: { country: GBR, country_iso: '826', latit: 50.9110102, longit: -1.404417, title: Southampton }, distance: 2815.49 }] }, unit: { type: string, example: km } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { distance: 3575.65, distanceAfterBorder: 2815.49, distanceToBorder: 760.16, legs: [{ 0: { country: UKR, country_iso: '804', latit: 50.4167119, longit: 30.539385, title: Kyiv }, 1: { country: UKR, country_iso: '804', latit: 50.4449244, longit: 30.5069196, title: Kyiv }, distance: 5.7 }, { 0: { country: UKR, country_iso: '804', latit: 50.4449244, longit: 30.5069196, title: Kyiv }, 1: { country: UKR, country_iso: '804', latit: 45.46056, longit: 28.28611, title: Reni }, distance: 754.46 }, { 0: { country: UKR, country_iso: '804', latit: 45.46056, longit: 28.28611, title: Reni }, 1: { country: GBR, country_iso: '826', latit: 50.9110102, longit: -1.404417, title: Southampton }, distance: 2815.49 }], unit: km }, status: success }
        400:
          description: 'Not allowed to view route'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Not allowed to view route':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
  /a/v2/rest/public/getRouteDocuments:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Routes & Tenders'
      summary: 'Get Documents'
      description: |-
        This endpoint allows you to retrieve documents related to a specific route.

        *   if successful response will include the documents related to the specified route.
      operationId: getDocuments
      parameters:
        -
          name: route
          in: query
          schema:
            type: string
            example: '{{singleRoute}}'
          description: 'Single route periodic'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { authorCompany: { type: string, example: 'Something, LTD' }, authorCompanyHash: { type: string, example: b1e411e6032a93bee5acfaff26173691 }, authorNatcomid: { type: string, example: '2722356984' }, authorUser: { type: string, example: 'Robot Valera' }, authorUserId: { type: string, example: '10194' }, extention: { type: string, example: png }, moment: { type: string, example: 1703076973 }, remark: { type: string, example: 2013-12-15-в-21.26.55-e1387135740104 }, route: { type: string, example: 52-10-23 }, url: { type: string, example: 'https://test.phleetto.co.uk:443/uploads/sovtes_uploadfile_6719_SPACE SPACE_6582c84b48b9f_.png' }, urlEncoded: { type: string, example: https%3A%2F%2Ftest.phleetto.co.uk%3A443%2Fuploads%2Fsovtes_uploadfile_6719_SPACE+SPACE_6582c84b48b9f_.png } } }, example: [{ authorCompany: 'Something, LTD', authorCompanyHash: b1e411e6032a93bee5acfaff26173691, authorNatcomid: '2722356984', authorUser: 'Robot Valera', authorUserId: '10194', extention: png, moment: 1703076973, remark: 2013-12-15-в-21.26.55-e1387135740104, route: 52-10-23, url: 'https://test.phleetto.co.uk:443/uploads/sovtes_uploadfile_6719_SPACE SPACE_6582c84b48b9f_.png', urlEncoded: https%3A%2F%2Ftest.phleetto.co.uk%3A443%2Fuploads%2Fsovtes_uploadfile_6719_SPACE+SPACE_6582c84b48b9f_.png }, { authorCompany: 'Something, LTD', authorCompanyHash: b1e411e6032a93bee5acfaff26173691, authorNatcomid: '6722356984', authorUser: 'Super Oleg', authorUserId: '11814', extention: png, moment: 1703078205, remark: ttndraft.png, route: 52-10-23, url: 'https://test.phleetto.co.uk/uploads/Phleetto-route-79669-a756fe-ttndraft.png', urlEncoded: https%3A%2F%2Ftest.phleetto.co.uk%2Fuploads%2FPhleetto-route-79669-a756fe-ttndraft.png }, { authorCompany: 'Something, LTD', authorCompanyHash: b1e411e6032a93bee5acfaff26173691, authorNatcomid: '722356984', authorUser: 'Some User', authorUserId: '11814', extention: png, moment: 1703078220, remark: ttndraft.png, route: 52-10-23, url: 'https://test.phleetto.co.uk/uploads/Phleetto-route-57346-ac3aa6-ttndraft.png', urlEncoded: https%3A%2F%2Ftest.phleetto.co.uk%2Fuploads%2FPhleetto-route-57346-ac3aa6-ttndraft.png }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ authorCompany: 'Something, LTD', authorCompanyHash: b1e411e6032a93bee5acfaff26173691, authorNatcomid: '2722356984', authorUser: 'Robot Valera', authorUserId: '10194', extention: png, moment: 1703076973, remark: 2013-12-15-в-21.26.55-e1387135740104, route: 52-10-23, url: 'https://test.phleetto.co.uk:443/uploads/sovtes_uploadfile_6719_SPACE SPACE_6582c84b48b9f_.png', urlEncoded: https%3A%2F%2Ftest.phleetto.co.uk%3A443%2Fuploads%2Fsovtes_uploadfile_6719_SPACE+SPACE_6582c84b48b9f_.png }, { authorCompany: 'Something, LTD', authorCompanyHash: b1e411e6032a93bee5acfaff26173691, authorNatcomid: '6722356984', authorUser: 'Super Oleg', authorUserId: '11814', extention: png, moment: 1703078205, remark: ttndraft.png, route: 52-10-23, url: 'https://test.phleetto.co.uk/uploads/Phleetto-route-79669-a756fe-ttndraft.png', urlEncoded: https%3A%2F%2Ftest.phleetto.co.uk%2Fuploads%2FPhleetto-route-79669-a756fe-ttndraft.png }, { authorCompany: 'Something, LTD', authorCompanyHash: b1e411e6032a93bee5acfaff26173691, authorNatcomid: '722356984', authorUser: 'Some User', authorUserId: '11814', extention: png, moment: 1703078220, remark: ttndraft.png, route: 52-10-23, url: 'https://test.phleetto.co.uk/uploads/Phleetto-route-57346-ac3aa6-ttndraft.png', urlEncoded: https%3A%2F%2Ftest.phleetto.co.uk%2Fuploads%2FPhleetto-route-57346-ac3aa6-ttndraft.png }], status: success }
        400:
          description: 'Invalid route number'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this route.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid route number':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
  /a/v2/rest/public/addDocument:
    post:
      tags:
        - 'Routes & tenders / Common Operations / Routes & Tenders'
      summary: 'Upload Document'
      description: |-
        Allows shippers and carriers to add documents to the order. Details of the allowed filetypes and size can be found in the endpoint GET getFileUploadRequirements (located in Aux folder of this documentation).

        No more than 5 files can be uploaded in a single request.
      operationId: uploadDocument
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                'documents[]':
                  type: string
                  format: binary
                periodic:
                  description: 'Periodic of the route. Required. String/tender'
                  type: string
                  example: 32676307200
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Thu, 16 Mar 2023 13:12:26 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { documents: { type: object, properties: { 0-02-0a-4f9bdbbac9084f6a3e726f30462e500aaf2ae740f4d8aa924e9e7a05d08e841d_2709ed6caa8.jpg: { type: object, properties: { size: { type: string, example: '250493' }, url: { type: string, example: 'https://test.phleetto.co.uk/uploads/Phleetto-route-43759-43a4af-0-02-0a-4f9bdbbac9084f6a3e726f30462e500aaf2ae740f4d8aa924e9e7a05d08e841d_2709ed6caa8.jpg' } } }, '856 (1).pdf': { type: object, properties: { size: { type: string, example: '189441' }, url: { type: string, example: 'https://test.phleetto.co.uk/uploads/Phleetto-route-71884-3dcba3-856 (1).pdf' } } } } }, route: { type: string, example: 32676307200 } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { documents: { 0-02-0a-4f9bdbbac9084f6a3e726f30462e500aaf2ae740f4d8aa924e9e7a05d08e841d_2709ed6caa8.jpg: { size: '250493', url: 'https://test.phleetto.co.uk/uploads/Phleetto-route-43759-43a4af-0-02-0a-4f9bdbbac9084f6a3e726f30462e500aaf2ae740f4d8aa924e9e7a05d08e841d_2709ed6caa8.jpg' }, '856 (1).pdf': { size: '189441', url: 'https://test.phleetto.co.uk/uploads/Phleetto-route-71884-3dcba3-856 (1).pdf' } }, route: 32676307200 }, status: success }
        400:
          description: 'Invalid route / Not allowed to view route / Invalid file type passed / Supplied file is infected / Too many documents supplied / Supplied document is too big'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Thu, 16 Mar 2023 13:19:42 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Route not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid file type passed':
                  value: { message: 'Cet134_assessment1_starter.zip document is not one of jpg, jpeg, png, bmp, gif, tif, pdf, doc, docx, xls, xlsx (zip passed). Cannot proceed.', relogin: false, status: error }
                'Invalid route':
                  value: { message: 'Route not found', relogin: false, status: error }
                'Not allowed to view route':
                  value: { message: 'You don’t have permission to view this route.', relogin: false, status: error }
                'Supplied document is too big':
                  value: { message: 'Ticket_4995937.pdf document is too big (9221KB). Must be less than 8MB. Cannot proceed.', relogin: false, status: error }
                'Supplied file is infected':
                  value: { message: 'CheckAbilityToRefuseRouteByOperatorCest.refuseFromRoute.fail.png document is infected. Cannot proceed.', relogin: false, status: error }
                'Too many documents supplied':
                  value: { message: 'No more than 5 documents are allowed (6 supplied). Cannot proceed.', relogin: false, status: error }
  /a/v2/rest/public/getTown:
    get:
      tags:
        - 'Routes & tenders / Common Operations / Routes & Tenders'
      summary: 'Get Stop Towns'
      description: |-
        Returns the list of towns, depending on the list of parameters. The method is complex, allows not only to get a list of cities, but also to get cities in which points with complex filtering are present for example: get the list of cities with checkpoints in a specific country or get cities with border checkpoints.

        *   if successful you will receive list of towns, depending of the list parameters
        *   If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getStopTowns
      parameters:
        -
          name: byCheckpoint
          in: query
          schema:
            type: string
            example: '{{townsByCheckpoint}}'
          description: 'Optional int. True: Returns the list of cities in which checkpoints/warehouses of current user company are present. False: ignores the parameter'
        -
          name: byCompany
          in: query
          schema:
            type: string
            example: '{{townsByCheckpointCompany}}'
          description: 'Optional int. Filter. Id of the company. Narrows the list of cities to cities in which checkpoints/warehouses of given company are present, works only if `byCheckpoint` parameter is passed.'
        -
          name: byCountry
          in: query
          schema:
            type: string
            example: '{{townsByCheckpointCountry}}'
          description: 'Optional Int. Filter. Id of the country. Narrows the list of cities by checkpoints in a given country, works only if `byCheckpoint` parameter is passed.'
        -
          name: byRegion
          in: query
          schema:
            type: string
            example: '{{townsByCheckpointRegion}}'
          description: 'Optional Int. Filter. Id of the region. Narrows the list of cities by checkpoints in a given region, works only if `byCheckpoint` parameter is passed.'
        -
          name: byCustoms
          in: query
          schema:
            type: string
            example: '{{customsFlag}}'
          description: 'Optional int. Narrows the list given with `byCheckpoint` parameter to cities with customs checkpoints. Works only if `byCheckpoint` parameter is passed.'
        -
          name: byBorder
          in: query
          schema:
            type: string
            example: '{{townsByCheckpointBorder}}'
          description: 'Optional int. Returns the list of cities with border checkpoints'
        -
          name: bordersWith
          in: query
          schema:
            type: string
            example: '{{borderCountryId}}'
          description: 'Optional int. Filter. Narrows the list given by `byBorder` parameter to cities with border checkpoints of Ukraine and another country, id of which is passed. `byBorder` parameter must be passed.'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: 'Success (Towns with checkpoints of given company in a given region are returned) / Success (Towns with checkpoints in Ukraine are returned) / Success (Towns with border checkpoints of Ukraine and Poland)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { borderswith: { type: number, example: 0 }, country: { type: number, example: 215 }, district: { type: string, example: '' }, id: { type: number, example: 9657 }, latit: { type: number, example: 50.44028 }, longit: { type: number, example: 30.55944 }, nationalId: { type: string, example: '3200000000' }, region: { type: object, properties: { id: { type: number, example: 9 }, title: { type: string, example: 'Kyiv oblast' } } }, title: { type: string, example: Kyiv } } }, example: [{ borderswith: 0, country: 215, district: '', id: 9657, latit: 50.44028, longit: 30.55944, nationalId: '3200000000', region: { id: 9, title: 'Kyiv oblast' }, title: Kyiv }, { borderswith: 0, country: 215, district: 'Nemyrivskyi raion', id: 1447, latit: 48.95694, longit: 29.21972, nationalId: '0500000000', region: { id: 1, title: 'Vinnytsia oblast' }, title: Yurkovtsy }, { borderswith: 0, country: 215, district: '', id: 16944, latit: 46.46889, longit: 30.73056, nationalId: '5110100000', region: { id: 15, title: 'Odesa oblast' }, title: Odesa }, { borderswith: 0, country: 215, district: 'Vyshhorodskyi raion', id: 9421, latit: 50.5875, longit: 30.49472, nationalId: '3221810100', region: { id: 9, title: 'Kyiv oblast' }, title: Vyshhorod }, { borderswith: 0, country: 215, district: '', id: 4474, latit: 48.72806, longit: 37.56583, nationalId: '1412900000', region: { id: 4, title: 'Donetsk oblast' }, title: Kramatorsk }, { borderswith: 0, country: 215, district: '', id: 14380, latit: 49.84306, longit: 24.01778, nationalId: '4610100000', region: { id: 13, title: 'Lviv oblast' }, title: Lviv }, { borderswith: 0, country: 215, district: 'Teplitskyi raion', id: 149, latit: 48.63278, longit: 29.58694, nationalId: '0500000000', region: { id: 1, title: 'Vinnytsia oblast' }, title: 'Velyka Mochulka' }, { borderswith: 0, country: 215, district: 'Trostianetskyi raion', id: 327, latit: 48.45583, longit: 29.34, nationalId: '0524181701', region: { id: 1, title: 'Vinnytsia oblast' }, title: Demydovka }, { borderswith: 0, country: 215, district: '', id: 15783, latit: 46.95861, longit: 32.04556, nationalId: '4810100000', region: { id: 14, title: 'Mykolaiv oblast' }, title: Mykolaiv }, { borderswith: 0, country: 215, district: 'Velykonovoselkivskyi raion', id: 5245, latit: 47.88222, longit: 37.03306, nationalId: '1421286403', region: { id: 4, title: 'Donetsk oblast' }, title: 'Yasna Polyana' }, { borderswith: 0, country: 215, district: '', id: 21517, latit: 50.9075, longit: 34.79833, nationalId: '5900000000', region: { id: 18, title: 'Sumy oblast' }, title: Sumy }, { borderswith: 0, country: 215, district: 'Murovanokurylovetskyi raion', id: 1218, latit: 48.77361, longit: 27.85667, nationalId: '0523487805', region: { id: 1, title: 'Vinnytsia oblast' }, title: Stepanky }, { borderswith: 0, country: 215, district: '', id: 16577, latit: 45.34694, longit: 28.83528, nationalId: '5110600000', region: { id: 15, title: 'Odesa oblast' }, title: Izmail }, { borderswith: 0, country: 215, district: 'Starosambirskyi raion', id: 14463, latit: 49.55083, longit: 22.72472, nationalId: '4625182904', region: { id: 13, title: 'Lviv oblast' }, title: Myhove }, { borderswith: 0, country: 215, district: '', id: 19507, latit: 50.40722, longit: 25.76194, nationalId: '5625082602', region: { id: 17, title: 'Rivne oblast' }, title: Dubno }, { borderswith: 0, country: 215, district: 'Kalynivskyi raion', id: 948, latit: 49.57694, longit: 28.70306, nationalId: '0521682409', region: { id: 1, title: 'Vinnytsia oblast' }, title: Pervomaiske }, { borderswith: 0, country: 215, district: 'Krasnolymanskyi raion', id: 4446, latit: 49.08667, longit: 37.88667, nationalId: '1400000000', region: { id: 4, title: 'Donetsk oblast' }, title: Kolodiazi }, { borderswith: 0, country: 215, district: '', id: 399, latit: 49.03222, longit: 28.11639, nationalId: '0510300000', region: { id: 1, title: 'Vinnytsia oblast' }, title: Zhmerynka }, { borderswith: 0, country: 215, district: 'Haisynskyi raion', id: 1222, latit: 48.73278, longit: 29.13639, nationalId: '0520885603', region: { id: 1, title: 'Vinnytsia oblast' }, title: Stepashky }, { borderswith: 0, country: 215, district: 'Mohyliv-Podilskyi raion', id: 617, latit: 48.595, longit: 27.85389, nationalId: '0522683701', region: { id: 1, title: 'Vinnytsia oblast' }, title: Krychanovka }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 16306, latit: 45.4075, longit: 28.93694, nationalId: '5122080401', region: { id: 15, title: 'Odesa oblast' }, title: Bohate }, { borderswith: 0, country: 215, district: 'Nemyrivskyi raion', id: 544, latit: 49.02528, longit: 28.88889, nationalId: '0500000000', region: { id: 1, title: 'Vinnytsia oblast' }, title: Kovalivka }, { borderswith: 0, country: 215, district: 'Kovel raion', id: 2323, latit: 51.04361, longit: 25.09833, nationalId: '0722188006', region: { id: 2, title: 'Volyn oblast' }, title: Svydnyky }, { borderswith: 0, country: 215, district: 'Mohyliv-Podilskyi raion', id: 875, latit: 48.41083, longit: 28.07833, nationalId: '0522684503', region: { id: 1, title: 'Vinnytsia oblast' }, title: Novonikolsk }, { borderswith: 0, country: 215, district: 'Marinskyi raion', id: 4374, latit: 48.05722, longit: 37.34639, nationalId: '1423385404', region: { id: 4, title: 'Donetsk oblast' }, title: Izmailovka }, { borderswith: 0, country: 215, district: 'Bar raion', id: 535, latit: 48.9875, longit: 27.71417, nationalId: '0520283606', region: { id: 1, title: 'Vinnytsia oblast' }, title: Kyianivka }, { borderswith: 172, country: 215, district: '', id: 2401854, latit: 0, longit: 0, nationalId: '5100000000', region: { id: 15, title: 'Odesa oblast' }, title: Nyashkohrad }, { borderswith: 0, country: 215, district: 'Ovidiopolskyi raion', id: 2401925, latit: 46.2433958, longit: 30.4406292, nationalId: '5123755100', region: { id: 15, title: 'Odesa oblast' }, title: Ovidiopol }, { borderswith: 0, country: 215, district: 'Kyiv city', id: 2401924, latit: 50.4781687, longit: 30.4926825, nationalId: '3200000000', region: { id: 3370, title: 'Kyiv city' }, title: Kyiv }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 2401943, latit: 45.3375111, longit: 28.8342837, nationalId: '5110600000', region: { id: 15, title: 'Odesa oblast' }, title: Izmail }, { borderswith: 0, country: 215, district: '', id: 2401882, latit: 46.482526, longit: 30.7233095, nationalId: '5110100000', region: { id: 15, title: 'Odesa oblast' }, title: Odesa }, { borderswith: 0, country: 215, district: 'Kalanchakskyi raion', id: 2401929, latit: 46.0781094, longit: 33.2938802, nationalId: '6523286601', region: { id: 21, title: 'Kherson oblast' }, title: Khorly }, { borderswith: 0, country: 215, district: 'Saratskyi raion', id: 2401960, latit: 45.956169, longit: 29.6956249, nationalId: '5100000000', region: { id: 15, title: 'Odesa oblast' }, title: Zaria }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 2401961, latit: 41.7228102, longit: -97.6765157, nationalId: '5122083401', region: { id: 15, title: 'Odesa oblast' }, title: Loshchynivka }, { borderswith: 0, country: 215, district: 'Pershotravnevyi raion', id: 2401962, latit: 46.9573015, longit: 37.3940991, nationalId: '1423984401', region: { id: 4, title: 'Donetsk oblast' }, title: Melekyne }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 2401963, latit: 41.1825545, longit: -97.4165053, nationalId: '5122083201', region: { id: 15, title: 'Odesa oblast' }, title: Larzhanka }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 2401964, latit: 45.3349816, longit: 28.8513317, nationalId: '5122086301', region: { id: 15, title: 'Odesa oblast' }, title: 'Stara Nekrasovka' }, { borderswith: 0, country: 215, district: 'Kozelets raion', id: 2401965, latit: 40.2875007, longit: -76.2594981, nationalId: '7422084501', region: { id: 24, title: 'Chernihiv oblast' }, title: Krekhaiv }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 17179, latit: 45.34056, longit: 28.92417, nationalId: '5122086301', region: { id: 15, title: 'Odesa oblast' }, title: 'Stara Nekrasovka' }, { borderswith: 0, country: 215, district: 'Volodymyr-Volynskyi raion', id: 1494, latit: 50.81639, longit: 24.52306, nationalId: '0720580803', region: { id: 2, title: 'Volyn oblast' }, title: Beheta }, { borderswith: 0, country: 215, district: 'Bolhradskyi raion', id: 2401980, latit: 45.6838431, longit: 28.6143107, nationalId: '5121410100', region: { id: 15, title: 'Odesa oblast' }, title: Bolhrad }, { borderswith: 0, country: 215, district: 'Kryvyi Rih raion', id: 2401982, latit: 48.1549436, longit: 33.4573917, nationalId: '1200000000', region: { id: 3, title: 'Dnipropetrovsk oblast' }, title: Zaria }, { borderswith: 0, country: 215, district: 'Radomyshl raion', id: 2401985, latit: 50.4965282, longit: 29.2337369, nationalId: '1825010100', region: { id: 5, title: 'Zhytomyr oblast' }, title: Radomyshl }, { borderswith: 0, country: 215, district: 'Borodianka raion', id: 2401987, latit: 50.6445031, longit: 29.9146299, nationalId: '3221055100', region: { id: 9, title: 'Kyiv oblast' }, title: Borodianka }, { borderswith: 0, country: 215, district: 'Zolotonosha raion', id: 2401996, latit: 49.756486, longit: 31.9965, nationalId: '7100000000', region: { id: 23, title: 'Cherkasy oblast' }, title: '19725 Podolske' }, { borderswith: 0, country: 215, district: '', id: 2401999, latit: 46.0691944, longit: 30.4609372, nationalId: '5100000000', region: { id: 15, title: 'Odesa oblast' }, title: Zatoka }, { borderswith: 0, country: 215, district: 'Bilhorod-Dnistrovskyi (city)', id: 16556, latit: 46.06694, longit: 30.4575, nationalId: '5100000000', region: { id: 15, title: 'Odesa oblast' }, title: Zatoka }, { borderswith: 0, country: 215, district: 'Tatarbunary raion', id: 2402000, latit: 45.7639111, longit: 29.4776453, nationalId: '5125080501', region: { id: 15, title: 'Odesa oblast' }, title: Bashtanovka }, { borderswith: 0, country: 215, district: 'Tatarbunary raion', id: 16275, latit: 45.76361, longit: 29.47861, nationalId: '5125080501', region: { id: 15, title: 'Odesa oblast' }, title: Bashtanovka }, { borderswith: 0, country: 215, district: '', id: 2402002, latit: 50.2686005, longit: 28.6387354, nationalId: '1810100000', region: { id: 5, title: 'Zhytomyr oblast' }, title: Zhytomyr }, { borderswith: 0, country: 215, district: '', id: 2402010, latit: 50.9082465, longit: 34.7678886, nationalId: '5900000000', region: { id: 18, title: 'Sumy oblast' }, title: Sumy }, { borderswith: 0, country: 215, district: '', id: 2402022, latit: 46.6671575, longit: 32.6022276, nationalId: '6510100000', region: { id: 21, title: 'Kherson oblast' }, title: Kherson }, { borderswith: 0, country: 215, district: 'Makariv raion', id: 2402023, latit: 50.4573262, longit: 29.8126552, nationalId: '3222755100', region: { id: 9, title: 'Kyiv oblast' }, title: Makariv }, { borderswith: 0, country: 215, district: 'Halych raion', id: 2402033, latit: 49.1344024, longit: 24.7423857, nationalId: '2621287301', region: { id: 8, title: 'Ivano-Frankivsk oblast' }, title: Tustan }, { borderswith: 0, country: 215, district: 'Reni raion', id: 2402040, latit: 45.455341, longit: 28.2959842, nationalId: '5124110100', region: { id: 15, title: 'Odesa oblast' }, title: Reni }, { borderswith: 0, country: 215, district: 'Velykonovoselkivskyi raion', id: 2402043, latit: 47.8817212, longit: 37.031651, nationalId: '1421286403', region: { id: 4, title: 'Donetsk oblast' }, title: 'Yasna Polyana' }, { borderswith: 0, country: 215, district: 'Brovary raion', id: 2402044, latit: 50.5214937, longit: 30.9066286, nationalId: '3224283601', region: { id: 9, title: 'Kyiv oblast' }, title: Krasylivka }, { borderswith: 0, country: 215, district: '', id: 2402051, latit: 51.498832, longit: 31.281942, nationalId: '7410100000', region: { id: 24, title: 'Chernihiv oblast' }, title: Chernihiv }, { borderswith: 0, country: 215, district: '', id: 2402052, latit: 49.554838, longit: 25.605172, nationalId: '6110100000', region: { id: 19, title: 'Ternopil oblast' }, title: Ternopil }, { borderswith: 0, country: 215, district: '', id: 2402055, latit: 50.7487015, longit: 25.3275473, nationalId: '0710100000', region: { id: 2, title: 'Volyn oblast' }, title: Lutsk }, { borderswith: 0, country: 215, district: '', id: 2402056, latit: 49.232516, longit: 28.447504, nationalId: '0510100000', region: { id: 1, title: 'Vinnytsia oblast' }, title: Vinnytsia }, { borderswith: 0, country: 215, district: '', id: 2402057, latit: 47.8403776, longit: 35.1269615, nationalId: '2325282803', region: { id: 7, title: 'Zaporizhzhia oblast' }, title: Zaporizhzhia }, { borderswith: 0, country: 215, district: '', id: 2402058, latit: 49.2687951, longit: 23.8178279, nationalId: '4611200000', region: { id: 13, title: 'Lviv oblast' }, title: Stryi }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 2401901, latit: 45.4072076, longit: 28.8752088, nationalId: '5122085901', region: { id: 15, title: 'Odesa oblast' }, title: Safiiany }, { borderswith: 0, country: 215, district: 'Horodok raion', id: 2402059, latit: 49.799354, longit: 23.518328, nationalId: '4600000000', region: { id: 13, title: 'Lviv oblast' }, title: Rodatychi }, { borderswith: 0, country: 215, district: '', id: 2402062, latit: 48.522386, longit: 32.2581692, nationalId: '3500000000', region: { id: 10, title: 'Kirovohrad oblast' }, title: Kirovohrad }, { borderswith: 0, country: 215, district: '', id: 2402063, latit: 49.0672277, longit: 33.398153, nationalId: '5310400000', region: { id: 16, title: 'Poltava oblast' }, title: Kremenchuk }, { borderswith: 0, country: 215, district: 'Kiliia raion', id: 2402067, latit: 45.5251012, longit: 29.6035438, nationalId: '5125083901', region: { id: 15, title: 'Odesa oblast' }, title: Prymorske }, { borderswith: 0, country: 215, district: '', id: 2402070, latit: 50.8525631, longit: 24.3265661, nationalId: '0710200000', region: { id: 2, title: 'Volyn oblast' }, title: Volodymyr-Volynskyi }, { borderswith: 0, country: 215, district: '', id: 2402071, latit: 48.6725271799, longit: 29.1980173621, nationalId: '0510600000', region: { id: 1, title: 'Vinnytsia oblast' }, title: Ladyzhyn }, { borderswith: 0, country: 215, district: 'Biliaivka raion', id: 2402072, latit: 46.5445659402, longit: 30.6291412349, nationalId: '5121084201', region: { id: 15, title: 'Odesa oblast' }, title: Nerubaiske }, { borderswith: 0, country: 215, district: '', id: 2402074, latit: 50.6199, longit: 26.251617, nationalId: '5610100000', region: { id: 17, title: 'Rivne oblast' }, title: Rivne }, { borderswith: 0, country: 215, district: 'Kaniv raion', id: 2402207, latit: 49.7068645256, longit: 31.3015742863, nationalId: '7100000000', region: { id: 23, title: 'Cherkasy oblast' }, title: Stepantsi }, { borderswith: 0, country: 215, district: 'Brovary raion', id: 2402047, latit: 50.6107749164, longit: 30.8724550823, nationalId: '3200000000', region: { id: 9, title: 'Kyiv oblast' }, title: 'Velyka Dymerka' }, { borderswith: 0, country: 215, district: 'Bobrynets raion', id: 2402226, latit: 48.0581761, longit: 32.1610803, nationalId: '3520810100', region: { id: 10, title: 'Kirovohrad oblast' }, title: Bobrynets }, { borderswith: 0, country: 215, district: 'Myronivka raion', id: 2402246, latit: 49.6607558, longit: 30.9855787, nationalId: '3222910100', region: { id: 9, title: 'Kyiv oblast' }, title: Myronivka }, { borderswith: 0, country: 215, district: '', id: 2402247, latit: 49.4593213, longit: 32.0496696, nationalId: '7110100000', region: { id: 23, title: 'Cherkasy oblast' }, title: Cherkasy }, { borderswith: 0, country: 215, district: 'Zhovtnevyi raion', id: 2402252, latit: 46.9487574, longit: 32.0027311, nationalId: '4810100000', region: { id: 14, title: 'Mykolaiv oblast' }, title: Mykolaiv }, { borderswith: 0, country: 215, district: 'Artsyz raion', id: 2402263, latit: 45.982089, longit: 29.438574, nationalId: '5120410100', region: { id: 15, title: 'Odesa oblast' }, title: Artsyz }, { borderswith: 0, country: 215, district: 'Vasylkiv raion', id: 2402204, latit: 50.259078, longit: 30.2723627, nationalId: '3221455300', region: { id: 9, title: 'Kyiv oblast' }, title: Hlevakha }, { borderswith: 0, country: 215, district: '', id: 2402053, latit: 48.44407, longit: 35.050085, nationalId: '1200000000', region: { id: 3, title: 'Dnipropetrovsk oblast' }, title: Dnipropetrovsk }, { borderswith: 0, country: 215, district: '', id: 2402268, latit: 50.5837638, longit: 34.4904643, nationalId: '', region: { id: 18, title: 'Sumy oblast' }, title: Lebedyn }, { borderswith: 0, country: 215, district: '', id: 2402250, latit: 47.8895879, longit: 33.3700087, nationalId: '1211000000', region: { id: 3, title: 'Dnipropetrovsk oblast' }, title: 'Kryvyi Rih' }, { borderswith: 0, country: 215, district: 'Dolynska raion', id: 2402270, latit: 48.1132559, longit: 32.7658685, nationalId: '', region: { id: 10, title: 'Kirovohrad oblast' }, title: Dolynska }, { borderswith: 0, country: 215, district: '', id: 2402271, latit: 49.424354, longit: 26.9920121, nationalId: '', region: { id: 22, title: 'Khmelnytskyi oblast' }, title: Khmelnytskyi }, { borderswith: 0, country: 215, district: '', id: 2402272, latit: 48.0087083, longit: 37.8069273, nationalId: '', region: { id: 4, title: 'Donetsk oblast' }, title: Donetsk }, { borderswith: 0, country: 215, district: '', id: 2402276, latit: 48.626319, longit: 22.284627, nationalId: '', region: { id: 6, title: 'Zakarpattia oblast' }, title: Uzhhorod }, { borderswith: 0, country: 215, district: '', id: 2402218, latit: 0, longit: 0, nationalId: '', region: { id: 3462, title: 'Kyiv oblast' }, title: Kyiv }, { borderswith: 0, country: 215, district: '', id: 2402305, latit: 46.7820091, longit: 36.7638474, nationalId: '', region: { id: 7, title: 'Zaporizhzhia oblast' }, title: Berdiansk }, { borderswith: 0, country: 215, district: 'Brovary raion', id: 2402307, latit: 50.5394949, longit: 30.6518034, nationalId: '', region: { id: 9, title: 'Kyiv oblast' }, title: Pohreby }, { borderswith: 0, country: 215, district: '', id: 2402309, latit: 0, longit: 0, nationalId: '', region: { id: 3493, title: 'Lviv oblast' }, title: Lviv }, { borderswith: 0, country: 215, district: 'Fastiv raion', id: 2402275, latit: 50.1758214, longit: 30.1017634, nationalId: '', region: { id: 9, title: 'Kyiv oblast' }, title: Borova }, { borderswith: 0, country: 215, district: '', id: 2402050, latit: 50.0648104, longit: 29.8959608, nationalId: '3211200000', region: { id: 9, title: 'Kyiv oblast' }, title: Fastiv }, { borderswith: 0, country: 215, district: '', id: 2407364, latit: 48.5778039, longit: 39.3055643, nationalId: '', region: { id: 12, title: 'Luhansk oblast' }, title: Luhansk }, { borderswith: 0, country: 215, district: '', id: 2402054, latit: 48.930697, longit: 24.733548, nationalId: '2610100000', region: { id: 8, title: 'Ivano-Frankivsk oblast' }, title: Ivano-Frankivsk }, { borderswith: 0, country: 215, district: '', id: 2407509, latit: 0, longit: 0, nationalId: '', region: { id: 3456, title: '' }, title: '123' }, { borderswith: 0, country: 215, district: 'Ovidiopolskyi raion', id: 2407523, latit: 0, longit: 0, nationalId: '', region: { id: 3474, title: 'Odesa oblast' }, title: Velykodolynske }, { borderswith: 0, country: 215, district: '', id: 2407535, latit: 0, longit: 0, nationalId: '', region: { id: 3456, title: '' }, title: 'Kyiv (city)' }, { borderswith: 0, country: 215, district: 'Kyiv city', id: 2407538, latit: 0, longit: 0, nationalId: '', region: { id: 3539, title: 'Pechersk district' }, title: Kyiv }, { borderswith: 0, country: 215, district: '', id: 2402212, latit: 0, longit: 0, nationalId: '', region: { id: 3462, title: 'Kyiv oblast' }, title: Kyiv }, { borderswith: 0, country: 215, district: '', id: 2407606, latit: 0, longit: 0, nationalId: '', region: { id: 3456, title: '' }, title: 'Kyiv (city)' }] }
                  status: { type: string, example: success }
              examples:
                'Success (Towns with border checkpoints of Ukraine and Poland)':
                  value: { data: [{ borderswith: 20, country: 215, district: 'Ratne raion', id: 1707, latit: 51.62556, longit: 24.12639, nationalId: '0724282201', region: { id: 2, title: 'Volyn oblast' }, title: Huta }, { borderswith: 20, country: 215, district: 'Liubeshiv raion', id: 1735, latit: 51.89306, longit: 25.51722, nationalId: '0725580901', region: { id: 2, title: 'Volyn oblast' }, title: Dolsk }, { borderswith: 20, country: 215, district: 'Ratne raion', id: 1737, latit: 51.82361, longit: 24.34139, nationalId: '0724285504', region: { id: 2, title: 'Volyn oblast' }, title: Domanove }, { borderswith: 20, country: 215, district: 'Shatsk raion', id: 2207, latit: 51.605, longit: 23.81, nationalId: '0725783901', region: { id: 2, title: 'Volyn oblast' }, title: Pishcha }, { borderswith: 20, country: 215, district: 'Shatsk raion', id: 2257, latit: 51.54194, longit: 23.71056, nationalId: '0725784501', region: { id: 2, title: 'Volyn oblast' }, title: Pulemets }, { borderswith: 20, country: 215, district: 'Ratne raion', id: 2314, latit: 51.865, longit: 24.61694, nationalId: '0724286901', region: { id: 2, title: 'Volyn oblast' }, title: Samary }, { borderswith: 20, country: 215, district: 'Ratne raion', id: 2446, latit: 51.675, longit: 24.27833, nationalId: '0724287601', region: { id: 2, title: 'Volyn oblast' }, title: Tur }, { borderswith: 20, country: 215, district: 'Shatsk raion', id: 2487, latit: 51.63833, longit: 23.72722, nationalId: '0725785005', region: { id: 2, title: 'Volyn oblast' }, title: Khrypsk }, { borderswith: 20, country: 215, district: 'Ovruch raion', id: 5526, latit: 51.56361, longit: 29.07806, nationalId: '1824286709', region: { id: 5, title: 'Zhytomyr oblast' }, title: Vystupovychi }, { borderswith: 20, country: 215, district: 'Poliske raion', id: 9374, latit: 51.36, longit: 29.43111, nationalId: '3200000000', region: { id: 9, title: 'Kyiv oblast' }, title: Vilcha }, { borderswith: 20, country: 215, district: 'Dubrovytsia raion', id: 19439, latit: 51.80361, longit: 26.69889, nationalId: '5624683001', region: { id: 17, title: 'Rivne oblast' }, title: Horodyshche }, { borderswith: 20, country: 215, district: 'Dubrovytsia raion', id: 19939, latit: 51.72444, longit: 26.9775, nationalId: '5600000000', region: { id: 17, title: 'Rivne oblast' }, title: Perebrody }, { borderswith: 20, country: 215, district: 'Chernihiv raion', id: 2138332, latit: 51.53162, longit: 30.7735551, nationalId: '7400000000', region: { id: 24, title: 'Chernihiv oblast' }, title: Slavutych }, { borderswith: 36, country: 215, district: 'Vynohradiv raion', id: 6992, latit: 48.11028, longit: 22.83833, nationalId: '2121255300', region: { id: 6, title: 'Zakarpattia oblast' }, title: Vylok }, { borderswith: 36, country: 215, district: 'Uzhhorod raion', id: 7488, latit: 48.42972, longit: 22.2175, nationalId: '2111000000', region: { id: 6, title: 'Zakarpattia oblast' }, title: Chop }, { borderswith: 127, country: 215, district: '', id: 824, latit: 48.44917, longit: 27.80306, nationalId: '0510400000', region: { id: 1, title: 'Vinnytsia oblast' }, title: Mohyliv-Podilskyi }, { borderswith: 127, country: 215, district: 'Reni raion', id: 17084, latit: 45.46056, longit: 28.28611, nationalId: '5124110100', region: { id: 15, title: 'Odesa oblast' }, title: Reni }, { borderswith: 127, country: 215, district: 'Kelmentsi raion', id: 29111, latit: 48.46861, longit: 26.82333, nationalId: '7322055100', region: { id: 25, title: 'Chernivtsi oblast' }, title: Kelmentsi }, { borderswith: 191, country: 215, district: '', id: 7448, latit: 48.62111, longit: 22.29694, nationalId: '2110100000', region: { id: 6, title: 'Zakarpattia oblast' }, title: Uzhhorod }], status: success }
                'Success (Towns with checkpoints in Ukraine are returned)':
                  value: { data: [{ borderswith: 0, country: 215, district: '', id: 9657, latit: 50.44028, longit: 30.55944, nationalId: '3200000000', region: { id: 9, title: 'Kyiv oblast' }, title: Kyiv }, { borderswith: 0, country: 215, district: 'Nemyrivskyi raion', id: 1447, latit: 48.95694, longit: 29.21972, nationalId: '0500000000', region: { id: 1, title: 'Vinnytsia oblast' }, title: Yurkovtsy }, { borderswith: 0, country: 215, district: '', id: 16944, latit: 46.46889, longit: 30.73056, nationalId: '5110100000', region: { id: 15, title: 'Odesa oblast' }, title: Odesa }, { borderswith: 0, country: 215, district: 'Vyshhorodskyi raion', id: 9421, latit: 50.5875, longit: 30.49472, nationalId: '3221810100', region: { id: 9, title: 'Kyiv oblast' }, title: Vyshhorod }, { borderswith: 0, country: 215, district: '', id: 4474, latit: 48.72806, longit: 37.56583, nationalId: '1412900000', region: { id: 4, title: 'Donetsk oblast' }, title: Kramatorsk }, { borderswith: 0, country: 215, district: '', id: 14380, latit: 49.84306, longit: 24.01778, nationalId: '4610100000', region: { id: 13, title: 'Lviv oblast' }, title: Lviv }, { borderswith: 0, country: 215, district: 'Teplytskyi raion', id: 149, latit: 48.63278, longit: 29.58694, nationalId: '0500000000', region: { id: 1, title: 'Vinnytsia oblast' }, title: 'Velyka Mochulka' }, { borderswith: 0, country: 215, district: 'Trostianetskyi raion', id: 327, latit: 48.45583, longit: 29.34, nationalId: '0524181701', region: { id: 1, title: 'Vinnytsia oblast' }, title: Demydovka }, { borderswith: 0, country: 215, district: '', id: 15783, latit: 46.95861, longit: 32.04556, nationalId: '4810100000', region: { id: 14, title: 'Mykolaiv oblast' }, title: Mykolaiv }, { borderswith: 0, country: 215, district: 'Velykonovoselkivskyi raion', id: 5245, latit: 47.88222, longit: 37.03306, nationalId: '1421286403', region: { id: 4, title: 'Donetsk oblast' }, title: 'Yasna Polyana' }, { borderswith: 0, country: 215, district: '', id: 21517, latit: 50.9075, longit: 34.79833, nationalId: '5900000000', region: { id: 18, title: 'Sumy oblast' }, title: Sumy }], status: success }
                'Success (Towns with checkpoints of given company in a given region are returned)':
                  value: { data: [{ borderswith: 0, country: 215, district: '', id: 9657, latit: 50.44028, longit: 30.55944, nationalId: '3200000000', region: { id: 9, title: 'Kyiv oblast' }, title: Kyiv }, { borderswith: 0, country: 215, district: 'Nemyrivskyi raion', id: 1447, latit: 48.95694, longit: 29.21972, nationalId: '0500000000', region: { id: 1, title: 'Vinnytsia oblast' }, title: Yurkovtsy }, { borderswith: 0, country: 215, district: '', id: 16944, latit: 46.46889, longit: 30.73056, nationalId: '5110100000', region: { id: 15, title: 'Odesa oblast' }, title: Odesa }, { borderswith: 0, country: 215, district: 'Vyshhorodskyi raion', id: 9421, latit: 50.5875, longit: 30.49472, nationalId: '3221810100', region: { id: 9, title: 'Kyiv oblast' }, title: Vyshhorod }, { borderswith: 0, country: 215, district: '', id: 4474, latit: 48.72806, longit: 37.56583, nationalId: '1412900000', region: { id: 4, title: 'Donetsk oblast' }, title: Kramatorsk }, { borderswith: 0, country: 215, district: '', id: 14380, latit: 49.84306, longit: 24.01778, nationalId: '4610100000', region: { id: 13, title: 'Lviv oblast' }, title: Lviv }, { borderswith: 0, country: 215, district: 'Teplitskyi raion', id: 149, latit: 48.63278, longit: 29.58694, nationalId: '0500000000', region: { id: 1, title: 'Vinnytsia oblast' }, title: 'Velyka Mochulka' }, { borderswith: 0, country: 215, district: 'Trostianetskyi raion', id: 327, latit: 48.45583, longit: 29.34, nationalId: '0524181701', region: { id: 1, title: 'Vinnytsia oblast' }, title: Demydovka }, { borderswith: 0, country: 215, district: '', id: 15783, latit: 46.95861, longit: 32.04556, nationalId: '4810100000', region: { id: 14, title: 'Mykolaiv oblast' }, title: Mykolaiv }, { borderswith: 0, country: 215, district: 'Velykonovoselkivskyi raion', id: 5245, latit: 47.88222, longit: 37.03306, nationalId: '1421286403', region: { id: 4, title: 'Donetsk oblast' }, title: 'Yasna Polyana' }, { borderswith: 0, country: 215, district: '', id: 21517, latit: 50.9075, longit: 34.79833, nationalId: '5900000000', region: { id: 18, title: 'Sumy oblast' }, title: Sumy }, { borderswith: 0, country: 215, district: 'Murovanokurylovetskyi raion', id: 1218, latit: 48.77361, longit: 27.85667, nationalId: '0523487805', region: { id: 1, title: 'Vinnytsia oblast' }, title: Stepanky }, { borderswith: 0, country: 215, district: '', id: 16577, latit: 45.34694, longit: 28.83528, nationalId: '5110600000', region: { id: 15, title: 'Odesa oblast' }, title: Izmail }, { borderswith: 0, country: 215, district: 'Starosambirskyi raion', id: 14463, latit: 49.55083, longit: 22.72472, nationalId: '4625182904', region: { id: 13, title: 'Lviv oblast' }, title: Myhove }, { borderswith: 0, country: 215, district: '', id: 19507, latit: 50.40722, longit: 25.76194, nationalId: '5625082602', region: { id: 17, title: 'Rivne oblast' }, title: Dubno }, { borderswith: 0, country: 215, district: 'Kalynivskyi raion', id: 948, latit: 49.57694, longit: 28.70306, nationalId: '0521682409', region: { id: 1, title: 'Vinnytsia oblast' }, title: Pervomaiske }, { borderswith: 0, country: 215, district: 'Krasnolymanskyi raion', id: 4446, latit: 49.08667, longit: 37.88667, nationalId: '1400000000', region: { id: 4, title: 'Donetsk oblast' }, title: Kolodiazi }, { borderswith: 0, country: 215, district: '', id: 399, latit: 49.03222, longit: 28.11639, nationalId: '0510300000', region: { id: 1, title: 'Vinnytsia oblast' }, title: Zhmerynka }, { borderswith: 0, country: 215, district: 'Haisynskyi raion', id: 1222, latit: 48.73278, longit: 29.13639, nationalId: '0520885603', region: { id: 1, title: 'Vinnytsia oblast' }, title: Stepashky }, { borderswith: 0, country: 215, district: 'Mohyliv-Podilskyi raion', id: 617, latit: 48.595, longit: 27.85389, nationalId: '0522683701', region: { id: 1, title: 'Vinnytsia oblast' }, title: Krychanovka }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 16306, latit: 45.4075, longit: 28.93694, nationalId: '5122080401', region: { id: 15, title: 'Odesa oblast' }, title: Bohate }, { borderswith: 0, country: 215, district: 'Nemyrivskyi raion', id: 544, latit: 49.02528, longit: 28.88889, nationalId: '0500000000', region: { id: 1, title: 'Vinnytsia oblast' }, title: Kovalivka }, { borderswith: 0, country: 215, district: 'Kovel raion', id: 2323, latit: 51.04361, longit: 25.09833, nationalId: '0722188006', region: { id: 2, title: 'Volyn oblast' }, title: Svydnyky }, { borderswith: 0, country: 215, district: 'Mohyliv-Podilskyi raion', id: 875, latit: 48.41083, longit: 28.07833, nationalId: '0522684503', region: { id: 1, title: 'Vinnytsia oblast' }, title: Novonikolsk }, { borderswith: 0, country: 215, district: 'Marinskyi raion', id: 4374, latit: 48.05722, longit: 37.34639, nationalId: '1423385404', region: { id: 4, title: 'Donetsk oblast' }, title: Izmailovka }, { borderswith: 0, country: 215, district: 'Bar raion', id: 535, latit: 48.9875, longit: 27.71417, nationalId: '0520283606', region: { id: 1, title: 'Vinnytsia oblast' }, title: Kyianivka }, { borderswith: 172, country: 215, district: '', id: 2401854, latit: 0, longit: 0, nationalId: '5100000000', region: { id: 15, title: 'Odesa oblast' }, title: Nyashkohrad }, { borderswith: 0, country: 215, district: 'Ovidiopolskyi raion', id: 2401925, latit: 46.2433958, longit: 30.4406292, nationalId: '5123755100', region: { id: 15, title: 'Odesa oblast' }, title: Ovidiopol }, { borderswith: 0, country: 215, district: 'Kyiv city', id: 2401924, latit: 50.4781687, longit: 30.4926825, nationalId: '3200000000', region: { id: 3370, title: 'Kyiv city' }, title: Kyiv }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 2401943, latit: 45.3375111, longit: 28.8342837, nationalId: '5110600000', region: { id: 15, title: 'Odesa oblast' }, title: Izmail }, { borderswith: 0, country: 215, district: '', id: 2401882, latit: 46.482526, longit: 30.7233095, nationalId: '5110100000', region: { id: 15, title: 'Odesa oblast' }, title: Odesa }, { borderswith: 0, country: 215, district: 'Kalanchakskyi raion', id: 2401929, latit: 46.0781094, longit: 33.2938802, nationalId: '6523286601', region: { id: 21, title: 'Kherson oblast' }, title: Khorly }, { borderswith: 0, country: 215, district: 'Saratskyi raion', id: 2401960, latit: 45.956169, longit: 29.6956249, nationalId: '5100000000', region: { id: 15, title: 'Odesa oblast' }, title: Zaria }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 2401961, latit: 41.7228102, longit: -97.6765157, nationalId: '5122083401', region: { id: 15, title: 'Odesa oblast' }, title: Loshchynivka }, { borderswith: 0, country: 215, district: 'Pershotravnevyi raion', id: 2401962, latit: 46.9573015, longit: 37.3940991, nationalId: '1423984401', region: { id: 4, title: 'Donetsk oblast' }, title: Melekyne }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 2401963, latit: 41.1825545, longit: -97.4165053, nationalId: '5122083201', region: { id: 15, title: 'Odesa oblast' }, title: Larzhanka }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 2401964, latit: 45.3349816, longit: 28.8513317, nationalId: '5122086301', region: { id: 15, title: 'Odesa oblast' }, title: 'Stara Nekrasovka' }, { borderswith: 0, country: 215, district: 'Kozelets raion', id: 2401965, latit: 40.2875007, longit: -76.2594981, nationalId: '7422084501', region: { id: 24, title: 'Chernihiv oblast' }, title: Krekhaiv }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 17179, latit: 45.34056, longit: 28.92417, nationalId: '5122086301', region: { id: 15, title: 'Odesa oblast' }, title: 'Stara Nekrasovka' }, { borderswith: 0, country: 215, district: 'Volodymyr-Volynskyi raion', id: 1494, latit: 50.81639, longit: 24.52306, nationalId: '0720580803', region: { id: 2, title: 'Volyn oblast' }, title: Beheta }, { borderswith: 0, country: 215, district: 'Bolhradskyi raion', id: 2401980, latit: 45.6838431, longit: 28.6143107, nationalId: '5121410100', region: { id: 15, title: 'Odesa oblast' }, title: Bolhrad }, { borderswith: 0, country: 215, district: 'Kryvyi Rih raion', id: 2401982, latit: 48.1549436, longit: 33.4573917, nationalId: '1200000000', region: { id: 3, title: 'Dnipropetrovsk oblast' }, title: Zaria }, { borderswith: 0, country: 215, district: 'Radomyshl raion', id: 2401985, latit: 50.4965282, longit: 29.2337369, nationalId: '1825010100', region: { id: 5, title: 'Zhytomyr oblast' }, title: Radomyshl }, { borderswith: 0, country: 215, district: 'Borodianka raion', id: 2401987, latit: 50.6445031, longit: 29.9146299, nationalId: '3221055100', region: { id: 9, title: 'Kyiv oblast' }, title: Borodianka }, { borderswith: 0, country: 215, district: 'Zolotonosha raion', id: 2401996, latit: 49.756486, longit: 31.9965, nationalId: '7100000000', region: { id: 23, title: 'Cherkasy oblast' }, title: '19725 Podolske' }, { borderswith: 0, country: 215, district: '', id: 2401999, latit: 46.0691944, longit: 30.4609372, nationalId: '5100000000', region: { id: 15, title: 'Odesa oblast' }, title: Zatoka }, { borderswith: 0, country: 215, district: 'Bilhorod-Dnistrovskyi (city)', id: 16556, latit: 46.06694, longit: 30.4575, nationalId: '5100000000', region: { id: 15, title: 'Odesa oblast' }, title: Zatoka }, { borderswith: 0, country: 215, district: 'Tatarbunary raion', id: 2402000, latit: 45.7639111, longit: 29.4776453, nationalId: '5125080501', region: { id: 15, title: 'Odesa oblast' }, title: Bashtanovka }, { borderswith: 0, country: 215, district: 'Tatarbunary raion', id: 16275, latit: 45.76361, longit: 29.47861, nationalId: '5125080501', region: { id: 15, title: 'Odesa oblast' }, title: Bashtanovka }, { borderswith: 0, country: 215, district: '', id: 2402002, latit: 50.2686005, longit: 28.6387354, nationalId: '1810100000', region: { id: 5, title: 'Zhytomyr oblast' }, title: Zhytomyr }, { borderswith: 0, country: 215, district: '', id: 2402010, latit: 50.9082465, longit: 34.7678886, nationalId: '5900000000', region: { id: 18, title: 'Sumy oblast' }, title: Sumy }, { borderswith: 0, country: 215, district: '', id: 2402022, latit: 46.6671575, longit: 32.6022276, nationalId: '6510100000', region: { id: 21, title: 'Kherson oblast' }, title: Kherson }, { borderswith: 0, country: 215, district: 'Makariv raion', id: 2402023, latit: 50.4573262, longit: 29.8126552, nationalId: '3222755100', region: { id: 9, title: 'Kyiv oblast' }, title: Makariv }, { borderswith: 0, country: 215, district: 'Halych raion', id: 2402033, latit: 49.1344024, longit: 24.7423857, nationalId: '2621287301', region: { id: 8, title: 'Ivano-Frankivsk oblast' }, title: Tustan }, { borderswith: 0, country: 215, district: 'Reni raion', id: 2402040, latit: 45.455341, longit: 28.2959842, nationalId: '5124110100', region: { id: 15, title: 'Odesa oblast' }, title: Reni }, { borderswith: 0, country: 215, district: 'Velykonovoselkivskyi raion', id: 2402043, latit: 47.8817212, longit: 37.031651, nationalId: '1421286403', region: { id: 4, title: 'Donetsk oblast' }, title: 'Yasna Polyana' }, { borderswith: 0, country: 215, district: 'Brovary raion', id: 2402044, latit: 50.5214937, longit: 30.9066286, nationalId: '3224283601', region: { id: 9, title: 'Kyiv oblast' }, title: Krasylivka }, { borderswith: 0, country: 215, district: '', id: 2402051, latit: 51.498832, longit: 31.281942, nationalId: '7410100000', region: { id: 24, title: 'Chernihiv oblast' }, title: Chernihiv }, { borderswith: 0, country: 215, district: '', id: 2402052, latit: 49.554838, longit: 25.605172, nationalId: '6110100000', region: { id: 19, title: 'Ternopil oblast' }, title: Ternopil }, { borderswith: 0, country: 215, district: '', id: 2402055, latit: 50.7487015, longit: 25.3275473, nationalId: '0710100000', region: { id: 2, title: 'Volyn oblast' }, title: Lutsk }, { borderswith: 0, country: 215, district: '', id: 2402056, latit: 49.232516, longit: 28.447504, nationalId: '0510100000', region: { id: 1, title: 'Vinnytsia oblast' }, title: Vinnytsia }, { borderswith: 0, country: 215, district: '', id: 2402057, latit: 47.8403776, longit: 35.1269615, nationalId: '2325282803', region: { id: 7, title: 'Zaporizhzhia oblast' }, title: Zaporizhzhia }, { borderswith: 0, country: 215, district: '', id: 2402058, latit: 49.2687951, longit: 23.8178279, nationalId: '4611200000', region: { id: 13, title: 'Lviv oblast' }, title: Stryi }, { borderswith: 0, country: 215, district: 'Izmailskyi raion', id: 2401901, latit: 45.4072076, longit: 28.8752088, nationalId: '5122085901', region: { id: 15, title: 'Odesa oblast' }, title: Safiiany }, { borderswith: 0, country: 215, district: 'Horodok raion', id: 2402059, latit: 49.799354, longit: 23.518328, nationalId: '4600000000', region: { id: 13, title: 'Lviv oblast' }, title: Rodatychi }, { borderswith: 0, country: 215, district: '', id: 2402062, latit: 48.522386, longit: 32.2581692, nationalId: '3500000000', region: { id: 10, title: 'Kirovohrad oblast' }, title: Kirovohrad }, { borderswith: 0, country: 215, district: '', id: 2402063, latit: 49.0672277, longit: 33.398153, nationalId: '5310400000', region: { id: 16, title: 'Poltava oblast' }, title: Kremenchuk }, { borderswith: 0, country: 215, district: 'Kiliia raion', id: 2402067, latit: 45.5251012, longit: 29.6035438, nationalId: '5125083901', region: { id: 15, title: 'Odesa oblast' }, title: Prymorske }, { borderswith: 0, country: 215, district: '', id: 2402070, latit: 50.8525631, longit: 24.3265661, nationalId: '0710200000', region: { id: 2, title: 'Volyn oblast' }, title: Volodymyr-Volynskyi }, { borderswith: 0, country: 215, district: '', id: 2402071, latit: 48.6725271799, longit: 29.1980173621, nationalId: '0510600000', region: { id: 1, title: 'Vinnytsia oblast' }, title: Ladyzhyn }, { borderswith: 0, country: 215, district: 'Biliaivka raion', id: 2402072, latit: 46.5445659402, longit: 30.6291412349, nationalId: '5121084201', region: { id: 15, title: 'Odesa oblast' }, title: Nerubaiske }, { borderswith: 0, country: 215, district: '', id: 2402074, latit: 50.6199, longit: 26.251617, nationalId: '5610100000', region: { id: 17, title: 'Rivne oblast' }, title: Rivne }, { borderswith: 0, country: 215, district: 'Kaniv raion', id: 2402207, latit: 49.7068645256, longit: 31.3015742863, nationalId: '7100000000', region: { id: 23, title: 'Cherkasy oblast' }, title: Stepantsi }, { borderswith: 0, country: 215, district: 'Brovary raion', id: 2402047, latit: 50.6107749164, longit: 30.8724550823, nationalId: '3200000000', region: { id: 9, title: 'Kyiv oblast' }, title: 'Velyka Dymerka' }, { borderswith: 0, country: 215, district: 'Bobrynets raion', id: 2402226, latit: 48.0581761, longit: 32.1610803, nationalId: '3520810100', region: { id: 10, title: 'Kirovohrad oblast' }, title: Bobrynets }, { borderswith: 0, country: 215, district: 'Myronivka raion', id: 2402246, latit: 49.6607558, longit: 30.9855787, nationalId: '3222910100', region: { id: 9, title: 'Kyiv oblast' }, title: Myronivka }, { borderswith: 0, country: 215, district: '', id: 2402247, latit: 49.4593213, longit: 32.0496696, nationalId: '7110100000', region: { id: 23, title: 'Cherkasy oblast' }, title: Cherkasy }, { borderswith: 0, country: 215, district: 'Zhovtnevyi raion', id: 2402252, latit: 46.9487574, longit: 32.0027311, nationalId: '4810100000', region: { id: 14, title: 'Mykolaiv oblast' }, title: Mykolaiv }, { borderswith: 0, country: 215, district: 'Artsyz raion', id: 2402263, latit: 45.982089, longit: 29.438574, nationalId: '5120410100', region: { id: 15, title: 'Odesa oblast' }, title: Artsyz }, { borderswith: 0, country: 215, district: 'Vasylkiv raion', id: 2402204, latit: 50.259078, longit: 30.2723627, nationalId: '3221455300', region: { id: 9, title: 'Kyiv oblast' }, title: Hlevakha }, { borderswith: 0, country: 215, district: '', id: 2402053, latit: 48.44407, longit: 35.050085, nationalId: '1200000000', region: { id: 3, title: 'Dnipropetrovsk oblast' }, title: Dnipropetrovsk }, { borderswith: 0, country: 215, district: '', id: 2402268, latit: 50.5837638, longit: 34.4904643, nationalId: '', region: { id: 18, title: 'Sumy oblast' }, title: Lebedyn }, { borderswith: 0, country: 215, district: '', id: 2402250, latit: 47.8895879, longit: 33.3700087, nationalId: '1211000000', region: { id: 3, title: 'Dnipropetrovsk oblast' }, title: 'Kryvyi Rih' }, { borderswith: 0, country: 215, district: 'Dolynska raion', id: 2402270, latit: 48.1132559, longit: 32.7658685, nationalId: '', region: { id: 10, title: 'Kirovohrad oblast' }, title: Dolynska }, { borderswith: 0, country: 215, district: '', id: 2402271, latit: 49.424354, longit: 26.9920121, nationalId: '', region: { id: 22, title: 'Khmelnytskyi oblast' }, title: Khmelnytskyi }, { borderswith: 0, country: 215, district: '', id: 2402272, latit: 48.0087083, longit: 37.8069273, nationalId: '', region: { id: 4, title: 'Donetsk oblast' }, title: Donetsk }, { borderswith: 0, country: 215, district: '', id: 2402276, latit: 48.626319, longit: 22.284627, nationalId: '', region: { id: 6, title: 'Zakarpattia oblast' }, title: Uzhhorod }, { borderswith: 0, country: 215, district: '', id: 2402218, latit: 0, longit: 0, nationalId: '', region: { id: 3462, title: 'Kyiv oblast' }, title: Kyiv }, { borderswith: 0, country: 215, district: '', id: 2402305, latit: 46.7820091, longit: 36.7638474, nationalId: '', region: { id: 7, title: 'Zaporizhzhia oblast' }, title: Berdiansk }, { borderswith: 0, country: 215, district: 'Brovary raion', id: 2402307, latit: 50.5394949, longit: 30.6518034, nationalId: '', region: { id: 9, title: 'Kyiv oblast' }, title: Pohreby }, { borderswith: 0, country: 215, district: '', id: 2402309, latit: 0, longit: 0, nationalId: '', region: { id: 3493, title: 'Lviv oblast' }, title: Lviv }, { borderswith: 0, country: 215, district: 'Fastiv raion', id: 2402275, latit: 50.1758214, longit: 30.1017634, nationalId: '', region: { id: 9, title: 'Kyiv oblast' }, title: Borova }, { borderswith: 0, country: 215, district: '', id: 2402050, latit: 50.0648104, longit: 29.8959608, nationalId: '3211200000', region: { id: 9, title: 'Kyiv oblast' }, title: Fastiv }, { borderswith: 0, country: 215, district: '', id: 2407364, latit: 48.5778039, longit: 39.3055643, nationalId: '', region: { id: 12, title: 'Luhansk oblast' }, title: Luhansk }, { borderswith: 0, country: 215, district: '', id: 2402054, latit: 48.930697, longit: 24.733548, nationalId: '2610100000', region: { id: 8, title: 'Ivano-Frankivsk oblast' }, title: Ivano-Frankivsk }, { borderswith: 0, country: 215, district: '', id: 2407509, latit: 0, longit: 0, nationalId: '', region: { id: 3456, title: '' }, title: '123' }, { borderswith: 0, country: 215, district: 'Ovidiopolskyi raion', id: 2407523, latit: 0, longit: 0, nationalId: '', region: { id: 3474, title: 'Odesa oblast' }, title: Velykodolynske }, { borderswith: 0, country: 215, district: '', id: 2407535, latit: 0, longit: 0, nationalId: '', region: { id: 3456, title: '' }, title: 'Kyiv (city)' }, { borderswith: 0, country: 215, district: 'Kyiv city', id: 2407538, latit: 0, longit: 0, nationalId: '', region: { id: 3539, title: 'Pechersk district' }, title: Kyiv }, { borderswith: 0, country: 215, district: '', id: 2402212, latit: 0, longit: 0, nationalId: '', region: { id: 3462, title: 'Kyiv oblast' }, title: Kyiv }, { borderswith: 0, country: 215, district: '', id: 2407606, latit: 0, longit: 0, nationalId: '', region: { id: 3456, title: '' }, title: 'Kyiv (city)' }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is required' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is required', relogin: true, status: error }
  /a/v2/rest/public/getRouteGroups:
    get:
      tags:
        - 'Routes & tenders / Listings / Routes'
      summary: 'Get Route Groups'
      description: |-
        The method shows the groups or categories of routes available to the user.

        The contents differ depending on the type of user (shipper or carrier).

        For each group of routes, you also receive a list of route stati, that are included in this group. This list is useful when you have to sort the list of routes through groups.

        - If successful, you will receive the groups of routes available to you
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getRouteGroups
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: 'Success for carrier / Success for shipper'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { aux: { type: string, nullable: true, example: null }, id: { type: number, example: 33 }, stati: { type: array, items: { type: number, example: 4 }, example: [4] }, title: { type: string, example: 'Commit to doing jobs' } } }, example: [{ aux: null, id: 33, stati: [4], title: 'Commit to doing jobs' }, { aux: '{"api":"required"}', id: 31, stati: [2], title: Available }, { aux: '{"api":"required"}', id: 34, stati: [5, 6, 8, 9, 11, 15, 16, 17], title: 'In progress' }, { aux: '{"api":"required"}', id: 36, stati: [7], title: 'At loading' }, { aux: '{"api":"required"}', id: 41, stati: [10], title: 'At unloading' }, { aux: null, id: 32, stati: [3], title: 'Vehicle in ratification' }, { aux: '{"api":"required"}', id: 65, stati: [14], title: Complete }] }
                  status: { type: string, example: success }
              examples:
                'Success for carrier':
                  value: { data: [{ aux: null, id: 33, stati: [4], title: 'Commit to doing jobs' }, { aux: '{"api":"required"}', id: 31, stati: [2], title: Available }, { aux: '{"api":"required"}', id: 34, stati: [5, 6, 8, 9, 11, 15, 16, 17], title: 'In progress' }, { aux: '{"api":"required"}', id: 36, stati: [7], title: 'At loading' }, { aux: '{"api":"required"}', id: 41, stati: [10], title: 'At unloading' }, { aux: null, id: 32, stati: [3], title: 'Vehicle in ratification' }, { aux: '{"api":"required"}', id: 65, stati: [14], title: Complete }], status: success }
                'Success for shipper':
                  value: { data: [{ aux: '{"api":"required"}', id: 24, stati: [3], title: 'Ratify carrier' }, { aux: '{"api":"required"}', id: 27, stati: [7], title: 'Confirm loading' }, { aux: '{"api":"required"}', id: 29, stati: [10], title: 'Confirm unloading' }, { aux: null, id: 26, stati: [5, 8, 15, 16], title: 'In progress' }, { aux: null, id: 23, stati: [2], title: Open }, { aux: '{"api":"required"}', id: 25, stati: [4], title: 'Waiting for confirmation' }, { aux: null, id: 42, stati: [11, 14], title: Complete }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getRouteActions:
    get:
      tags:
        - 'Routes & tenders / Listings / Routes'
      summary: 'Get Available Route Actions'
      description: |-
        The method shows the available actions for the routes or tenders.

        For each group of routes, you also receive a list of route stati, messages, and actions.

        - If successful, you will receive the groups of routes available to you
            
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getAvailableRouteActions
      parameters:
        -
          name: routes
          in: query
          schema:
            type: string
            example: '{{routePeriodic1}},{{routePeriodic2}}'
          description: |
            Required. String. Comma-separated lisf of routes or tenders.
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getAllRoutes:
    get:
      tags:
        - 'Routes & tenders / Listings / Routes'
      summary: 'Get Active Routes'
      description: |-
        Get the list of routes which are active at the moment for current user.

        The list excludes complete/finished routes.

        The list includes the routes that are:
        - vacant and available for delivery
        - in progress by current user
        - in negotiation phase

        For each route within the list, you get id, route periodic (public route id), status and attention flag.

        - If successful, you will receive the list of routes
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: routes with `needAttention` set to `true` are the ones in which immediate action is required by the user.
      operationId: getActiveRoutes
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { bookedbyclient: { type: boolean, nullable: true, example: null }, id: { type: number, example: 99341 }, needAttention: { type: boolean, example: true }, periodic: { type: string, example: 33-11-24 }, routestatus: { type: number, example: 4 }, tenderparent: { type: string, nullable: true, example: null } } }, example: [{ bookedbyclient: null, id: 99341, needAttention: true, periodic: 33-11-24, routestatus: 4, tenderparent: null }, { bookedbyclient: null, id: 99366, needAttention: true, periodic: 57-11-24, routestatus: 4, tenderparent: 56-11-24 }, { bookedbyclient: null, id: 99398, needAttention: true, periodic: 3-12-24, routestatus: 4, tenderparent: null }, { bookedbyclient: null, id: 99400, needAttention: true, periodic: 5-12-24, routestatus: 17, tenderparent: null }, { bookedbyclient: true, id: 99725, needAttention: true, periodic: 175-01-25, routestatus: 2, tenderparent: 171-01-25 }, { bookedbyclient: true, id: 99668, needAttention: true, periodic: 118-01-25, routestatus: 2, tenderparent: 37-01-25 }, { bookedbyclient: true, id: 99669, needAttention: true, periodic: 119-01-25, routestatus: 2, tenderparent: 37-01-25 }, { bookedbyclient: true, id: 99576, needAttention: true, periodic: 26-01-25, routestatus: 2, tenderparent: 25-01-25 }, { bookedbyclient: true, id: 99574, needAttention: true, periodic: 24-01-25, routestatus: 2, tenderparent: 21-01-25 }, { bookedbyclient: true, id: 99560, needAttention: true, periodic: 10-01-25, routestatus: 2, tenderparent: 5-01-25 }, { bookedbyclient: true, id: 99557, needAttention: true, periodic: 7-01-25, routestatus: 2, tenderparent: 5-01-25 }, { bookedbyclient: true, id: 99556, needAttention: true, periodic: 6-01-25, routestatus: 2, tenderparent: 5-01-25 }, { bookedbyclient: true, id: 99554, needAttention: true, periodic: 4-01-25, routestatus: 2, tenderparent: 3-01-25 }, { bookedbyclient: null, id: 99706, needAttention: true, periodic: 156-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99705, needAttention: true, periodic: 155-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99701, needAttention: true, periodic: 151-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99697, needAttention: true, periodic: 147-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99626, needAttention: true, periodic: 76-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99627, needAttention: true, periodic: 77-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99628, needAttention: true, periodic: 78-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99629, needAttention: true, periodic: 79-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99630, needAttention: true, periodic: 80-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99631, needAttention: true, periodic: 81-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99632, needAttention: true, periodic: 82-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99633, needAttention: true, periodic: 83-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99634, needAttention: true, periodic: 84-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99635, needAttention: true, periodic: 85-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99642, needAttention: true, periodic: 92-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99643, needAttention: true, periodic: 93-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99644, needAttention: true, periodic: 94-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99645, needAttention: true, periodic: 95-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99646, needAttention: true, periodic: 96-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99647, needAttention: true, periodic: 97-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99648, needAttention: true, periodic: 98-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99649, needAttention: true, periodic: 99-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99650, needAttention: true, periodic: 100-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99651, needAttention: true, periodic: 101-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99652, needAttention: true, periodic: 102-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99653, needAttention: true, periodic: 103-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99654, needAttention: true, periodic: 104-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99655, needAttention: true, periodic: 105-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99656, needAttention: true, periodic: 106-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99657, needAttention: true, periodic: 107-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99658, needAttention: true, periodic: 108-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99659, needAttention: true, periodic: 109-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99660, needAttention: true, periodic: 110-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99661, needAttention: true, periodic: 111-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99662, needAttention: true, periodic: 112-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99663, needAttention: true, periodic: 113-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99664, needAttention: true, periodic: 114-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99665, needAttention: true, periodic: 115-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99666, needAttention: true, periodic: 116-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99667, needAttention: true, periodic: 117-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99670, needAttention: true, periodic: 120-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99671, needAttention: true, periodic: 121-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99672, needAttention: true, periodic: 122-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99673, needAttention: true, periodic: 123-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99674, needAttention: true, periodic: 124-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99675, needAttention: true, periodic: 125-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99676, needAttention: true, periodic: 126-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99677, needAttention: true, periodic: 127-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99678, needAttention: true, periodic: 128-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99679, needAttention: true, periodic: 129-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99714, needAttention: false, periodic: 164-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99712, needAttention: false, periodic: 162-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99713, needAttention: false, periodic: 163-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99710, needAttention: false, periodic: 160-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99708, needAttention: false, periodic: 158-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99703, needAttention: false, periodic: 153-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99696, needAttention: false, periodic: 146-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99694, needAttention: false, periodic: 144-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99693, needAttention: false, periodic: 143-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99623, needAttention: true, periodic: 73-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99620, needAttention: true, periodic: 70-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99621, needAttention: true, periodic: 71-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99622, needAttention: true, periodic: 72-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99617, needAttention: true, periodic: 67-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99618, needAttention: true, periodic: 68-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99619, needAttention: true, periodic: 69-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99614, needAttention: true, periodic: 64-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99615, needAttention: true, periodic: 65-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99616, needAttention: true, periodic: 66-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99611, needAttention: true, periodic: 61-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99612, needAttention: true, periodic: 62-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99613, needAttention: true, periodic: 63-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99608, needAttention: true, periodic: 58-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99609, needAttention: true, periodic: 59-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99610, needAttention: true, periodic: 60-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99605, needAttention: true, periodic: 55-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99606, needAttention: true, periodic: 56-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99607, needAttention: true, periodic: 57-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99602, needAttention: true, periodic: 52-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99603, needAttention: true, periodic: 53-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99604, needAttention: true, periodic: 54-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99599, needAttention: true, periodic: 49-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99600, needAttention: true, periodic: 50-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99601, needAttention: true, periodic: 51-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99596, needAttention: true, periodic: 46-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99597, needAttention: true, periodic: 47-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99598, needAttention: true, periodic: 48-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99593, needAttention: true, periodic: 43-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99594, needAttention: true, periodic: 44-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99595, needAttention: true, periodic: 45-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99590, needAttention: true, periodic: 40-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99591, needAttention: true, periodic: 41-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99592, needAttention: true, periodic: 42-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99589, needAttention: true, periodic: 39-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99637, needAttention: false, periodic: 87-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99585, needAttention: false, periodic: 35-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99583, needAttention: false, periodic: 33-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99544, needAttention: false, periodic: 109-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99542, needAttention: false, periodic: 107-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99516, needAttention: true, periodic: 92-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99511, needAttention: true, periodic: 87-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99512, needAttention: true, periodic: 88-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99513, needAttention: true, periodic: 89-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99515, needAttention: true, periodic: 91-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99518, needAttention: false, periodic: 94-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99451, needAttention: false, periodic: 32-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99450, needAttention: false, periodic: 31-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99448, needAttention: false, periodic: 29-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99447, needAttention: false, periodic: 28-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99436, needAttention: false, periodic: 17-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99437, needAttention: false, periodic: 18-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99438, needAttention: false, periodic: 19-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99439, needAttention: false, periodic: 20-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99440, needAttention: false, periodic: 21-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99441, needAttention: false, periodic: 22-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99442, needAttention: false, periodic: 23-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99443, needAttention: false, periodic: 24-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99444, needAttention: false, periodic: 25-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99445, needAttention: false, periodic: 26-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99432, needAttention: false, periodic: 14-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99431, needAttention: false, periodic: 13-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99430, needAttention: false, periodic: 12-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99429, needAttention: false, periodic: 11-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99428, needAttention: false, periodic: 10-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99335, needAttention: false, periodic: 27-11-24, routestatus: 2, tenderparent: null }, { bookedbyclient: true, id: 99328, needAttention: true, periodic: 20-11-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99325, needAttention: false, periodic: 19-11-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99317, needAttention: false, periodic: 13-11-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99304, needAttention: false, periodic: 87-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: true, id: 99259, needAttention: true, periodic: 47-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99260, needAttention: false, periodic: 48-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99261, needAttention: false, periodic: 49-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99264, needAttention: false, periodic: 52-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99250, needAttention: false, periodic: 38-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99209, needAttention: false, periodic: 8-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99188, needAttention: true, periodic: 66-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99175, needAttention: false, periodic: 57-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99171, needAttention: false, periodic: 53-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99145, needAttention: true, periodic: 30-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99140, needAttention: false, periodic: 28-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99138, needAttention: false, periodic: 26-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99137, needAttention: false, periodic: 25-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99134, needAttention: true, periodic: 22-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99131, needAttention: true, periodic: 19-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99132, needAttention: true, periodic: 20-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99133, needAttention: true, periodic: 21-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99130, needAttention: true, periodic: 18-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99129, needAttention: true, periodic: 17-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99106, needAttention: false, periodic: 54-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99104, needAttention: false, periodic: 52-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99103, needAttention: false, periodic: 51-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99102, needAttention: false, periodic: 50-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99101, needAttention: false, periodic: 49-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99100, needAttention: false, periodic: 48-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99099, needAttention: false, periodic: 47-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99098, needAttention: false, periodic: 46-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99097, needAttention: false, periodic: 45-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99085, needAttention: false, periodic: 33-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99681, needAttention: false, periodic: 131-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99683, needAttention: false, periodic: 133-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99399, needAttention: false, periodic: 4-12-24, routestatus: 3, tenderparent: null }, { bookedbyclient: null, id: 99545, needAttention: false, periodic: 110-12-24, routestatus: 3, tenderparent: null }, { bookedbyclient: null, id: 99547, needAttention: false, periodic: 112-12-24, routestatus: 3, tenderparent: null }, { bookedbyclient: null, id: 99108, needAttention: false, periodic: 56-08-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99123, needAttention: false, periodic: 12-09-24, routestatus: 5, tenderparent: 11-09-24 }, { bookedbyclient: null, id: 99139, needAttention: false, periodic: 27-09-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99265, needAttention: false, periodic: 53-10-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99322, needAttention: false, periodic: 16-11-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99323, needAttention: false, periodic: 17-11-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99337, needAttention: false, periodic: 29-11-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99372, needAttention: false, periodic: 63-11-24, routestatus: 5, tenderparent: 62-11-24 }, { bookedbyclient: null, id: 99378, needAttention: false, periodic: 69-11-24, routestatus: 5, tenderparent: 68-11-24 }, { bookedbyclient: null, id: 99395, needAttention: false, periodic: 80-11-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99396, needAttention: false, periodic: 81-11-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99724, needAttention: false, periodic: 174-01-25, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99303, needAttention: false, periodic: 86-10-24, routestatus: 8, tenderparent: null }, { bookedbyclient: null, id: 99514, needAttention: false, periodic: 90-12-24, routestatus: 8, tenderparent: null }, { bookedbyclient: null, id: 99200, needAttention: false, periodic: 74-09-24, routestatus: 11, tenderparent: null }, { bookedbyclient: null, id: 99202, needAttention: false, periodic: 76-09-24, routestatus: 11, tenderparent: null }, { bookedbyclient: null, id: 99086, needAttention: false, periodic: 34-08-24, routestatus: 10, tenderparent: null }, { bookedbyclient: null, id: 99198, needAttention: false, periodic: 72-09-24, routestatus: 10, tenderparent: null }, { bookedbyclient: null, id: 99301, needAttention: false, periodic: 84-10-24, routestatus: 10, tenderparent: null }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ bookedbyclient: null, id: 99341, needAttention: true, periodic: 33-11-24, routestatus: 4, tenderparent: null }, { bookedbyclient: null, id: 99366, needAttention: true, periodic: 57-11-24, routestatus: 4, tenderparent: 56-11-24 }, { bookedbyclient: null, id: 99398, needAttention: true, periodic: 3-12-24, routestatus: 4, tenderparent: null }, { bookedbyclient: null, id: 99400, needAttention: true, periodic: 5-12-24, routestatus: 17, tenderparent: null }, { bookedbyclient: true, id: 99725, needAttention: true, periodic: 175-01-25, routestatus: 2, tenderparent: 171-01-25 }, { bookedbyclient: true, id: 99668, needAttention: true, periodic: 118-01-25, routestatus: 2, tenderparent: 37-01-25 }, { bookedbyclient: true, id: 99669, needAttention: true, periodic: 119-01-25, routestatus: 2, tenderparent: 37-01-25 }, { bookedbyclient: true, id: 99576, needAttention: true, periodic: 26-01-25, routestatus: 2, tenderparent: 25-01-25 }, { bookedbyclient: true, id: 99574, needAttention: true, periodic: 24-01-25, routestatus: 2, tenderparent: 21-01-25 }, { bookedbyclient: true, id: 99560, needAttention: true, periodic: 10-01-25, routestatus: 2, tenderparent: 5-01-25 }, { bookedbyclient: true, id: 99557, needAttention: true, periodic: 7-01-25, routestatus: 2, tenderparent: 5-01-25 }, { bookedbyclient: true, id: 99556, needAttention: true, periodic: 6-01-25, routestatus: 2, tenderparent: 5-01-25 }, { bookedbyclient: true, id: 99554, needAttention: true, periodic: 4-01-25, routestatus: 2, tenderparent: 3-01-25 }, { bookedbyclient: null, id: 99706, needAttention: true, periodic: 156-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99705, needAttention: true, periodic: 155-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99701, needAttention: true, periodic: 151-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99697, needAttention: true, periodic: 147-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99626, needAttention: true, periodic: 76-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99627, needAttention: true, periodic: 77-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99628, needAttention: true, periodic: 78-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99629, needAttention: true, periodic: 79-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99630, needAttention: true, periodic: 80-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99631, needAttention: true, periodic: 81-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99632, needAttention: true, periodic: 82-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99633, needAttention: true, periodic: 83-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99634, needAttention: true, periodic: 84-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99635, needAttention: true, periodic: 85-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99642, needAttention: true, periodic: 92-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99643, needAttention: true, periodic: 93-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99644, needAttention: true, periodic: 94-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99645, needAttention: true, periodic: 95-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99646, needAttention: true, periodic: 96-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99647, needAttention: true, periodic: 97-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99648, needAttention: true, periodic: 98-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99649, needAttention: true, periodic: 99-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99650, needAttention: true, periodic: 100-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99651, needAttention: true, periodic: 101-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99652, needAttention: true, periodic: 102-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99653, needAttention: true, periodic: 103-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99654, needAttention: true, periodic: 104-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99655, needAttention: true, periodic: 105-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99656, needAttention: true, periodic: 106-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99657, needAttention: true, periodic: 107-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99658, needAttention: true, periodic: 108-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99659, needAttention: true, periodic: 109-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99660, needAttention: true, periodic: 110-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99661, needAttention: true, periodic: 111-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99662, needAttention: true, periodic: 112-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99663, needAttention: true, periodic: 113-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99664, needAttention: true, periodic: 114-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99665, needAttention: true, periodic: 115-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99666, needAttention: true, periodic: 116-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99667, needAttention: true, periodic: 117-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99670, needAttention: true, periodic: 120-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99671, needAttention: true, periodic: 121-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99672, needAttention: true, periodic: 122-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99673, needAttention: true, periodic: 123-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99674, needAttention: true, periodic: 124-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99675, needAttention: true, periodic: 125-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99676, needAttention: true, periodic: 126-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99677, needAttention: true, periodic: 127-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99678, needAttention: true, periodic: 128-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99679, needAttention: true, periodic: 129-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99714, needAttention: false, periodic: 164-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99712, needAttention: false, periodic: 162-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99713, needAttention: false, periodic: 163-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99710, needAttention: false, periodic: 160-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99708, needAttention: false, periodic: 158-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99703, needAttention: false, periodic: 153-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99696, needAttention: false, periodic: 146-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99694, needAttention: false, periodic: 144-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99693, needAttention: false, periodic: 143-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99623, needAttention: true, periodic: 73-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99620, needAttention: true, periodic: 70-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99621, needAttention: true, periodic: 71-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99622, needAttention: true, periodic: 72-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99617, needAttention: true, periodic: 67-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99618, needAttention: true, periodic: 68-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99619, needAttention: true, periodic: 69-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99614, needAttention: true, periodic: 64-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99615, needAttention: true, periodic: 65-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99616, needAttention: true, periodic: 66-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99611, needAttention: true, periodic: 61-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99612, needAttention: true, periodic: 62-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99613, needAttention: true, periodic: 63-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99608, needAttention: true, periodic: 58-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99609, needAttention: true, periodic: 59-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99610, needAttention: true, periodic: 60-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99605, needAttention: true, periodic: 55-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99606, needAttention: true, periodic: 56-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99607, needAttention: true, periodic: 57-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99602, needAttention: true, periodic: 52-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99603, needAttention: true, periodic: 53-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99604, needAttention: true, periodic: 54-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99599, needAttention: true, periodic: 49-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99600, needAttention: true, periodic: 50-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99601, needAttention: true, periodic: 51-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99596, needAttention: true, periodic: 46-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99597, needAttention: true, periodic: 47-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99598, needAttention: true, periodic: 48-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99593, needAttention: true, periodic: 43-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99594, needAttention: true, periodic: 44-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99595, needAttention: true, periodic: 45-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99590, needAttention: true, periodic: 40-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99591, needAttention: true, periodic: 41-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99592, needAttention: true, periodic: 42-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99589, needAttention: true, periodic: 39-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99637, needAttention: false, periodic: 87-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99585, needAttention: false, periodic: 35-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99583, needAttention: false, periodic: 33-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99544, needAttention: false, periodic: 109-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99542, needAttention: false, periodic: 107-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99516, needAttention: true, periodic: 92-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99511, needAttention: true, periodic: 87-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99512, needAttention: true, periodic: 88-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99513, needAttention: true, periodic: 89-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99515, needAttention: true, periodic: 91-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99518, needAttention: false, periodic: 94-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99451, needAttention: false, periodic: 32-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99450, needAttention: false, periodic: 31-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99448, needAttention: false, periodic: 29-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99447, needAttention: false, periodic: 28-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99436, needAttention: false, periodic: 17-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99437, needAttention: false, periodic: 18-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99438, needAttention: false, periodic: 19-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99439, needAttention: false, periodic: 20-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99440, needAttention: false, periodic: 21-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99441, needAttention: false, periodic: 22-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99442, needAttention: false, periodic: 23-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99443, needAttention: false, periodic: 24-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99444, needAttention: false, periodic: 25-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99445, needAttention: false, periodic: 26-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99432, needAttention: false, periodic: 14-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99431, needAttention: false, periodic: 13-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99430, needAttention: false, periodic: 12-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99429, needAttention: false, periodic: 11-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99428, needAttention: false, periodic: 10-12-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99335, needAttention: false, periodic: 27-11-24, routestatus: 2, tenderparent: null }, { bookedbyclient: true, id: 99328, needAttention: true, periodic: 20-11-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99325, needAttention: false, periodic: 19-11-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99317, needAttention: false, periodic: 13-11-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99304, needAttention: false, periodic: 87-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: true, id: 99259, needAttention: true, periodic: 47-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99260, needAttention: false, periodic: 48-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99261, needAttention: false, periodic: 49-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99264, needAttention: false, periodic: 52-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99250, needAttention: false, periodic: 38-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99209, needAttention: false, periodic: 8-10-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99188, needAttention: true, periodic: 66-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99175, needAttention: false, periodic: 57-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99171, needAttention: false, periodic: 53-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99145, needAttention: true, periodic: 30-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99140, needAttention: false, periodic: 28-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99138, needAttention: false, periodic: 26-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99137, needAttention: false, periodic: 25-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99134, needAttention: true, periodic: 22-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99131, needAttention: true, periodic: 19-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99132, needAttention: true, periodic: 20-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99133, needAttention: true, periodic: 21-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99130, needAttention: true, periodic: 18-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99129, needAttention: true, periodic: 17-09-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99106, needAttention: false, periodic: 54-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99104, needAttention: false, periodic: 52-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99103, needAttention: false, periodic: 51-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99102, needAttention: false, periodic: 50-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99101, needAttention: false, periodic: 49-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99100, needAttention: false, periodic: 48-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99099, needAttention: false, periodic: 47-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99098, needAttention: false, periodic: 46-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99097, needAttention: false, periodic: 45-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99085, needAttention: false, periodic: 33-08-24, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99681, needAttention: false, periodic: 131-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99683, needAttention: false, periodic: 133-01-25, routestatus: 2, tenderparent: null }, { bookedbyclient: null, id: 99399, needAttention: false, periodic: 4-12-24, routestatus: 3, tenderparent: null }, { bookedbyclient: null, id: 99545, needAttention: false, periodic: 110-12-24, routestatus: 3, tenderparent: null }, { bookedbyclient: null, id: 99547, needAttention: false, periodic: 112-12-24, routestatus: 3, tenderparent: null }, { bookedbyclient: null, id: 99108, needAttention: false, periodic: 56-08-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99123, needAttention: false, periodic: 12-09-24, routestatus: 5, tenderparent: 11-09-24 }, { bookedbyclient: null, id: 99139, needAttention: false, periodic: 27-09-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99265, needAttention: false, periodic: 53-10-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99322, needAttention: false, periodic: 16-11-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99323, needAttention: false, periodic: 17-11-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99337, needAttention: false, periodic: 29-11-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99372, needAttention: false, periodic: 63-11-24, routestatus: 5, tenderparent: 62-11-24 }, { bookedbyclient: null, id: 99378, needAttention: false, periodic: 69-11-24, routestatus: 5, tenderparent: 68-11-24 }, { bookedbyclient: null, id: 99395, needAttention: false, periodic: 80-11-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99396, needAttention: false, periodic: 81-11-24, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99724, needAttention: false, periodic: 174-01-25, routestatus: 5, tenderparent: null }, { bookedbyclient: null, id: 99303, needAttention: false, periodic: 86-10-24, routestatus: 8, tenderparent: null }, { bookedbyclient: null, id: 99514, needAttention: false, periodic: 90-12-24, routestatus: 8, tenderparent: null }, { bookedbyclient: null, id: 99200, needAttention: false, periodic: 74-09-24, routestatus: 11, tenderparent: null }, { bookedbyclient: null, id: 99202, needAttention: false, periodic: 76-09-24, routestatus: 11, tenderparent: null }, { bookedbyclient: null, id: 99086, needAttention: false, periodic: 34-08-24, routestatus: 10, tenderparent: null }, { bookedbyclient: null, id: 99198, needAttention: false, periodic: 72-09-24, routestatus: 10, tenderparent: null }, { bookedbyclient: null, id: 99301, needAttention: false, periodic: 84-10-24, routestatus: 10, tenderparent: null }], status: success }
        403:
          description: 'Token is required'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Token is required':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getMyRoutes:
    get:
      tags:
        - 'Routes & tenders / Listings / Routes'
      summary: 'Get My Active Routes'
      description: |-
        Get the list of routes which are active at the moment for you current user. This method is different from `getAllRoutes` because it returns the routes for a particular user:
        - if you represent a shipper, the method will return routes that the current user had published
        - if you represent a carrier, the method will return routes in which the current user had offered truck 

        This method, as opposed to `getAllRoutes` is useful when there are more than manager working in the company.

        The list excludes complete/finished routes.

        The list includes the routes that are:
        - vacant and available for delivery
        - in progress
        - in negotiation phase

        For each route within the list, you get id, route periodic (public route id), status and attention flag.

        - If successful, you will receive the list of routes
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: routes with `needAttention` set to `true` are the ones in which immediate action is required by the user.
      operationId: getMyActiveRoutes
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { id: { type: number, example: 120162 }, needAttention: { type: boolean, example: true }, periodic: { type: string, example: 461-05-20 }, routestatus: { type: number, example: 6 } } }, example: [{ id: 120162, needAttention: true, periodic: 461-05-20, routestatus: 6 }, { id: 120331, needAttention: true, periodic: 610-05-20, routestatus: 6 }, { id: 124004, needAttention: true, periodic: -22493203200, routestatus: 6 }, { id: 124246, needAttention: true, periodic: -16181856000, routestatus: 6 }, { id: 138702, needAttention: true, periodic: -23395132800, routestatus: 6 }, { id: 119329, needAttention: false, periodic: 549-04-20, routestatus: 3 }, { id: 119334, needAttention: false, periodic: 554-04-20, routestatus: 3 }, { id: 129435, needAttention: false, periodic: -14406768000, routestatus: 7 }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ id: 120162, needAttention: true, periodic: 461-05-20, routestatus: 6 }, { id: 120331, needAttention: true, periodic: 610-05-20, routestatus: 6 }, { id: 124004, needAttention: true, periodic: -22493203200, routestatus: 6 }, { id: 124246, needAttention: true, periodic: -16181856000, routestatus: 6 }, { id: 138702, needAttention: true, periodic: -23395132800, routestatus: 6 }, { id: 119329, needAttention: false, periodic: 549-04-20, routestatus: 3 }, { id: 119334, needAttention: false, periodic: 554-04-20, routestatus: 3 }, { id: 129435, needAttention: false, periodic: -14406768000, routestatus: 7 }], status: success }
        403:
          description: 'Get my active routes'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Get my active routes':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getCompleteRoutes:
    get:
      tags:
        - 'Routes & tenders / Listings / Routes'
      summary: 'Get Complete Routes'
      description: |-
        Returns the list of the complete routes of your company.

        - if successful you will receive the list of the current company/your completed routes 
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getCompleteRoutes
      parameters:
        -
          name: page
          in: query
          schema:
            type: string
            example: '{{page}}'
          description: 'Optional, int. Default = 1. Number of the page'
        -
          name: perPage
          in: query
          schema:
            type: string
            example: '{{routesPerPage}}'
          description: 'Optional, int. Default = 100 (max). Amount of the routes per page'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: 'Success (Shipper) / Success (Carrier)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { offset: { type: number, example: 0 }, page: { type: number, example: 1 }, perPage: { type: number, example: 100 }, routes: { type: array, items: { type: object, properties: { id: { type: number, example: 125618 }, periodic: { type: string, example: -23374137600 }, routestatus: { type: number, example: 11 } } }, example: [{ id: 125618, periodic: -23374137600, routestatus: 11 }, { id: 125617, periodic: -23405673600, routestatus: 11 }, { id: 125616, periodic: -23437296000, routestatus: 11 }, { id: 125450, periodic: -28107734400, routestatus: 11 }, { id: 125395, periodic: -29748729600, routestatus: 11 }, { id: 125394, periodic: -29780265600, routestatus: 11 }, { id: 125284, periodic: 928-04-21, routestatus: 11 }, { id: 125245, periodic: 895-04-21, routestatus: 11 }, { id: 125240, periodic: 890-04-21, routestatus: 11 }, { id: 125213, periodic: 863-04-21, routestatus: 11 }, { id: 125190, periodic: 841-04-21, routestatus: 11 }, { id: 125184, periodic: 835-04-21, routestatus: 11 }, { id: 125182, periodic: 833-04-21, routestatus: 11 }, { id: 125174, periodic: 827-04-21, routestatus: 11 }, { id: 125074, periodic: 733-04-21, routestatus: 11 }, { id: 125069, periodic: 728-04-21, routestatus: 11 }, { id: 125067, periodic: 726-04-21, routestatus: 11 }, { id: 125053, periodic: 712-04-21, routestatus: 11 }, { id: 124992, periodic: 664-04-21, routestatus: 11 }, { id: 124974, periodic: 648-04-21, routestatus: 11 }, { id: 124721, periodic: 425-04-21, routestatus: 11 }, { id: 124600, periodic: 323-04-21, routestatus: 11 }, { id: 124599, periodic: 322-04-21, routestatus: 11 }, { id: 124444, periodic: 181-04-21, routestatus: 11 }, { id: 124443, periodic: 180-04-21, routestatus: 11 }, { id: 124397, periodic: 140-04-21, routestatus: 11 }, { id: 124390, periodic: 133-04-21, routestatus: 11 }, { id: 124389, periodic: 132-04-21, routestatus: 11 }, { id: 124320, periodic: 75-04-21, routestatus: 11 }, { id: 124319, periodic: 74-04-21, routestatus: 11 }, { id: 124282, periodic: 37-04-21, routestatus: 11 }, { id: 124280, periodic: 35-04-21, routestatus: 11 }, { id: 124097, periodic: -20126448000, routestatus: 11 }, { id: 124096, periodic: -20158070400, routestatus: 11 }, { id: 124014, periodic: -22177670400, routestatus: 11 }, { id: 123758, periodic: -29498947200, routestatus: 11 }, { id: 123756, periodic: -29562019200, routestatus: 11 }, { id: 123701, periodic: 978-03-21, routestatus: 11 }, { id: 123700, periodic: 977-03-21, routestatus: 11 }, { id: 123652, periodic: 935-03-21, routestatus: 11 }, { id: 123651, periodic: 934-03-21, routestatus: 11 }, { id: 123457, periodic: 758-03-21, routestatus: 11 }, { id: 123451, periodic: 752-03-21, routestatus: 11 }, { id: 123449, periodic: 750-03-21, routestatus: 11 }, { id: 123448, periodic: 749-03-21, routestatus: 11 }, { id: 123257, periodic: 582-03-21, routestatus: 11 }, { id: 123252, periodic: 577-03-21, routestatus: 11 }, { id: 123251, periodic: 576-03-21, routestatus: 11 }, { id: 123047, periodic: 390-03-21, routestatus: 11 }, { id: 122929, periodic: 290-03-21, routestatus: 11 }, { id: 122928, periodic: 289-03-21, routestatus: 11 }, { id: 122835, periodic: 202-03-21, routestatus: 11 }, { id: 122832, periodic: 199-03-21, routestatus: 11 }, { id: 122830, periodic: 197-03-21, routestatus: 11 }, { id: 122770, periodic: 138-03-21, routestatus: 11 }, { id: 122769, periodic: 137-03-21, routestatus: 11 }, { id: 122718, periodic: 86-03-21, routestatus: 11 }, { id: 122717, periodic: 85-03-21, routestatus: 11 }, { id: 122710, periodic: 78-03-21, routestatus: 11 }, { id: 122709, periodic: 77-03-21, routestatus: 11 }, { id: 122708, periodic: 76-03-21, routestatus: 11 }, { id: 122707, periodic: 75-03-21, routestatus: 11 }, { id: 122677, periodic: 52-03-21, routestatus: 11 }, { id: 122675, periodic: 50-03-21, routestatus: 11 }, { id: 122655, periodic: 30-03-21, routestatus: 11 }, { id: 122652, periodic: 27-03-21, routestatus: 11 }, { id: 122644, periodic: 19-03-21, routestatus: 11 }, { id: 122634, periodic: 9-03-21, routestatus: 11 }, { id: 122621, periodic: 442-07-20, routestatus: 11 }, { id: 122618, periodic: 441-07-20, routestatus: 11 }, { id: 122493, periodic: 317-07-20, routestatus: 11 }, { id: 122480, periodic: 304-07-20, routestatus: 11 }, { id: 122474, periodic: 298-07-20, routestatus: 11 }, { id: 122385, periodic: 209-07-20, routestatus: 11 }, { id: 122340, periodic: 173-07-20, routestatus: 11 }, { id: 122229, periodic: 73-07-20, routestatus: 11 }, { id: 122163, periodic: 7-07-20, routestatus: 11 }, { id: 122095, periodic: -24284102400, routestatus: 11 }, { id: 122038, periodic: -25798867200, routestatus: 11 }, { id: 122032, periodic: -25988256000, routestatus: 11 }, { id: 121876, periodic: 990-06-20, routestatus: 11 }, { id: 121866, periodic: 980-06-20, routestatus: 11 }, { id: 121795, periodic: 918-06-20, routestatus: 11 }, { id: 121771, periodic: 894-06-20, routestatus: 11 }, { id: 121762, periodic: 885-06-20, routestatus: 11 }, { id: 121704, periodic: 836-06-20, routestatus: 11 }, { id: 121695, periodic: 827-06-20, routestatus: 11 }, { id: 121578, periodic: 723-06-20, routestatus: 11 }, { id: 121501, periodic: 655-06-20, routestatus: 11 }, { id: 121500, periodic: 654-06-20, routestatus: 11 }, { id: 121469, periodic: 630-06-20, routestatus: 11 }, { id: 121467, periodic: 628-06-20, routestatus: 11 }, { id: 121458, periodic: 619-06-20, routestatus: 11 }, { id: 121447, periodic: 611-06-20, routestatus: 11 }, { id: 121329, periodic: 502-06-20, routestatus: 11 }, { id: 121187, periodic: 369-06-20, routestatus: 11 }, { id: 121017, periodic: 199-06-20, routestatus: 11 }, { id: 120784, periodic: 5-06-20, routestatus: 11 }, { id: 120728, periodic: 941-05-20, routestatus: 11 }, { id: 120688, periodic: 903-05-20, routestatus: 11 }] }, total: { type: number, example: 614 } } }
                  status: { type: string, example: success }
              examples:
                'Success (Carrier)':
                  value: { data: { offset: 0, page: 1, perPage: 100, routes: [{ id: 660420, periodic: 68653785600, routestatus: 11 }, { id: 659247, periodic: 33846422400, routestatus: 11 }, { id: 659244, periodic: 33751728000, routestatus: 11 }, { id: 659241, periodic: 33657120000, routestatus: 11 }, { id: 658216, periodic: 3267820800, routestatus: 11 }, { id: 657939, periodic: -5157993600, routestatus: 11 }, { id: 656070, periodic: 46-07-21, routestatus: 11 }, { id: 655673, periodic: 248336409600, routestatus: 11 }, { id: 655589, periodic: 245780352000, routestatus: 11 }, { id: 655251, periodic: 235398096000, routestatus: 11 }, { id: 654382, periodic: 209868537600, routestatus: 11 }, { id: 653070, periodic: 171211276800, routestatus: 11 }, { id: 651707, periodic: 131386406400, routestatus: 11 }, { id: 651681, periodic: 130692096000, routestatus: 11 }, { id: 650670, periodic: 100523635200, routestatus: 11 }, { id: 650666, periodic: 100397404800, routestatus: 11 }, { id: 650398, periodic: 92224310400, routestatus: 11 }, { id: 650360, periodic: 91025078400, routestatus: 11 }, { id: 649127, periodic: 53977276800, routestatus: 11 }, { id: 649117, periodic: 53661657600, routestatus: 11 }, { id: 648859, periodic: 46056384000, routestatus: 11 }, { id: 648776, periodic: 43689628800, routestatus: 11 }, { id: 648640, periodic: 39650342400, routestatus: 11 }, { id: 648639, periodic: 39618806400, routestatus: 11 }, { id: 648596, periodic: 38451196800, routestatus: 11 }, { id: 648584, periodic: 38072505600, routestatus: 11 }, { id: 648533, periodic: 36683971200, routestatus: 11 }, { id: 648096, periodic: 24218956800, routestatus: 11 }, { id: 648088, periodic: 23966496000, routestatus: 11 }, { id: 647631, periodic: 10996560000, routestatus: 11 }, { id: 647598, periodic: 9986803200, routestatus: 11 }, { id: 647452, periodic: 5600361600, routestatus: 11 }, { id: 647435, periodic: 5127062400, routestatus: 11 }, { id: 647420, periodic: 4716748800, routestatus: 11 }, { id: 647410, periodic: 4401216000, routestatus: 11 }, { id: 647403, periodic: 4180291200, routestatus: 11 }, { id: 646984, periodic: -8316259200, routestatus: 11 }, { id: 565729, periodic: 211299062400, routestatus: 11 }, { id: 565688, periodic: 210005222400, routestatus: 11 }, { id: 533793, periodic: -15821568000, routestatus: 11 }], total: 40 }, status: success }
                'Success (Shipper)':
                  value: { data: { offset: 0, page: 1, perPage: 100, routes: [{ id: 125618, periodic: -23374137600, routestatus: 11 }, { id: 125617, periodic: -23405673600, routestatus: 11 }, { id: 125616, periodic: -23437296000, routestatus: 11 }, { id: 125450, periodic: -28107734400, routestatus: 11 }, { id: 125395, periodic: -29748729600, routestatus: 11 }, { id: 125394, periodic: -29780265600, routestatus: 11 }, { id: 125284, periodic: 928-04-21, routestatus: 11 }, { id: 125245, periodic: 895-04-21, routestatus: 11 }, { id: 125240, periodic: 890-04-21, routestatus: 11 }, { id: 125213, periodic: 863-04-21, routestatus: 11 }, { id: 125190, periodic: 841-04-21, routestatus: 11 }, { id: 125184, periodic: 835-04-21, routestatus: 11 }, { id: 125182, periodic: 833-04-21, routestatus: 11 }, { id: 125174, periodic: 827-04-21, routestatus: 11 }, { id: 125074, periodic: 733-04-21, routestatus: 11 }, { id: 125069, periodic: 728-04-21, routestatus: 11 }, { id: 125067, periodic: 726-04-21, routestatus: 11 }, { id: 125053, periodic: 712-04-21, routestatus: 11 }, { id: 124992, periodic: 664-04-21, routestatus: 11 }, { id: 124974, periodic: 648-04-21, routestatus: 11 }, { id: 124721, periodic: 425-04-21, routestatus: 11 }, { id: 124600, periodic: 323-04-21, routestatus: 11 }, { id: 124599, periodic: 322-04-21, routestatus: 11 }, { id: 124444, periodic: 181-04-21, routestatus: 11 }, { id: 124443, periodic: 180-04-21, routestatus: 11 }, { id: 124397, periodic: 140-04-21, routestatus: 11 }, { id: 124390, periodic: 133-04-21, routestatus: 11 }, { id: 124389, periodic: 132-04-21, routestatus: 11 }, { id: 124320, periodic: 75-04-21, routestatus: 11 }, { id: 124319, periodic: 74-04-21, routestatus: 11 }, { id: 124282, periodic: 37-04-21, routestatus: 11 }, { id: 124280, periodic: 35-04-21, routestatus: 11 }, { id: 124097, periodic: -20126448000, routestatus: 11 }, { id: 124096, periodic: -20158070400, routestatus: 11 }, { id: 124014, periodic: -22177670400, routestatus: 11 }, { id: 123758, periodic: -29498947200, routestatus: 11 }, { id: 123756, periodic: -29562019200, routestatus: 11 }, { id: 123701, periodic: 978-03-21, routestatus: 11 }, { id: 123700, periodic: 977-03-21, routestatus: 11 }, { id: 123652, periodic: 935-03-21, routestatus: 11 }, { id: 123651, periodic: 934-03-21, routestatus: 11 }, { id: 123457, periodic: 758-03-21, routestatus: 11 }, { id: 123451, periodic: 752-03-21, routestatus: 11 }, { id: 123449, periodic: 750-03-21, routestatus: 11 }, { id: 123448, periodic: 749-03-21, routestatus: 11 }, { id: 123257, periodic: 582-03-21, routestatus: 11 }, { id: 123252, periodic: 577-03-21, routestatus: 11 }, { id: 123251, periodic: 576-03-21, routestatus: 11 }, { id: 123047, periodic: 390-03-21, routestatus: 11 }, { id: 122929, periodic: 290-03-21, routestatus: 11 }, { id: 122928, periodic: 289-03-21, routestatus: 11 }, { id: 122835, periodic: 202-03-21, routestatus: 11 }, { id: 122832, periodic: 199-03-21, routestatus: 11 }, { id: 122830, periodic: 197-03-21, routestatus: 11 }, { id: 122770, periodic: 138-03-21, routestatus: 11 }, { id: 122769, periodic: 137-03-21, routestatus: 11 }, { id: 122718, periodic: 86-03-21, routestatus: 11 }, { id: 122717, periodic: 85-03-21, routestatus: 11 }, { id: 122710, periodic: 78-03-21, routestatus: 11 }, { id: 122709, periodic: 77-03-21, routestatus: 11 }, { id: 122708, periodic: 76-03-21, routestatus: 11 }, { id: 122707, periodic: 75-03-21, routestatus: 11 }, { id: 122677, periodic: 52-03-21, routestatus: 11 }, { id: 122675, periodic: 50-03-21, routestatus: 11 }, { id: 122655, periodic: 30-03-21, routestatus: 11 }, { id: 122652, periodic: 27-03-21, routestatus: 11 }, { id: 122644, periodic: 19-03-21, routestatus: 11 }, { id: 122634, periodic: 9-03-21, routestatus: 11 }, { id: 122621, periodic: 442-07-20, routestatus: 11 }, { id: 122618, periodic: 441-07-20, routestatus: 11 }, { id: 122493, periodic: 317-07-20, routestatus: 11 }, { id: 122480, periodic: 304-07-20, routestatus: 11 }, { id: 122474, periodic: 298-07-20, routestatus: 11 }, { id: 122385, periodic: 209-07-20, routestatus: 11 }, { id: 122340, periodic: 173-07-20, routestatus: 11 }, { id: 122229, periodic: 73-07-20, routestatus: 11 }, { id: 122163, periodic: 7-07-20, routestatus: 11 }, { id: 122095, periodic: -24284102400, routestatus: 11 }, { id: 122038, periodic: -25798867200, routestatus: 11 }, { id: 122032, periodic: -25988256000, routestatus: 11 }, { id: 121876, periodic: 990-06-20, routestatus: 11 }, { id: 121866, periodic: 980-06-20, routestatus: 11 }, { id: 121795, periodic: 918-06-20, routestatus: 11 }, { id: 121771, periodic: 894-06-20, routestatus: 11 }, { id: 121762, periodic: 885-06-20, routestatus: 11 }, { id: 121704, periodic: 836-06-20, routestatus: 11 }, { id: 121695, periodic: 827-06-20, routestatus: 11 }, { id: 121578, periodic: 723-06-20, routestatus: 11 }, { id: 121501, periodic: 655-06-20, routestatus: 11 }, { id: 121500, periodic: 654-06-20, routestatus: 11 }, { id: 121469, periodic: 630-06-20, routestatus: 11 }, { id: 121467, periodic: 628-06-20, routestatus: 11 }, { id: 121458, periodic: 619-06-20, routestatus: 11 }, { id: 121447, periodic: 611-06-20, routestatus: 11 }, { id: 121329, periodic: 502-06-20, routestatus: 11 }, { id: 121187, periodic: 369-06-20, routestatus: 11 }, { id: 121017, periodic: 199-06-20, routestatus: 11 }, { id: 120784, periodic: 5-06-20, routestatus: 11 }, { id: 120728, periodic: 941-05-20, routestatus: 11 }, { id: 120688, periodic: 903-05-20, routestatus: 11 }], total: 614 }, status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
  /a/v2/rest/public/getNotInterested:
    get:
      tags:
        - 'Routes & tenders / Listings / Tenders'
      summary: 'Get Not Interested Routes'
      description: |-
        Returns the list of the complete routes of your company.

        - if successful you will receive the list of the current company/your completed routes 
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getNotInterestedRoutes
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: tender
          in: query
          schema:
            type: string
            example: '1'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
        403:
          description: 'Invalid token / Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
  /a/v2/rest/public/getCompletedFilters:
    get:
      tags:
        - 'Routes & tenders / Listings / Routes'
      summary: 'Get Filters for Completed Routes'
      description: 'Get Filters for Completed Routes'
      operationId: getFiltersForCompletedRoutes
      parameters:
        -
          name: page
          in: query
          schema:
            type: string
            example: '1'
        -
          name: perPage
          in: query
          schema:
            type: string
            example: '10'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getTenderGroups:
    get:
      tags:
        - 'Routes & tenders / Listings / Tenders'
      summary: 'Get Tender Groups'
      description: |-
        The endpoint shows the groups or categories of tenders available to the user.

        The contents differ depending on the type of user (shipper or carrier).

        For each group of tenders, you also receive a list of tenders stati, that are included in this group. This list is useful when you have to sort the list of tenders through groups.

        *   If successful, you will receive the groups of tenders available to you
        *   If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getTenderGroups
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: 'Success for shipper / Success for carrier'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { aux: { type: object, properties: { api: { type: string, example: required } } }, id: { type: number, example: 1 }, stati: { type: array, items: { type: number, example: 91 }, example: [91] }, title: { type: string, example: Текущие } } }, example: [{ aux: { api: required }, id: 1, stati: [91], title: Текущие }, { aux: { api: required }, id: 2, stati: [null], title: 'Время истекло' }, { aux: { api: required }, id: 3, stati: [92], title: Выигранные }, { aux: { api: required }, id: 8, stati: [null], title: Запланированные }, { aux: { api: required }, id: 6, stati: [0], title: Архив }] }
                  status: { type: string, example: success }
              examples:
                'Success for carrier':
                  value: { data: [{ aux: { api: required }, id: 1, stati: [91], title: Текущие }, { aux: { api: required }, id: 3, stati: [92], title: Выигранные }, { aux: { api: required }, id: 4, stati: [93], title: 'В которых я участвовал' }, { aux: { api: required }, id: 6, stati: [0], title: Архив }], status: success }
                'Success for shipper':
                  value: { data: [{ aux: { api: required }, id: 1, stati: [91], title: Текущие }, { aux: { api: required }, id: 2, stati: [null], title: 'Время истекло' }, { aux: { api: required }, id: 3, stati: [92], title: Выигранные }, { aux: { api: required }, id: 8, stati: [null], title: Запланированные }, { aux: { api: required }, id: 6, stati: [0], title: Архив }], status: success }
        403:
          description: 'Get tender groups'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Токен недействителен' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Get tender groups':
                  value: { message: 'Токен недействителен', relogin: true, status: error }
  /a/v2/rest/public/getAllTenders:
    get:
      tags:
        - 'Routes & tenders / Listings / Tenders'
      summary: 'Get All Tenders'
      description: |-
        Get the list of tenders which are active at the moment for current user.

        For shipper, the list excludes complete/finished tenders. For carrier, complete tenders are included.

        The list includes the tenders that are:

        - vacant and available for bids
            
        - in active bargain
            
        - bargain complete and implementation in progress
            
        - implemented ones
            
        For each tender within the list, you get id, route periodic (public route id), status and attention flag.

        - If successful, you will receive the list of tenders
            
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        (!) NOTE: tenders with `needAttention` set to `true` are the ones in which immediate action is required by the user.
      operationId: getAllTenders
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { contextstatus: { type: number, example: 92 }, id: { type: number, example: 129653 }, needAttention: { type: boolean, example: false }, periodic: { type: string, example: -8000640000 } } }, example: [{ contextstatus: 92, id: 129653, needAttention: false, periodic: -8000640000 }, { contextstatus: 92, id: 129638, needAttention: false, periodic: -8474025600 }, { contextstatus: 92, id: 128974, needAttention: false, periodic: -27976233600 }, { contextstatus: 92, id: 128374, needAttention: false, periodic: 564-06-21 }, { contextstatus: 92, id: 128242, needAttention: false, periodic: 449-06-21 }, { contextstatus: 92, id: 127456, needAttention: false, periodic: -14788137600 }, { contextstatus: 92, id: 119352, needAttention: false, periodic: 572-04-20 }, { contextstatus: 92, id: 99050, needAttention: false, periodic: 100-03-19 }, { contextstatus: 92, id: 95614, needAttention: false, periodic: 28-09-16 }, { contextstatus: 92, id: 91042, needAttention: false, periodic: 338-09-15 }, { contextstatus: 92, id: 89847, needAttention: false, periodic: -15259276800 }, { contextstatus: 92, id: 88970, needAttention: false, periodic: 624-06-15 }, { contextstatus: 92, id: 85749, needAttention: false, periodic: -20374156800 }, { contextstatus: 92, id: 84866, needAttention: false, periodic: 460-05-15 }, { contextstatus: 92, id: 84856, needAttention: false, periodic: 452-05-15 }, { contextstatus: 92, id: 84833, needAttention: false, periodic: 429-05-15 }, { contextstatus: 92, id: 84782, needAttention: false, periodic: 378-05-15 }, { contextstatus: 92, id: 84731, needAttention: false, periodic: 329-05-15 }, { contextstatus: 92, id: 81406, needAttention: false, periodic: 542-04-15 }, { contextstatus: 92, id: 79160, needAttention: false, periodic: 778-03-15 }, { contextstatus: 92, id: 78657, needAttention: false, periodic: 301-03-15 }, { contextstatus: 92, id: 74863, needAttention: false, periodic: -1134864000 }, { contextstatus: 92, id: 70443, needAttention: false, periodic: -3030998400 }, { contextstatus: 92, id: 68544, needAttention: false, periodic: 84600028800 }, { contextstatus: 92, id: 67123, needAttention: false, periodic: 40704336000 }, { contextstatus: 92, id: 58459, needAttention: false, periodic: 2767651200 }, { contextstatus: 92, id: 54109, needAttention: false, periodic: -27119577600 }, { contextstatus: 92, id: 52450, needAttention: false, periodic: 49087814400 }, { contextstatus: 92, id: 46190, needAttention: false, periodic: 6120614 }, { contextstatus: 92, id: 45130, needAttention: false, periodic: 25660514 }, { contextstatus: 92, id: 44106, needAttention: false, periodic: 15570514 }, { contextstatus: 92, id: 43962, needAttention: false, periodic: 14140514 }, { contextstatus: 92, id: 42428, needAttention: false, periodic: 7720514 }, { contextstatus: 92, id: 34611, needAttention: false, periodic: 6180514 }, { contextstatus: 92, id: 25912, needAttention: false, periodic: 20500414 }, { contextstatus: 92, id: 24057, needAttention: false, periodic: 3810414 }, { contextstatus: 92, id: 15179, needAttention: false, periodic: 3411013 }, { contextstatus: 93, id: 127406, needAttention: false, periodic: -16334352000 }, { contextstatus: 93, id: 95614, needAttention: false, periodic: 28-09-16 }, { contextstatus: 93, id: 91042, needAttention: false, periodic: 338-09-15 }, { contextstatus: 93, id: 79334, needAttention: false, periodic: 952-03-15 }, { contextstatus: 93, id: 74238, needAttention: false, periodic: -19532534400 }, { contextstatus: 93, id: 73770, needAttention: false, periodic: 890-01-15 }, { contextstatus: 93, id: 70443, needAttention: false, periodic: -3030998400 }, { contextstatus: 93, id: 57288, needAttention: false, periodic: 899-09-14 }, { contextstatus: 93, id: 54109, needAttention: false, periodic: -27119577600 }, { contextstatus: 93, id: 53656, needAttention: false, periodic: 676-08-14 }, { contextstatus: 93, id: 49590, needAttention: false, periodic: 695-07-14 }, { contextstatus: 93, id: 47141, needAttention: false, periodic: 15580614 }, { contextstatus: 93, id: 76061, needAttention: false, periodic: 674-02-15 }, { contextstatus: 93, id: 46118, needAttention: false, periodic: 5400614 }, { contextstatus: 93, id: 24388, needAttention: false, periodic: 5620414 }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ contextstatus: 92, id: 129653, needAttention: false, periodic: -8000640000 }, { contextstatus: 92, id: 129638, needAttention: false, periodic: -8474025600 }, { contextstatus: 92, id: 128974, needAttention: false, periodic: -27976233600 }, { contextstatus: 92, id: 128374, needAttention: false, periodic: 564-06-21 }, { contextstatus: 92, id: 128242, needAttention: false, periodic: 449-06-21 }, { contextstatus: 92, id: 127456, needAttention: false, periodic: -14788137600 }, { contextstatus: 92, id: 119352, needAttention: false, periodic: 572-04-20 }, { contextstatus: 92, id: 99050, needAttention: false, periodic: 100-03-19 }, { contextstatus: 92, id: 95614, needAttention: false, periodic: 28-09-16 }, { contextstatus: 92, id: 91042, needAttention: false, periodic: 338-09-15 }, { contextstatus: 92, id: 89847, needAttention: false, periodic: -15259276800 }, { contextstatus: 92, id: 88970, needAttention: false, periodic: 624-06-15 }, { contextstatus: 92, id: 85749, needAttention: false, periodic: -20374156800 }, { contextstatus: 92, id: 84866, needAttention: false, periodic: 460-05-15 }, { contextstatus: 92, id: 84856, needAttention: false, periodic: 452-05-15 }, { contextstatus: 92, id: 84833, needAttention: false, periodic: 429-05-15 }, { contextstatus: 92, id: 84782, needAttention: false, periodic: 378-05-15 }, { contextstatus: 92, id: 84731, needAttention: false, periodic: 329-05-15 }, { contextstatus: 92, id: 81406, needAttention: false, periodic: 542-04-15 }, { contextstatus: 92, id: 79160, needAttention: false, periodic: 778-03-15 }, { contextstatus: 92, id: 78657, needAttention: false, periodic: 301-03-15 }, { contextstatus: 92, id: 74863, needAttention: false, periodic: -1134864000 }, { contextstatus: 92, id: 70443, needAttention: false, periodic: -3030998400 }, { contextstatus: 92, id: 68544, needAttention: false, periodic: 84600028800 }, { contextstatus: 92, id: 67123, needAttention: false, periodic: 40704336000 }, { contextstatus: 92, id: 58459, needAttention: false, periodic: 2767651200 }, { contextstatus: 92, id: 54109, needAttention: false, periodic: -27119577600 }, { contextstatus: 92, id: 52450, needAttention: false, periodic: 49087814400 }, { contextstatus: 92, id: 46190, needAttention: false, periodic: 6120614 }, { contextstatus: 92, id: 45130, needAttention: false, periodic: 25660514 }, { contextstatus: 92, id: 44106, needAttention: false, periodic: 15570514 }, { contextstatus: 92, id: 43962, needAttention: false, periodic: 14140514 }, { contextstatus: 92, id: 42428, needAttention: false, periodic: 7720514 }, { contextstatus: 92, id: 34611, needAttention: false, periodic: 6180514 }, { contextstatus: 92, id: 25912, needAttention: false, periodic: 20500414 }, { contextstatus: 92, id: 24057, needAttention: false, periodic: 3810414 }, { contextstatus: 92, id: 15179, needAttention: false, periodic: 3411013 }, { contextstatus: 93, id: 127406, needAttention: false, periodic: -16334352000 }, { contextstatus: 93, id: 95614, needAttention: false, periodic: 28-09-16 }, { contextstatus: 93, id: 91042, needAttention: false, periodic: 338-09-15 }, { contextstatus: 93, id: 79334, needAttention: false, periodic: 952-03-15 }, { contextstatus: 93, id: 74238, needAttention: false, periodic: -19532534400 }, { contextstatus: 93, id: 73770, needAttention: false, periodic: 890-01-15 }, { contextstatus: 93, id: 70443, needAttention: false, periodic: -3030998400 }, { contextstatus: 93, id: 57288, needAttention: false, periodic: 899-09-14 }, { contextstatus: 93, id: 54109, needAttention: false, periodic: -27119577600 }, { contextstatus: 93, id: 53656, needAttention: false, periodic: 676-08-14 }, { contextstatus: 93, id: 49590, needAttention: false, periodic: 695-07-14 }, { contextstatus: 93, id: 47141, needAttention: false, periodic: 15580614 }, { contextstatus: 93, id: 76061, needAttention: false, periodic: 674-02-15 }, { contextstatus: 93, id: 46118, needAttention: false, periodic: 5400614 }, { contextstatus: 93, id: 24388, needAttention: false, periodic: 5620414 }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Токен недействителен' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Токен недействителен', relogin: true, status: error }
  /a/v2/rest/public/getCurrentTenders:
    get:
      tags:
        - 'Routes & tenders / Listings / Tenders'
      summary: 'Get Open Tenders'
      description: |-
        Get the list of tenders which are active at the moment for current user.

        For shipper, the list excludes complete/finished tenders. For carrier, complete tenders are included.

        The list includes the tenders that are:

        - vacant and available for bids
            
        - in active bargain
            
        - bargain complete and implementation in progress
            
        For each tender within the list, you get id, route periodic (public route id), status and attention flag.

        - If successful, you will receive the list of tenders
            
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
            
        (!) NOTE: tenders with `needAttention` set to `true` are the ones in which immediate action is required by the user.
      operationId: getOpenTenders
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { contextstatus: { type: number, example: 92 }, id: { type: number, example: 129653 }, needAttention: { type: boolean, example: false }, periodic: { type: string, example: -8000640000 } } }, example: [{ contextstatus: 92, id: 129653, needAttention: false, periodic: -8000640000 }, { contextstatus: 92, id: 129638, needAttention: false, periodic: -8474025600 }, { contextstatus: 92, id: 128974, needAttention: false, periodic: -27976233600 }, { contextstatus: 92, id: 128374, needAttention: false, periodic: 564-06-21 }, { contextstatus: 92, id: 128242, needAttention: false, periodic: 449-06-21 }, { contextstatus: 92, id: 127456, needAttention: false, periodic: -14788137600 }, { contextstatus: 92, id: 119352, needAttention: false, periodic: 572-04-20 }, { contextstatus: 92, id: 99050, needAttention: false, periodic: 100-03-19 }, { contextstatus: 92, id: 95614, needAttention: false, periodic: 28-09-16 }, { contextstatus: 92, id: 91042, needAttention: false, periodic: 338-09-15 }, { contextstatus: 92, id: 89847, needAttention: false, periodic: -15259276800 }, { contextstatus: 92, id: 88970, needAttention: false, periodic: 624-06-15 }, { contextstatus: 92, id: 85749, needAttention: false, periodic: -20374156800 }, { contextstatus: 92, id: 84866, needAttention: false, periodic: 460-05-15 }, { contextstatus: 92, id: 84856, needAttention: false, periodic: 452-05-15 }, { contextstatus: 92, id: 84833, needAttention: false, periodic: 429-05-15 }, { contextstatus: 92, id: 84782, needAttention: false, periodic: 378-05-15 }, { contextstatus: 92, id: 84731, needAttention: false, periodic: 329-05-15 }, { contextstatus: 92, id: 81406, needAttention: false, periodic: 542-04-15 }, { contextstatus: 92, id: 79160, needAttention: false, periodic: 778-03-15 }, { contextstatus: 92, id: 78657, needAttention: false, periodic: 301-03-15 }, { contextstatus: 92, id: 74863, needAttention: false, periodic: -1134864000 }, { contextstatus: 92, id: 70443, needAttention: false, periodic: -3030998400 }, { contextstatus: 92, id: 68544, needAttention: false, periodic: 84600028800 }, { contextstatus: 92, id: 67123, needAttention: false, periodic: 40704336000 }, { contextstatus: 92, id: 58459, needAttention: false, periodic: 2767651200 }, { contextstatus: 92, id: 54109, needAttention: false, periodic: -27119577600 }, { contextstatus: 92, id: 52450, needAttention: false, periodic: 49087814400 }, { contextstatus: 92, id: 46190, needAttention: false, periodic: 6120614 }, { contextstatus: 92, id: 45130, needAttention: false, periodic: 25660514 }, { contextstatus: 92, id: 44106, needAttention: false, periodic: 15570514 }, { contextstatus: 92, id: 43962, needAttention: false, periodic: 14140514 }, { contextstatus: 92, id: 42428, needAttention: false, periodic: 7720514 }, { contextstatus: 92, id: 34611, needAttention: false, periodic: 6180514 }, { contextstatus: 92, id: 25912, needAttention: false, periodic: 20500414 }, { contextstatus: 92, id: 24057, needAttention: false, periodic: 3810414 }, { contextstatus: 92, id: 15179, needAttention: false, periodic: 3411013 }, { contextstatus: 93, id: 127406, needAttention: false, periodic: -16334352000 }, { contextstatus: 93, id: 95614, needAttention: false, periodic: 28-09-16 }, { contextstatus: 93, id: 91042, needAttention: false, periodic: 338-09-15 }, { contextstatus: 93, id: 79334, needAttention: false, periodic: 952-03-15 }, { contextstatus: 93, id: 74238, needAttention: false, periodic: -19532534400 }, { contextstatus: 93, id: 73770, needAttention: false, periodic: 890-01-15 }, { contextstatus: 93, id: 70443, needAttention: false, periodic: -3030998400 }, { contextstatus: 93, id: 57288, needAttention: false, periodic: 899-09-14 }, { contextstatus: 93, id: 54109, needAttention: false, periodic: -27119577600 }, { contextstatus: 93, id: 53656, needAttention: false, periodic: 676-08-14 }, { contextstatus: 93, id: 49590, needAttention: false, periodic: 695-07-14 }, { contextstatus: 93, id: 47141, needAttention: false, periodic: 15580614 }, { contextstatus: 93, id: 76061, needAttention: false, periodic: 674-02-15 }, { contextstatus: 93, id: 46118, needAttention: false, periodic: 5400614 }, { contextstatus: 93, id: 24388, needAttention: false, periodic: 5620414 }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ contextstatus: 92, id: 129653, needAttention: false, periodic: -8000640000 }, { contextstatus: 92, id: 129638, needAttention: false, periodic: -8474025600 }, { contextstatus: 92, id: 128974, needAttention: false, periodic: -27976233600 }, { contextstatus: 92, id: 128374, needAttention: false, periodic: 564-06-21 }, { contextstatus: 92, id: 128242, needAttention: false, periodic: 449-06-21 }, { contextstatus: 92, id: 127456, needAttention: false, periodic: -14788137600 }, { contextstatus: 92, id: 119352, needAttention: false, periodic: 572-04-20 }, { contextstatus: 92, id: 99050, needAttention: false, periodic: 100-03-19 }, { contextstatus: 92, id: 95614, needAttention: false, periodic: 28-09-16 }, { contextstatus: 92, id: 91042, needAttention: false, periodic: 338-09-15 }, { contextstatus: 92, id: 89847, needAttention: false, periodic: -15259276800 }, { contextstatus: 92, id: 88970, needAttention: false, periodic: 624-06-15 }, { contextstatus: 92, id: 85749, needAttention: false, periodic: -20374156800 }, { contextstatus: 92, id: 84866, needAttention: false, periodic: 460-05-15 }, { contextstatus: 92, id: 84856, needAttention: false, periodic: 452-05-15 }, { contextstatus: 92, id: 84833, needAttention: false, periodic: 429-05-15 }, { contextstatus: 92, id: 84782, needAttention: false, periodic: 378-05-15 }, { contextstatus: 92, id: 84731, needAttention: false, periodic: 329-05-15 }, { contextstatus: 92, id: 81406, needAttention: false, periodic: 542-04-15 }, { contextstatus: 92, id: 79160, needAttention: false, periodic: 778-03-15 }, { contextstatus: 92, id: 78657, needAttention: false, periodic: 301-03-15 }, { contextstatus: 92, id: 74863, needAttention: false, periodic: -1134864000 }, { contextstatus: 92, id: 70443, needAttention: false, periodic: -3030998400 }, { contextstatus: 92, id: 68544, needAttention: false, periodic: 84600028800 }, { contextstatus: 92, id: 67123, needAttention: false, periodic: 40704336000 }, { contextstatus: 92, id: 58459, needAttention: false, periodic: 2767651200 }, { contextstatus: 92, id: 54109, needAttention: false, periodic: -27119577600 }, { contextstatus: 92, id: 52450, needAttention: false, periodic: 49087814400 }, { contextstatus: 92, id: 46190, needAttention: false, periodic: 6120614 }, { contextstatus: 92, id: 45130, needAttention: false, periodic: 25660514 }, { contextstatus: 92, id: 44106, needAttention: false, periodic: 15570514 }, { contextstatus: 92, id: 43962, needAttention: false, periodic: 14140514 }, { contextstatus: 92, id: 42428, needAttention: false, periodic: 7720514 }, { contextstatus: 92, id: 34611, needAttention: false, periodic: 6180514 }, { contextstatus: 92, id: 25912, needAttention: false, periodic: 20500414 }, { contextstatus: 92, id: 24057, needAttention: false, periodic: 3810414 }, { contextstatus: 92, id: 15179, needAttention: false, periodic: 3411013 }, { contextstatus: 93, id: 127406, needAttention: false, periodic: -16334352000 }, { contextstatus: 93, id: 95614, needAttention: false, periodic: 28-09-16 }, { contextstatus: 93, id: 91042, needAttention: false, periodic: 338-09-15 }, { contextstatus: 93, id: 79334, needAttention: false, periodic: 952-03-15 }, { contextstatus: 93, id: 74238, needAttention: false, periodic: -19532534400 }, { contextstatus: 93, id: 73770, needAttention: false, periodic: 890-01-15 }, { contextstatus: 93, id: 70443, needAttention: false, periodic: -3030998400 }, { contextstatus: 93, id: 57288, needAttention: false, periodic: 899-09-14 }, { contextstatus: 93, id: 54109, needAttention: false, periodic: -27119577600 }, { contextstatus: 93, id: 53656, needAttention: false, periodic: 676-08-14 }, { contextstatus: 93, id: 49590, needAttention: false, periodic: 695-07-14 }, { contextstatus: 93, id: 47141, needAttention: false, periodic: 15580614 }, { contextstatus: 93, id: 76061, needAttention: false, periodic: 674-02-15 }, { contextstatus: 93, id: 46118, needAttention: false, periodic: 5400614 }, { contextstatus: 93, id: 24388, needAttention: false, periodic: 5620414 }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Токен недействителен' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Токен недействителен', relogin: true, status: error }
  /a/v2/rest/public/getMyTenders:
    get:
      tags:
        - 'Routes & tenders / Listings / Tenders'
      summary: 'Get My Active Tenders'
      description: |-
        Get the list of tenders which are active at the moment for current user. This method is different from `getAllTenders` in that is intended for this particular user. Namely:
        - if you represent a shipper, the method will return tenders that the current user had published
        - if you represent a carrier, the method will return tenders, in which the current user offered delivery price

        The list excludes complete/finished tenders.
        The list includes the tenders that are:
        - vacant and available for delivery
        - in progress
        - in negotiation phase

        For each tender within the list, you get id, tender periodic (public tender id), status and attention flag.

        - If successful, you will receive the list of tenders
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: tenders with `needAttention` set to true are the ones in which immediate action is required by the user.
      operationId: getMyActiveTenders
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: |
            the language in which you would like to receive feedback, if the authentication attempts are unsuccessful
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: 'Get my active tenders'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { contextstatus: { type: number, example: 92 }, id: { type: number, example: 129653 }, needAttention: { type: boolean, example: false }, periodic: { type: string, example: -8000640000 } } }, example: [{ contextstatus: 92, id: 129653, needAttention: false, periodic: -8000640000 }, { contextstatus: 92, id: 129638, needAttention: false, periodic: -8474025600 }, { contextstatus: 92, id: 128974, needAttention: false, periodic: -27976233600 }, { contextstatus: 92, id: 128374, needAttention: false, periodic: 564-06-21 }, { contextstatus: 92, id: 128242, needAttention: false, periodic: 449-06-21 }, { contextstatus: 92, id: 127456, needAttention: false, periodic: -14788137600 }, { contextstatus: 92, id: 119352, needAttention: false, periodic: 572-04-20 }, { contextstatus: 92, id: 99050, needAttention: false, periodic: 100-03-19 }, { contextstatus: 92, id: 95614, needAttention: false, periodic: 28-09-16 }, { contextstatus: 92, id: 91042, needAttention: false, periodic: 338-09-15 }, { contextstatus: 92, id: 89847, needAttention: false, periodic: -15259276800 }, { contextstatus: 92, id: 88970, needAttention: false, periodic: 624-06-15 }, { contextstatus: 92, id: 85749, needAttention: false, periodic: -20374156800 }, { contextstatus: 92, id: 84866, needAttention: false, periodic: 460-05-15 }, { contextstatus: 92, id: 84856, needAttention: false, periodic: 452-05-15 }, { contextstatus: 92, id: 84833, needAttention: false, periodic: 429-05-15 }, { contextstatus: 92, id: 84782, needAttention: false, periodic: 378-05-15 }, { contextstatus: 92, id: 84731, needAttention: false, periodic: 329-05-15 }, { contextstatus: 92, id: 81406, needAttention: false, periodic: 542-04-15 }, { contextstatus: 92, id: 79160, needAttention: false, periodic: 778-03-15 }, { contextstatus: 92, id: 78657, needAttention: false, periodic: 301-03-15 }, { contextstatus: 92, id: 74863, needAttention: false, periodic: -1134864000 }, { contextstatus: 92, id: 70443, needAttention: false, periodic: -3030998400 }, { contextstatus: 92, id: 68544, needAttention: false, periodic: 84600028800 }, { contextstatus: 92, id: 67123, needAttention: false, periodic: 40704336000 }, { contextstatus: 92, id: 58459, needAttention: false, periodic: 2767651200 }, { contextstatus: 92, id: 54109, needAttention: false, periodic: -27119577600 }, { contextstatus: 92, id: 52450, needAttention: false, periodic: 49087814400 }, { contextstatus: 92, id: 46190, needAttention: false, periodic: 6120614 }, { contextstatus: 92, id: 45130, needAttention: false, periodic: 25660514 }, { contextstatus: 92, id: 44106, needAttention: false, periodic: 15570514 }, { contextstatus: 92, id: 43962, needAttention: false, periodic: 14140514 }, { contextstatus: 92, id: 42428, needAttention: false, periodic: 7720514 }, { contextstatus: 92, id: 34611, needAttention: false, periodic: 6180514 }, { contextstatus: 92, id: 25912, needAttention: false, periodic: 20500414 }, { contextstatus: 92, id: 24057, needAttention: false, periodic: 3810414 }, { contextstatus: 92, id: 15179, needAttention: false, periodic: 3411013 }, { contextstatus: 93, id: 127406, needAttention: false, periodic: -16334352000 }, { contextstatus: 93, id: 95614, needAttention: false, periodic: 28-09-16 }, { contextstatus: 93, id: 91042, needAttention: false, periodic: 338-09-15 }, { contextstatus: 93, id: 79334, needAttention: false, periodic: 952-03-15 }, { contextstatus: 93, id: 74238, needAttention: false, periodic: -19532534400 }, { contextstatus: 93, id: 73770, needAttention: false, periodic: 890-01-15 }, { contextstatus: 93, id: 70443, needAttention: false, periodic: -3030998400 }, { contextstatus: 93, id: 57288, needAttention: false, periodic: 899-09-14 }, { contextstatus: 93, id: 54109, needAttention: false, periodic: -27119577600 }, { contextstatus: 93, id: 53656, needAttention: false, periodic: 676-08-14 }, { contextstatus: 93, id: 49590, needAttention: false, periodic: 695-07-14 }, { contextstatus: 93, id: 47141, needAttention: false, periodic: 15580614 }, { contextstatus: 93, id: 76061, needAttention: false, periodic: 674-02-15 }, { contextstatus: 93, id: 46118, needAttention: false, periodic: 5400614 }, { contextstatus: 93, id: 24388, needAttention: false, periodic: 5620414 }] }
                  status: { type: string, example: success }
              examples:
                'Get my active tenders':
                  value: { data: [{ contextstatus: 92, id: 129653, needAttention: false, periodic: -8000640000 }, { contextstatus: 92, id: 129638, needAttention: false, periodic: -8474025600 }, { contextstatus: 92, id: 128974, needAttention: false, periodic: -27976233600 }, { contextstatus: 92, id: 128374, needAttention: false, periodic: 564-06-21 }, { contextstatus: 92, id: 128242, needAttention: false, periodic: 449-06-21 }, { contextstatus: 92, id: 127456, needAttention: false, periodic: -14788137600 }, { contextstatus: 92, id: 119352, needAttention: false, periodic: 572-04-20 }, { contextstatus: 92, id: 99050, needAttention: false, periodic: 100-03-19 }, { contextstatus: 92, id: 95614, needAttention: false, periodic: 28-09-16 }, { contextstatus: 92, id: 91042, needAttention: false, periodic: 338-09-15 }, { contextstatus: 92, id: 89847, needAttention: false, periodic: -15259276800 }, { contextstatus: 92, id: 88970, needAttention: false, periodic: 624-06-15 }, { contextstatus: 92, id: 85749, needAttention: false, periodic: -20374156800 }, { contextstatus: 92, id: 84866, needAttention: false, periodic: 460-05-15 }, { contextstatus: 92, id: 84856, needAttention: false, periodic: 452-05-15 }, { contextstatus: 92, id: 84833, needAttention: false, periodic: 429-05-15 }, { contextstatus: 92, id: 84782, needAttention: false, periodic: 378-05-15 }, { contextstatus: 92, id: 84731, needAttention: false, periodic: 329-05-15 }, { contextstatus: 92, id: 81406, needAttention: false, periodic: 542-04-15 }, { contextstatus: 92, id: 79160, needAttention: false, periodic: 778-03-15 }, { contextstatus: 92, id: 78657, needAttention: false, periodic: 301-03-15 }, { contextstatus: 92, id: 74863, needAttention: false, periodic: -1134864000 }, { contextstatus: 92, id: 70443, needAttention: false, periodic: -3030998400 }, { contextstatus: 92, id: 68544, needAttention: false, periodic: 84600028800 }, { contextstatus: 92, id: 67123, needAttention: false, periodic: 40704336000 }, { contextstatus: 92, id: 58459, needAttention: false, periodic: 2767651200 }, { contextstatus: 92, id: 54109, needAttention: false, periodic: -27119577600 }, { contextstatus: 92, id: 52450, needAttention: false, periodic: 49087814400 }, { contextstatus: 92, id: 46190, needAttention: false, periodic: 6120614 }, { contextstatus: 92, id: 45130, needAttention: false, periodic: 25660514 }, { contextstatus: 92, id: 44106, needAttention: false, periodic: 15570514 }, { contextstatus: 92, id: 43962, needAttention: false, periodic: 14140514 }, { contextstatus: 92, id: 42428, needAttention: false, periodic: 7720514 }, { contextstatus: 92, id: 34611, needAttention: false, periodic: 6180514 }, { contextstatus: 92, id: 25912, needAttention: false, periodic: 20500414 }, { contextstatus: 92, id: 24057, needAttention: false, periodic: 3810414 }, { contextstatus: 92, id: 15179, needAttention: false, periodic: 3411013 }, { contextstatus: 93, id: 127406, needAttention: false, periodic: -16334352000 }, { contextstatus: 93, id: 95614, needAttention: false, periodic: 28-09-16 }, { contextstatus: 93, id: 91042, needAttention: false, periodic: 338-09-15 }, { contextstatus: 93, id: 79334, needAttention: false, periodic: 952-03-15 }, { contextstatus: 93, id: 74238, needAttention: false, periodic: -19532534400 }, { contextstatus: 93, id: 73770, needAttention: false, periodic: 890-01-15 }, { contextstatus: 93, id: 70443, needAttention: false, periodic: -3030998400 }, { contextstatus: 93, id: 57288, needAttention: false, periodic: 899-09-14 }, { contextstatus: 93, id: 54109, needAttention: false, periodic: -27119577600 }, { contextstatus: 93, id: 53656, needAttention: false, periodic: 676-08-14 }, { contextstatus: 93, id: 49590, needAttention: false, periodic: 695-07-14 }, { contextstatus: 93, id: 47141, needAttention: false, periodic: 15580614 }, { contextstatus: 93, id: 76061, needAttention: false, periodic: 674-02-15 }, { contextstatus: 93, id: 46118, needAttention: false, periodic: 5400614 }, { contextstatus: 93, id: 24388, needAttention: false, periodic: 5620414 }], status: success }
        403:
          description: 'Invalid token'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: '*'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Sun, 29 Aug 2021 17:40:35 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: 'nginx/1.18.0 (Ubuntu)'
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Токен недействителен' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Токен недействителен', relogin: true, status: error }
  /a/v2/rest/public/getCompleteTenders:
    get:
      tags:
        - 'Routes & tenders / Listings / Tenders'
      summary: 'Get Completed Tenders'
      description: |-
        Returns the list of the complete tenders of your company. Tender is complete when all routes within this tender are complete.

        - if successful you will receive the list of the current company/your completed tenders
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getCompletedTenders
      parameters:
        -
          name: page
          in: query
          schema:
            type: string
            example: '{{page}}'
          description: 'Optional, int. Default = 1. Number of the page'
        -
          name: perPage
          in: query
          schema:
            type: string
            example: |
              {{tendersPerPage}}
          description: 'Optional, int. Default = 100 (max). Amount of the tenders per page'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: 'Success (Shipper) / Success (Carrier) / Invalid Token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { offset: { type: number, example: 0 }, page: { type: number, example: 1 }, perPage: { type: number, example: 5 }, routes: { type: array, items: { type: object, properties: { id: { type: number, example: 125189 }, periodic: { type: string, example: 840-04-21 }, routestatus: { type: number, example: -1 } } }, example: [{ id: 125189, periodic: 840-04-21, routestatus: -1 }, { id: 124818, periodic: 510-04-21, routestatus: -1 }, { id: 124598, periodic: 321-04-21, routestatus: -1 }, { id: 124442, periodic: 179-04-21, routestatus: -1 }, { id: 124388, periodic: 131-04-21, routestatus: -1 }] }, total: { type: number, example: 126 } } }
                  status: { type: string, example: success }
              examples:
                'Invalid Token':
                  value: { data: { offset: 0, page: 1, perPage: 5, routes: [{ id: 660151, periodic: 60732979200, routestatus: -1 }, { id: 658844, periodic: 21602332800, routestatus: -1 }, { id: 658810, periodic: 20529417600, routestatus: -1 }, { id: 658211, periodic: 3110054400, routestatus: -1 }, { id: 657193, periodic: -27121651200, routestatus: -1 }], total: 25 }, status: success }
                'Success (Carrier)':
                  value: { data: { offset: 0, page: 1, perPage: 5, routes: [{ id: 660151, periodic: 60732979200, routestatus: -1 }, { id: 658844, periodic: 21602332800, routestatus: -1 }, { id: 658810, periodic: 20529417600, routestatus: -1 }, { id: 658211, periodic: 3110054400, routestatus: -1 }, { id: 657193, periodic: -27121651200, routestatus: -1 }], total: 25 }, status: success }
                'Success (Shipper)':
                  value: { data: { offset: 0, page: 1, perPage: 5, routes: [{ id: 125189, periodic: 840-04-21, routestatus: -1 }, { id: 124818, periodic: 510-04-21, routestatus: -1 }, { id: 124598, periodic: 321-04-21, routestatus: -1 }, { id: 124442, periodic: 179-04-21, routestatus: -1 }, { id: 124388, periodic: 131-04-21, routestatus: -1 }], total: 126 }, status: success }
  /a/v2/rest/public/searchRoutes:
    get:
      tags:
        - 'Routes & tenders / Listings / Routes & Tenders'
      summary: 'Search Routes or Tenders'
      description: 'Search Routes or Tenders'
      operationId: searchRoutesOrTenders
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                by:
                  type: string
                  example: ''
                searchQuery:
                  description: 'String. Required'
                  type: string
                  example: ''
      responses:
        200:
          description: ''
  /a/v2/rest/public/getBasicDetailsOfRoutes:
    get:
      tags:
        - 'Routes & tenders / Listings / Routes & Tenders'
      summary: 'Get Routes or Tenders Summaries'
      description: |-
        The method returns basic details of the routes/tenders passed. Those basic details include shipper and carrier titles, truck/driver/trailer details, loading and unloading geography and metrics, payload parameters, dates, etc.

        - if successful you will receive the details of routes that you passed in the route list
        - if unsuccessful you will receive an error explaining the problem in the language you supplied with the header

        (!) NOTE: the method will return data only for the routes/tenders that current user has access to, ignoring others, regardless of whether they were passed in parameter for listing.
      operationId: getRoutesOrTendersSummaries
      parameters:
        -
          name: routes
          in: query
          schema:
            type: string
            example: '{{routeList}}'
          description: 'Comma-separated list of periodics.'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { routes: { type: array, items: { type: object, properties: { blindtender: { type: boolean, example: false }, bookedbyme: { type: boolean, example: false }, bookedsince: { nullable: true, example: null }, bookedtill: { nullable: true, example: null }, booktime: { type: number, example: 30 }, budget: { type: number, example: 15230 }, cartypeRelation: { type: array, items: [], example: [] }, chargetype: { type: array, items: { nullable: true, example: null }, example: [null] }, client: { type: number, example: 1274 }, client_relation: { type: object, properties: { company_relation: { type: object, properties: { natcomid: { type: string, example: '1231231231231' }, title_ru: { type: string, example: 'Super Shipper, LTD' } } }, hash: { type: string, example: 3c5e448b11f15293807d9cfdedf21582 } } }, completemoment: { nullable: true, example: null }, context: { type: object, properties: { iconTitle: { nullable: true, example: null }, title: { nullable: true, example: null } } }, defaultcurrency: { nullable: true, example: null }, distance: { type: number, example: 47 }, ferryproperty: { type: array, items: { type: string, example: 'Aggregates 15 pcs' }, example: ['Aggregates 15 pcs', temperature, 'belts 5 pcs'] }, id: { type: number, example: 94352 }, istender: { type: boolean, example: false }, kmprice: { type: number, example: 0 }, maxquotewithcommission: { nullable: true, example: null }, mcubeprice: { type: number, example: 0 }, minquote: { nullable: true, example: null }, needAttention: { type: boolean, example: true }, newMessages: { type: number, example: 0 }, operator: { type: number, example: 180 }, operator_relation: { type: object, properties: { company: { type: number, example: 844 }, company_relation: { type: object, properties: { natcomid: { type: string, example: '37534111223' }, title_ru: { type: string, example: 'Mega Carrier, LTD' } } }, hash: { type: string, example: da9cc741ae2ca7e4adf596b773a7b187 }, id: { type: number, example: 278 } } }, periodic: { type: string, example: 243-06-16 }, routeparts: { type: array, items: { type: object, properties: { bordercrossforoperator: { type: boolean, example: false }, cargo: { type: string, example: Aggregates }, checkpoint_relation: { type: object, properties: { id: { type: number, example: 3941 }, town_relation: { type: object, properties: { district: { type: string, example: '' }, title_ru: { type: string, example: Berdiansk } } } } }, complete: { type: boolean, example: false }, date1: { type: string, example: 1466035200 }, date2: { type: string, example: 1466467200 }, id: { type: number, example: 111365645 }, route: { type: number, example: 94352 }, time1: { type: string, example: '08:30:00' }, time2: { type: string, example: '14:00:00' }, triggered: { type: boolean, example: true }, workaction: { type: number, example: 1 } } }, example: [{ bordercrossforoperator: false, cargo: Aggregates, checkpoint_relation: { id: 3941, town_relation: { district: '', title_ru: Berdiansk } }, complete: false, date1: 1466035200, date2: 1466467200, id: 111365645, route: 94352, time1: '08:30:00', time2: '14:00:00', triggered: true, workaction: 1 }, { bordercrossforoperator: false, cargo: А, checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1466467200, date2: -62169984000, id: 111365646, route: 94352, time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 1 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1467244800, date2: 1466640000, id: 111365647, route: 94352, time1: '08:30:00', time2: '22:00:00', triggered: false, workaction: 2 }] }, routeresponse: { type: number, example: 73702 }, routeresponse_relation: { type: array, items: { type: object, properties: { cancelled: { type: number, example: 0 }, car: { type: number, example: 15677 }, car_relation: { type: object, properties: { id: { type: number, example: 15677 }, make: { type: number, example: 6 }, make_relation: { type: object, properties: { id: { type: number, example: 6 }, title_ru: { type: string, example: Citroen } } }, model: { nullable: true, example: null }, number: { type: string, example: '123' } } }, driver: { type: number, example: 14793 }, driver2: { nullable: true, example: null }, driver2_relation: { nullable: true, example: null }, driver_relation: { type: object, properties: { firstname: { type: string, example: '123' }, id: { type: number, example: 14793 }, lastname: { type: string, example: /0 }, maincellphone: { type: string, example: '123' }, patronymic: { type: string, example: '' } } }, id: { type: number, example: 73702 }, moment: { type: string, example: 1466096342 }, pricequotewithcommission: { nullable: true, example: null }, route: { type: number, example: 94352 }, trailer: { nullable: true, example: null }, trailer_relation: { nullable: true, example: null } } }, example: [{ cancelled: 0, car: 15677, car_relation: { id: 15677, make: 6, make_relation: { id: 6, title_ru: Citroen }, model: null, number: '123' }, driver: 14793, driver2: null, driver2_relation: null, driver_relation: { firstname: '123', id: 14793, lastname: /0, maincellphone: '123', patronymic: '' }, id: 73702, moment: 1466096342, pricequotewithcommission: null, route: 94352, trailer: null, trailer_relation: null }] }, routestatus: { type: number, example: 6 }, routetender: { type: object, properties: { currentminpricewithcommission: { nullable: true, example: null }, tenderstatus: { nullable: true, example: null }, winnerpricewithcommission: { nullable: true, example: null }, winnerstatus: { nullable: true, example: null } } }, stepwithcommission: { nullable: true, example: null }, tenderavailableuntilmoment: { type: string, example: -62169984000 }, tenderparent: { type: string, example: 18-02-26 }, tenderparticipant: { type: boolean, example: false }, tenderuntil: { type: object, properties: { date: { type: string, example: -62169984000 }, time: { type: string, example: '00:00:00' } } }, tonnprice: { type: number, example: 0 }, unitPrices: { type: array, items: { type: object, properties: { title: { type: string, example: UAH/tonn }, value: { nullable: true, example: null } } }, example: [{ title: UAH/tonn, value: null }, { title: UAH/mcub, value: null }, { title: UAH/km, value: null }] } } }, example: [{ blindtender: false, bookedbyme: false, bookedsince: null, bookedtill: null, booktime: 30, budget: 15230, cartypeRelation: [], chargetype: [null], client: 1274, client_relation: { company_relation: { natcomid: '1231231231231', title_ru: 'Super Shipper, LTD' }, hash: 3c5e448b11f15293807d9cfdedf21582 }, completemoment: null, context: { iconTitle: null, title: null }, defaultcurrency: null, distance: 47, ferryproperty: ['Aggregates 15 pcs', temperature, 'belts 5 pcs'], id: 94352, istender: false, kmprice: 0, maxquotewithcommission: null, mcubeprice: 0, minquote: null, needAttention: true, newMessages: 0, operator: 180, operator_relation: { company: 844, company_relation: { natcomid: '37534111223', title_ru: 'Mega Carrier, LTD' }, hash: da9cc741ae2ca7e4adf596b773a7b187, id: 278 }, periodic: 243-06-16, routeparts: [{ bordercrossforoperator: false, cargo: Aggregates, checkpoint_relation: { id: 3941, town_relation: { district: '', title_ru: Berdiansk } }, complete: false, date1: 1466035200, date2: 1466467200, id: 111365645, route: 94352, time1: '08:30:00', time2: '14:00:00', triggered: true, workaction: 1 }, { bordercrossforoperator: false, cargo: А, checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1466467200, date2: -62169984000, id: 111365646, route: 94352, time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 1 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1467244800, date2: 1466640000, id: 111365647, route: 94352, time1: '08:30:00', time2: '22:00:00', triggered: false, workaction: 2 }], routeresponse: 73702, routeresponse_relation: [{ cancelled: 0, car: 15677, car_relation: { id: 15677, make: 6, make_relation: { id: 6, title_ru: Citroen }, model: null, number: '123' }, driver: 14793, driver2: null, driver2_relation: null, driver_relation: { firstname: '123', id: 14793, lastname: /0, maincellphone: '123', patronymic: '' }, id: 73702, moment: 1466096342, pricequotewithcommission: null, route: 94352, trailer: null, trailer_relation: null }], routestatus: 6, routetender: { currentminpricewithcommission: null, tenderstatus: null, winnerpricewithcommission: null, winnerstatus: null }, stepwithcommission: null, tenderavailableuntilmoment: -62169984000, tenderparent: 18-02-26, tenderparticipant: false, tenderuntil: { date: -62169984000, time: '00:00:00' }, tonnprice: 0, unitPrices: [{ title: UAH/tonn, value: null }, { title: UAH/mcub, value: null }, { title: UAH/km, value: null }] }, { blindtender: false, bookedbyme: false, bookedsince: null, bookedtill: null, booktime: 30, budget: 7500, cartypeRelation: [], chargetype: [null], client: 1274, client_relation: { company_relation: { title_ru: 'The client, LTD' } }, completemoment: null, context: { iconTitle: null, title: null }, defaultcurrency: null, distance: 566, ferryproperty: ['Aggregates 10 pcs'], id: 94362, istender: false, kmprice: 0, maxquotewithcommission: null, mcubeprice: 0, minquote: null, needAttention: true, newMessages: 1, operator: 180, operator_relation: { company: 406, company_relation: { title_ru: 'Carrier 1, LTD' }, id: 180 }, periodic: 253-06-16, routeparts: [{ bordercrossforoperator: false, cargo: 'груз 1', checkpoint_relation: { id: 6665, town_relation: { district: '', title_ru: Odesa } }, complete: false, date1: 1466985600, date2: 1466467200, id: 111365673, route: 94362, time1: '09:30:00', time2: '12:30:00', triggered: true, workaction: 1 }, { bordercrossforoperator: false, cargo: 'груз 2', checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1467072000, date2: 1466726400, id: 111365674, route: 94362, time1: '13:00:00', time2: '19:00:00', triggered: false, workaction: 1 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 5251, town_relation: { district: '', title_ru: Brovary } }, complete: false, date1: 1467158400, date2: 1466640000, id: 111365675, route: 94362, time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 2 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 6665, town_relation: { district: '', title_ru: Odesa } }, complete: false, date1: 1467244800, date2: 1466726400, id: 111365676, route: 94362, time1: '09:00:00', time2: '15:00:00', triggered: false, workaction: 2 }], routeresponse: 73719, routeresponse_relation: [{ cancelled: 0, car: 8062, car_relation: { id: 8062, make: 8, make_relation: { id: 8, title_ru: DAF }, model: null, number: АА1122ЕЕ }, driver: 7953, driver2: null, driver2_relation: null, driver_relation: { firstname: John, id: 7953, lastname: Driver, maincellphone: 38(050)111-22-33, patronymic: '' }, id: 73719, moment: 1466160341, pricequotewithcommission: null, route: 94362, trailer: 8120, trailer_relation: { id: 8120, model: null, number: АА2211ХХ } }], routestatus: 6, routetender: { currentminpricewithcommission: null, tenderstatus: null, winnerpricewithcommission: null, winnerstatus: null }, stepwithcommission: null, tenderavailableuntilmoment: -62169984000, tenderparticipant: false, tenderuntil: { date: -62169984000, time: '00:00:00' }, tonnprice: 0, unitPrices: [{ title: UAH/tonn, value: null }, { title: UAH/mcub, value: null }, { title: UAH/km, value: null }] }, { blindtender: false, bookedbyme: false, bookedsince: null, bookedtill: null, booktime: 30, budget: 15230, cartypeRelation: [], chargetype: [null], client: 1274, client_relation: { company_relation: { title_ru: 'The client, LTD' } }, completemoment: null, context: { iconTitle: null, title: null }, defaultcurrency: null, distance: 47, ferryproperty: ['Aggregates 15 pcs', temperature, 'belts 5 pcs'], id: 94352, istender: false, kmprice: 0, maxquotewithcommission: null, mcubeprice: 0, minquote: null, needAttention: true, newMessages: 0, operator: 180, operator_relation: { company: 406, company_relation: { title_ru: 'Carrier 1, LTD' }, id: 180 }, periodic: 243-06-16, routeparts: [{ bordercrossforoperator: false, cargo: Aggregates, checkpoint_relation: { id: 3941, town_relation: { district: '', title_ru: Berdiansk } }, complete: false, date1: 1466035200, date2: 1466467200, id: 111365645, route: 94352, time1: '08:30:00', time2: '14:00:00', triggered: true, workaction: 1 }, { bordercrossforoperator: false, cargo: А, checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1466467200, date2: -62169984000, id: 111365646, route: 94352, time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 1 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1467244800, date2: 1466640000, id: 111365647, route: 94352, time1: '08:30:00', time2: '22:00:00', triggered: false, workaction: 2 }], routeresponse: 73702, routeresponse_relation: [{ cancelled: 0, car: 15677, car_relation: { id: 15677, make: 6, make_relation: { id: 6, title_ru: Citroen }, model: null, number: '123' }, driver: 14793, driver2: null, driver2_relation: null, driver_relation: { firstname: '123', id: 14793, lastname: /0, maincellphone: '123', patronymic: '' }, id: 73702, moment: 1466096342, pricequotewithcommission: null, route: 94352, trailer: null, trailer_relation: null }], routestatus: 6, routetender: { currentminpricewithcommission: null, tenderstatus: null, winnerpricewithcommission: null, winnerstatus: null }, stepwithcommission: null, tenderavailableuntilmoment: -62169984000, tenderparticipant: false, tenderuntil: { date: -62169984000, time: '00:00:00' }, tonnprice: 0, unitPrices: [{ title: UAH/tonn, value: null }, { title: UAH/mcub, value: null }, { title: UAH/km, value: null }] }, { blindtender: false, bookedbyme: false, bookedsince: null, bookedtill: null, booktime: 30, budget: 45, cartypeRelation: [], chargetype: [null], client: 1274, client_relation: { company_relation: { title_ru: 'The client, LTD' } }, completemoment: null, context: { iconTitle: null, title: null }, defaultcurrency: null, distance: 493, id: 94363, istender: false, kmprice: 0, maxquotewithcommission: null, mcubeprice: 0, minquote: null, needAttention: true, newMessages: 0, operator: 180, operator_relation: { company: 406, company_relation: { title_ru: 'Carrier 1, LTD' }, id: 180 }, periodic: 254-06-16, routeparts: [{ bordercrossforoperator: false, cargo: d, checkpoint_relation: { id: 5251, town_relation: { district: '', title_ru: Brovary } }, complete: true, date1: 1466208000, date2: -62169984000, id: 111365677, route: 94363, time1: '09:30:00', time2: '00:00:00', triggered: true, workaction: 1 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 6665, town_relation: { district: '', title_ru: Odesa } }, complete: false, date1: 1466380800, date2: -62169984000, id: 111365678, route: 94363, time1: '09:30:00', time2: '00:00:00', triggered: true, workaction: 2 }], routeresponse: 80828, routeresponse_relation: [{ cancelled: 0, car: 9820, car_relation: { id: 9820, make: 11, make_relation: { id: 11, title_ru: ERF }, model: null, number: '444' }, driver: 9501, driver2: null, driver2_relation: null, driver_relation: { firstname: asd, id: 9501, lastname: asd, maincellphone: '222', patronymic: asd }, id: 73720, moment: 1466160842, pricequotewithcommission: null, route: 94363, trailer: 9704, trailer_relation: { id: 9704, model: null, number: '666' } }, { cancelled: 0, car: 15741, car_relation: { id: 15741, make: 8, make_relation: { id: 8, title_ru: DAF }, model: null, number: АА1111AА }, driver: 14857, driver2: null, driver2_relation: null, driver_relation: { firstname: Jesse, id: 14857, lastname: Pinkman, maincellphone: '3805011111111', patronymic: '' }, id: 80828, moment: 1580309291, pricequotewithcommission: null, route: 94363, trailer: 9704, trailer_relation: { id: 9704, model: null, number: '666' } }], routestatus: 9, routetender: { currentminpricewithcommission: null, tenderstatus: null, winnerpricewithcommission: null, winnerstatus: null }, stepwithcommission: null, tenderavailableuntilmoment: -62169984000, tenderparticipant: false, tenderuntil: { date: -62169984000, time: '00:00:00' }, tonnprice: 0, unitPrices: [{ title: UAH/tonn, value: null }, { title: UAH/mcub, value: null }, { title: UAH/km, value: null }] }, { blindtender: false, bookedbyme: false, bookedsince: null, bookedtill: null, booktime: 30, budget: 15230, cartypeRelation: [], chargetype: [null], client: 1274, client_relation: { company_relation: { title_ru: 'The client, LTD' } }, completemoment: null, context: { iconTitle: null, title: null }, defaultcurrency: null, distance: 47, ferryproperty: ['Aggregates 15 pcs', temperature, 'belts 5 pcs'], id: 94352, istender: false, kmprice: 0, maxquotewithcommission: null, mcubeprice: 0, minquote: null, needAttention: true, newMessages: 0, operator: 180, operator_relation: { company: 406, company_relation: { title_ru: 'Carrier 1, LTD' }, id: 180 }, periodic: 243-06-16, routeparts: [{ bordercrossforoperator: false, cargo: Aggregates, checkpoint_relation: { id: 3941, town_relation: { district: '', title_ru: Berdiansk } }, complete: false, date1: 1466035200, date2: 1466467200, id: 111365645, route: 94352, time1: '08:30:00', time2: '14:00:00', triggered: true, workaction: 1 }, { bordercrossforoperator: false, cargo: А, checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1466467200, date2: -62169984000, id: 111365646, route: 94352, time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 1 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1467244800, date2: 1466640000, id: 111365647, route: 94352, time1: '08:30:00', time2: '22:00:00', triggered: false, workaction: 2 }], routeresponse: 73702, routeresponse_relation: [{ cancelled: 0, car: 15677, car_relation: { id: 15677, make: 6, make_relation: { id: 6, title_ru: Citroen }, model: null, number: '123' }, driver: 14793, driver2: null, driver2_relation: null, driver_relation: { firstname: '123', id: 14793, lastname: /0, maincellphone: '123', patronymic: '' }, id: 73702, moment: 1466096342, pricequotewithcommission: null, route: 94352, trailer: null, trailer_relation: null }], routestatus: 6, routetender: { currentminpricewithcommission: null, tenderstatus: null, winnerpricewithcommission: null, winnerstatus: null }, stepwithcommission: null, tenderavailableuntilmoment: -62169984000, tenderparticipant: false, tenderuntil: { date: -62169984000, time: '00:00:00' }, tonnprice: 0, unitPrices: [{ title: UAH/tonn, value: null }, { title: UAH/mcub, value: null }, { title: UAH/km, value: null }] }] } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { routes: [{ blindtender: false, bookedbyme: false, bookedsince: null, bookedtill: null, booktime: 30, budget: 15230, cartypeRelation: [], chargetype: [null], client: 1274, client_relation: { company_relation: { natcomid: '1231231231231', title_ru: 'Super Shipper, LTD' }, hash: 3c5e448b11f15293807d9cfdedf21582 }, completemoment: null, context: { iconTitle: null, title: null }, defaultcurrency: null, distance: 47, ferryproperty: ['Aggregates 15 pcs', temperature, 'belts 5 pcs'], id: 94352, istender: false, kmprice: 0, maxquotewithcommission: null, mcubeprice: 0, minquote: null, needAttention: true, newMessages: 0, operator: 180, operator_relation: { company: 844, company_relation: { natcomid: '37534111223', title_ru: 'Mega Carrier, LTD' }, hash: da9cc741ae2ca7e4adf596b773a7b187, id: 278 }, periodic: 243-06-16, routeparts: [{ bordercrossforoperator: false, cargo: Aggregates, checkpoint_relation: { id: 3941, town_relation: { district: '', title_ru: Berdiansk } }, complete: false, date1: 1466035200, date2: 1466467200, id: 111365645, route: 94352, time1: '08:30:00', time2: '14:00:00', triggered: true, workaction: 1 }, { bordercrossforoperator: false, cargo: А, checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1466467200, date2: -62169984000, id: 111365646, route: 94352, time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 1 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1467244800, date2: 1466640000, id: 111365647, route: 94352, time1: '08:30:00', time2: '22:00:00', triggered: false, workaction: 2 }], routeresponse: 73702, routeresponse_relation: [{ cancelled: 0, car: 15677, car_relation: { id: 15677, make: 6, make_relation: { id: 6, title_ru: Citroen }, model: null, number: '123' }, driver: 14793, driver2: null, driver2_relation: null, driver_relation: { firstname: '123', id: 14793, lastname: /0, maincellphone: '123', patronymic: '' }, id: 73702, moment: 1466096342, pricequotewithcommission: null, route: 94352, trailer: null, trailer_relation: null }], routestatus: 6, routetender: { currentminpricewithcommission: null, tenderstatus: null, winnerpricewithcommission: null, winnerstatus: null }, stepwithcommission: null, tenderavailableuntilmoment: -62169984000, tenderparent: 18-02-26, tenderparticipant: false, tenderuntil: { date: -62169984000, time: '00:00:00' }, tonnprice: 0, unitPrices: [{ title: UAH/tonn, value: null }, { title: UAH/mcub, value: null }, { title: UAH/km, value: null }] }, { blindtender: false, bookedbyme: false, bookedsince: null, bookedtill: null, booktime: 30, budget: 7500, cartypeRelation: [], chargetype: [null], client: 1274, client_relation: { company_relation: { title_ru: 'The client, LTD' } }, completemoment: null, context: { iconTitle: null, title: null }, defaultcurrency: null, distance: 566, ferryproperty: ['Aggregates 10 pcs'], id: 94362, istender: false, kmprice: 0, maxquotewithcommission: null, mcubeprice: 0, minquote: null, needAttention: true, newMessages: 1, operator: 180, operator_relation: { company: 406, company_relation: { title_ru: 'Carrier 1, LTD' }, id: 180 }, periodic: 253-06-16, routeparts: [{ bordercrossforoperator: false, cargo: 'груз 1', checkpoint_relation: { id: 6665, town_relation: { district: '', title_ru: Odesa } }, complete: false, date1: 1466985600, date2: 1466467200, id: 111365673, route: 94362, time1: '09:30:00', time2: '12:30:00', triggered: true, workaction: 1 }, { bordercrossforoperator: false, cargo: 'груз 2', checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1467072000, date2: 1466726400, id: 111365674, route: 94362, time1: '13:00:00', time2: '19:00:00', triggered: false, workaction: 1 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 5251, town_relation: { district: '', title_ru: Brovary } }, complete: false, date1: 1467158400, date2: 1466640000, id: 111365675, route: 94362, time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 2 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 6665, town_relation: { district: '', title_ru: Odesa } }, complete: false, date1: 1467244800, date2: 1466726400, id: 111365676, route: 94362, time1: '09:00:00', time2: '15:00:00', triggered: false, workaction: 2 }], routeresponse: 73719, routeresponse_relation: [{ cancelled: 0, car: 8062, car_relation: { id: 8062, make: 8, make_relation: { id: 8, title_ru: DAF }, model: null, number: АА1122ЕЕ }, driver: 7953, driver2: null, driver2_relation: null, driver_relation: { firstname: John, id: 7953, lastname: Driver, maincellphone: 38(050)111-22-33, patronymic: '' }, id: 73719, moment: 1466160341, pricequotewithcommission: null, route: 94362, trailer: 8120, trailer_relation: { id: 8120, model: null, number: АА2211ХХ } }], routestatus: 6, routetender: { currentminpricewithcommission: null, tenderstatus: null, winnerpricewithcommission: null, winnerstatus: null }, stepwithcommission: null, tenderavailableuntilmoment: -62169984000, tenderparticipant: false, tenderuntil: { date: -62169984000, time: '00:00:00' }, tonnprice: 0, unitPrices: [{ title: UAH/tonn, value: null }, { title: UAH/mcub, value: null }, { title: UAH/km, value: null }] }, { blindtender: false, bookedbyme: false, bookedsince: null, bookedtill: null, booktime: 30, budget: 15230, cartypeRelation: [], chargetype: [null], client: 1274, client_relation: { company_relation: { title_ru: 'The client, LTD' } }, completemoment: null, context: { iconTitle: null, title: null }, defaultcurrency: null, distance: 47, ferryproperty: ['Aggregates 15 pcs', temperature, 'belts 5 pcs'], id: 94352, istender: false, kmprice: 0, maxquotewithcommission: null, mcubeprice: 0, minquote: null, needAttention: true, newMessages: 0, operator: 180, operator_relation: { company: 406, company_relation: { title_ru: 'Carrier 1, LTD' }, id: 180 }, periodic: 243-06-16, routeparts: [{ bordercrossforoperator: false, cargo: Aggregates, checkpoint_relation: { id: 3941, town_relation: { district: '', title_ru: Berdiansk } }, complete: false, date1: 1466035200, date2: 1466467200, id: 111365645, route: 94352, time1: '08:30:00', time2: '14:00:00', triggered: true, workaction: 1 }, { bordercrossforoperator: false, cargo: А, checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1466467200, date2: -62169984000, id: 111365646, route: 94352, time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 1 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1467244800, date2: 1466640000, id: 111365647, route: 94352, time1: '08:30:00', time2: '22:00:00', triggered: false, workaction: 2 }], routeresponse: 73702, routeresponse_relation: [{ cancelled: 0, car: 15677, car_relation: { id: 15677, make: 6, make_relation: { id: 6, title_ru: Citroen }, model: null, number: '123' }, driver: 14793, driver2: null, driver2_relation: null, driver_relation: { firstname: '123', id: 14793, lastname: /0, maincellphone: '123', patronymic: '' }, id: 73702, moment: 1466096342, pricequotewithcommission: null, route: 94352, trailer: null, trailer_relation: null }], routestatus: 6, routetender: { currentminpricewithcommission: null, tenderstatus: null, winnerpricewithcommission: null, winnerstatus: null }, stepwithcommission: null, tenderavailableuntilmoment: -62169984000, tenderparticipant: false, tenderuntil: { date: -62169984000, time: '00:00:00' }, tonnprice: 0, unitPrices: [{ title: UAH/tonn, value: null }, { title: UAH/mcub, value: null }, { title: UAH/km, value: null }] }, { blindtender: false, bookedbyme: false, bookedsince: null, bookedtill: null, booktime: 30, budget: 45, cartypeRelation: [], chargetype: [null], client: 1274, client_relation: { company_relation: { title_ru: 'The client, LTD' } }, completemoment: null, context: { iconTitle: null, title: null }, defaultcurrency: null, distance: 493, id: 94363, istender: false, kmprice: 0, maxquotewithcommission: null, mcubeprice: 0, minquote: null, needAttention: true, newMessages: 0, operator: 180, operator_relation: { company: 406, company_relation: { title_ru: 'Carrier 1, LTD' }, id: 180 }, periodic: 254-06-16, routeparts: [{ bordercrossforoperator: false, cargo: d, checkpoint_relation: { id: 5251, town_relation: { district: '', title_ru: Brovary } }, complete: true, date1: 1466208000, date2: -62169984000, id: 111365677, route: 94363, time1: '09:30:00', time2: '00:00:00', triggered: true, workaction: 1 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 6665, town_relation: { district: '', title_ru: Odesa } }, complete: false, date1: 1466380800, date2: -62169984000, id: 111365678, route: 94363, time1: '09:30:00', time2: '00:00:00', triggered: true, workaction: 2 }], routeresponse: 80828, routeresponse_relation: [{ cancelled: 0, car: 9820, car_relation: { id: 9820, make: 11, make_relation: { id: 11, title_ru: ERF }, model: null, number: '444' }, driver: 9501, driver2: null, driver2_relation: null, driver_relation: { firstname: asd, id: 9501, lastname: asd, maincellphone: '222', patronymic: asd }, id: 73720, moment: 1466160842, pricequotewithcommission: null, route: 94363, trailer: 9704, trailer_relation: { id: 9704, model: null, number: '666' } }, { cancelled: 0, car: 15741, car_relation: { id: 15741, make: 8, make_relation: { id: 8, title_ru: DAF }, model: null, number: АА1111AА }, driver: 14857, driver2: null, driver2_relation: null, driver_relation: { firstname: Jesse, id: 14857, lastname: Pinkman, maincellphone: '3805011111111', patronymic: '' }, id: 80828, moment: 1580309291, pricequotewithcommission: null, route: 94363, trailer: 9704, trailer_relation: { id: 9704, model: null, number: '666' } }], routestatus: 9, routetender: { currentminpricewithcommission: null, tenderstatus: null, winnerpricewithcommission: null, winnerstatus: null }, stepwithcommission: null, tenderavailableuntilmoment: -62169984000, tenderparticipant: false, tenderuntil: { date: -62169984000, time: '00:00:00' }, tonnprice: 0, unitPrices: [{ title: UAH/tonn, value: null }, { title: UAH/mcub, value: null }, { title: UAH/km, value: null }] }, { blindtender: false, bookedbyme: false, bookedsince: null, bookedtill: null, booktime: 30, budget: 15230, cartypeRelation: [], chargetype: [null], client: 1274, client_relation: { company_relation: { title_ru: 'The client, LTD' } }, completemoment: null, context: { iconTitle: null, title: null }, defaultcurrency: null, distance: 47, ferryproperty: ['Aggregates 15 pcs', temperature, 'belts 5 pcs'], id: 94352, istender: false, kmprice: 0, maxquotewithcommission: null, mcubeprice: 0, minquote: null, needAttention: true, newMessages: 0, operator: 180, operator_relation: { company: 406, company_relation: { title_ru: 'Carrier 1, LTD' }, id: 180 }, periodic: 243-06-16, routeparts: [{ bordercrossforoperator: false, cargo: Aggregates, checkpoint_relation: { id: 3941, town_relation: { district: '', title_ru: Berdiansk } }, complete: false, date1: 1466035200, date2: 1466467200, id: 111365645, route: 94352, time1: '08:30:00', time2: '14:00:00', triggered: true, workaction: 1 }, { bordercrossforoperator: false, cargo: А, checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1466467200, date2: -62169984000, id: 111365646, route: 94352, time1: '00:00:00', time2: '00:00:00', triggered: false, workaction: 1 }, { bordercrossforoperator: false, cargo: '', checkpoint_relation: { id: 4518, town_relation: { district: Irpin, title_ru: Bucha } }, complete: false, date1: 1467244800, date2: 1466640000, id: 111365647, route: 94352, time1: '08:30:00', time2: '22:00:00', triggered: false, workaction: 2 }], routeresponse: 73702, routeresponse_relation: [{ cancelled: 0, car: 15677, car_relation: { id: 15677, make: 6, make_relation: { id: 6, title_ru: Citroen }, model: null, number: '123' }, driver: 14793, driver2: null, driver2_relation: null, driver_relation: { firstname: '123', id: 14793, lastname: /0, maincellphone: '123', patronymic: '' }, id: 73702, moment: 1466096342, pricequotewithcommission: null, route: 94352, trailer: null, trailer_relation: null }], routestatus: 6, routetender: { currentminpricewithcommission: null, tenderstatus: null, winnerpricewithcommission: null, winnerstatus: null }, stepwithcommission: null, tenderavailableuntilmoment: -62169984000, tenderparticipant: false, tenderuntil: { date: -62169984000, time: '00:00:00' }, tonnprice: 0, unitPrices: [{ title: UAH/tonn, value: null }, { title: UAH/mcub, value: null }, { title: UAH/km, value: null }] }] }, status: success }
        403:
          description: 'Missing token'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: '*'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Fri, 31 May 2024 12:31:03 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: 'nginx/1.18.0 (Ubuntu)'
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is required' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Missing token':
                  value: { message: 'Token is required', relogin: true, status: error }
  /a/v2/rest/public/getMyDrivers:
    get:
      tags:
        - 'Fleet / Carriers'
      summary: 'Get My Drivers'
      description: |-
        Returns the information about all the drivers within your company (name, phone number, license number, etc.) 

        - if successful you will receive information about all the drivers within your company 
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Can be only used by carriers
      operationId: getMyDrivers
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { car: { type: number, example: 3687 }, driverlicenseissued: { type: string, example: 1568246400 }, driverlicenseissuedby: { type: string, nullable: true, example: 'DVLA Swansea' }, driverlicensenumber: { type: string, nullable: true, example: '420335' }, driverlicenseserial: { type: string, example: DVLA }, firstname: { type: string, example: Walter }, id: { type: number, example: 3653 }, inblacklist: { type: number, example: 0 }, lastname: { type: string, example: White }, maincellphone: { type: string, example: '+447700900001' }, passportserial: { type: string, example: 'UK 123321' }, patronymic: { type: string, example: Hartwell }, taxid: { type: string, example: '' } } }, example: [{ car: 3687, driverlicenseissued: 1568246400, driverlicenseissuedby: 'DVLA Swansea', driverlicensenumber: '420335', driverlicenseserial: DVLA, firstname: Walter, id: 3653, inblacklist: 0, lastname: White, maincellphone: '+447700900001', passportserial: 'UK 123321', patronymic: Hartwell, taxid: '' }, { car: 8062, driverlicenseissued: 'DVLA London', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKA123, firstname: Jesse, id: 7953, inblacklist: 0, lastname: Pinkman, maincellphone: '+447700900002', passportserial: 'UK 123456', patronymic: Bruce, taxid: '' }, { car: 8356, driverlicenseissued: 'DVLA Manchester', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKB989, firstname: Hank, id: 8244, inblacklist: 0, lastname: Schrader, maincellphone: '+447700900003', passportserial: '', patronymic: Douglas, taxid: '' }, { car: 8357, driverlicenseissued: 'DVLA Birmingham', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKC889, firstname: Saul, id: 8245, inblacklist: 0, lastname: Goodman, maincellphone: '+447700900004', passportserial: '', patronymic: James, taxid: '' }, { car: 8358, driverlicenseissued: 'DVLA Leeds', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKD998, firstname: Mike, id: 8246, inblacklist: 0, lastname: Ehrmantraut, maincellphone: '+447700900005', passportserial: '', patronymic: Jonathan, taxid: '' }, { car: 9820, driverlicenseissued: 'DVLA Bristol', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKE111, firstname: Gustavo, id: 9501, inblacklist: 0, lastname: Fring, maincellphone: '+447700900006', passportserial: '', patronymic: Alberto, taxid: '' }, { car: 13535, driverlicenseissued: 'DVLA Liverpool', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKF222, firstname: Tuco, id: 12715, inblacklist: 0, lastname: Salamanca, maincellphone: '+447700900007', passportserial: '', patronymic: '', taxid: '' }, { car: 13538, driverlicenseissued: 'DVLA Sheffield', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKG333, firstname: Nacho, id: 12716, inblacklist: 0, lastname: Varga, maincellphone: '+447700900008', passportserial: '', patronymic: '', taxid: '' }, { car: 13540, driverlicenseissued: 'DVLA Nottingham', driverlicenseissuedby: 'DVLA Office', driverlicensenumber: null, driverlicenseserial: UKH444, firstname: Jimmy, id: 12717, inblacklist: 0, lastname: McGill, maincellphone: '+447700900009', passportserial: '', patronymic: '', taxid: '' }, { car: 13541, driverlicenseissued: 1567382400, driverlicenseissuedby: 'DVLA Swansea', driverlicensenumber: AS789654, driverlicenseserial: UKI555, firstname: Kim, id: 12718, inblacklist: 0, lastname: Wexler, maincellphone: '+447700900010', passportserial: '', patronymic: '', taxid: '' }, { car: 13543, driverlicenseissued: 'DVLA Oxford', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKJ666, firstname: Gale, id: 12719, inblacklist: 0, lastname: Boetticher, maincellphone: '+447700900011', passportserial: '', patronymic: '', taxid: '' }, { car: 13546, driverlicenseissued: 'DVLA Reading', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKK777, firstname: Andrea, id: 12720, inblacklist: 0, lastname: Cantillo, maincellphone: '+447700900012', passportserial: '', patronymic: '', taxid: '' }, { car: 13555, driverlicenseissued: 'DVLA Cardiff', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKL888, firstname: Brock, id: 12724, inblacklist: 0, lastname: Molina, maincellphone: '+447700900013', passportserial: '', patronymic: '', taxid: '' }, { car: 13559, driverlicenseissued: 'DVLA Glasgow', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKM999, firstname: Patrick, id: 12727, inblacklist: 0, lastname: Kuby, maincellphone: '+447700900014', passportserial: '', patronymic: '', taxid: '' }, { car: 13572, driverlicenseissued: 'DVLA Edinburgh', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKN101, firstname: Bill, id: 12738, inblacklist: 0, lastname: Hu, maincellphone: '+447700900015', passportserial: '', patronymic: '', taxid: '' }, { car: 13576, driverlicenseissued: 'DVLA Newcastle', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKP747, firstname: Francesca, id: 12742, inblacklist: 0, lastname: Babineaux, maincellphone: '+447700900016', passportserial: '', patronymic: '', taxid: '' }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ car: 3687, driverlicenseissued: 1568246400, driverlicenseissuedby: 'DVLA Swansea', driverlicensenumber: '420335', driverlicenseserial: DVLA, firstname: Walter, id: 3653, inblacklist: 0, lastname: White, maincellphone: '+447700900001', passportserial: 'UK 123321', patronymic: Hartwell, taxid: '' }, { car: 8062, driverlicenseissued: 'DVLA London', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKA123, firstname: Jesse, id: 7953, inblacklist: 0, lastname: Pinkman, maincellphone: '+447700900002', passportserial: 'UK 123456', patronymic: Bruce, taxid: '' }, { car: 8356, driverlicenseissued: 'DVLA Manchester', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKB989, firstname: Hank, id: 8244, inblacklist: 0, lastname: Schrader, maincellphone: '+447700900003', passportserial: '', patronymic: Douglas, taxid: '' }, { car: 8357, driverlicenseissued: 'DVLA Birmingham', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKC889, firstname: Saul, id: 8245, inblacklist: 0, lastname: Goodman, maincellphone: '+447700900004', passportserial: '', patronymic: James, taxid: '' }, { car: 8358, driverlicenseissued: 'DVLA Leeds', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKD998, firstname: Mike, id: 8246, inblacklist: 0, lastname: Ehrmantraut, maincellphone: '+447700900005', passportserial: '', patronymic: Jonathan, taxid: '' }, { car: 9820, driverlicenseissued: 'DVLA Bristol', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKE111, firstname: Gustavo, id: 9501, inblacklist: 0, lastname: Fring, maincellphone: '+447700900006', passportserial: '', patronymic: Alberto, taxid: '' }, { car: 13535, driverlicenseissued: 'DVLA Liverpool', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKF222, firstname: Tuco, id: 12715, inblacklist: 0, lastname: Salamanca, maincellphone: '+447700900007', passportserial: '', patronymic: '', taxid: '' }, { car: 13538, driverlicenseissued: 'DVLA Sheffield', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKG333, firstname: Nacho, id: 12716, inblacklist: 0, lastname: Varga, maincellphone: '+447700900008', passportserial: '', patronymic: '', taxid: '' }, { car: 13540, driverlicenseissued: 'DVLA Nottingham', driverlicenseissuedby: 'DVLA Office', driverlicensenumber: null, driverlicenseserial: UKH444, firstname: Jimmy, id: 12717, inblacklist: 0, lastname: McGill, maincellphone: '+447700900009', passportserial: '', patronymic: '', taxid: '' }, { car: 13541, driverlicenseissued: 1567382400, driverlicenseissuedby: 'DVLA Swansea', driverlicensenumber: AS789654, driverlicenseserial: UKI555, firstname: Kim, id: 12718, inblacklist: 0, lastname: Wexler, maincellphone: '+447700900010', passportserial: '', patronymic: '', taxid: '' }, { car: 13543, driverlicenseissued: 'DVLA Oxford', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKJ666, firstname: Gale, id: 12719, inblacklist: 0, lastname: Boetticher, maincellphone: '+447700900011', passportserial: '', patronymic: '', taxid: '' }, { car: 13546, driverlicenseissued: 'DVLA Reading', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKK777, firstname: Andrea, id: 12720, inblacklist: 0, lastname: Cantillo, maincellphone: '+447700900012', passportserial: '', patronymic: '', taxid: '' }, { car: 13555, driverlicenseissued: 'DVLA Cardiff', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKL888, firstname: Brock, id: 12724, inblacklist: 0, lastname: Molina, maincellphone: '+447700900013', passportserial: '', patronymic: '', taxid: '' }, { car: 13559, driverlicenseissued: 'DVLA Glasgow', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKM999, firstname: Patrick, id: 12727, inblacklist: 0, lastname: Kuby, maincellphone: '+447700900014', passportserial: '', patronymic: '', taxid: '' }, { car: 13572, driverlicenseissued: 'DVLA Edinburgh', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKN101, firstname: Bill, id: 12738, inblacklist: 0, lastname: Hu, maincellphone: '+447700900015', passportserial: '', patronymic: '', taxid: '' }, { car: 13576, driverlicenseissued: 'DVLA Newcastle', driverlicenseissuedby: null, driverlicensenumber: null, driverlicenseserial: UKP747, firstname: Francesca, id: 12742, inblacklist: 0, lastname: Babineaux, maincellphone: '+447700900016', passportserial: '', patronymic: '', taxid: '' }], status: success }
        400:
          description: 'Request by shipper'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this data' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Request by shipper':
                  value: { message: 'You don’t have permission to view this data', relogin: false, status: error }
  /a/v2/rest/public/getMyTrailers:
    get:
      tags:
        - 'Fleet / Carriers'
      summary: 'Get My Trailers'
      description: |-
        Returns the information about all the trailers of your company (registration number, load capacity, model, etc.)

        - if successful you will receive information about all the trailers within your company
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Can be only used by carriers
      operationId: getMyTrailers
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { axes: { type: number, example: 0 }, id: { type: number, example: 3709 }, length: { type: number, example: 21 }, loadcapacity: { type: number, example: 19 }, model: { type: string, nullable: true, example: 'SCHWARZMULLER PA-2E' }, number: { type: string, example: BN08XHR }, volume: { type: number, example: 0 }, width: { type: number, example: 0 } } }, example: [{ axes: 0, id: 3709, length: 21, loadcapacity: 19, model: 'SCHWARZMULLER PA-2E', number: BN08XHR, volume: 0, width: 0 }, { axes: 0, id: 8120, length: 13.6, loadcapacity: 22, model: null, number: AA22XXH, volume: 86, width: 0 }, { axes: 0, id: 8416, length: 12, loadcapacity: 22, model: null, number: LL99SSQ, volume: 89, width: 0 }, { axes: 0, id: 8417, length: 12, loadcapacity: 189, model: null, number: OO77OOO, volume: 90, width: 0 }, { axes: 0, id: 9704, length: 0, loadcapacity: 0, model: null, number: '666', volume: 0, width: 0 }, { axes: 0, id: 12932, length: 0, loadcapacity: 0, model: null, number: CCC, volume: 0, width: 0 }, { axes: 0, id: 12933, length: 0, loadcapacity: 0, model: null, number: FYVYF, volume: 0, width: 0 }, { axes: 0, id: 12934, length: 0, loadcapacity: 0, model: null, number: FYAP, volume: 0, width: 0 }, { axes: 0, id: 12935, length: 0, loadcapacity: 0, model: null, number: '666', volume: 0, width: 0 }, { axes: 0, id: 12936, length: 0, loadcapacity: 0, model: null, number: '777', volume: 0, width: 0 }, { axes: 0, id: 12937, length: 0, loadcapacity: 20, model: null, number: YVAV, volume: 0, width: 0 }, { axes: 0, id: 12941, length: 0, loadcapacity: 0, model: null, number: UKPUKP, volume: 0, width: 0 }, { axes: 0, id: 12944, length: 0, loadcapacity: 0, model: null, number: TEST, volume: 0, width: 0 }, { axes: 0, id: 12955, length: 0, loadcapacity: 0, model: null, number: '123', volume: 0, width: 0 }, { axes: 0, id: 12959, length: 0, loadcapacity: 21, model: null, number: BK56NBV, volume: 86, width: 0 }, { axes: 0, id: 12960, length: 0, loadcapacity: 0, model: null, number: OOO, volume: 0, width: 0 }, { axes: 0, id: 34906, length: 0, loadcapacity: 0, model: null, number: BC, volume: 0, width: 0 }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ axes: 0, id: 3709, length: 21, loadcapacity: 19, model: 'SCHWARZMULLER PA-2E', number: BN08XHR, volume: 0, width: 0 }, { axes: 0, id: 8120, length: 13.6, loadcapacity: 22, model: null, number: AA22XXH, volume: 86, width: 0 }, { axes: 0, id: 8416, length: 12, loadcapacity: 22, model: null, number: LL99SSQ, volume: 89, width: 0 }, { axes: 0, id: 8417, length: 12, loadcapacity: 189, model: null, number: OO77OOO, volume: 90, width: 0 }, { axes: 0, id: 9704, length: 0, loadcapacity: 0, model: null, number: '666', volume: 0, width: 0 }, { axes: 0, id: 12932, length: 0, loadcapacity: 0, model: null, number: CCC, volume: 0, width: 0 }, { axes: 0, id: 12933, length: 0, loadcapacity: 0, model: null, number: FYVYF, volume: 0, width: 0 }, { axes: 0, id: 12934, length: 0, loadcapacity: 0, model: null, number: FYAP, volume: 0, width: 0 }, { axes: 0, id: 12935, length: 0, loadcapacity: 0, model: null, number: '666', volume: 0, width: 0 }, { axes: 0, id: 12936, length: 0, loadcapacity: 0, model: null, number: '777', volume: 0, width: 0 }, { axes: 0, id: 12937, length: 0, loadcapacity: 20, model: null, number: YVAV, volume: 0, width: 0 }, { axes: 0, id: 12941, length: 0, loadcapacity: 0, model: null, number: UKPUKP, volume: 0, width: 0 }, { axes: 0, id: 12944, length: 0, loadcapacity: 0, model: null, number: TEST, volume: 0, width: 0 }, { axes: 0, id: 12955, length: 0, loadcapacity: 0, model: null, number: '123', volume: 0, width: 0 }, { axes: 0, id: 12959, length: 0, loadcapacity: 21, model: null, number: BK56NBV, volume: 86, width: 0 }, { axes: 0, id: 12960, length: 0, loadcapacity: 0, model: null, number: OOO, volume: 0, width: 0 }, { axes: 0, id: 34906, length: 0, loadcapacity: 0, model: null, number: BC, volume: 0, width: 0 }], status: success }
        400:
          description: 'Request by shipper'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this data' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Request by shipper':
                  value: { message: 'You don’t have permission to view this data', relogin: false, status: error }
  /a/v2/rest/public/getMyCars:
    get:
      tags:
        - 'Fleet / Carriers'
      summary: 'Get My Trucks'
      description: |-
        Returns information about all the trucks within your company (brand, model, registration number, etc.).

        - if successful you will receive information about all the trucks within your company
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Can be only used by carriers.
      operationId: getMyTrucks
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { axes: { type: number, example: 0 }, carstyle: { type: string, example: forcesplitcarstyle }, cartype: { type: number, example: 35 }, cellnum: { type: string, example: '' }, height: { type: number, example: 0 }, id: { type: number, example: 3687 }, insuredTil: { type: string, example: -62169984000 }, length: { type: number, example: 0 }, loadcapacity: { type: number, example: 0.999 }, make: { type: object, properties: { id: { type: number, example: 43 }, title_ru: { type: string, example: Renault } } }, model: { type: string, nullable: true, example: 'MAGNUM 430' }, number: { type: string, example: BN2582BO }, remark: { type: string, example: '' }, trailer: { type: number, nullable: true, example: 3709 }, vehicleclass: { nullable: true, example: null }, vin: { type: string, example: '' }, volume: { type: number, example: 0 }, weight: { type: number, example: 0 }, width: { type: number, example: 0 } } }, example: [{ axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 3687, insuredTil: -62169984000, length: 0, loadcapacity: 0.999, make: { id: 43, title_ru: Renault }, model: 'MAGNUM 430', number: BN2582BO, remark: '', trailer: 3709, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 8062, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 8, title_ru: DAF }, model: null, number: AA1122EE, remark: '', trailer: 8120, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 8356, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 5, title_ru: Chevrolet }, model: null, number: RR9988GG, remark: 'lights too bright', trailer: 8416, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: optionalsplitcarstyle, cartype: 31, cellnum: '', height: 0, id: 8357, insuredTil: -62169984000, length: 0.999, loadcapacity: 0.999, make: { id: 7, title_ru: Daewoo }, model: null, number: FF6767YY, remark: '', trailer: 8417, vehicleclass: null, vin: '', volume: 0.999, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 30, cellnum: '', height: 0, id: 8358, insuredTil: -62169984000, length: 0.999, loadcapacity: 0.999, make: { id: 14, title_ru: Ford }, model: null, number: AA0909AO, remark: 'nice truck', trailer: null, vehicleclass: null, vin: '', volume: 0.999, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 9820, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 11, title_ru: ERF }, model: null, number: '444', remark: '', trailer: 9704, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: optionalsplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13534, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 3, title_ru: BAW }, model: null, number: CCC, remark: ccc, trailer: 12932, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: optionalsplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13535, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 3, title_ru: BAW }, model: null, number: CCC, remark: ccc, trailer: 12932, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: optionalsplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13536, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 3, title_ru: BAW }, model: null, number: CCC, remark: ccc, trailer: 12932, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: optionalsplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13537, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 3, title_ru: BAW }, model: null, number: CCC, remark: ccc, trailer: 12932, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13538, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 6, title_ru: Citroen }, model: null, number: FYVAFY, remark: '', trailer: 12933, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13539, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 5, title_ru: Chevrolet }, model: null, number: FYAP, remark: '', trailer: 12934, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13540, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 5, title_ru: Chevrolet }, model: null, number: FYAP, remark: '', trailer: 12934, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13541, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 3, title_ru: BAW }, model: null, number: '666', remark: '', trailer: 12935, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13542, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 4, title_ru: CAMC }, model: null, number: '777', remark: '', trailer: 12936, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13543, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 4, title_ru: CAMC }, model: null, number: '777', remark: '', trailer: 12936, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13544, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 4, title_ru: CAMC }, model: null, number: '777', remark: '', trailer: 12936, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13545, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 4, title_ru: CAMC }, model: null, number: '777', remark: '', trailer: 12936, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13546, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 8, title_ru: DAF }, model: null, number: BAY, remark: '', trailer: 12937, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13555, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 3, title_ru: BAW }, model: null, number: UKPUKP, remark: '', trailer: 12941, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13558, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 5, title_ru: Chevrolet }, model: null, number: TEST, remark: '', trailer: 12944, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13559, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 5, title_ru: Chevrolet }, model: null, number: TEST, remark: '', trailer: 12944, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13572, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 8, title_ru: DAF }, model: null, number: '11221', remark: '', trailer: 12955, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13576, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 45, title_ru: Scania }, model: null, number: BK5865NB, remark: '', trailer: 12959, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13577, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 8, title_ru: DAF }, model: null, number: '112121', remark: '', trailer: 12960, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 14, cellnum: '', height: 0, id: 15660, insuredTil: -62169984000, length: 0, loadcapacity: 0.999, make: { id: 12, title_ru: FAW }, model: null, number: AA5748BK, remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 18, cellnum: '', height: 0, id: 15662, insuredTil: -62169984000, length: 0.999, loadcapacity: 0.999, make: { id: 14, title_ru: Ford }, model: null, number: AP3455AK, remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0.999, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 12, cellnum: '', height: 0, id: 15663, insuredTil: -62169984000, length: 0, loadcapacity: 0.999, make: { id: 16, title_ru: Foton }, model: null, number: AP3456BV, remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 10, cellnum: '', height: 0, id: 15677, insuredTil: -62169984000, length: 0.999, loadcapacity: 0, make: { id: 6, title_ru: Citroen }, model: null, number: '123', remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0.999, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 35, cellnum: '', height: 0, id: 15680, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 7, title_ru: Daewoo }, model: null, number: FYV, remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 4, cellnum: '', height: 0, id: 15741, insuredTil: -62169984000, length: 0, loadcapacity: 0.999, make: { id: 8, title_ru: DAF }, model: null, number: AA4543BA, remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 35, cellnum: '', height: 0, id: 16039, insuredTil: -62169984000, length: 0, loadcapacity: 0.999, make: { id: 8, title_ru: DAF }, model: null, number: AP4567BK, remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '380', height: 0, id: 36431, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 4, title_ru: CAMC }, model: null, number: BYA, remark: '', trailer: 34906, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 3687, insuredTil: -62169984000, length: 0, loadcapacity: 0.999, make: { id: 43, title_ru: Renault }, model: 'MAGNUM 430', number: BN2582BO, remark: '', trailer: 3709, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 8062, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 8, title_ru: DAF }, model: null, number: AA1122EE, remark: '', trailer: 8120, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 8356, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 5, title_ru: Chevrolet }, model: null, number: RR9988GG, remark: 'lights too bright', trailer: 8416, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: optionalsplitcarstyle, cartype: 31, cellnum: '', height: 0, id: 8357, insuredTil: -62169984000, length: 0.999, loadcapacity: 0.999, make: { id: 7, title_ru: Daewoo }, model: null, number: FF6767YY, remark: '', trailer: 8417, vehicleclass: null, vin: '', volume: 0.999, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 30, cellnum: '', height: 0, id: 8358, insuredTil: -62169984000, length: 0.999, loadcapacity: 0.999, make: { id: 14, title_ru: Ford }, model: null, number: AA0909AO, remark: 'nice truck', trailer: null, vehicleclass: null, vin: '', volume: 0.999, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 9820, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 11, title_ru: ERF }, model: null, number: '444', remark: '', trailer: 9704, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: optionalsplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13534, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 3, title_ru: BAW }, model: null, number: CCC, remark: ccc, trailer: 12932, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: optionalsplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13535, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 3, title_ru: BAW }, model: null, number: CCC, remark: ccc, trailer: 12932, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: optionalsplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13536, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 3, title_ru: BAW }, model: null, number: CCC, remark: ccc, trailer: 12932, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: optionalsplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13537, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 3, title_ru: BAW }, model: null, number: CCC, remark: ccc, trailer: 12932, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13538, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 6, title_ru: Citroen }, model: null, number: FYVAFY, remark: '', trailer: 12933, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13539, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 5, title_ru: Chevrolet }, model: null, number: FYAP, remark: '', trailer: 12934, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13540, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 5, title_ru: Chevrolet }, model: null, number: FYAP, remark: '', trailer: 12934, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13541, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 3, title_ru: BAW }, model: null, number: '666', remark: '', trailer: 12935, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13542, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 4, title_ru: CAMC }, model: null, number: '777', remark: '', trailer: 12936, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13543, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 4, title_ru: CAMC }, model: null, number: '777', remark: '', trailer: 12936, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13544, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 4, title_ru: CAMC }, model: null, number: '777', remark: '', trailer: 12936, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13545, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 4, title_ru: CAMC }, model: null, number: '777', remark: '', trailer: 12936, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13546, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 8, title_ru: DAF }, model: null, number: BAY, remark: '', trailer: 12937, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13555, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 3, title_ru: BAW }, model: null, number: UKPUKP, remark: '', trailer: 12941, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13558, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 5, title_ru: Chevrolet }, model: null, number: TEST, remark: '', trailer: 12944, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13559, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 5, title_ru: Chevrolet }, model: null, number: TEST, remark: '', trailer: 12944, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13572, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 8, title_ru: DAF }, model: null, number: '11221', remark: '', trailer: 12955, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13576, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 45, title_ru: Scania }, model: null, number: BK5865NB, remark: '', trailer: 12959, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '', height: 0, id: 13577, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 8, title_ru: DAF }, model: null, number: '112121', remark: '', trailer: 12960, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 14, cellnum: '', height: 0, id: 15660, insuredTil: -62169984000, length: 0, loadcapacity: 0.999, make: { id: 12, title_ru: FAW }, model: null, number: AA5748BK, remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 18, cellnum: '', height: 0, id: 15662, insuredTil: -62169984000, length: 0.999, loadcapacity: 0.999, make: { id: 14, title_ru: Ford }, model: null, number: AP3455AK, remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0.999, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 12, cellnum: '', height: 0, id: 15663, insuredTil: -62169984000, length: 0, loadcapacity: 0.999, make: { id: 16, title_ru: Foton }, model: null, number: AP3456BV, remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 10, cellnum: '', height: 0, id: 15677, insuredTil: -62169984000, length: 0.999, loadcapacity: 0, make: { id: 6, title_ru: Citroen }, model: null, number: '123', remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0.999, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 35, cellnum: '', height: 0, id: 15680, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 7, title_ru: Daewoo }, model: null, number: FYV, remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 4, cellnum: '', height: 0, id: 15741, insuredTil: -62169984000, length: 0, loadcapacity: 0.999, make: { id: 8, title_ru: DAF }, model: null, number: AA4543BA, remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: singlecarstyle, cartype: 35, cellnum: '', height: 0, id: 16039, insuredTil: -62169984000, length: 0, loadcapacity: 0.999, make: { id: 8, title_ru: DAF }, model: null, number: AP4567BK, remark: '', trailer: null, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }, { axes: 0, carstyle: forcesplitcarstyle, cartype: 35, cellnum: '380', height: 0, id: 36431, insuredTil: -62169984000, length: 0, loadcapacity: 0, make: { id: 4, title_ru: CAMC }, model: null, number: BYA, remark: '', trailer: 34906, vehicleclass: null, vin: '', volume: 0, weight: 0, width: 0 }], status: success }
        400:
          description: 'Request by shipper'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to view this data' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Request by shipper':
                  value: { message: 'You don’t have permission to view this data', relogin: false, status: error }
  '/a/v2/rest/public/driver/{driverId}':
    put:
      tags:
        - 'Fleet / Carriers'
      summary: 'Update Driver'
      description: |-
        Allow carriers to update the data of a single driver.

        The actual data is passed as an object of the request body. All body params are optional.

        *   if successful you will receive a 200 response and data will be immediately changed
        *   If unsuccessful you will receive an error explaining  
            the problem in the language you supplied with the header or the language  
            set in the app

            
        Request body params explained:

        | param | explanation | type |
        | --- | --- | --- |
        | lastname | Last name | string |
        | firstname | First name | string |
        | patronymic | Patronymic | string |
        | maincellphone | Direct phone number | string |
        | passportserial | Series of passport or ID | string |
        | passportnumber | Number of passport or ID | string |
        | passportissued | Date of issue of passport or id | string |
        | passportissuedby | Issuing entity of driver's license | string |
        | driverlicenseserial | Series of driver's license | string |
        | driverlicensenumber | Number of driver's license | string |
        | driverlicenseissued | Date of issue of passport or id | string |
        | driverlicenseissuedby | Issuing entity of driver's license | string |
        | taxid | National tax number | string |
        | inblacklist | Flag indicating that the driver is marked as irresponsible | bool |
        | car | ID of the car that relates to this driver | int |
        | birthdate | Date of birth in whatever format | string |
        | remark | A company-wide remark or comment | string |
      operationId: updateDriver
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                car:
                  nullable: true
                  example: null
                driverlicenseissued:
                  type: string
                  example: цу
                driverlicenseissuedby:
                  nullable: true
                  example: null
                driverlicensenumber:
                  nullable: true
                  example: null
                driverlicenseserial:
                  type: string
                  example: УК
                firstname:
                  type: string
                  example: 'Тест 1'
                inblacklist:
                  type: boolean
                  example: false
                lastname:
                  type: string
                  example: 'Снова 1'
                maincellphone:
                  type: string
                  example: +380637479032d
                passportissued:
                  type: string
                  example: ''
                passportissuedby:
                  type: string
                  example: ''
                passportnumber:
                  type: string
                  example: asd
                passportserial:
                  type: string
                  example: ''
                patronymic:
                  type: string
                  example: 'Водителя 1'
                taxid:
                  type: string
                  example: asd
            examples:
              'Update Driver':
                value:
                  car: null
                  driverlicenseissued: цу
                  driverlicenseissuedby: null
                  driverlicensenumber: null
                  driverlicenseserial: УК
                  firstname: 'Тест 1'
                  inblacklist: false
                  lastname: 'Снова 1'
                  maincellphone: +380637479032d
                  passportissued: ''
                  passportissuedby: ''
                  passportnumber: asd
                  passportserial: ''
                  patronymic: 'Водителя 1'
                  taxid: asd
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Driver not found'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Driver not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Driver not found':
                  value: { message: 'Driver not found', relogin: false, status: error }
    delete:
      tags:
        - 'Fleet / Carriers'
      summary: 'Delete Driver'
      description: |-
        Allow carriers to soft delete a driver.

        - if successful you will receive a 200 response and data will be immediately changed
            
        - If unsuccessful you will receive an error explaining  
            the problem in the language you supplied with the header or the language  
            set in the app
      operationId: deleteDriver
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                car:
                  nullable: true
                  example: null
                driverlicenseissued:
                  type: string
                  example: цу
                driverlicenseissuedby:
                  nullable: true
                  example: null
                driverlicensenumber:
                  nullable: true
                  example: null
                driverlicenseserial:
                  type: string
                  example: УК
                firstname:
                  type: string
                  example: 'Тест 1'
                inblacklist:
                  type: boolean
                  example: false
                lastname:
                  type: string
                  example: 'Снова 1'
                maincellphone:
                  type: string
                  example: +380637479032d
                passportissued:
                  type: string
                  example: ''
                passportissuedby:
                  type: string
                  example: ''
                passportnumber:
                  type: string
                  example: asd
                passportserial:
                  type: string
                  example: ''
                patronymic:
                  type: string
                  example: 'Водителя 1'
                taxid:
                  type: string
                  example: asd
            examples:
              'Delete Driver':
                value:
                  car: null
                  driverlicenseissued: цу
                  driverlicenseissuedby: null
                  driverlicensenumber: null
                  driverlicenseserial: УК
                  firstname: 'Тест 1'
                  inblacklist: false
                  lastname: 'Снова 1'
                  maincellphone: +380637479032d
                  passportissued: ''
                  passportissuedby: ''
                  passportnumber: asd
                  passportserial: ''
                  patronymic: 'Водителя 1'
                  taxid: asd
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Driver not found'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Driver not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Driver not found':
                  value: { message: 'Driver not found', relogin: false, status: error }
    parameters:
      -
        name: driverId
        in: path
        required: true
        schema:
          type: string
  '/a/v2/rest/public/car/{carId}':
    put:
      tags:
        - 'Fleet / Carriers'
      summary: 'Update Truck'
      description: |-
        Allow carriers to update the data of a single driver.

        The actual data is passed as an object of the request body. All body params are optional.

        *   if successful you will receive a 200 response and data will be immediately changed
        *   If unsuccessful you will receive an error explaining  
            the problem in the language you supplied with the header or the language  
            set in the app

            
        Request body params explained:

        | param | explanation | type |
        | --- | --- | --- |
        | lastname | Last name | string |
        | firstname | First name | string |
        | patronymic | Patronymic | string |
        | maincellphone | Direct phone number | string |
        | passportserial | Series of passport or ID | string |
        | passportnumber | Number of passport or ID | string |
        | passportissued | Date of issue of passport or id | string |
        | passportissuedby | Issuing entity of driver's license | string |
        | driverlicenseserial | Series of driver's license | string |
        | driverlicensenumber | Number of driver's license | string |
        | driverlicenseissued | Date of issue of passport or id | string |
        | driverlicenseissuedby | Issuing entity of driver's license | string |
        | taxid | National tax number | string |
        | inblacklist | Flag indicating that the driver is marked as irresponsible | bool |
        | car | ID of the car that relates to this driver | int |
        | birthdate | Date of birth in whatever format | string |
        | remark | A company-wide remark or comment | string |
      operationId: updateTruck
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                car:
                  nullable: true
                  example: null
                driverlicenseissued:
                  type: string
                  example: цу
                driverlicenseissuedby:
                  nullable: true
                  example: null
                driverlicensenumber:
                  nullable: true
                  example: null
                driverlicenseserial:
                  type: string
                  example: УК
                firstname:
                  type: string
                  example: 'Тест 1'
                inblacklist:
                  type: boolean
                  example: false
                lastname:
                  type: string
                  example: 'Снова 1'
                maincellphone:
                  type: string
                  example: +380637479032d
                passportissued:
                  type: string
                  example: ''
                passportissuedby:
                  type: string
                  example: ''
                passportnumber:
                  type: string
                  example: asd
                passportserial:
                  type: string
                  example: ''
                patronymic:
                  type: string
                  example: 'Водителя 1'
                taxid:
                  type: string
                  example: asd
            examples:
              'Update Truck':
                value:
                  car: null
                  driverlicenseissued: цу
                  driverlicenseissuedby: null
                  driverlicensenumber: null
                  driverlicenseserial: УК
                  firstname: 'Тест 1'
                  inblacklist: false
                  lastname: 'Снова 1'
                  maincellphone: +380637479032d
                  passportissued: ''
                  passportissuedby: ''
                  passportnumber: asd
                  passportserial: ''
                  patronymic: 'Водителя 1'
                  taxid: asd
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Driver not found'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Truck not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Driver not found':
                  value: { message: 'Truck not found', relogin: false, status: error }
    delete:
      tags:
        - 'Fleet / Carriers'
      summary: 'Delete Truck'
      description: |-
        Allow carriers to soft delete truck.

        - if successful you will receive a 200 response and data will be immediately changed
            
        - If unsuccessful you will receive an error explaining  
            the problem in the language you supplied with the header or the language  
            set in the app
      operationId: deleteTruck
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                car:
                  nullable: true
                  example: null
                driverlicenseissued:
                  type: string
                  example: цу
                driverlicenseissuedby:
                  nullable: true
                  example: null
                driverlicensenumber:
                  nullable: true
                  example: null
                driverlicenseserial:
                  type: string
                  example: УК
                firstname:
                  type: string
                  example: 'Тест 1'
                inblacklist:
                  type: boolean
                  example: false
                lastname:
                  type: string
                  example: 'Снова 1'
                maincellphone:
                  type: string
                  example: +380637479032d
                passportissued:
                  type: string
                  example: ''
                passportissuedby:
                  type: string
                  example: ''
                passportnumber:
                  type: string
                  example: asd
                passportserial:
                  type: string
                  example: ''
                patronymic:
                  type: string
                  example: 'Водителя 1'
                taxid:
                  type: string
                  example: asd
            examples:
              'Delete Truck':
                value:
                  car: null
                  driverlicenseissued: цу
                  driverlicenseissuedby: null
                  driverlicensenumber: null
                  driverlicenseserial: УК
                  firstname: 'Тест 1'
                  inblacklist: false
                  lastname: 'Снова 1'
                  maincellphone: +380637479032d
                  passportissued: ''
                  passportissuedby: ''
                  passportnumber: asd
                  passportserial: ''
                  patronymic: 'Водителя 1'
                  taxid: asd
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Driver not found'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Truck not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Driver not found':
                  value: { message: 'Truck not found', relogin: false, status: error }
    parameters:
      -
        name: carId
        in: path
        required: true
        schema:
          type: string
  '/a/v2/rest/public/trailer/{trailerId}':
    put:
      tags:
        - 'Fleet / Carriers'
      summary: 'Update Trailer'
      description: |-
        Allow carriers to update the data of a single driver.

        The actual data is passed as an object of the request body. All body params are optional.

        *   if successful you will receive a 200 response and data will be immediately changed
        *   If unsuccessful you will receive an error explaining  
            the problem in the language you supplied with the header or the language  
            set in the app

            
        Request body params explained:

        | param | explanation | type |
        | --- | --- | --- |
        | lastname | Last name | string |
        | firstname | First name | string |
        | patronymic | Patronymic | string |
        | maincellphone | Direct phone number | string |
        | passportserial | Series of passport or ID | string |
        | passportnumber | Number of passport or ID | string |
        | passportissued | Date of issue of passport or id | string |
        | passportissuedby | Issuing entity of driver's license | string |
        | driverlicenseserial | Series of driver's license | string |
        | driverlicensenumber | Number of driver's license | string |
        | driverlicenseissued | Date of issue of passport or id | string |
        | driverlicenseissuedby | Issuing entity of driver's license | string |
        | taxid | National tax number | string |
        | inblacklist | Flag indicating that the driver is marked as irresponsible | bool |
        | car | ID of the car that relates to this driver | int |
        | birthdate | Date of birth in whatever format | string |
        | remark | A company-wide remark or comment | string |
      operationId: updateTrailer
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                car:
                  nullable: true
                  example: null
                driverlicenseissued:
                  type: string
                  example: цу
                driverlicenseissuedby:
                  nullable: true
                  example: null
                driverlicensenumber:
                  nullable: true
                  example: null
                driverlicenseserial:
                  type: string
                  example: УК
                firstname:
                  type: string
                  example: 'Тест 1'
                inblacklist:
                  type: boolean
                  example: false
                lastname:
                  type: string
                  example: 'Снова 1'
                maincellphone:
                  type: string
                  example: +380637479032d
                passportissued:
                  type: string
                  example: ''
                passportissuedby:
                  type: string
                  example: ''
                passportnumber:
                  type: string
                  example: asd
                passportserial:
                  type: string
                  example: ''
                patronymic:
                  type: string
                  example: 'Водителя 1'
                taxid:
                  type: string
                  example: asd
            examples:
              'Update Trailer':
                value:
                  car: null
                  driverlicenseissued: цу
                  driverlicenseissuedby: null
                  driverlicensenumber: null
                  driverlicenseserial: УК
                  firstname: 'Тест 1'
                  inblacklist: false
                  lastname: 'Снова 1'
                  maincellphone: +380637479032d
                  passportissued: ''
                  passportissuedby: ''
                  passportnumber: asd
                  passportserial: ''
                  patronymic: 'Водителя 1'
                  taxid: asd
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Driver not found'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Авто не знайдено' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Driver not found':
                  value: { message: 'Авто не знайдено', relogin: false, status: error }
    parameters:
      -
        name: trailerId
        in: path
        required: true
        schema:
          type: string
  '/a/v2/rest/public/trailer/{driverId}':
    delete:
      tags:
        - 'Fleet / Carriers'
      summary: 'Delete Trailer'
      description: |-
        Allow carriers to soft delete a trailer.

        - if successful you will receive a 200 response and data will be immediately changed
            
        - If unsuccessful you will receive an error explaining  
            the problem in the language you supplied with the header or the language  
            set in the app
      operationId: deleteTrailer
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                car:
                  nullable: true
                  example: null
                driverlicenseissued:
                  type: string
                  example: цу
                driverlicenseissuedby:
                  nullable: true
                  example: null
                driverlicensenumber:
                  nullable: true
                  example: null
                driverlicenseserial:
                  type: string
                  example: УК
                firstname:
                  type: string
                  example: 'Тест 1'
                inblacklist:
                  type: boolean
                  example: false
                lastname:
                  type: string
                  example: 'Снова 1'
                maincellphone:
                  type: string
                  example: +380637479032d
                passportissued:
                  type: string
                  example: ''
                passportissuedby:
                  type: string
                  example: ''
                passportnumber:
                  type: string
                  example: asd
                passportserial:
                  type: string
                  example: ''
                patronymic:
                  type: string
                  example: 'Водителя 1'
                taxid:
                  type: string
                  example: asd
            examples:
              'Delete Trailer':
                value:
                  car: null
                  driverlicenseissued: цу
                  driverlicenseissuedby: null
                  driverlicensenumber: null
                  driverlicenseserial: УК
                  firstname: 'Тест 1'
                  inblacklist: false
                  lastname: 'Снова 1'
                  maincellphone: +380637479032d
                  passportissued: ''
                  passportissuedby: ''
                  passportnumber: asd
                  passportserial: ''
                  patronymic: 'Водителя 1'
                  taxid: asd
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Truck not found'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Trailer not found' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Truck not found':
                  value: { message: 'Trailer not found', relogin: false, status: error }
    parameters:
      -
        name: driverId
        in: path
        required: true
        schema:
          type: string
  /a/v2/rest/public/addVehicle:
    post:
      tags:
        - 'Fleet / Carriers'
      summary: 'Register Fleet Assets'
      description: |-
        Allows carriers to add drivers, cars and trailers and fill up the data of those entities.

        The endpoint works in 2 modes:

        1. **complex adding**: adding 3 entities at a time (driver, car and trailer) and linking them together (default mode)
            
        2. **entity specific**: adding a single entity (driver, car or trailer), is activated using a specific `only` param
            
        - if successful you will receive a 201 response and data will be immediately changed
            
        - If unsuccessful you will receive an error explaining  
            the problem in the language you supplied with the header or the language  
            set in the app

            
        `driver` object params:

        | param | required | explanation | type |
        | --- | --- | --- | --- |
        | lastname | yes | Last name | string |
        | firstname | yes | First name | string |
        | patronymic |  | Patronymic | string |
        | maincellphone | yes | Direct phone number | string (>7) |
        | passportserial |  | Series of passport or ID | string |
        | passportnumber |  | Number of passport or ID | string |
        | passportissued |  | Date of issue of passport or id | string |
        | passportissuedby |  | Issuing entity of driver's license | string |
        | driverlicenseserial | yes | Series of driver's license | string |
        | driverlicensenumber | yes | Number of driver's license | string |
        | driverlicenseissued |  | Date of issue of passport or id | YYYY-MM-DD |
        | driverlicenseissuedby |  | Issuing entity of driver's license | string |
        | demographicid |  | National demographic id | string |
        | taxid |  | National tax number | string |
        | inblacklist |  | Flag indicating that the driver is marked as irresponsible | bool |
        | car |  | ID of the car that relates to this driver | int |
        | birthdate |  | Date of birth in whatever format | string |
        | remark |  | A company-wide remark or comment | string |

        `car` object params:

        | param | required | explanation | type |
        | --- | --- | --- | --- |
        | number | yes | License plate number | string |
        | carstyle | yes | Indicates the tractor type. `forcesplitcarstyle` for tractors, `singlecarstyle` for box truck, and `optionalsplitcarstyle` for box truck with additional trailer. | enum: optionalsplitcarstyle, forcesplitcarstyle, singlecarstyle |
        | carbodytype | yes | ID of national registry truck types | int |
        | year_of_manufact | yes | Truck manufacturing year | YYYY |
        | vin | yes | VIN number | string |
        | weight |  | Truck weight in kg | float |
        | width | yes | Truck width, in m | float |
        | length | yes | Truck length in m |  |
        | height | yes | Truck height in m | float |
        | total_weight | yes | Maximum loaded truck weight, in tonns | float |
        | axes |  | Number of axes | int |
        | cellnum |  | Direct phone number in the truck | string |
        | make | yes | ID of the make of the truck | int |
        | make-new-form | yes | Duplicate of `make` | int |
        | model | yes | Model | string |
        | cartype |  | ID of the type of truck | int |
        | insuredTil |  | Insurance expiration date | YYYY-MM-DD |
        | carbase |  | ID of the base point of the truck | int |
        | gpsid |  | Internal GPS identifier for location tracking | string |
        | deadpath |  | Minimum price of dead path, in local currency | float |
        | fullpath |  | Minimum price of loaded path, in local currency | float |
        | minRoutePrice |  | Minimum price of delivery, in local currency | float |
        | vehicleclass |  | ID of internal user supplied truck category | int |
        | chargetype-N |  | N indicates the ID of the charge type. Supply separate parameter for every charge type the truck supports. Substitute N with the ID of the type. Example `chargetype-1: true, chargetype-11: true` | bool |
        | ferryproperty-N |  | N indicates the ID of the box property. Supply separate parameter for every box property the truck supports. Substitute N with the ID of the property. Example `ferryproperty-1: true, ferryproperty-11: true` | bool |
        | quantity-ferryproperty-N |  | Additional data for a box property of ID N, for example, temperature requirments. Example: `quantity-ferryproperty-11: "-5"` | string |
        | remark |  | Company-wide remark or comment about the truck. | string |

        `trailer` object params:

        | param | required | explanation | type |
        | --- | --- | --- | --- |
        | number | yes | License plate number | string |
        | loadcapacity | yes | Load capacity in tonns | float |
        | cartype | yes | ID of the trailer type | int |
        | model | yes | Model title | string |
        | make | yes | User supplied trailer make | string |
        | total_weight | yes | Maximum loaded trailer weight, in tonns | float |
        | trailerbodytype | yes | ID of national registry box type | int |
        | vin | yes | VIN number | string |
        | year_of_manufact | yes | Trailer manufacturing year | YYYY |
        | width | yes | Width in m | float |
        | height | yes | Height in m | float |
        | volume |  | Volume in cubic m | float |
        | length | yes | Length in m | float |
        | weight | yes | Trailer weight in tonns | float |
        | axes |  | Number of axes | int |
        | chargetype-1 |  | N indicates the ID of the charge type. Supply separate parameter for every charge type the truck supports. Substitute N with the ID of the type. Example `chargetype-1: true, chargetype-11: true` | bool |
        | ferryproperty-1 |  | N indicates the ID of the box property. Supply separate parameter for every box property the truck supports. Substitute N with the ID of the property. Example `ferryproperty-1: true, ferryproperty-11: true` | bool |
        | quantity-ferryproperty-N |  | Additional data for a box property of ID N, for example, temperature requirments. Example: `quantity-ferryproperty-11: "-5"` | string |
        | remark |  | Company-wide remark or comment about the truck. | string |
      operationId: registerFleetAssets
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                car:
                  type: object
                  properties: { axes: { type: string, example: '' }, carbase: { type: string, example: '' }, carstyle: { type: string, example: optionalsplitcarstyle }, cartype: { type: number, example: 1 }, cellnum: { type: string, example: '' }, chargetype-0: { type: number, example: 1 }, chargetype-1: { type: number, example: 1 }, chargetype-2: { type: number, example: 1 }, chargetype-7: { type: number, example: 1 }, craft: { type: string, example: '' }, deadpath: { type: string, example: '' }, ferryproperty-0: { type: string, example: '5' }, ferryproperty-13: { type: number, example: 1 }, ferryproperty-14: { type: number, example: 1 }, ferryproperty-7: { type: number, example: 1 }, ferryproperty-8: { type: number, example: 1 }, fullpath: { type: string, example: '' }, gpsid: { type: string, example: '' }, insuredTil: { type: string, example: '' }, make-new-form: { type: number, example: 41 }, minRoutePrice: { type: string, example: '' }, model: { type: string, example: 'Consectetur volupta' }, number: { type: number, example: 103 }, quantity-ferryproperty-13: { type: number, example: 5 }, remark: { type: string, example: '' }, vehicleclass: { type: string, example: '' }, vin: { type: string, example: '' }, weight: { type: string, example: '' } }
                driver:
                  type: object
                  properties: { birthdate: { type: string, example: '' }, driverlicenseissued: { type: string, example: 15.06.2021 }, driverlicenseissuedby: { type: string, example: 'Impedit sed nemo si' }, driverlicensenumber: { type: number, example: 590 }, driverlicenseserial: { type: string, example: 'Harum repellendus Q' }, firstname: { type: string, example: Stephanie }, lastname: { type: string, example: 'Frank 1' }, maincellphone: { type: string, example: '+12551452087' }, passportissued: { type: string, example: '' }, passportissuedby: { type: string, example: '' }, passportnumber: { type: string, example: '' }, passportserial: { type: string, example: '' }, patronymic: { type: string, example: 'Perferendis aspernat' }, remark: { type: string, example: '' }, taxid: { type: string, example: '' } }
                trailer:
                  type: object
                  properties: { axes: { type: string, example: '' }, cartype: { type: number, example: 38 }, chargetype-0: { type: string, example: '' }, chargetype-1: { type: number, example: 1 }, chargetype-2: { type: number, example: 1 }, chargetype-3: { type: number, example: 1 }, chargetype-7: { type: number, example: 1 }, ferryproperty-0: { type: string, example: '' }, ferryproperty-11: { type: number, example: 1 }, ferryproperty-5: { type: number, example: 1 }, ferryproperty-6: { type: number, example: 1 }, height: { type: string, example: '' }, length: { type: string, example: '' }, loadcapacity: { type: number, example: 50 }, model: { type: string, example: 'Numquam eu commodi u' }, number: { type: number, example: 543 }, quantity-ferryproperty-11: { type: string, example: '-4' }, remark: { type: string, example: '' }, vin: { type: string, example: '' }, volume: { type: string, example: '' }, weight: { type: string, example: '' }, width: { type: string, example: '' } }
            examples:
              'Register Fleet Assets':
                value:
                  car: { axes: '', carbase: '', carstyle: optionalsplitcarstyle, cartype: 1, cellnum: '', chargetype-0: 1, chargetype-1: 1, chargetype-2: 1, chargetype-7: 1, craft: '', deadpath: '', ferryproperty-0: '5', ferryproperty-13: 1, ferryproperty-14: 1, ferryproperty-7: 1, ferryproperty-8: 1, fullpath: '', gpsid: '', insuredTil: '', make-new-form: 41, minRoutePrice: '', model: 'Consectetur volupta', number: 103, quantity-ferryproperty-13: 5, remark: '', vehicleclass: '', vin: '', weight: '' }
                  driver: { birthdate: '', driverlicenseissued: 15.06.2021, driverlicenseissuedby: 'Impedit sed nemo si', driverlicensenumber: 590, driverlicenseserial: 'Harum repellendus Q', firstname: Stephanie, lastname: 'Frank 1', maincellphone: '+12551452087', passportissued: '', passportissuedby: '', passportnumber: '', passportserial: '', patronymic: 'Perferendis aspernat', remark: '', taxid: '' }
                  trailer: { axes: '', cartype: 38, chargetype-0: '', chargetype-1: 1, chargetype-2: 1, chargetype-3: 1, chargetype-7: 1, ferryproperty-0: '', ferryproperty-11: 1, ferryproperty-5: 1, ferryproperty-6: 1, height: '', length: '', loadcapacity: 50, model: 'Numquam eu commodi u', number: 543, quantity-ferryproperty-11: '-4', remark: '', vin: '', volume: '', weight: '', width: '' }
      responses:
        201:
          description: 'Success / Success (only driver)'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: '*'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Sat, 09 Apr 2022 13:55:54 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: 'nginx/1.18.0 (Ubuntu)'
            Strict-Transport-Security:
              schema:
                type: string
                example: max-age=31536000;
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { allowPush: { nullable: true, example: null }, birthdate: { type: string, example: -62169984000 }, car: { type: number, nullable: true, example: 39196 }, car_relation: { type: object, properties: { ImeiInviteAndroid: { nullable: true, example: null }, available: { nullable: true, example: null }, availabledatetime: { nullable: true, example: null }, availablenextroute: { type: number, example: 0 }, availableregion: { nullable: true, example: null }, availabletown: { nullable: true, example: null }, axes: { type: number, example: 0 }, body_type: { type: number, example: 1 }, bookedNextRouteStatus: { type: number, example: 0 }, car_id_1C: { nullable: true, example: null }, carbase: { nullable: true, example: null }, carmodel_id_1C: { nullable: true, example: null }, carstyle: { type: string, example: optionalsplitcarstyle }, cartype: { type: number, example: 1 }, cellnum: { type: string, example: '' }, client: { type: number, example: 180 }, consumptionempty: { type: string, example: '0.000' }, consumptiongt10lte15: { type: string, example: '0.000' }, consumptiongt15lte20: { type: string, example: '0.000' }, consumptiongt20: { type: string, example: '0.000' }, consumptiongt5lte10: { type: string, example: '0.000' }, consumptionlte5: { type: string, example: '0.000' }, craft: { type: string, example: '' }, currentrouteperiodic: { type: string, example: '' }, dateAcceptInviteAndroid: { type: string, example: -62169984000 }, dateInviteAndroid: { type: string, example: -62169984000 }, deadpath: { type: string, example: '0.00' }, deleted: { type: number, example: 0 }, driver: { nullable: true, example: null }, expeditorClient: { nullable: true, example: null }, expense10descr: { type: string, example: '' }, expense10sum: { type: string, example: '0.00' }, expense1descr: { type: string, example: '' }, expense1sum: { type: string, example: '0.00' }, expense2descr: { type: string, example: '' }, expense2sum: { type: string, example: '0.00' }, expense3descr: { type: string, example: '' }, expense3sum: { type: string, example: '0.00' }, expense4descr: { type: string, example: '' }, expense4sum: { type: string, example: '0.00' }, expense5descr: { type: string, example: '' }, expense5sum: { type: string, example: '0.00' }, expense6descr: { type: string, example: '' }, expense6sum: { type: string, example: '0.00' }, expense7descr: { type: string, example: '' }, expense7sum: { type: string, example: '0.00' }, expense8descr: { type: string, example: '' }, expense8sum: { type: string, example: '0.00' }, expense9descr: { type: string, example: '' }, expense9sum: { type: string, example: '0.00' }, factclient: { nullable: true, example: null }, forbidedit: { type: number, example: 0 }, fullpath: { type: string, example: '0.00' }, gpsid: { nullable: true, example: null }, gpsprovider: { type: number, example: 0 }, gpsstatus: { type: string, example: '' }, height: { type: string, example: '5.000' }, id: { type: number, example: 39196 }, idhash: { type: string, example: e6659b3056627af11246faa24c164e5a }, insuredTil: { type: string, example: -62169984000 }, latit: { type: string, example: '0.000000000000000' }, length: { type: string, example: '20.000' }, loadcapacity: { type: string, example: '0.000' }, longit: { type: string, example: '0.000000000000000' }, make: { type: number, example: 41 }, minrouteprice: { type: string, example: '0.00' }, model: { type: string, example: 'Consectetur volupta' }, nextrouteid: { nullable: true, example: null }, number: { type: string, example: AA1033BB }, ratify: { type: number, example: 1 }, remark: { type: string, example: '' }, seenbyadmin: { type: number, example: 0 }, telnum: { type: string, example: '' }, total_weight: { type: string, example: '20.000' }, trailer: { type: number, example: 37347 }, trailer_relation: { type: object, properties: { axes: { type: number, example: 0 }, body_type: { type: number, example: 1 }, cartype: { type: number, example: 38 }, client: { type: number, example: 180 }, deleted: { type: number, example: 0 }, forbidedit: { type: number, example: 0 }, height: { type: string, example: '5.000' }, id: { type: number, example: 37347 }, insuredTil: { type: string, example: -62169984000 }, length: { type: string, example: '20.000' }, loadcapacity: { type: string, example: '50.000' }, make: { type: string, example: '1' }, model: { type: string, example: 'Numquam eu commodi u' }, number: { type: string, example: '543' }, ratify: { type: number, example: 1 }, remark: { type: string, example: '' }, seenbyadmin: { type: number, example: 0 }, total_weight: { type: string, example: '12.000' }, trailer_id_1C: { nullable: true, example: null }, trailermodel_id_1C: { nullable: true, example: null }, vin: { type: string, example: '09876890' }, volume: { type: string, example: '0.000' }, weight: { type: string, example: '0.000' }, width: { type: string, example: '4.000' }, year_of_manufact: { type: number, example: 2000 } } }, userInviteAndroid: { nullable: true, example: null }, vehicleclass: { nullable: true, example: null }, vin: { type: string, example: '123123' }, volume: { type: string, example: '0.000' }, weight: { type: string, example: '0.000' }, width: { type: string, example: '4.000' }, year_of_manufact: { type: number, example: 2000 } }, nullable: true }, client: { type: number, example: 180 }, contactinfo: { type: string, example: '' }, deleted: { type: number, example: 0 }, driver_id_1C: { nullable: true, example: null }, driverlicenseissued: { type: string, example: 1620172800 }, driverlicenseissuedby: { type: string, example: 'Impedit sed nemo si' }, driverlicensenumber: { type: string, example: '590' }, driverlicenseserial: { type: string, example: 'Harum repellendus Q' }, firstname: { type: string, example: Stephanie }, forbidedit: { type: number, example: 0 }, hired: { type: number, example: 0 }, id: { type: number, example: 37033 }, inblacklist: { nullable: true, example: null }, invitationdetails: { nullable: true, example: null }, invitationstatus: { nullable: true, example: null }, language: { nullable: true, example: null }, lastname: { type: string, example: 'Frank 1' }, maincellphone: { type: string, example: '+380501112233' }, passportissued: { type: string, example: '' }, passportissuedby: { type: string, example: '' }, passportnumber: { type: string, example: '' }, passportserial: { type: string, example: '' }, patronymic: { type: string, example: '' }, ratify: { type: number, example: 1 }, seenbyadmin: { type: number, example: 0 }, taxid: { type: string, example: '' }, vacant: { type: number, example: 0 } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { allowPush: null, birthdate: -62169984000, car: 39196, car_relation: { ImeiInviteAndroid: null, available: null, availabledatetime: null, availablenextroute: 0, availableregion: null, availabletown: null, axes: 0, body_type: 1, bookedNextRouteStatus: 0, car_id_1C: null, carbase: null, carmodel_id_1C: null, carstyle: optionalsplitcarstyle, cartype: 1, cellnum: '', client: 180, consumptionempty: '0.000', consumptiongt10lte15: '0.000', consumptiongt15lte20: '0.000', consumptiongt20: '0.000', consumptiongt5lte10: '0.000', consumptionlte5: '0.000', craft: '', currentrouteperiodic: '', dateAcceptInviteAndroid: -62169984000, dateInviteAndroid: -62169984000, deadpath: '0.00', deleted: 0, driver: null, expeditorClient: null, expense10descr: '', expense10sum: '0.00', expense1descr: '', expense1sum: '0.00', expense2descr: '', expense2sum: '0.00', expense3descr: '', expense3sum: '0.00', expense4descr: '', expense4sum: '0.00', expense5descr: '', expense5sum: '0.00', expense6descr: '', expense6sum: '0.00', expense7descr: '', expense7sum: '0.00', expense8descr: '', expense8sum: '0.00', expense9descr: '', expense9sum: '0.00', factclient: null, forbidedit: 0, fullpath: '0.00', gpsid: null, gpsprovider: 0, gpsstatus: '', height: '5.000', id: 39196, idhash: e6659b3056627af11246faa24c164e5a, insuredTil: -62169984000, latit: '0.000000000000000', length: '20.000', loadcapacity: '0.000', longit: '0.000000000000000', make: 41, minrouteprice: '0.00', model: 'Consectetur volupta', nextrouteid: null, number: AA1033BB, ratify: 1, remark: '', seenbyadmin: 0, telnum: '', total_weight: '20.000', trailer: 37347, trailer_relation: { axes: 0, body_type: 1, cartype: 38, client: 180, deleted: 0, forbidedit: 0, height: '5.000', id: 37347, insuredTil: -62169984000, length: '20.000', loadcapacity: '50.000', make: '1', model: 'Numquam eu commodi u', number: '543', ratify: 1, remark: '', seenbyadmin: 0, total_weight: '12.000', trailer_id_1C: null, trailermodel_id_1C: null, vin: '09876890', volume: '0.000', weight: '0.000', width: '4.000', year_of_manufact: 2000 }, userInviteAndroid: null, vehicleclass: null, vin: '123123', volume: '0.000', weight: '0.000', width: '4.000', year_of_manufact: 2000 }, client: 180, contactinfo: '', deleted: 0, driver_id_1C: null, driverlicenseissued: 1620172800, driverlicenseissuedby: 'Impedit sed nemo si', driverlicensenumber: '590', driverlicenseserial: 'Harum repellendus Q', firstname: Stephanie, forbidedit: 0, hired: 0, id: 37033, inblacklist: null, invitationdetails: null, invitationstatus: null, language: null, lastname: 'Frank 1', maincellphone: '+380501112233', passportissued: '', passportissuedby: '', passportnumber: '', passportserial: '', patronymic: '', ratify: 1, seenbyadmin: 0, taxid: '', vacant: 0 }, status: success }
                'Success (only driver)':
                  value: { data: { allowPush: null, birthdate: -62169984000, car: null, car_relation: null, client: 180, contactinfo: '', deleted: 0, driver_id_1C: null, driverlicenseissued: 1623715200, driverlicenseissuedby: 'Impedit sed nemo si', driverlicensenumber: '590', driverlicenseserial: 'Harum repellendus Q', firstname: Stephanie, forbidedit: 0, hired: 0, id: 37031, inblacklist: null, invitationdetails: null, invitationstatus: null, language: null, lastname: 'Frank 1', maincellphone: '+12551452087', passportissued: '', passportissuedby: '', passportnumber: '', passportserial: '', patronymic: 'Perferendis aspernat', ratify: 1, seenbyadmin: 0, taxid: '', vacant: 0 }, status: success }
        400:
          description: 'Request by shipper / Incorrect "only" param / Missing required params'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Invalid action' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Incorrect "only" param':
                  value: { message: 'Wrong param only', relogin: false, status: error }
                'Missing required params':
                  value: { message: 'Required fields missing', relogin: false, status: error }
                'Request by shipper':
                  value: { message: 'Invalid action', relogin: false, status: error }
  /a/v2/rest/public/addVehicleClass:
    post:
      tags:
        - 'Fleet / Carriers'
      summary: 'Create Fleet Group'
      description: 'Create Fleet Group'
      operationId: createFleetGroup
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                vehicleclass:
                  type: string
                  example: test2
            examples:
              'Create Fleet Group':
                value:
                  vehicleclass: test2
      responses:
        200:
          description: ''
  /a/v2/rest/public/getVehicleClasses:
    get:
      tags:
        - 'Fleet / Carriers'
      summary: 'Get Fleet Groups'
      description: |-
        Returns all vehicle classes of current user company that are set in the app in the settings section. Classes help you to segment your fleet

        - if successful you will receive your vehicle classes

        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getFleetGroups
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { id: { type: number, example: 63 }, title: { type: string, example: DesertEagle } } }, example: [{ id: 63, title: DesertEagle }, { id: 62, title: Mustang }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ id: 63, title: DesertEagle }, { id: 62, title: Mustang }], status: success }
        400:
          description: 'Operation is not available (request by shipper)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Invalid action' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Operation is not available (request by shipper)':
                  value: { message: 'Invalid action', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/addCarbase:
    post:
      tags:
        - 'Fleet / Carriers'
      summary: 'Create Home Depot'
      description: 'Create Home Depot'
      operationId: createHomeDepot
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                address:
                  type: string
                  example: 'Hürriyet, 48439 Sk, 33000 Mezitli/Mersin'
                carbase:
                  type: string
                  example: Test
            examples:
              'Create Home Depot':
                value:
                  address: 'Hürriyet, 48439 Sk, 33000 Mezitli/Mersin'
                  carbase: Test
      responses:
        200:
          description: ''
  /a/v2/rest/public/getVehicleBases:
    get:
      tags:
        - 'Fleet / Carriers'
      summary: 'Get Home Depots'
      description: |-
        Returns all vehicle bases of current user company that are set in the app in the settings section.

        - if successful you will receive your vehicle classes
            
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getHomeDepots
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
        400:
          description: 'Operation is not available (request by shipper)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Invalid action' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Operation is not available (request by shipper)':
                  value: { message: 'Invalid action', relogin: false, status: error }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/addGenericDocument:
    post:
      tags:
        - 'Account / Company Profile'
      summary: 'Upload Document'
      description: |-
        Allows carriers to add documents to the fleet entitities. Details of the allowed filetypes and size can be found in the endpoint GET getFileUploadRequirements (located in Aux folder of this documentation).

        No more than 5 files can be uploaded in a single request.
      operationId: uploadDocument1
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                'documents[]':
                  type: string
                  format: binary
                entity:
                  type: string
                  example: company
                entityid:
                  type: string
                  example: hash
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Thu, 16 Mar 2023 13:12:26 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { documents: { type: object, properties: { 0-02-0a-4f9bdbbac9084f6a3e726f30462e500aaf2ae740f4d8aa924e9e7a05d08e841d_2709ed6caa8.jpg: { type: object, properties: { size: { type: string, example: '250493' }, url: { type: string, example: 'https://test.phleetto.co.uk/uploads/Phleetto-route-43759-43a4af-0-02-0a-4f9bdbbac9084f6a3e726f30462e500aaf2ae740f4d8aa924e9e7a05d08e841d_2709ed6caa8.jpg' } } }, '856 (1).pdf': { type: object, properties: { size: { type: string, example: '189441' }, url: { type: string, example: 'https://test.phleetto.co.uk/uploads/Phleetto-route-71884-3dcba3-856 (1).pdf' } } } } }, route: { type: string, example: 32676307200 } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { documents: { 0-02-0a-4f9bdbbac9084f6a3e726f30462e500aaf2ae740f4d8aa924e9e7a05d08e841d_2709ed6caa8.jpg: { size: '250493', url: 'https://test.phleetto.co.uk/uploads/Phleetto-route-43759-43a4af-0-02-0a-4f9bdbbac9084f6a3e726f30462e500aaf2ae740f4d8aa924e9e7a05d08e841d_2709ed6caa8.jpg' }, '856 (1).pdf': { size: '189441', url: 'https://test.phleetto.co.uk/uploads/Phleetto-route-71884-3dcba3-856 (1).pdf' } }, route: 32676307200 }, status: success }
        400:
          description: 'Invalid file type passed / Supplied file is infected / Too many documents supplied / Supplied document is too big'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Thu, 16 Mar 2023 13:19:42 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.23.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Cet134_assessment1_starter.zip document is not one of jpg, jpeg, png, bmp, gif, tif, pdf, doc, docx, xls, xlsx (zip passed). Cannot proceed.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid file type passed':
                  value: { message: 'Cet134_assessment1_starter.zip document is not one of jpg, jpeg, png, bmp, gif, tif, pdf, doc, docx, xls, xlsx (zip passed). Cannot proceed.', relogin: false, status: error }
                'Supplied document is too big':
                  value: { message: 'Ticket_4995937.pdf document is too big (9221KB). Must be less than 8MB. Cannot proceed.', relogin: false, status: error }
                'Supplied file is infected':
                  value: { message: 'CheckAbilityToRefuseRouteByOperatorCest.refuseFromRoute.fail.png document is infected. Cannot proceed.', relogin: false, status: error }
                'Too many documents supplied':
                  value: { message: 'No more than 5 documents are allowed (6 supplied). Cannot proceed.', relogin: false, status: error }
  /a/v2/rest/public/document/:
    delete:
      tags:
        - 'Fleet / Carriers'
      summary: 'Delete Documents'
      description: |-
        Allow carriers to soft delete a trailer.

        - if successful you will receive a 200 response and data will be immediately changed
            
        - If unsuccessful you will receive an error explaining  
            the problem in the language you supplied with the header or the language  
            set in the app
      operationId: deleteDocuments
      parameters:
        -
          name: documentids
          in: query
          schema:
            type: string
            example: '12663,12664'
          description: 'Int. Required.'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                birthdate:
                  type: string
                  example: ''
                car:
                  nullable: true
                  example: null
                driverlicenseissued:
                  type: string
                  example: цу
                driverlicenseissuedby:
                  nullable: true
                  example: null
                driverlicensenumber:
                  nullable: true
                  example: null
                driverlicenseserial:
                  type: string
                  example: УК
                firstname:
                  type: string
                  example: 'Тест 1'
                inblacklist:
                  type: boolean
                  example: false
                lastname:
                  type: string
                  example: 'Снова 1'
                maincellphone:
                  type: string
                  example: +380637479032d
                passportissued:
                  type: string
                  example: ''
                passportissuedby:
                  type: string
                  example: ''
                passportnumber:
                  type: string
                  example: asd
                passportserial:
                  type: string
                  example: ''
                patronymic:
                  type: string
                  example: 'Водителя 1'
                remark:
                  type: string
                  example: ''
                taxid:
                  type: string
                  example: asd
            examples:
              'Delete Documents':
                value: ''
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: [], example: [] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [], status: success }
        400:
          description: 'Not allowed'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, PUT, DELETE, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Thu, 11 Sep 2025 08:15:50 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.27.3
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
            X-Xdebug-Profile-Filename:
              schema:
                type: string
                example: /var/tmp/cachegrind.out.6674
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'You don’t have permission to delete one or more of the provided documents.' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Not allowed':
                  value: { message: 'You don’t have permission to delete one or more of the provided documents.', relogin: false, status: error }
  /a/v2/rest/public/getCartype:
    get:
      tags:
        - 'Fleet / Reference Data'
      summary: 'Get Vehicle Types'
      description: |-
        Returns the list of  truck or trailer types available in the app.

        - if successful you will receive all truck or trailer types available in the app
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getVehicleTypes
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: []
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: 'https://mobile-sandbox.phleetto.uk'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: 'Thu, 04 Jan 2024 11:38:21 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: nginx/1.25.1
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Accept-Encoding
            X-Powered-By:
              schema:
                type: string
                example: PHP/7.3.33
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { id: { type: string, example: '6' }, title: { type: string, example: 'bus (passenger + freight)' } } }, example: [{ id: '6', title: 'bus (passenger + freight)' }, { id: '7', title: 'luxury coach' }, { id: '8', title: 'car transporter' }, { id: '9', title: 'mobile crane' }, { id: '10', title: 'fuel tanker' }, { id: '11', title: 'bitumen tanker' }, { id: '12', title: flatbed }, { id: '48', title: 'light van (Gazelle-type)' }, { id: '56', title: 'dual-zone refrigerated trailer' }, { id: '13', title: 'grain truck' }, { id: '14', title: 'isothermal box' }, { id: '15', title: container }, { id: '16', title: 'container carrier' }, { id: '2', title: 'box / enclosed' }, { id: '54', title: 'low-loader trailer (bed trailer)' }, { id: '18', title: 'timber truck' }, { id: '19', title: any }, { id: '21', title: 'furniture van' }, { id: '22', title: minibus }, { id: '49', title: 'cargo van' }, { id: '23', title: 'flour tanker' }, { id: '24', title: 'oversize / abnormal load' }, { id: '25', title: open }, { id: '26', title: 'panel carrier' }, { id: '27', title: platform }, { id: '50', title: 'trailer with hydraulic tail lift' }, { id: '53', title: 'poultry truck' }, { id: '5', title: 'refrigerated (reefer)' }, { id: '29', title: tipper }, { id: '30', title: 'livestock truck' }, { id: '31', title: 'special purpose vehicle' }, { id: '47', title: 'glass carrier' }, { id: '1', title: 'curtain sider' }, { id: '33', title: 'low-loader (step-frame)' }, { id: '34', title: 'pipe carrier' }, { id: '35', title: 'tractor unit' }, { id: '4', title: 'box van (all-metal)' }, { id: '37', title: 'plastic-bodied van' }, { id: '38', title: 'cement tanker' }, { id: '46', title: 'gas tanker' }, { id: '39', title: 'food-grade tanker' }, { id: '51', title: 'steam-jacketed tanker' }, { id: '40', title: 'chemical tanker' }, { id: '45', title: tipper }, { id: '41', title: 'recovery truck' }, { id: '42', title: excavator }, { id: '52', title: 'boat / yacht transporter' }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ id: '6', title: 'bus (passenger + freight)' }, { id: '7', title: 'luxury coach' }, { id: '8', title: 'car transporter' }, { id: '9', title: 'mobile crane' }, { id: '10', title: 'fuel tanker' }, { id: '11', title: 'bitumen tanker' }, { id: '12', title: flatbed }, { id: '48', title: 'light van (Gazelle-type)' }, { id: '56', title: 'dual-zone refrigerated trailer' }, { id: '13', title: 'grain truck' }, { id: '14', title: 'isothermal box' }, { id: '15', title: container }, { id: '16', title: 'container carrier' }, { id: '2', title: 'box / enclosed' }, { id: '54', title: 'low-loader trailer (bed trailer)' }, { id: '18', title: 'timber truck' }, { id: '19', title: any }, { id: '21', title: 'furniture van' }, { id: '22', title: minibus }, { id: '49', title: 'cargo van' }, { id: '23', title: 'flour tanker' }, { id: '24', title: 'oversize / abnormal load' }, { id: '25', title: open }, { id: '26', title: 'panel carrier' }, { id: '27', title: platform }, { id: '50', title: 'trailer with hydraulic tail lift' }, { id: '53', title: 'poultry truck' }, { id: '5', title: 'refrigerated (reefer)' }, { id: '29', title: tipper }, { id: '30', title: 'livestock truck' }, { id: '31', title: 'special purpose vehicle' }, { id: '47', title: 'glass carrier' }, { id: '1', title: 'curtain sider' }, { id: '33', title: 'low-loader (step-frame)' }, { id: '34', title: 'pipe carrier' }, { id: '35', title: 'tractor unit' }, { id: '4', title: 'box van (all-metal)' }, { id: '37', title: 'plastic-bodied van' }, { id: '38', title: 'cement tanker' }, { id: '46', title: 'gas tanker' }, { id: '39', title: 'food-grade tanker' }, { id: '51', title: 'steam-jacketed tanker' }, { id: '40', title: 'chemical tanker' }, { id: '45', title: tipper }, { id: '41', title: 'recovery truck' }, { id: '42', title: excavator }, { id: '52', title: 'boat / yacht transporter' }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getCarMake:
    get:
      tags:
        - 'Fleet / Reference Data'
      summary: 'Get Vehicle Manufacturers'
      description: |-
        Returns the list of truck/trailer manufacturing companies available in the app.

        - if successful you will receive all truck/trailer manufacturing companies available in the app
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getVehicleManufacturers
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { id: { type: number, example: 1 }, title: { type: string, example: Avia } } }, example: [{ id: 1, title: Avia }, { id: 2, title: Barkas }, { id: 3, title: BAW }, { id: 4, title: CAMC }, { id: 5, title: Chevrolet }, { id: 6, title: Citroen }, { id: 7, title: Daewoo }, { id: 8, title: DAF }, { id: 9, title: Dongfeng }, { id: 10, title: Eagle }, { id: 11, title: ERF }, { id: 12, title: FAW }, { id: 13, title: Fiat }, { id: 14, title: Ford }, { id: 15, title: Forland }, { id: 16, title: Foton }, { id: 17, title: Freightliner }, { id: 18, title: GMC }, { id: 19, title: Groz }, { id: 20, title: Hino }, { id: 21, title: Howo }, { id: 22, title: Hyundai }, { id: 23, title: IFA }, { id: 24, title: International }, { id: 25, title: Isuzu }, { id: 26, title: Iveco }, { id: 27, title: JAC }, { id: 28, title: Kenworth }, { id: 29, title: KIA }, { id: 30, title: LDV }, { id: 31, title: LIAZ }, { id: 32, title: Mack }, { id: 33, title: Magnum }, { id: 34, title: MAN }, { id: 35, title: Mazda }, { id: 36, title: Mercedes-Benz }, { id: 37, title: Mitsubishi }, { id: 38, title: Mudan }, { id: 39, title: Nissan }, { id: 40, title: Opel }, { id: 67, title: Peterbilt }, { id: 41, title: Peugeot }, { id: 42, title: Praga }, { id: 43, title: Renault }, { id: 44, title: Robur }, { id: 45, title: Scania }, { id: 71, title: Skoda }, { id: 72, title: Sterling }, { id: 46, title: Steyr }, { id: 47, title: Tata }, { id: 48, title: Tatra }, { id: 49, title: Toyota }, { id: 50, title: Volkswagen }, { id: 51, title: Volvo }, { id: 66, title: 'Western Star' }, { id: 52, title: Yuejin }, { id: 53, title: Zuk }, { id: 69, title: Алтай }, { id: 54, title: БЕЛАЗ }, { id: 74, title: Бычок }, { id: 55, title: ГАЗ }, { id: 73, title: Газель }, { id: 56, title: ЗАЗ }, { id: 57, title: ЗИЛ }, { id: 58, title: ЗИС }, { id: 60, title: КАЗ }, { id: 59, title: КамАЗ }, { id: 61, title: КРАЗ }, { id: 62, title: МАЗ }, { id: 63, title: РАФ }, { id: 64, title: УАЗ }, { id: 65, title: УРАЛ }, { id: 70, title: Шаанхи }, { id: 68, title: Шеньци }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ id: 1, title: Avia }, { id: 2, title: Barkas }, { id: 3, title: BAW }, { id: 4, title: CAMC }, { id: 5, title: Chevrolet }, { id: 6, title: Citroen }, { id: 7, title: Daewoo }, { id: 8, title: DAF }, { id: 9, title: Dongfeng }, { id: 10, title: Eagle }, { id: 11, title: ERF }, { id: 12, title: FAW }, { id: 13, title: Fiat }, { id: 14, title: Ford }, { id: 15, title: Forland }, { id: 16, title: Foton }, { id: 17, title: Freightliner }, { id: 18, title: GMC }, { id: 19, title: Groz }, { id: 20, title: Hino }, { id: 21, title: Howo }, { id: 22, title: Hyundai }, { id: 23, title: IFA }, { id: 24, title: International }, { id: 25, title: Isuzu }, { id: 26, title: Iveco }, { id: 27, title: JAC }, { id: 28, title: Kenworth }, { id: 29, title: KIA }, { id: 30, title: LDV }, { id: 31, title: LIAZ }, { id: 32, title: Mack }, { id: 33, title: Magnum }, { id: 34, title: MAN }, { id: 35, title: Mazda }, { id: 36, title: Mercedes-Benz }, { id: 37, title: Mitsubishi }, { id: 38, title: Mudan }, { id: 39, title: Nissan }, { id: 40, title: Opel }, { id: 67, title: Peterbilt }, { id: 41, title: Peugeot }, { id: 42, title: Praga }, { id: 43, title: Renault }, { id: 44, title: Robur }, { id: 45, title: Scania }, { id: 71, title: Skoda }, { id: 72, title: Sterling }, { id: 46, title: Steyr }, { id: 47, title: Tata }, { id: 48, title: Tatra }, { id: 49, title: Toyota }, { id: 50, title: Volkswagen }, { id: 51, title: Volvo }, { id: 66, title: 'Western Star' }, { id: 52, title: Yuejin }, { id: 53, title: Zuk }, { id: 69, title: Алтай }, { id: 54, title: БЕЛАЗ }, { id: 74, title: Бычок }, { id: 55, title: ГАЗ }, { id: 73, title: Газель }, { id: 56, title: ЗАЗ }, { id: 57, title: ЗИЛ }, { id: 58, title: ЗИС }, { id: 60, title: КАЗ }, { id: 59, title: КамАЗ }, { id: 61, title: КРАЗ }, { id: 62, title: МАЗ }, { id: 63, title: РАФ }, { id: 64, title: УАЗ }, { id: 65, title: УРАЛ }, { id: 70, title: Шаанхи }, { id: 68, title: Шеньци }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/paymentRequestPotentialRoutes:
    get:
      tags:
        - 'Partners / Payment Requests'
      summary: 'Get Eligible Routes for Payment Request'
      description: 'Get Eligible Routes for Payment Request'
      operationId: getEligibleRoutesForPaymentRequest
      parameters:
        -
          name: client
          in: query
          schema:
            type: string
            example: clienthash
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/paymentRequestCreate:
    post:
      tags:
        - 'Partners / Payment Requests'
      summary: 'Create Payment Request'
      description: 'Create Payment Request'
      operationId: createPaymentRequest
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client:
                  type: string
                  example: '{{clienthash}}'
                routes:
                  type: array
                  items: { type: string, example: 111-04-15 }
                  example: [111-04-15, 222-04-15, 333-04-15]
                title:
                  type: string
                  example: '1'
            examples:
              'Create Payment Request':
                value:
                  client: '{{clienthash}}'
                  routes: [111-04-15, 222-04-15, 333-04-15]
                  title: '1'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getPaymentRequests:
    get:
      tags:
        - 'Partners / Payment Requests'
      summary: 'Get Payment Request Summaries'
      description: |-
        This endpoint retrieves a list of payment requests along with their details. Clients must provide an authorization token and a language header to access this endpoint. The response includes the status of the request and an array of payment request objects with detailed routing information.

        **Field Descriptions:**

        *   **status**: Indicates the success of the API call.
        *   **data**: An array of payment request objects.
            *   **number**: Unique identifier of the payment request.
            *   **state**: Current state of the payment request (e.g., new, paid, declined, ratified).
            *   **moment**: Timestamp of the payment request.
            *   **uuid**: Unique identifier for the request.
            *   **sum**: Total amount requested.
            *   **issuer**: Entity issuing the payment request.
            *   **routes**: Array of route objects associated with the payment request.
                *   **apicode**: Code associated with the API.
                *   **budget**: Budget allocated for the route.
                *   **hash**: Hash value for the route.
      operationId: getPaymentRequestSummaries
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { issuer: { type: string, example: provider }, moment: { type: string, example: 1700246452 }, number: { type: string, example: asodmasdasd }, routes: { type: array, items: { type: object, properties: { apicode: { type: string, example: test-api }, budget: { type: number, example: 2650 }, hash: { type: string, example: 00e22611bcaf7f64d97a75aa8d074f99 } } }, example: [{ apicode: test-api, budget: 2650, hash: 00e22611bcaf7f64d97a75aa8d074f99 }, { apicode: '0.9670328488266401', budget: 6000, hash: 350689b31d5f009b3ba341945cb12d81 }, { apicode: '0.6557187891152862', budget: 5000, hash: b3671908c16817aee16697e5049c89f1 }, { apicode: '0.001982429066656557', budget: 5000, hash: 8392c5d2d73ca8e66e11e6d20bf5ac3b }, { apicode: '0.947122911873388', budget: 5000, hash: d193a5ec8e8d27023e3c95f695c5373f }, { apicode: '0.7163089632208542', budget: 5000, hash: 35c643e29439c52502bf41e08d0b9efa }, { apicode: '0.23221729996820661', budget: 5000, hash: 4a1db079f0e123bfa3f86822e6d149de }, { apicode: '', budget: 0, hash: 83aad578d4e5a8294ef6a32d84ae46ba }, { apicode: '0.17621022479255705', budget: 5000, hash: af54562917dc5d00bf6ad1fd38e96f15 }, { apicode: '0.8608113144159423', budget: 13454, hash: 486ab2ad90f2632de1372ccd6c8fa628 }, { apicode: '0.10723068202587839', budget: 7548, hash: e06d41cdd713c62ee3b6cb2dbd5742a2 }, { apicode: '', budget: 7841, hash: c5eccbf76ae05674a4b673f35050621d }, { apicode: '123', budget: 5000, hash: 87f583c8dcc6952d09523e94c8f10f77 }, { apicode: '0.08158724948911672', budget: 5000, hash: d3b7854c2948696b34b71c4aa32b12da }, { apicode: '0.01728116256862987', budget: 5000, hash: c7dd120ba457b7455df640826e5464fa }, { apicode: asdasda, budget: 2650, hash: 7f133b2a86715674a6455989d2e5058f }, { apicode: 1a12f2209281e1c, budget: 25000, hash: 389efc1d5aa91fe6c955c5a0f1de5927 }, { apicode: ол, budget: 297000, hash: c0ece27c0b0e995058f9252f201b2b7a }, { apicode: фи, budget: 600, hash: 577db620755b70be0f088e510846ba15 }, { apicode: unique-external-id-11212, budget: 0, hash: 191e84a2c4555141928da10a0bb015fd }, { apicode: фивфив, budget: 5000, hash: 2a667ad3e1cabf5c99ab8b29f58ad5d8 }, { apicode: asd, budget: 1000, hash: d0d3df54657663b6683ea0cf8cc84cd1 }] }, state: { type: string, example: new }, sum: { type: string, example: '413743.00' }, uuid: { type: string, example: 302ebf7c-8568-11ee-ab72-1eee848349a0 } } }, example: [{ issuer: provider, moment: 1700246452, number: asodmasdasd, routes: [{ apicode: test-api, budget: 2650, hash: 00e22611bcaf7f64d97a75aa8d074f99 }, { apicode: '0.9670328488266401', budget: 6000, hash: 350689b31d5f009b3ba341945cb12d81 }, { apicode: '0.6557187891152862', budget: 5000, hash: b3671908c16817aee16697e5049c89f1 }, { apicode: '0.001982429066656557', budget: 5000, hash: 8392c5d2d73ca8e66e11e6d20bf5ac3b }, { apicode: '0.947122911873388', budget: 5000, hash: d193a5ec8e8d27023e3c95f695c5373f }, { apicode: '0.7163089632208542', budget: 5000, hash: 35c643e29439c52502bf41e08d0b9efa }, { apicode: '0.23221729996820661', budget: 5000, hash: 4a1db079f0e123bfa3f86822e6d149de }, { apicode: '', budget: 0, hash: 83aad578d4e5a8294ef6a32d84ae46ba }, { apicode: '0.17621022479255705', budget: 5000, hash: af54562917dc5d00bf6ad1fd38e96f15 }, { apicode: '0.8608113144159423', budget: 13454, hash: 486ab2ad90f2632de1372ccd6c8fa628 }, { apicode: '0.10723068202587839', budget: 7548, hash: e06d41cdd713c62ee3b6cb2dbd5742a2 }, { apicode: '', budget: 7841, hash: c5eccbf76ae05674a4b673f35050621d }, { apicode: '123', budget: 5000, hash: 87f583c8dcc6952d09523e94c8f10f77 }, { apicode: '0.08158724948911672', budget: 5000, hash: d3b7854c2948696b34b71c4aa32b12da }, { apicode: '0.01728116256862987', budget: 5000, hash: c7dd120ba457b7455df640826e5464fa }, { apicode: asdasda, budget: 2650, hash: 7f133b2a86715674a6455989d2e5058f }, { apicode: 1a12f2209281e1c, budget: 25000, hash: 389efc1d5aa91fe6c955c5a0f1de5927 }, { apicode: ол, budget: 297000, hash: c0ece27c0b0e995058f9252f201b2b7a }, { apicode: фи, budget: 600, hash: 577db620755b70be0f088e510846ba15 }, { apicode: unique-external-id-11212, budget: 0, hash: 191e84a2c4555141928da10a0bb015fd }, { apicode: фивфив, budget: 5000, hash: 2a667ad3e1cabf5c99ab8b29f58ad5d8 }, { apicode: asd, budget: 1000, hash: d0d3df54657663b6683ea0cf8cc84cd1 }], state: new, sum: '413743.00', uuid: 302ebf7c-8568-11ee-ab72-1eee848349a0 }, { issuer: provider, moment: 1700503396, number: 11kjhgasad4553, routes: [{ apicode: '456372', budget: 2650, hash: 087b904e9577eb643fa41b92cd287494 }, { apicode: '', budget: 3666, hash: 0d6be3b2a42c4ffa3b5dbd91ef7cb1f2 }, { apicode: '123', budget: 0, hash: 58e7aa4ae4b14f936c8d3c1ff4c448f0 }, { apicode: '0.03256814464234574', budget: 5000, hash: ef39b5a90e5611474eafb4448244a6ce }, { apicode: '0.041961475314536575', budget: 5000, hash: 5645eabd53f29db62b3f6b46b0a4ee9a }, { apicode: '0.3684386716861638', budget: 5000, hash: b653ef7b944b6ff8bc6ec1b819c6fb81 }, { apicode: current1, budget: 5000, hash: 9c7a4379b985bf3634a5ad139367f2f2 }, { apicode: '0.4784866063655229', budget: 10, hash: 0edcca852b3e0de26dff7a10813ce2c5 }, { apicode: '8441356513', budget: 1000, hash: 5a21f0c91de0f8fbd40113920300accc }, { apicode: '0.6827000097210519', budget: 5000, hash: be71efd31cb899aa56ddf56b0e37db72 }, { apicode: '0.0035039428654163544', budget: 14121, hash: f2c1f78ba69ccff34f71a8767b8840b1 }, { apicode: '876', budget: 5000, hash: bc41f091ef5a25dd6d9438bbb1e0141c }, { apicode: '0.7642754658723953', budget: 5000, hash: 9b3f80d8d665ae7b173783e9c3739f69 }, { apicode: '7829934231', budget: 17575, hash: e55861eb4be354aae3fbe83ee20c0dfa }, { apicode: 46e19ffc-6f6d-443b-bcb2-c9d530410a70, budget: 25000, hash: 37253dab0574eea7030b3b795343a701 }, { apicode: '114', budget: 20000, hash: eba9b5a18ae64bfbd260fad858104f7f }, { apicode: фив, budget: 12000, hash: f0f5fbbcf9ec1cf91d15893237d6a67c }, { apicode: asd, budget: 833.33, hash: b26a7ff43a4bba713ee8fba040832051 }, { apicode: asd, budget: 960, hash: ff69467de7b7adee36c9f974ad8c8e6a }, { apicode: asd, budget: 180, hash: 8e4764d672dbc3faf1db53cb3f54fb6a }], state: paid, sum: '132995.33', uuid: fe64b5e3-1fd9-476f-936a-1e47f98694c6 }, { issuer: provider2, moment: 1700503429, number: 11kjhgasad5239, routes: [{ apicode: '123213421343123443213', budget: 5000, hash: 0e9c48a40a6d183e81575211287297c9 }, { apicode: '123', budget: 0, hash: 78149e53be95ca6e535193b389c9867a }, { apicode: '0.18076632561233483', budget: 5000, hash: 206c906176b19163cc029d5f541277ab }, { apicode: '', budget: 100, hash: a66ec3335bd24509d0274a3fbc40fbda }, { apicode: '0.35819345466624336', budget: 5000, hash: d55fa808a91c6218a7dd5228597f1b5d }, { apicode: '', budget: 5000, hash: 8abb2f0d91a7d3f07d9279979d1a07b2 }, { apicode: '0.8310661360910778', budget: 5000, hash: a469769adb3779f9822e34d83424fd4a }, { apicode: '0.04295503258980348', budget: 14125, hash: 3dd722c23ecad004a78a5da3815109d7 }, { apicode: '0.3365506709893706', budget: 7544, hash: b917ccb2a8137b2981d878251ab5e8b1 }, { apicode: '', budget: 7845, hash: 3bec55eae27babb1d8fa9e89479336fd }, { apicode: '66', budget: 5000, hash: d7028b6e881c432a4a33354120b9b363 }, { apicode: '0.33630321764974225', budget: 5000, hash: b39f9f90e2ce24fb73be250bfa0a178e }, { apicode: '7', budget: 5000, hash: d1a1dd211c80133fa981128488338625 }, { apicode: 932352532523-gdfgfgf-4343-5353, budget: 25000, hash: 8fae6e6688cfc3c6cb44625a705ab097 }, { apicode: 6ca132f6-0904-4f48-9e29-2b9174541c4c, budget: 25000, hash: 5efeadf58926c4016cbfa84fef8aeeae }, { apicode: фив, budget: 12000, hash: 60e8be3580609f91986939f85a567574 }, { apicode: asd, budget: 12000, hash: dac27ada7ffc0e9cc4576d48c7205b72 }, { apicode: asda, budget: 10000, hash: baad44ba3e64695782395a90a197a473 }, { apicode: asd, budget: 833.33, hash: b3df4cdffa14e604bf9e1a6e9f754c46 }, { apicode: asd, budget: 833.33, hash: ba58532fe8f53fded9003d9c7037caea }], state: declined, sum: '155280.66', uuid: 5025145e-ed1f-47aa-a6dd-1dac5cbc9b91 }, { issuer: 'Seifert Polska Sp.Z.o.p', moment: 1700503437, number: 11kjhgasad1826, routes: [{ apicode: '0.8047545541122132', budget: 5000, hash: 27f1d7942632d86869896e84942f025d }, { apicode: '0.1133978684557582', budget: 5000, hash: 5a9daf1a032c4cb8d068c391298874ac }, { apicode: '0.5106133879261217', budget: 5000, hash: f7404b05aa7b09616181d92e1560a015 }, { apicode: '', budget: 14517, hash: 361635f7d97576ac7b14ecd9f4b6446b }, { apicode: '0.028826862600470765', budget: 21000, hash: d0c9a279f95fe2fb6f2157da46339a55 }, { apicode: '0.22141165213790875', budget: 5000, hash: f2e0ec3c7f42022a14dad81378f18242 }, { apicode: 213у, budget: 2800, hash: 406d6fad4c26161c770b0e587e9123b5 }, { apicode: '4373479240', budget: 23755, hash: a686653f683620217423b0cdd08de499 }, { apicode: unique-external-id-11212, budget: 0, hash: 83292a2ac21c4fe3759208d21520df07 }, { apicode: asd, budget: 1000, hash: c197d4f99c439f0ae669d1d0e9533517 }], state: new, sum: '83072.00', uuid: 80c7822b-a347-4a90-98d2-b6b0b05e73aa }, { issuer: 'Seifert Polska Sp.Z.o.p', moment: 1700503589, number: 11kjhgasad3741, routes: [{ apicode: '0.3625902266824527', budget: 5000, hash: b2400c08318741f252afc3c47a5a8d11 }, { apicode: '0.4762288317794249', budget: 5000, hash: c00e0ab13cf29ef43bbdad0220255f33 }, { apicode: '0.8930831476050272', budget: 5789, hash: 5f2339fd3fd66e8b6237bd0634c745ee }], state: ratified, sum: '15789.00', uuid: 738b625f-99c9-4a48-abd7-b6554ced405d }, { issuer: 'Seifert Polska Sp.Z.o.p', moment: 1700503653, number: '1112312313833', routes: [{ apicode: '1878106341', budget: 34361.37, hash: c3a48e5ab83cf25e84ae34148816302a }, { apicode: status5route, budget: 14000, hash: f05b06a60817c9d4951212a89778ef18 }, { apicode: asda, budget: 10000, hash: 5e4fc189e7722906028323b33f7b3ca9 }, { apicode: asd, budget: 1000, hash: fa7fb75a84bfb1bb49597cafda0a7114 }], state: new, sum: '59361.37', uuid: f606852c-9597-4282-bbdd-4e4c186492e9 }, { issuer: 'Агротеп, ООО', moment: 1700675321, number: '9988895079', routes: [{ apicode: '0.07540218166578765', budget: 5000, hash: 9057e606af4ed0bb775e1206bec1022f }, { apicode: '0.5668147444415975', budget: 5000, hash: 51f0b0458d87c9ef8c103b7fde061014 }, { apicode: '0.3388918371302', budget: 5000, hash: 7c0dd3fba6d384e7f3c157b795167abb }, { apicode: '0.07548966358927048', budget: 5000, hash: ab4c17577f301db3a49d8107293d3953 }, { apicode: '0.8890950827757782', budget: 5000, hash: 005d6ffc9d32c9236face835d7a2f422 }, { apicode: '0.8226471485780991', budget: 5000, hash: ebee917dfcc13a35ca7aa3a903e869e9 }, { apicode: '0.8978843715953495', budget: 5000, hash: 510f42035c9aed2ee85675467150b0e9 }, { apicode: '0.09345130537958006', budget: 5000, hash: 1bf416f127ac104f61bcdea39d88baaf }, { apicode: '0.8675047055515505', budget: 5000, hash: 5f35f4c62837cbb9557a98053b7a7ddd }], state: paid, sum: '45000.00', uuid: 121766cf-3118-4d27-b08e-acbf950ed40e }, { issuer: 'Агротеп, ООО', moment: 1700752276, number: kljhvg, routes: [{ apicode: '123', budget: 0, hash: 35b62927a596bc654c68e020af92b048 }, { apicode: '0.3646109023733166', budget: 5000, hash: 532c3d7623bbd7c37d0f6d70a3d65fd7 }, { apicode: '0.7557448621427126', budget: 5000, hash: e45644c2c1e1f49a915773aacb3e91f3 }], state: new, sum: '10000.00', uuid: b4625416-3abf-4c5a-b789-998bb7e0cbd2 }, { issuer: 'Seifert Polska Sp.Z.o.p', moment: 1700752951, number: number, state: new, sum: '0.00', uuid: f2f45f7f-185c-4540-901e-fbecfadf6626 }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ issuer: provider, moment: 1700246452, number: asodmasdasd, routes: [{ apicode: test-api, budget: 2650, hash: 00e22611bcaf7f64d97a75aa8d074f99 }, { apicode: '0.9670328488266401', budget: 6000, hash: 350689b31d5f009b3ba341945cb12d81 }, { apicode: '0.6557187891152862', budget: 5000, hash: b3671908c16817aee16697e5049c89f1 }, { apicode: '0.001982429066656557', budget: 5000, hash: 8392c5d2d73ca8e66e11e6d20bf5ac3b }, { apicode: '0.947122911873388', budget: 5000, hash: d193a5ec8e8d27023e3c95f695c5373f }, { apicode: '0.7163089632208542', budget: 5000, hash: 35c643e29439c52502bf41e08d0b9efa }, { apicode: '0.23221729996820661', budget: 5000, hash: 4a1db079f0e123bfa3f86822e6d149de }, { apicode: '', budget: 0, hash: 83aad578d4e5a8294ef6a32d84ae46ba }, { apicode: '0.17621022479255705', budget: 5000, hash: af54562917dc5d00bf6ad1fd38e96f15 }, { apicode: '0.8608113144159423', budget: 13454, hash: 486ab2ad90f2632de1372ccd6c8fa628 }, { apicode: '0.10723068202587839', budget: 7548, hash: e06d41cdd713c62ee3b6cb2dbd5742a2 }, { apicode: '', budget: 7841, hash: c5eccbf76ae05674a4b673f35050621d }, { apicode: '123', budget: 5000, hash: 87f583c8dcc6952d09523e94c8f10f77 }, { apicode: '0.08158724948911672', budget: 5000, hash: d3b7854c2948696b34b71c4aa32b12da }, { apicode: '0.01728116256862987', budget: 5000, hash: c7dd120ba457b7455df640826e5464fa }, { apicode: asdasda, budget: 2650, hash: 7f133b2a86715674a6455989d2e5058f }, { apicode: 1a12f2209281e1c, budget: 25000, hash: 389efc1d5aa91fe6c955c5a0f1de5927 }, { apicode: ол, budget: 297000, hash: c0ece27c0b0e995058f9252f201b2b7a }, { apicode: фи, budget: 600, hash: 577db620755b70be0f088e510846ba15 }, { apicode: unique-external-id-11212, budget: 0, hash: 191e84a2c4555141928da10a0bb015fd }, { apicode: фивфив, budget: 5000, hash: 2a667ad3e1cabf5c99ab8b29f58ad5d8 }, { apicode: asd, budget: 1000, hash: d0d3df54657663b6683ea0cf8cc84cd1 }], state: new, sum: '413743.00', uuid: 302ebf7c-8568-11ee-ab72-1eee848349a0 }, { issuer: provider, moment: 1700503396, number: 11kjhgasad4553, routes: [{ apicode: '456372', budget: 2650, hash: 087b904e9577eb643fa41b92cd287494 }, { apicode: '', budget: 3666, hash: 0d6be3b2a42c4ffa3b5dbd91ef7cb1f2 }, { apicode: '123', budget: 0, hash: 58e7aa4ae4b14f936c8d3c1ff4c448f0 }, { apicode: '0.03256814464234574', budget: 5000, hash: ef39b5a90e5611474eafb4448244a6ce }, { apicode: '0.041961475314536575', budget: 5000, hash: 5645eabd53f29db62b3f6b46b0a4ee9a }, { apicode: '0.3684386716861638', budget: 5000, hash: b653ef7b944b6ff8bc6ec1b819c6fb81 }, { apicode: current1, budget: 5000, hash: 9c7a4379b985bf3634a5ad139367f2f2 }, { apicode: '0.4784866063655229', budget: 10, hash: 0edcca852b3e0de26dff7a10813ce2c5 }, { apicode: '8441356513', budget: 1000, hash: 5a21f0c91de0f8fbd40113920300accc }, { apicode: '0.6827000097210519', budget: 5000, hash: be71efd31cb899aa56ddf56b0e37db72 }, { apicode: '0.0035039428654163544', budget: 14121, hash: f2c1f78ba69ccff34f71a8767b8840b1 }, { apicode: '876', budget: 5000, hash: bc41f091ef5a25dd6d9438bbb1e0141c }, { apicode: '0.7642754658723953', budget: 5000, hash: 9b3f80d8d665ae7b173783e9c3739f69 }, { apicode: '7829934231', budget: 17575, hash: e55861eb4be354aae3fbe83ee20c0dfa }, { apicode: 46e19ffc-6f6d-443b-bcb2-c9d530410a70, budget: 25000, hash: 37253dab0574eea7030b3b795343a701 }, { apicode: '114', budget: 20000, hash: eba9b5a18ae64bfbd260fad858104f7f }, { apicode: фив, budget: 12000, hash: f0f5fbbcf9ec1cf91d15893237d6a67c }, { apicode: asd, budget: 833.33, hash: b26a7ff43a4bba713ee8fba040832051 }, { apicode: asd, budget: 960, hash: ff69467de7b7adee36c9f974ad8c8e6a }, { apicode: asd, budget: 180, hash: 8e4764d672dbc3faf1db53cb3f54fb6a }], state: paid, sum: '132995.33', uuid: fe64b5e3-1fd9-476f-936a-1e47f98694c6 }, { issuer: provider2, moment: 1700503429, number: 11kjhgasad5239, routes: [{ apicode: '123213421343123443213', budget: 5000, hash: 0e9c48a40a6d183e81575211287297c9 }, { apicode: '123', budget: 0, hash: 78149e53be95ca6e535193b389c9867a }, { apicode: '0.18076632561233483', budget: 5000, hash: 206c906176b19163cc029d5f541277ab }, { apicode: '', budget: 100, hash: a66ec3335bd24509d0274a3fbc40fbda }, { apicode: '0.35819345466624336', budget: 5000, hash: d55fa808a91c6218a7dd5228597f1b5d }, { apicode: '', budget: 5000, hash: 8abb2f0d91a7d3f07d9279979d1a07b2 }, { apicode: '0.8310661360910778', budget: 5000, hash: a469769adb3779f9822e34d83424fd4a }, { apicode: '0.04295503258980348', budget: 14125, hash: 3dd722c23ecad004a78a5da3815109d7 }, { apicode: '0.3365506709893706', budget: 7544, hash: b917ccb2a8137b2981d878251ab5e8b1 }, { apicode: '', budget: 7845, hash: 3bec55eae27babb1d8fa9e89479336fd }, { apicode: '66', budget: 5000, hash: d7028b6e881c432a4a33354120b9b363 }, { apicode: '0.33630321764974225', budget: 5000, hash: b39f9f90e2ce24fb73be250bfa0a178e }, { apicode: '7', budget: 5000, hash: d1a1dd211c80133fa981128488338625 }, { apicode: 932352532523-gdfgfgf-4343-5353, budget: 25000, hash: 8fae6e6688cfc3c6cb44625a705ab097 }, { apicode: 6ca132f6-0904-4f48-9e29-2b9174541c4c, budget: 25000, hash: 5efeadf58926c4016cbfa84fef8aeeae }, { apicode: фив, budget: 12000, hash: 60e8be3580609f91986939f85a567574 }, { apicode: asd, budget: 12000, hash: dac27ada7ffc0e9cc4576d48c7205b72 }, { apicode: asda, budget: 10000, hash: baad44ba3e64695782395a90a197a473 }, { apicode: asd, budget: 833.33, hash: b3df4cdffa14e604bf9e1a6e9f754c46 }, { apicode: asd, budget: 833.33, hash: ba58532fe8f53fded9003d9c7037caea }], state: declined, sum: '155280.66', uuid: 5025145e-ed1f-47aa-a6dd-1dac5cbc9b91 }, { issuer: 'Seifert Polska Sp.Z.o.p', moment: 1700503437, number: 11kjhgasad1826, routes: [{ apicode: '0.8047545541122132', budget: 5000, hash: 27f1d7942632d86869896e84942f025d }, { apicode: '0.1133978684557582', budget: 5000, hash: 5a9daf1a032c4cb8d068c391298874ac }, { apicode: '0.5106133879261217', budget: 5000, hash: f7404b05aa7b09616181d92e1560a015 }, { apicode: '', budget: 14517, hash: 361635f7d97576ac7b14ecd9f4b6446b }, { apicode: '0.028826862600470765', budget: 21000, hash: d0c9a279f95fe2fb6f2157da46339a55 }, { apicode: '0.22141165213790875', budget: 5000, hash: f2e0ec3c7f42022a14dad81378f18242 }, { apicode: 213у, budget: 2800, hash: 406d6fad4c26161c770b0e587e9123b5 }, { apicode: '4373479240', budget: 23755, hash: a686653f683620217423b0cdd08de499 }, { apicode: unique-external-id-11212, budget: 0, hash: 83292a2ac21c4fe3759208d21520df07 }, { apicode: asd, budget: 1000, hash: c197d4f99c439f0ae669d1d0e9533517 }], state: new, sum: '83072.00', uuid: 80c7822b-a347-4a90-98d2-b6b0b05e73aa }, { issuer: 'Seifert Polska Sp.Z.o.p', moment: 1700503589, number: 11kjhgasad3741, routes: [{ apicode: '0.3625902266824527', budget: 5000, hash: b2400c08318741f252afc3c47a5a8d11 }, { apicode: '0.4762288317794249', budget: 5000, hash: c00e0ab13cf29ef43bbdad0220255f33 }, { apicode: '0.8930831476050272', budget: 5789, hash: 5f2339fd3fd66e8b6237bd0634c745ee }], state: ratified, sum: '15789.00', uuid: 738b625f-99c9-4a48-abd7-b6554ced405d }, { issuer: 'Seifert Polska Sp.Z.o.p', moment: 1700503653, number: '1112312313833', routes: [{ apicode: '1878106341', budget: 34361.37, hash: c3a48e5ab83cf25e84ae34148816302a }, { apicode: status5route, budget: 14000, hash: f05b06a60817c9d4951212a89778ef18 }, { apicode: asda, budget: 10000, hash: 5e4fc189e7722906028323b33f7b3ca9 }, { apicode: asd, budget: 1000, hash: fa7fb75a84bfb1bb49597cafda0a7114 }], state: new, sum: '59361.37', uuid: f606852c-9597-4282-bbdd-4e4c186492e9 }, { issuer: 'Агротеп, ООО', moment: 1700675321, number: '9988895079', routes: [{ apicode: '0.07540218166578765', budget: 5000, hash: 9057e606af4ed0bb775e1206bec1022f }, { apicode: '0.5668147444415975', budget: 5000, hash: 51f0b0458d87c9ef8c103b7fde061014 }, { apicode: '0.3388918371302', budget: 5000, hash: 7c0dd3fba6d384e7f3c157b795167abb }, { apicode: '0.07548966358927048', budget: 5000, hash: ab4c17577f301db3a49d8107293d3953 }, { apicode: '0.8890950827757782', budget: 5000, hash: 005d6ffc9d32c9236face835d7a2f422 }, { apicode: '0.8226471485780991', budget: 5000, hash: ebee917dfcc13a35ca7aa3a903e869e9 }, { apicode: '0.8978843715953495', budget: 5000, hash: 510f42035c9aed2ee85675467150b0e9 }, { apicode: '0.09345130537958006', budget: 5000, hash: 1bf416f127ac104f61bcdea39d88baaf }, { apicode: '0.8675047055515505', budget: 5000, hash: 5f35f4c62837cbb9557a98053b7a7ddd }], state: paid, sum: '45000.00', uuid: 121766cf-3118-4d27-b08e-acbf950ed40e }, { issuer: 'Агротеп, ООО', moment: 1700752276, number: kljhvg, routes: [{ apicode: '123', budget: 0, hash: 35b62927a596bc654c68e020af92b048 }, { apicode: '0.3646109023733166', budget: 5000, hash: 532c3d7623bbd7c37d0f6d70a3d65fd7 }, { apicode: '0.7557448621427126', budget: 5000, hash: e45644c2c1e1f49a915773aacb3e91f3 }], state: new, sum: '10000.00', uuid: b4625416-3abf-4c5a-b789-998bb7e0cbd2 }, { issuer: 'Seifert Polska Sp.Z.o.p', moment: 1700752951, number: number, state: new, sum: '0.00', uuid: f2f45f7f-185c-4540-901e-fbecfadf6626 }], status: success }
        403:
          description: 'Missing token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is required' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Missing token':
                  value: { message: 'Token is required', relogin: true, status: error }
  /a/v2/rest/public/paymentRequests:
    get:
      tags:
        - 'Partners / Payment Requests'
      summary: 'Get Payment Requests'
      description: 'Get Payment Requests'
      operationId: getPaymentRequests
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/paymentRequest:
    get:
      tags:
        - 'Partners / Payment Requests'
      summary: 'Get Payment Request'
      description: 'Get Payment Request'
      operationId: getPaymentRequest
      parameters:
        -
          name: request
          in: query
          schema:
            type: string
            example: uuid
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/paymentRequestXlsExport:
    get:
      tags:
        - 'Partners / Payment Requests'
      summary: 'Export Payment Request XLS'
      description: 'Export Payment Request XLS'
      operationId: exportPaymentRequestXls
      parameters:
        -
          name: request
          in: query
          schema:
            type: string
            example: uuid
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/paymentRequestUpdate:
    post:
      tags:
        - 'Partners / Payment Requests'
      summary: 'Update Payment Request'
      description: 'Update Payment Request'
      operationId: updatePaymentRequest
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                request:
                  type: string
                  example: uuid
                routes:
                  type: array
                  items: { type: string, example: 111-11-25 }
                  example: [111-11-25, 222-02-20, 333-02-20]
            examples:
              'Update Payment Request':
                value:
                  request: uuid
                  routes: [111-11-25, 222-02-20, 333-02-20]
      responses:
        200:
          description: ''
  /a/v2/rest/public/paymentRequestPaid:
    post:
      tags:
        - 'Partners / Payment Requests'
      summary: 'Mark Payment Request as Paid'
      description: 'Mark Payment Request as Paid'
      operationId: markPaymentRequestAsPaid
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                date:
                  type: string
                  example: 1766102400
                request:
                  type: string
                  example: uuid
            examples:
              'Mark Payment Request as Paid':
                value:
                  date: 1766102400
                  request: uuid
      responses:
        200:
          description: ''
  /a/v2/rest/public/paymentRequestDelete:
    post:
      tags:
        - 'Partners / Payment Requests'
      summary: 'Delete Payment Request'
      description: 'Delete Payment Request'
      operationId: deletePaymentRequest
      parameters:
        -
          name: request
          in: query
          schema:
            type: string
            example: uuid
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getPartners:
    get:
      tags:
        - 'Partners / Partnerships'
      summary: 'Get Current Partners'
      description: |-
        Get the list of legal entities with which the legal entity of the current user has direct contracts for cargo deliveries.

        Each element of the list contains basic details of each partner, including the hash, by which full details can be queried using the `getCompany` endpoint.

        If queried by a shipper, the method will return the list of carriers, and vice versa. 

        - If successful, you will receive the list of partner legal entities
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getCurrentPartners
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { blocked: { type: boolean, example: true }, clientHash: { type: string, example: 588a6b0ff42a6c39834c80dfc9fb38ba }, company: { type: number, example: 49 }, contract: { type: string, example: '' }, date: { type: string, example: 1472774400 }, dateend: { type: string, example: '' }, natcomid: { type: string, example: '6722356984' }, title: { type: string, example: 'Northern Freight Solutions Ltd' }, type: { type: string, example: operator } } }, example: [{ blocked: true, clientHash: 588a6b0ff42a6c39834c80dfc9fb38ba, company: 49, contract: '', date: 1472774400, dateend: '', natcomid: '6722356984', title: 'Northern Freight Solutions Ltd', type: operator }, { blocked: false, clientHash: a65e7164cbc4d08fc2f9d0a164a6dc84, company: 405, contract: '', date: -62169984000, dateend: '', natcomid: '4722356984', title: 'Red Fox Transport Ltd', type: operator }, { blocked: false, clientHash: 321c3857d663d927239e33d87869197b, company: 2704, contract: GH-1/2, date: 1422403200, dateend: '', natcomid: '6722356984', title: 'Diamond Logistics Group plc', type: expeditor }, { blocked: false, clientHash: 21a797775797725b9cc5925a722e2746, company: 3458, contract: '', date: -62169984000, dateend: '', natcomid: '6722356984', title: 'Cosmos Logistics Ltd', type: operator }, { blocked: false, clientHash: 302482b88fbe4901c7a773bcc4c5d124, company: 779709, contract: '5', date: 1616371200, dateend: '', natcomid: '6722356984', title: 'Prime Haulage Services Ltd', type: '' }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ blocked: true, clientHash: 588a6b0ff42a6c39834c80dfc9fb38ba, company: 49, contract: '', date: 1472774400, dateend: '', natcomid: '6722356984', title: 'Northern Freight Solutions Ltd', type: operator }, { blocked: false, clientHash: a65e7164cbc4d08fc2f9d0a164a6dc84, company: 405, contract: '', date: -62169984000, dateend: '', natcomid: '4722356984', title: 'Red Fox Transport Ltd', type: operator }, { blocked: false, clientHash: 321c3857d663d927239e33d87869197b, company: 2704, contract: GH-1/2, date: 1422403200, dateend: '', natcomid: '6722356984', title: 'Diamond Logistics Group plc', type: expeditor }, { blocked: false, clientHash: 21a797775797725b9cc5925a722e2746, company: 3458, contract: '', date: -62169984000, dateend: '', natcomid: '6722356984', title: 'Cosmos Logistics Ltd', type: operator }, { blocked: false, clientHash: 302482b88fbe4901c7a773bcc4c5d124, company: 779709, contract: '5', date: 1616371200, dateend: '', natcomid: '6722356984', title: 'Prime Haulage Services Ltd', type: '' }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/showCompany:
    get:
      tags:
        - 'Partners / Partnerships'
      summary: 'Get Partner Company Details'
      description: |-
        Return the data about a legal entity, identified by the `companyHash`.

        - If successful, you will receive the details of the legal entity passed
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: current user might not have permission to view particular legal entities based on the relationships between the requested legal entity and the legal entity of the current user.
      operationId: getPartnerCompanyDetails
      parameters:
        -
          name: hash
          in: query
          schema:
            type: string
            example: '{{companyHash}}'
          description: 'Internal unique hash of the legal entity.'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { actsonbaseof: { type: string, example: 'power of attorney' }, apikeyNP: { type: string, example: '' }, bankAccount: { type: string, example: GB29NWBK60161331926819 }, bankname: { type: string, example: 'NatWest Bank plc' }, country: { type: string, example: 'United Kingdom' }, created: { type: string, example: 1394064000 }, director: { type: string, example: Thompson }, directorCase: { type: string, example: '' }, directorFirstName: { type: string, example: Michael }, directorPatronymic: { type: string, example: '' }, email: { type: string, example: operations@logisticanova.co.uk }, factAddress: { type: string, example: 'Warehouse B, Dock Gate 3, Southampton Docks, SO15 1HJ, United Kingdom' }, faxnum: { type: string, example: '+442380654321' }, hash: { type: string, example: 518a6b0fg42a6c39834c80dfc9fb38ba }, ifoid: { type: string, example: '305749' }, korraccount: { type: string, example: '' }, legalAddress: { type: string, example: 'Unit 4, Meridian Business Park, Southampton, SO14 5QF, United Kingdom' }, logisticsRatified: { type: number, example: 0 }, logisticsRatifiedByUser: { type: number, example: 0 }, logisticsRatifiedMoment: { type: string, example: -62169984000 }, natcomid: { type: string, example: '09876543' }, otherContactInfo: { type: string, example: '' }, ownership: { type: string, example: '' }, registryValidated: { nullable: true, example: null }, signer: { type: string, example: 'Head of Road Transport Operations' }, signerCase: { type: string, example: '' }, swift: { type: string, example: NWBKGB2L }, taxid: { type: string, example: GB123456789 }, telnum: { type: string, example: '+442380123456' }, titleFull: { type: string, example: 'LogisticaNova Limited' }, titleRu: { type: string, example: 'LogisticaNova Ltd' }, vatid: { type: string, example: GB123456789 }, website: { type: string, example: www.logisticanova.co.uk } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { actsonbaseof: 'power of attorney', apikeyNP: '', bankAccount: GB29NWBK60161331926819, bankname: 'NatWest Bank plc', country: 'United Kingdom', created: 1394064000, director: Thompson, directorCase: '', directorFirstName: Michael, directorPatronymic: '', email: operations@logisticanova.co.uk, factAddress: 'Warehouse B, Dock Gate 3, Southampton Docks, SO15 1HJ, United Kingdom', faxnum: '+442380654321', hash: 518a6b0fg42a6c39834c80dfc9fb38ba, ifoid: '305749', korraccount: '', legalAddress: 'Unit 4, Meridian Business Park, Southampton, SO14 5QF, United Kingdom', logisticsRatified: 0, logisticsRatifiedByUser: 0, logisticsRatifiedMoment: -62169984000, natcomid: '09876543', otherContactInfo: '', ownership: '', registryValidated: null, signer: 'Head of Road Transport Operations', signerCase: '', swift: NWBKGB2L, taxid: GB123456789, telnum: '+442380123456', titleFull: 'LogisticaNova Limited', titleRu: 'LogisticaNova Ltd', vatid: GB123456789, website: www.logisticanova.co.uk }, status: success }
        400:
          description: 'Invalid companyHash passed'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Cannot find the company' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Invalid companyHash passed':
                  value: { message: 'Cannot find the company', relogin: false, status: error }
  /a/v2/rest/public/blockPartner:
    post:
      tags:
        - 'Partners / Partnerships'
      summary: 'Block Partner'
      description: 'Block Partner'
      operationId: blockPartner
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                clienthash:
                  type: string
                  example: ''
            examples:
              'Block Partner':
                value:
                  clienthash: ''
      responses:
        200:
          description: ''
  /a/v2/rest/public/getCarriersOpenForCooperation:
    get:
      tags:
        - 'Partners / Partnerships'
      summary: 'Find Carrier Partners'
      description: 'Find Carrier Partners'
      operationId: findCarrierPartners
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getShippersOpenForCooperation:
    get:
      tags:
        - 'Partners / Partnerships'
      summary: 'Find Shipper Partners'
      description: |-
        Returns the summary of notifications. Includes unread messages and routes, in which actions are required.

        - if successful you will receive all your notifications
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Endpoint returns the number of notifications and number of routes in which actions are required, but does not return messages contents or route details.
      operationId: findShipperPartners
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/inviteForCooperation:
    post:
      tags:
        - 'Partners / Partnerships'
      summary: 'Send Partnership Invitation'
      description: |-
        Returns the summary of notifications. Includes unread messages and routes, in which actions are required.

        - if successful you will receive all your notifications
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Endpoint returns the number of notifications and number of routes in which actions are required, but does not return messages contents or route details.
      operationId: sendPartnershipInvitation
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            examples:
              'Send Partnership Invitation':
                value: |-
                  {
                      "clienthash":{{clientHash}}
                  }
      responses:
        200:
          description: ''
  /a/v2/rest/public/inviteForCooperationWithSpecificUser:
    post:
      tags:
        - 'Partners / Partnerships'
      summary: 'Invite Company to Join Platform'
      description: 'Invite Company to Join Platform'
      operationId: inviteCompanyToJoinPlatform
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cellnum:
                  type: string
                  example: '+380500000000'
                clienthash:
                  type: string
                  example: ''
                contractdate:
                  type: string
                  example: 01.01.2025
                contractnumber:
                  type: string
                  example: 'contract#1'
                email:
                  type: string
                  example: dddd@dd.com
                secretcode:
                  type: string
                  example: '1'
                username:
                  type: string
                  example: '1'
                v3_frontend:
                  type: number
                  example: 1
            examples:
              'Invite Company to Join Platform':
                value:
                  cellnum: '+380500000000'
                  clienthash: ''
                  contractdate: 01.01.2025
                  contractnumber: 'contract#1'
                  email: dddd@dd.com
                  secretcode: '1'
                  username: '1'
                  v3_frontend: 1
      responses:
        200:
          description: ''
  /a/v2/rest/public/getMyInvites:
    get:
      tags:
        - 'Partners / Partnerships'
      summary: 'Get Sent Invitations'
      description: 'Get Sent Invitations'
      operationId: getSentInvitations
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getIncomingInvites:
    get:
      tags:
        - 'Partners / Partnerships'
      summary: 'Get Received Invitations'
      description: 'Get Received Invitations'
      operationId: getReceivedInvitations
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getMyAcceptedInvites:
    get:
      tags:
        - 'Partners / Partnerships'
      summary: 'Get Accepted Invitations'
      description: 'Get Accepted Invitations'
      operationId: getAcceptedInvitations
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/remindInvites:
    post:
      tags:
        - 'Partners / Partnerships'
      summary: 'Send Invitation Reminders'
      description: 'Send Invitation Reminders'
      operationId: sendInvitationReminders
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/acceptInvite:
    post:
      tags:
        - 'Partners / Partnerships'
      summary: 'Accept Invitation'
      description: 'Accept Invitation'
      operationId: acceptInvitation
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                clienthash:
                  type: string
                  example: ''
                reason:
                  type: string
                  example: 'Перевірка API accept'
            examples:
              'Accept Invitation':
                value:
                  clienthash: ''
                  reason: 'Перевірка API accept'
      responses:
        200:
          description: ''
  /a/v2/rest/public/declineInvite:
    post:
      tags:
        - 'Partners / Partnerships'
      summary: 'Reject Invitation'
      description: 'Reject Invitation'
      operationId: rejectInvitation
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                clienthash:
                  type: string
                  example: 3912aaebebbfc4b0b3dd2a1d6db9a114
                reason:
                  type: string
                  example: 'Перевірка API decline'
            examples:
              'Reject Invitation':
                value:
                  clienthash: 3912aaebebbfc4b0b3dd2a1d6db9a114
                  reason: 'Перевірка API decline'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getBlockedPartners:
    get:
      tags:
        - 'Partners / Partnerships'
      summary: 'Get Blocked Partners'
      description: 'Get Blocked Partners'
      operationId: getBlockedPartners
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/unblockPartner:
    post:
      tags:
        - 'Partners / Partnerships'
      summary: 'Unblock Partner'
      description: 'Unblock Partner'
      operationId: unblockPartner
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                clienthash:
                  type: string
                  example: ''
            examples:
              'Unblock Partner':
                value:
                  clienthash: ''
      responses:
        200:
          description: ''
  /a/v2/rest/public/updatePassword:
    put:
      tags:
        - 'Account / Security'
      summary: 'Update password'
      description: 'Update password'
      operationId: updatePassword
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                oldpassword:
                  type: string
                  example: 'old password'
                password1:
                  type: string
                  example: 'new password'
                password2:
                  type: string
                  example: 'new password'
            examples:
              'Update password':
                value:
                  oldpassword: 'old password'
                  password1: 'new password'
                  password2: 'new password'
      responses:
        200:
          description: ''
  /a/v2/rest/public/userMfaSettings:
    get:
      tags:
        - 'Account / Security'
      summary: 'Get MFA Settings'
      description: 'Get MFA Settings'
      operationId: getMfaSettings
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/userMfaEnable:
    post:
      tags:
        - 'Account / Security'
      summary: 'Enable MFA'
      description: 'Enable MFA'
      operationId: enableMfa
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                mfa_method:
                  type: number
                  example: 1
            examples:
              'Enable MFA':
                value:
                  mfa_method: 1
      responses:
        200:
          description: ''
  /a/v2/rest/public/userMfaConfirm:
    post:
      tags:
        - 'Account / Security'
      summary: 'Confirm MFA'
      description: 'Confirm MFA'
      operationId: confirmMfa
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                code:
                  type: string
                  example: '980756'
                mfa_method:
                  type: number
                  example: 1
            examples:
              'Confirm MFA':
                value:
                  code: '980756'
                  mfa_method: 1
      responses:
        200:
          description: ''
  /a/v2/rest/public/userMfaDisable:
    post:
      tags:
        - 'Account / Security'
      summary: 'Disable MFA'
      description: 'Disable MFA'
      operationId: disableMfa
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: []
      responses:
        200:
          description: ''
  /a/v2/rest/public/getUserProfile:
    get:
      tags:
        - 'Account / User Profile'
      summary: 'Get Current User Profile'
      description: |-
        Allows you to see basic details of current user profile.

        - If successful you will receive details of your profile such as: avatar, client, company, country, id, language, mackey, name, usertype
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header
      operationId: getCurrentUserProfile
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            examples:
              'Get Current User Profile':
                value: ''
      responses:
        200:
          description: ''
        403:
          description: 'Invalid JWT token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid JWT token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/personalDetails:
    put:
      tags:
        - 'Account / User Profile'
      summary: 'Update Personal Details'
      description: 'Update Personal Details'
      operationId: updatePersonalDetails
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: 'Harry Potter'
                systemlanguage:
                  type: string
                  example: ua
            examples:
              'Update Personal Details':
                value:
                  name: 'Harry Potter'
                  systemlanguage: ua
      responses:
        200:
          description: ''
  /a/v2/rest/public/userMeasureSettings:
    get:
      tags:
        - 'Account / User Profile'
      summary: 'Get Regional Settings'
      description: 'Get Regional Settings'
      operationId: getRegionalSettings
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/updateUserMeasureSettings:
    post:
      tags:
        - 'Account / User Profile'
      summary: 'Update Regional Settings'
      description: 'Update Regional Settings'
      operationId: updateRegionalSettings
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                distance_unit:
                  type: string
                  example: km
            examples:
              'Update Regional Settings':
                value:
                  distance_unit: km
      responses:
        200:
          description: ''
  /a/v2/rest/public/myDocuments:
    get:
      tags:
        - 'Account / Company Profile'
      summary: 'Company Documents'
      description: 'Company Documents'
      operationId: companyDocuments
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                login:
                  description: 'your username or email from the app'
                  type: string
                  example: '{{username}}'
                password:
                  description: 'your password from the app'
                  type: string
                  example: '{{password}}'
      responses:
        200:
          description: ''
  /a/v2/rest/public/myRequisites:
    get:
      tags:
        - 'Account / Company Profile'
      summary: 'Company Details'
      description: 'Company Details'
      operationId: companyDetails
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                login:
                  description: 'your username or email from the app'
                  type: string
                  example: '{{username}}'
                password:
                  description: 'your password from the app'
                  type: string
                  example: '{{password}}'
      responses:
        200:
          description: ''
  /a/v2/rest/public/updateMyRequisites:
    post:
      tags:
        - 'Account / Company Profile'
      summary: 'Update Company Details'
      description: 'Update Company Details'
      operationId: updateCompanyDetails
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                actsonbaseof:
                  type: string
                  example: устава
                bankaccount:
                  type: string
                  example: '5896742345'
                bankname:
                  type: string
                  example: Приватбанк
                country:
                  type: string
                  example: '215'
                director:
                  type: string
                  example: Руденко
                directorfirstname:
                  type: string
                  example: Георгий
                directorpatronymic:
                  type: string
                  example: Владимирович
                email:
                  type: string
                  example: m.sevostianov@phleetto.uk
                factaddress:
                  type: string
                  example: 'г. Киев, ул. Симиренка, 8а, оф. 501'
                gln:
                  type: string
                  example: '0'
                ifoid:
                  type: string
                  example: '320569'
                legaladdress:
                  type: string
                  example: '02068, м.Київ, Дарницький район ВУЛИЦЯ ДРАГОМАНОВА буд. 1Б кв. 51'
                natcomid:
                  type: string
                  example: '3648901827'
                othercontactinfo:
                  type: string
                  example: 'ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ!'
                replaced_country_select_primary_key:
                  type: string
                  example: '215'
                signer:
                  type: string
                  example: Директор
                taxid:
                  type: string
                  example: '987456123997'
                telnum:
                  type: string
                  example: '+380445689887'
                title_full_ru:
                  type: string
                  example: 'Берг Денис Олегович'
                title_ru:
                  type: string
                  example: 'Берг Денис Олегович 180'
                vatid:
                  type: string
                  example: '869788'
                website:
                  type: string
                  example: 'http://logist.ua'
            examples:
              'Update Company Details':
                value:
                  actsonbaseof: устава
                  bankaccount: '5896742345'
                  bankname: Приватбанк
                  country: '215'
                  director: Руденко
                  directorfirstname: Георгий
                  directorpatronymic: Владимирович
                  email: m.sevostianov@phleetto.uk
                  factaddress: 'г. Киев, ул. Симиренка, 8а, оф. 501'
                  gln: '0'
                  ifoid: '320569'
                  legaladdress: '02068, м.Київ, Дарницький район ВУЛИЦЯ ДРАГОМАНОВА буд. 1Б кв. 51'
                  natcomid: '3648901827'
                  othercontactinfo: 'ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ!'
                  replaced_country_select_primary_key: '215'
                  signer: Директор
                  taxid: '987456123997'
                  telnum: '+380445689887'
                  title_full_ru: 'Берг Денис Олегович'
                  title_ru: 'Берг Денис Олегович 180'
                  vatid: '869788'
                  website: 'http://logist.ua'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getPayor:
    get:
      tags:
        - 'Account / Company Profile'
      summary: 'Get Payer Legal Entities'
      description: |-
        The method shows available payor legal entities. Available only to shipper user type (usertype 1). 

        Every shipper has an opportunity to add additional payor legal entities in settings section in Phleetto webapp. Thus, the response may differ from user to user, because the content of the response shows the very payor legal entities for that particular user's company.

        - If successful, you will receive the list payor legal entities
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getPayerLegalEntities
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { natcomid: { type: string, example: '54839217' }, title: { type: string, example: 'Northwind Logistics Ltd' } } }, example: [{ natcomid: '54839217', title: 'Northwind Logistics Ltd' }, { natcomid: '11223344', title: 'BlueRiver Transport' }, { natcomid: '9988776655', title: 'Atlas Freight Solutions' }, { natcomid: '', title: 'GreenLine Haulage' }, { natcomid: '6739201458', title: 'Redwood Supply Chain' }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ natcomid: '54839217', title: 'Northwind Logistics Ltd' }, { natcomid: '11223344', title: 'BlueRiver Transport' }, { natcomid: '9988776655', title: 'Atlas Freight Solutions' }, { natcomid: '', title: 'GreenLine Haulage' }, { natcomid: '6739201458', title: 'Redwood Supply Chain' }], status: success }
        400:
          description: 'Carrier request error'
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: '*'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Mon, 23 Aug 2021 22:06:57 GMT'
            Server:
              schema:
                type: string
                example: 'nginx/1.18.0 (Ubuntu)'
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Action not allowed' }
                  relogin: { type: boolean, example: false }
                  status: { type: string, example: error }
              examples:
                'Carrier request error':
                  value: { message: 'Action not allowed', relogin: false, status: error }
  /a/v2/rest/public/publicWebsite:
    get:
      tags:
        - 'Account / Public Profile'
      summary: 'Get Public Website'
      description: 'Get Public Website'
      operationId: getPublicWebsite
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: ''
          in: header
          schema:
            type: string
            example: ''
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/updatePublicWebsite:
    post:
      tags:
        - 'Account / Public Profile'
      summary: 'Update Public Website'
      description: 'Update Public Website'
      operationId: updatePublicWebsite
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cartype:
                  type: array
                  items: { type: number, example: 1 }
                  example: [1, 2]
                companyaboutphoto1label:
                  type: string
                  example: asdasd
                companyaboutphoto2label:
                  type: string
                  example: companyaboutphoto2label
                companyaboutphoto3label:
                  type: string
                  example: companyaboutphoto3label
                companydescription:
                  type: string
                  example: companydescription
                companyfoundingyear:
                  type: string
                  example: '2990'
                companysize:
                  type: string
                  example: '1'
                companytitle:
                  type: string
                  example: Test
                della:
                  type: string
                  example: della
                expeditorinsurancelimit:
                  type: string
                  example: asdasd
                facebook:
                  type: string
                  example: asdasd
                inceptionyear:
                  type: string
                  example: '2222'
                larditrans:
                  type: string
                  example: larditrans
                linkedin:
                  type: string
                  example: asdas
                maincellphone:
                  type: string
                  example: '+380500000000'
                slogan:
                  type: string
                  example: slogan
                sovtesadvantages:
                  type: string
                  example: dasdas
                sovtesdisadvantages:
                  type: string
                  example: asdasd
                telnum:
                  type: string
                  example: '+380500000000'
                website:
                  type: string
                  example: website
                youtube:
                  type: string
                  example: youtube
            examples:
              'Update Public Website':
                value:
                  cartype: [1, 2]
                  companyaboutphoto1label: asdasd
                  companyaboutphoto2label: companyaboutphoto2label
                  companyaboutphoto3label: companyaboutphoto3label
                  companydescription: companydescription
                  companyfoundingyear: '2990'
                  companysize: '1'
                  companytitle: Test
                  della: della
                  expeditorinsurancelimit: asdasd
                  facebook: asdasd
                  inceptionyear: '2222'
                  larditrans: larditrans
                  linkedin: asdas
                  maincellphone: '+380500000000'
                  slogan: slogan
                  sovtesadvantages: dasdas
                  sovtesdisadvantages: asdasd
                  telnum: '+380500000000'
                  website: website
                  youtube: youtube
      responses:
        200:
          description: ''
  /a/v2/rest/public/publishPublicWebsite:
    post:
      tags:
        - 'Account / Public Profile'
      summary: 'Publish Public Website'
      description: 'Publish Public Website'
      operationId: publishPublicWebsite
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            examples:
              'Publish Public Website':
                value: ''
      responses:
        200:
          description: ''
  /a/v2/rest/public/getUserWeb:
    get:
      tags:
        - 'Account / Account Switching'
      summary: 'Linked Accounts'
      description: 'Linked Accounts'
      operationId: linkedAccounts
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getUserWebToken:
    get:
      tags:
        - 'Account / Account Switching'
      summary: 'Account Switching Token'
      description: 'Account Switching Token'
      operationId: accountSwitchingToken
      parameters:
        -
          name: token
          in: query
          schema:
            type: string
            example: ''
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/myUsers:
    get:
      tags:
        - 'Account / User Management'
      summary: 'Get Users'
      description: 'Get Users'
      operationId: getUsers
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                login:
                  description: 'your username or email from the app'
                  type: string
                  example: '{{username}}'
                password:
                  description: 'your password from the app'
                  type: string
                  example: '{{password}}'
      responses:
        200:
          description: ''
  /a/v2/rest/public/addUser:
    post:
      tags:
        - 'Account / User Management'
      summary: 'Create User'
      description: 'Create User'
      operationId: createUser
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cellnum:
                  type: string
                  example: '+3805000000'
                confirmation_password:
                  type: string
                  example: '123456'
                email:
                  type: string
                  example: addUserTest2@gmail.com
                name:
                  type: string
                  example: addUserTest5
                password:
                  type: string
                  example: '123456'
                username:
                  type: string
                  example: addUserTest5
                v3_frontend:
                  type: number
                  example: 1
            examples:
              'Create User':
                value:
                  cellnum: '+3805000000'
                  confirmation_password: '123456'
                  email: addUserTest2@gmail.com
                  name: addUserTest5
                  password: '123456'
                  username: addUserTest5
                  v3_frontend: 1
      responses:
        200:
          description: ''
  /a/v2/rest/public/partnersForUser:
    get:
      tags:
        - 'Account / User Management'
      summary: 'Get Customer Access Filters'
      description: 'Get Customer Access Filters'
      operationId: getCustomerAccessFilters
      parameters:
        -
          name: id
          in: query
          schema:
            type: string
            example: ''
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                login:
                  description: 'your username or email from the app'
                  type: string
                  example: '{{username}}'
                password:
                  description: 'your password from the app'
                  type: string
                  example: '{{password}}'
      responses:
        200:
          description: ''
  /a/v2/rest/public/setPartnersForUser:
    post:
      tags:
        - 'Account / User Management'
      summary: 'Update Customer Access Filters'
      description: 'Update Customer Access Filters'
      operationId: updateCustomerAccessFilters
      parameters:
        -
          name: id
          in: query
          schema:
            type: string
            example: ''
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                clienthashes:
                  type: array
                  items: { type: string, example: '' }
                  example: ['', '']
            examples:
              'Update Customer Access Filters':
                value:
                  clienthashes: ['', '']
      responses:
        200:
          description: ''
  /a/v2/rest/public/tariffs:
    get:
      tags:
        - 'Account / Billing'
      summary: 'Get Subscription Plans'
      description: 'Get Subscription Plans'
      operationId: getSubscriptionPlans
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/setTariff:
    post:
      tags:
        - 'Account / Billing'
      summary: 'Change Subscription Plan'
      description: 'Change Subscription Plan'
      operationId: changeSubscriptionPlan
      parameters:
        -
          name: tariff
          in: query
          schema:
            type: string
            example: '1'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            examples:
              'Change Subscription Plan':
                value: ''
      responses:
        200:
          description: ''
  /a/v2/rest/public/setTrial:
    post:
      tags:
        - 'Account / Billing'
      summary: 'Start Trial'
      description: 'Start Trial'
      operationId: startTrial
      parameters:
        -
          name: tariff
          in: query
          schema:
            type: string
            example: '3'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            examples:
              'Start Trial':
                value: ''
      responses:
        200:
          description: ''
  /a/v2/rest/public/invoicesUnpaid:
    get:
      tags:
        - 'Account / Billing'
      summary: 'Get Unpaid Invoices'
      description: 'Get Unpaid Invoices'
      operationId: getUnpaidInvoices
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/payment:
    post:
      tags:
        - 'Account / Billing'
      summary: 'Initiate Payment'
      description: 'Initiate Payment'
      operationId: initiatePayment
      parameters:
        -
          name: tariff
          in: query
          schema:
            type: string
            example: '3'
        -
          name: pack
          in: query
          schema:
            type: string
            example: '3'
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            examples:
              'Initiate Payment':
                value: ''
      responses:
        200:
          description: ''
  /a/v2/rest/public/paymentStatus:
    get:
      tags:
        - 'Account / Billing'
      summary: 'Get Payment Status'
      description: 'Get Payment Status'
      operationId: getPaymentStatus
      parameters:
        -
          name: payment
          in: query
          schema:
            type: string
            example: orderID
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/onlinePaymentForm:
    get:
      tags:
        - 'Account / Billing'
      summary: 'Get Payment Checkout Data'
      description: 'Get Payment Checkout Data'
      operationId: getPaymentCheckoutData
      parameters:
        -
          name: payment
          in: query
          schema:
            type: string
            example: orderID
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/makeInvoice:
    post:
      tags:
        - 'Account / Billing'
      summary: 'Create Invoice'
      description: 'Create Invoice'
      operationId: createInvoice
      parameters:
        -
          name: payment
          in: query
          schema:
            type: string
            example: orderID
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            examples:
              'Create Invoice':
                value: ''
      responses:
        200:
          description: ''
  /a/v2/rest/public/invoice:
    get:
      tags:
        - 'Account / Billing'
      summary: 'Get Invoice'
      description: 'Get Invoice'
      operationId: getInvoice
      parameters:
        -
          name: invoice
          in: query
          schema:
            type: string
            example: invoicePeriodic
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/invoiceDocument:
    get:
      tags:
        - 'Account / Billing'
      summary: 'Get Invoice Document'
      description: 'Get Invoice Document'
      operationId: getInvoiceDocument
      parameters:
        -
          name: invoice
          in: query
          schema:
            type: string
            example: invoicePeriodic
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/invoicesPaid:
    get:
      tags:
        - 'Account / Billing'
      summary: 'Get Paid Invoices'
      description: 'Get Paid Invoices'
      operationId: getPaidInvoices
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/invoiceDelete:
    post:
      tags:
        - 'Account / Billing'
      summary: 'Delete Invoice'
      description: 'Delete Invoice'
      operationId: deleteInvoice
      parameters:
        -
          name: invoice
          in: query
          schema:
            type: string
            example: invoicePeriodic
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            examples:
              'Delete Invoice':
                value: ''
      responses:
        200:
          description: ''
  /a/v2/rest/public/getSettings:
    get:
      tags:
        - 'Account / Platform Configuration'
      summary: 'Get Configuration'
      description: |-
        Returns your company-level settings list. 

        - if successful you will receive your company-level settings list
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getConfiguration
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { acceptinvitations: { type: object, properties: { explanation: { type: string, example: 'Allows carriers to invite your company to cooperation.' }, title: { type: string, example: 'Accept Partnership Invitations' }, values: { type: array, items: { type: boolean, example: false }, example: [false] } } }, acceptinvitationsemailtext: { type: object, properties: { explanation: { type: string, example: 'Specify requirements for carriers. This message will be automatically sent to potential partners requesting cooperation.' }, title: { type: string, example: 'Invitation Email Text' }, values: { type: array, items: { type: string, example: '' }, example: [''] } } }, addionalcarexpences: { type: object, properties: { explanation: { type: string, example: 'Allows accounting for additional vehicle operating costs.' }, title: { type: string, example: 'Additional Vehicle Expenses' }, values: { type: array, items: { type: boolean, example: false }, example: [false] } } }, allowautobook: { type: object, properties: { explanation: { type: string, example: 'Allows automatic booking when a published route matches carrier vehicle availability criteria.' }, title: { type: string, example: 'Allow Auto Booking' }, values: { type: array, items: { type: boolean, example: false }, example: [false] } } }, allowdistanceedit: { type: object, properties: { explanation: { type: string, example: 'Allows manual correction of route distance values stored for future reuse.' }, title: { type: string, example: 'Allow Distance Adjustment' }, values: { type: array, items: { type: boolean, example: false }, example: [false] } } }, allowunchargeoperatorconfirm: { type: object, properties: { explanation: { type: string, example: 'If enabled, carriers are allowed to confirm unloading completion.' }, title: { type: string, example: 'Allow Carrier Unloading Confirmation' }, values: { type: array, items: { type: boolean, example: true }, example: [true] } } }, bookingtime: { type: object, properties: { explanation: { type: string, example: 'Defines how long a booking remains reserved.' }, title: { type: string, example: 'Booking Time' }, values: { type: array, items: { type: number, example: 10 }, example: [10] } } }, copycategorytoload: { type: object, properties: { explanation: { type: string, example: 'Automatically copies the selected cargo category into load details.' }, title: { type: string, example: 'Copy Category to Load' }, values: { type: array, items: { type: boolean, example: false }, example: [false] } } }, deadpathallow: { type: object, properties: { explanation: { type: string, example: 'Enables tracking of empty mileage before loading.' }, title: { type: string, example: 'Empty Mileage Tracking' }, values: { type: array, items: { type: boolean, example: false }, example: [false] } } }, factfuelprice: { type: object, properties: { explanation: { type: string, example: 'Stores actual average fuel price for a selected period.' }, title: { type: string, example: 'Average Fuel Price (Actual)' }, values: { type: array, items: { type: number, example: 0 }, example: [0] } } }, forcemaxquote: { type: object, properties: { explanation: { type: string, example: 'Rejects bids exceeding the starting price if defined.' }, title: { type: string, example: 'Limit Bids by Starting Price' }, values: { type: array, items: { type: boolean, example: false }, example: [false] } } }, forcestepquotes: { type: object, properties: { explanation: { type: string, example: 'Accepts only bids matching the defined tender step increment.' }, title: { type: string, example: 'Enforce Bid Step' }, values: { type: array, items: { type: boolean, example: true }, example: [true] } } }, fuelprice: { type: object, properties: { explanation: { type: string, example: 'Defines fuel price used for calculations.' }, title: { type: string, example: 'Fuel Price' }, values: { type: array, items: { type: number, example: 0 }, example: [0] } } }, fuelpriceallow: { type: object, properties: { explanation: { type: string, example: 'Enables fuel cost accounting.' }, title: { type: string, example: 'Fuel Cost Tracking' }, values: { type: array, items: { type: boolean, example: false }, example: [false] } } }, lastissuedinvoicenumber: { type: object, properties: { explanation: { type: string, example: 'Stores the last issued invoice number used for automatic numbering.' }, title: { type: string, example: 'Last Issued Invoice Number' }, values: { type: array, items: { type: boolean, example: false }, example: [false] } } }, nds: { type: object, properties: { explanation: { type: string, example: 'Indicates whether VAT is applied.' }, title: { type: string, example: 'VAT Enabled' }, values: { type: array, items: { type: boolean, example: true }, example: [true] } } }, operatorselect: { type: object, properties: { explanation: { type: string, example: 'Allows selecting an operator during route creation.' }, title: { type: string, example: 'Operator Selection' }, values: { type: array, items: { type: boolean, example: true }, example: [true] } } }, paymenttype: { type: object, properties: { explanation: { type: string, example: 'Defines the default payment method.' }, title: { type: string, example: 'Payment Method' }, values: { type: array, items: { type: number, example: 2 }, example: [2] } } }, premiumindicate: { type: object, properties: { explanation: { type: string, example: 'Displays premium indicators for routes and tenders.' }, title: { type: string, example: 'Premium Indicator' }, values: { type: array, items: { type: boolean, example: true }, example: [true] } } }, priceriseby: { type: object, properties: { explanation: { type: string, example: 'This setting allows automatic price increases for Free routes by the specified amount at the defined interval while the route remains in Free status. When creating a route, you can choose whether automatic price increase should apply.' }, title: { type: string, example: 'Automatic Price Increase Amount' }, values: { type: array, items: { type: string, example: '' }, example: [''] } } }, priceriseevery: { type: object, properties: { explanation: { type: string, example: 'Defines how often the automatic price increase is applied.' }, title: { type: string, example: 'Price Increase Interval' }, values: { type: array, items: { type: number, example: 0 }, example: [0] } } }, prolongtenders: { type: object, properties: { explanation: { type: string, example: 'Extends tender duration automatically if a bid is received shortly before completion.' }, title: { type: string, example: 'Automatic Tender Extension' }, values: { type: array, items: { type: boolean, example: true }, example: [true] } } }, routereturnrequired: { type: object, properties: { explanation: { type: string, example: 'Requires specifying return route information when creating a route.' }, title: { type: string, example: 'Return Route Required' }, values: { type: array, items: { type: boolean, example: true }, example: [true] } } }, seekchargedetails: { type: object, properties: { explanation: { type: string, example: 'Requires carriers to provide planned vehicle arrival time during route confirmation and allows shippers to record actual loading times.' }, title: { type: string, example: 'Require Loading Time Details' }, values: { type: array, items: { type: boolean, example: true }, example: [true] } } }, showapicodeinlist: { type: object, properties: { explanation: { type: string, example: 'Displays user-defined route API codes within route lists.' }, title: { type: string, example: 'Display API Code in Lists' }, values: { type: array, items: { type: boolean, example: false }, example: [false] } } }, usercategoryrequired: { type: object, properties: { explanation: { type: string, example: 'Requires cargo category selection during route creation.' }, title: { type: string, example: 'Cargo Category Required' }, values: { type: array, items: { type: boolean, example: true }, example: [true] } } }, userroutenumberrequired: { type: object, properties: { explanation: { type: string, example: 'Requires users to specify a route number when creating a route.' }, title: { type: string, example: 'Route Number Required' }, values: { type: array, items: { type: boolean, example: false }, example: [false] } } } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { acceptinvitations: { explanation: 'Allows carriers to invite your company to cooperation.', title: 'Accept Partnership Invitations', values: [false] }, acceptinvitationsemailtext: { explanation: 'Specify requirements for carriers. This message will be automatically sent to potential partners requesting cooperation.', title: 'Invitation Email Text', values: [''] }, addionalcarexpences: { explanation: 'Allows accounting for additional vehicle operating costs.', title: 'Additional Vehicle Expenses', values: [false] }, allowautobook: { explanation: 'Allows automatic booking when a published route matches carrier vehicle availability criteria.', title: 'Allow Auto Booking', values: [false] }, allowdistanceedit: { explanation: 'Allows manual correction of route distance values stored for future reuse.', title: 'Allow Distance Adjustment', values: [false] }, allowunchargeoperatorconfirm: { explanation: 'If enabled, carriers are allowed to confirm unloading completion.', title: 'Allow Carrier Unloading Confirmation', values: [true] }, bookingtime: { explanation: 'Defines how long a booking remains reserved.', title: 'Booking Time', values: [10] }, copycategorytoload: { explanation: 'Automatically copies the selected cargo category into load details.', title: 'Copy Category to Load', values: [false] }, deadpathallow: { explanation: 'Enables tracking of empty mileage before loading.', title: 'Empty Mileage Tracking', values: [false] }, factfuelprice: { explanation: 'Stores actual average fuel price for a selected period.', title: 'Average Fuel Price (Actual)', values: [0] }, forcemaxquote: { explanation: 'Rejects bids exceeding the starting price if defined.', title: 'Limit Bids by Starting Price', values: [false] }, forcestepquotes: { explanation: 'Accepts only bids matching the defined tender step increment.', title: 'Enforce Bid Step', values: [true] }, fuelprice: { explanation: 'Defines fuel price used for calculations.', title: 'Fuel Price', values: [0] }, fuelpriceallow: { explanation: 'Enables fuel cost accounting.', title: 'Fuel Cost Tracking', values: [false] }, lastissuedinvoicenumber: { explanation: 'Stores the last issued invoice number used for automatic numbering.', title: 'Last Issued Invoice Number', values: [false] }, nds: { explanation: 'Indicates whether VAT is applied.', title: 'VAT Enabled', values: [true] }, operatorselect: { explanation: 'Allows selecting an operator during route creation.', title: 'Operator Selection', values: [true] }, paymenttype: { explanation: 'Defines the default payment method.', title: 'Payment Method', values: [2] }, premiumindicate: { explanation: 'Displays premium indicators for routes and tenders.', title: 'Premium Indicator', values: [true] }, priceriseby: { explanation: 'This setting allows automatic price increases for Free routes by the specified amount at the defined interval while the route remains in Free status. When creating a route, you can choose whether automatic price increase should apply.', title: 'Automatic Price Increase Amount', values: [''] }, priceriseevery: { explanation: 'Defines how often the automatic price increase is applied.', title: 'Price Increase Interval', values: [0] }, prolongtenders: { explanation: 'Extends tender duration automatically if a bid is received shortly before completion.', title: 'Automatic Tender Extension', values: [true] }, routereturnrequired: { explanation: 'Requires specifying return route information when creating a route.', title: 'Return Route Required', values: [true] }, seekchargedetails: { explanation: 'Requires carriers to provide planned vehicle arrival time during route confirmation and allows shippers to record actual loading times.', title: 'Require Loading Time Details', values: [true] }, showapicodeinlist: { explanation: 'Displays user-defined route API codes within route lists.', title: 'Display API Code in Lists', values: [false] }, usercategoryrequired: { explanation: 'Requires cargo category selection during route creation.', title: 'Cargo Category Required', values: [true] }, userroutenumberrequired: { explanation: 'Requires users to specify a route number when creating a route.', title: 'Route Number Required', values: [false] } }, status: success }
        403:
          description: 'Invalid Token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid Token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/apiSettings:
    get:
      tags:
        - 'Account / Platform Configuration'
      summary: 'API Settings'
      description: 'API Settings'
      operationId: apiSettings
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                login:
                  description: 'your username or email from the app'
                  type: string
                  example: '{{username}}'
                password:
                  description: 'your password from the app'
                  type: string
                  example: '{{password}}'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getAdvancedSettings:
    get:
      tags:
        - 'Account / Platform Configuration'
      summary: 'Get Advanced Settings'
      description: 'Get Advanced Settings'
      operationId: getAdvancedSettings
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: ''
          in: header
          schema:
            type: string
            example: ''
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/saveAdvancedSettings:
    post:
      tags:
        - 'Account / Platform Configuration'
      summary: 'Update Advanced Settings'
      description: 'Update Advanced Settings'
      operationId: updateAdvancedSettings
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                addionalcarexpences:
                  type: string
                  example: 'false'
                autosignFreeTransportPublish:
                  type: string
                  example: 'true'
                deadpathallow:
                  type: boolean
                  example: true
                freeTrDurationHours:
                  type: number
                  example: 2
                fuelpriceallow:
                  type: boolean
                  example: true
                onlyPartnerOpenTenders:
                  type: string
                  example: 'true'
                orderlist:
                  type: string
                  example: 'true'
            examples:
              'Update Advanced Settings':
                value:
                  addionalcarexpences: 'false'
                  autosignFreeTransportPublish: 'true'
                  deadpathallow: true
                  freeTrDurationHours: 2
                  fuelpriceallow: true
                  onlyPartnerOpenTenders: 'true'
                  orderlist: 'true'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getNotificationStatus:
    get:
      tags:
        - 'Account / Notifications & Messages'
      summary: 'Get Notification Summary'
      description: |-
        Returns the summary of notifications. Includes unread messages and routes, in which actions are required.

        - if successful you will receive all your notifications
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Endpoint returns the number of notifications and number of routes in which actions are required, but does not return messages contents or route details.
      operationId: getNotificationSummary
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: 'Success / Success, but no new notifications'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { anyOf: [{ type: object, properties: { attentionRoutes: { type: number, example: 5 }, unreadMessages: { type: number, example: 0 } } }, { type: array, items: [], example: [] }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { attentionRoutes: 5, unreadMessages: 0 }, status: success }
                'Success, but no new notifications':
                  value: { data: [], status: success }
  /a/v2/rest/public/allMessages:
    get:
      tags:
        - 'Account / Notifications & Messages'
      summary: 'Get All Messages'
      description: 'Get All Messages'
      operationId: getAllMessages
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/myNotifications:
    get:
      tags:
        - 'Account / Notifications & Messages'
      summary: 'Get Notification Settings'
      description: 'Get Notification Settings'
      operationId: getNotificationSettings
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/setMyNotifications:
    post:
      tags:
        - 'Account / Notifications & Messages'
      summary: 'Update Notification Settings'
      description: 'Update Notification Settings'
      operationId: updateNotificationSettings
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                notifications:
                  type: array
                  items: { type: object, properties: { id: { type: number, example: 113 }, media: { type: object, properties: { api: { type: boolean, example: false }, email: { type: boolean, example: true }, telegram: { type: boolean, example: false } } }, title: { type: string, example: 'Вантаж прийнято з зауваженнями' } } }
                  example: [{ id: 113, media: { api: false, email: true, telegram: false }, title: 'Вантаж прийнято з зауваженнями' }]
            examples:
              'Update Notification Settings':
                value:
                  notifications: [{ id: 113, media: { api: false, email: true, telegram: false }, title: 'Вантаж прийнято з зауваженнями' }]
      responses:
        200:
          description: ''
  '/a/v2/rest/public/unsubscribe/{unsubscribeToken}':
    post:
      tags:
        - 'Account / Notifications & Messages'
      summary: 'Unsubscribe from All Notifications'
      description: 'Unsubscribe from All Notifications'
      operationId: unsubscribeFromAllNotifications
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                actsonbaseof:
                  type: string
                  example: устава
                bankaccount:
                  type: string
                  example: '5896742345'
                bankname:
                  type: string
                  example: Приватбанк
                country:
                  type: string
                  example: '215'
                director:
                  type: string
                  example: Руденко
                directorfirstname:
                  type: string
                  example: Георгий
                directorpatronymic:
                  type: string
                  example: Владимирович
                email:
                  type: string
                  example: m.sevostianov@phleetto.uk
                factaddress:
                  type: string
                  example: 'г. Киев, ул. Симиренка, 8а, оф. 501'
                gln:
                  type: string
                  example: '0'
                ifoid:
                  type: string
                  example: '320569'
                legaladdress:
                  type: string
                  example: '02068, м.Київ, Дарницький район ВУЛИЦЯ ДРАГОМАНОВА буд. 1Б кв. 51'
                natcomid:
                  type: string
                  example: '3648901827'
                othercontactinfo:
                  type: string
                  example: 'ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ!'
                replaced_country_select_primary_key:
                  type: string
                  example: '215'
                signer:
                  type: string
                  example: Директор
                taxid:
                  type: string
                  example: '987456123997'
                telnum:
                  type: string
                  example: '+380445689887'
                title_full_ru:
                  type: string
                  example: 'Берг Денис Олегович'
                title_ru:
                  type: string
                  example: 'Берг Денис Олегович 180'
                vatid:
                  type: string
                  example: '869788'
                website:
                  type: string
                  example: 'http://logist.ua'
            examples:
              'Unsubscribe from All Notifications':
                value:
                  actsonbaseof: устава
                  bankaccount: '5896742345'
                  bankname: Приватбанк
                  country: '215'
                  director: Руденко
                  directorfirstname: Георгий
                  directorpatronymic: Владимирович
                  email: m.sevostianov@phleetto.uk
                  factaddress: 'г. Киев, ул. Симиренка, 8а, оф. 501'
                  gln: '0'
                  ifoid: '320569'
                  legaladdress: '02068, м.Київ, Дарницький район ВУЛИЦЯ ДРАГОМАНОВА буд. 1Б кв. 51'
                  natcomid: '3648901827'
                  othercontactinfo: 'ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ!'
                  replaced_country_select_primary_key: '215'
                  signer: Директор
                  taxid: '987456123997'
                  telnum: '+380445689887'
                  title_full_ru: 'Берг Денис Олегович'
                  title_ru: 'Берг Денис Олегович 180'
                  vatid: '869788'
                  website: 'http://logist.ua'
      responses:
        200:
          description: ''
    parameters:
      -
        name: unsubscribeToken
        in: path
        required: true
        schema:
          type: string
  /a/v2/rest/public/setWebHook:
    post:
      tags:
        - 'Account / Notifications & Messages'
      summary: 'Update Webhook URL'
      description: 'Update Webhook URL'
      operationId: updateWebhookUrl
      parameters:
        -
          name: ''
          in: query
          schema:
            type: string
            example: ''
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                webhookurl:
                  type: string
                  example: ''
            examples:
              'Update Webhook URL':
                value:
                  webhookurl: ''
      responses:
        200:
          description: ''
  /a/v2/rest/public/getPotentialGeographies:
    get:
      tags:
        - 'Account / Notifications & Messages'
      summary: 'Get Notification Geography Options'
      description: 'Get Notification Geography Options'
      operationId: getNotificationGeographyOptions
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/getNotificationFilter:
    get:
      tags:
        - 'Account / Notifications & Messages'
      summary: 'Get Notification Filter'
      description: 'Get Notification Filter'
      operationId: getNotificationFilter
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
    post:
      tags:
        - 'Account / Notifications & Messages'
      summary: 'Update Notification Filter'
      description: 'Update Notification Filter'
      operationId: updateNotificationFilter
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/systemDocuments:
    get:
      tags:
        - 'Reference Data / Platform Data'
      summary: 'Get Platform Legal Documents'
      description: 'Get Platform Legal Documents'
      operationId: getPlatformLegalDocuments
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                login:
                  description: 'your username or email from the app'
                  type: string
                  example: '{{username}}'
                password:
                  description: 'your password from the app'
                  type: string
                  example: '{{password}}'
      responses:
        200:
          description: ''
  /a/v2/rest/public/systemData:
    get:
      tags:
        - 'Reference Data / Platform Data'
      summary: 'Get Platform Information'
      description: 'Get Platform Information'
      operationId: getPlatformInformation
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                login:
                  description: 'your username or email from the app'
                  type: string
                  example: '{{username}}'
                password:
                  description: 'your password from the app'
                  type: string
                  example: '{{password}}'
      responses:
        200:
          description: ''
  /a/v2/rest/public/systemRequisites:
    get:
      tags:
        - 'Reference Data / Platform Data'
      summary: 'Get Platform Billing Details'
      description: 'Get Platform Billing Details'
      operationId: getPlatformBillingDetails
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                login:
                  description: 'your username or email from the app'
                  type: string
                  example: '{{username}}'
                password:
                  description: 'your password from the app'
                  type: string
                  example: '{{password}}'
      responses:
        200:
          description: ''
  /a/v2/rest/public/systemFeedback:
    post:
      tags:
        - 'Reference Data / Platform Data'
      summary: 'Submit Feedback'
      description: 'Submit Feedback'
      operationId: submitFeedback
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  type: string
                  example: 'Some message 1.12.25 14 49'
            examples:
              'Submit Feedback':
                value:
                  message: 'Some message 1.12.25 14 49'
      responses:
        200:
          description: ''
  /a/v2/rest/public/publicOffer:
    get:
      tags:
        - 'Reference Data / Platform Data'
      summary: 'Get Subscription Terms'
      description: 'Get Subscription Terms'
      operationId: getSubscriptionTerms
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/agreePublicOffer:
    post:
      tags:
        - 'Reference Data / Platform Data'
      summary: 'Accept Subscription Terms'
      description: 'Accept Subscription Terms'
      operationId: acceptSubscriptionTerms
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                agree:
                  type: string
                  example: 'true'
      responses:
        200:
          description: ''
  /a/v2/rest/public/userAgreement:
    get:
      tags:
        - 'Reference Data / Platform Data'
      summary: 'Get Terms of Service'
      description: 'Get Terms of Service'
      operationId: getTermsOfService
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                login:
                  description: 'your username or email from the app'
                  type: string
                  example: '{{username}}'
                password:
                  description: 'your password from the app'
                  type: string
                  example: '{{password}}'
      responses:
        200:
          description: ''
  /a/v2/rest/public/contactData:
    get:
      tags:
        - 'Reference Data / Platform Data'
      summary: 'Contact Data'
      description: 'Contact Data'
      operationId: contactData
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: ''
  /a/v2/rest/public/listLanguages:
    get:
      tags:
        - 'Reference Data / Lookup Data'
      summary: 'Get Languages'
      description: |-
        Returns the list of languages, supported by the app.

        (!) NOTE: Does not require JWT or static token.
      operationId: getLanguages
      responses:
        200:
          description: Success
          headers:
            Access-Control-Allow-Headers:
              schema:
                type: string
                example: 'Accept, User-Agent, Accept-Encoding, Authorization, Language, Extend, Content-Type'
            Access-Control-Allow-Methods:
              schema:
                type: string
                example: 'POST, GET, PUT, DELETE, OPTIONS'
            Access-Control-Allow-Origin:
              schema:
                type: string
                example: '*'
            Cache-Control:
              schema:
                type: string
                example: 'no-store, no-cache, must-revalidate'
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: 'Thu, 26 Feb 2026 13:48:50 GMT'
            Expires:
              schema:
                type: string
                example: 'Thu, 19 Nov 1981 08:52:00 GMT'
            Pragma:
              schema:
                type: string
                example: no-cache
            Server:
              schema:
                type: string
                example: 'nginx/1.18.0 (Ubuntu)'
            Set-Cookie:
              schema:
                type: string
                example: 'sovtes-session=96n9ho5076e2mjlfi3hjq4sorg; expires=Thu, 26-Feb-2026 23:48:50 GMT; Max-Age=36000; path=/; domain=.test.phleetto.co.uk; secure; HttpOnly'
            Strict-Transport-Security:
              schema:
                type: string
                example: max-age=31536000;
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { id: { type: string, example: ua }, title: { type: string, example: Українська }, title_iso2: { type: string, example: ukr } } }, example: [{ id: ua, title: Українська, title_iso2: ukr }, { id: en, title: English, title_iso2: eng }, { id: de, title: Deutsch, title_iso2: deu }, { id: pl, title: Polski, title_iso2: pol }, { id: sl, title: Slovenščina, title_iso2: slv }, { id: fr, title: Français, title_iso2: fra }, { id: et, title: Eesti, title_iso2: est }, { id: ru, title: Русский, title_iso2: rus }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ id: ua, title: Українська, title_iso2: ukr }, { id: en, title: English, title_iso2: eng }, { id: de, title: Deutsch, title_iso2: deu }, { id: pl, title: Polski, title_iso2: pol }, { id: sl, title: Slovenščina, title_iso2: slv }, { id: fr, title: Français, title_iso2: fra }, { id: et, title: Eesti, title_iso2: est }, { id: ru, title: Русский, title_iso2: rus }], status: success }
  /a/v2/rest/public/getMeasureUnit:
    get:
      tags:
        - 'Reference Data / Lookup Data'
      summary: 'Get Measurement Units'
      description: |-
        Returns the list of your company's unique measure units specified in the settings in the user interface. These measure units can be used to indicate the cargo quantity during the creation of route/tender.

        - if successful you will receive your company's unique measure units
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app

        (!) NOTE: Can be used only by shipper.
      operationId: getMeasurementUnits
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'The language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { id: { type: number, example: 7 }, title: { type: string, example: box } } }, example: [{ id: 7, title: box }, { id: 9, title: pallet }, { id: 773, title: GFKKTNF }, { id: 774, title: '12345/.,l' }, { id: 775, title: 'box plastic' }, { id: 776, title: 'metal GPS box' }, { id: 779, title: 'custom unit' }, { id: 780, title: 'custom unit' }, { id: 781, title: 'custom unit' }, { id: 782, title: case }, { id: 783, title: 'custom unit' }, { id: 784, title: unit }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ id: 7, title: box }, { id: 9, title: pallet }, { id: 773, title: GFKKTNF }, { id: 774, title: '12345/.,l' }, { id: 775, title: 'box plastic' }, { id: 776, title: 'metal GPS box' }, { id: 779, title: 'custom unit' }, { id: 780, title: 'custom unit' }, { id: 781, title: 'custom unit' }, { id: 782, title: case }, { id: 783, title: 'custom unit' }, { id: 784, title: unit }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getChargetype:
    get:
      tags:
        - 'Reference Data / Lookup Data'
      summary: 'Get Loading Types'
      description: |-
        Returns the available loading types.

        This is the list that contains available options that can be requested by the shipper when ordering a delivery, or can be listed as truck properties by the carrier.

        This list is useful in addition with `createRoute`/`createTender` endpoints for shipper, or `addVehicle` endpoint for carriers.

        - If successful, you will receive the list of loading types
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getLoadingTypes
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { id: { type: number, example: 7 }, title: { type: string, example: 'without rear doors' } } }, example: [{ id: 7, title: 'without rear doors' }, { id: 2, title: 'side loading' }, { id: 1, title: 'top loading' }, { id: 3, title: 'rear loading' }, { id: 4, title: 'full curtain opening' }, { id: 5, title: 'with crossbars removed' }, { id: 6, title: 'with side posts removed' }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ id: 7, title: 'without rear doors' }, { id: 2, title: 'side loading' }, { id: 1, title: 'top loading' }, { id: 3, title: 'rear loading' }, { id: 4, title: 'full curtain opening' }, { id: 5, title: 'with crossbars removed' }, { id: 6, title: 'with side posts removed' }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getFerryproperty:
    get:
      tags:
        - 'Reference Data / Lookup Data'
      summary: 'Get Vehicle Properties'
      description: |-
        Returns the available properties of the vehicle.

        This is the list that contains available options that can be requested by the shipper when ordering a delivery, or can be listed as truck properties by the carrier.

        This list is useful in addition with `createRoute`/`createTender` endpoints for shipper, or `addVehicle` endpoint for carriers.

        - If successful, you will receive the list of truck properties
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getVehicleProperties
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { id: { type: string, example: '5' }, quantifiable: { type: string, example: '' }, title: { type: string, example: 'load supports (stakes)' } } }, example: [{ id: '5', quantifiable: '', title: 'load supports (stakes)' }, { id: '6', quantifiable: '', title: 'removable side posts' }, { id: '7', quantifiable: '', title: 'rigid side walls' }, { id: '8', quantifiable: '', title: 'wooden floor' }, { id: '9', quantifiable: '', title: 'clean vehicle' }, { id: '10', quantifiable: pcs, title: pallets }, { id: '11', quantifiable: °C, title: temperature }, { id: '12', quantifiable: pcs, title: straps }, { id: '13', quantifiable: class, title: ADR }, { id: '14', quantifiable: '', title: TIR }, { id: '18', quantifiable: '', title: 'max length' }, { id: '19', quantifiable: '', title: 'max width' }, { id: '20', quantifiable: '', title: 'max height' }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ id: '5', quantifiable: '', title: 'load supports (stakes)' }, { id: '6', quantifiable: '', title: 'removable side posts' }, { id: '7', quantifiable: '', title: 'rigid side walls' }, { id: '8', quantifiable: '', title: 'wooden floor' }, { id: '9', quantifiable: '', title: 'clean vehicle' }, { id: '10', quantifiable: pcs, title: pallets }, { id: '11', quantifiable: °C, title: temperature }, { id: '12', quantifiable: pcs, title: straps }, { id: '13', quantifiable: class, title: ADR }, { id: '14', quantifiable: '', title: TIR }, { id: '18', quantifiable: '', title: 'max length' }, { id: '19', quantifiable: '', title: 'max width' }, { id: '20', quantifiable: '', title: 'max height' }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getPricefor:
    get:
      tags:
        - 'Reference Data / Lookup Data'
      summary: 'Get Pricing Modes'
      description: |-
        Get the options, for which the price for route or tender can be set. Default is for `ride` (id: 3). 

        This endpoint is useful in addition with the `createRoute`/`createTender` endpoints, because you can supply the price for kilometers, cubic meters, tons or rides. 

        This endpoint returns the list of valid options for those pricing modes.

        - If successful, you will receive the list of pricing modes
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getPricingModes
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { code: { type: string, example: tonn }, id: { type: number, example: 1 }, title: { type: string, example: 'per tonne' } } }, example: [{ code: tonn, id: 1, title: 'per tonne' }, { code: mcube, id: 2, title: 'per cubic meter' }, { code: ride, id: 3, title: 'per trip' }, { code: km, id: 4, title: 'per km' }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ code: tonn, id: 1, title: 'per tonne' }, { code: mcube, id: 2, title: 'per cubic meter' }, { code: ride, id: 3, title: 'per trip' }, { code: km, id: 4, title: 'per km' }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getCurrency:
    get:
      tags:
        - 'Reference Data / Lookup Data'
      summary: 'Get Currencies'
      description: |-
        The method shows the currencies available to the current user.

        The contents differ depending on the country of the user.

        - If successful, you will receive the list of currencies
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getCurrencies
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { currencycode: { type: string, example: uah }, key: { type: string, example: uah }, symbol: { type: string, example: ₴ }, title: { type: string, example: грн } } }, example: [{ currencycode: uah, key: uah, symbol: ₴, title: грн }, { currencycode: eur, key: eur, symbol: €, title: eur }, { currencycode: usd, key: usd, symbol: $, title: usd }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ currencycode: uah, key: uah, symbol: ₴, title: грн }, { currencycode: eur, key: eur, symbol: €, title: eur }, { currencycode: usd, key: usd, symbol: $, title: usd }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token invalid', relogin: true, status: error }
  /a/v2/rest/public/getPaymenttype:
    get:
      tags:
        - 'Reference Data / Lookup Data'
      summary: 'Get Payment Types'
      description: |-
        The method shows available payment types.

        - If successful, you will receive the list of payment types
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getPaymentTypes
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: array, items: { type: object, properties: { id: { type: number, example: 2 }, title: { type: string, example: 'Bank transfer' } } }, example: [{ id: 2, title: 'Bank transfer' }, { id: 3, title: Cash }, { id: 6, title: 'Simplified tax scheme' }] }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: [{ id: 2, title: 'Bank transfer' }, { id: 3, title: Cash }, { id: 6, title: 'Simplified tax scheme' }], status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
  /a/v2/rest/public/getFileUploadRequirements:
    get:
      tags:
        - 'Reference Data / Lookup Data'
      summary: 'Get Upload Requirements'
      description: |-
        The method shows the requirements for file upload. Note the `maxSize` and `types` parameters.

        - If successful, you will receive the requirements list 
        - If unsuccessful you will receive an error explaining the problem in the language you supplied with the header or the language set in the app
      operationId: getUploadRequirements
      parameters:
        -
          name: language
          in: header
          schema:
            type: string
            example: '{{language}}'
          description: 'the language in which you would like to receive feedback, if the authentication attempts are unsuccessful'
        -
          name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: '{token}'
          description: 'JWT access token received from the authentication endpoint.'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data: { type: object, properties: { maxSize: { type: number, example: 8388608 }, types: { type: array, items: { type: string, example: jpg }, example: [jpg, jpeg, png, bmp, gif, tif, pdf, doc, docx, xls, xlsx] } } }
                  status: { type: string, example: success }
              examples:
                Success:
                  value: { data: { maxSize: 8388608, types: [jpg, jpeg, png, bmp, gif, tif, pdf, doc, docx, xls, xlsx] }, status: success }
        403:
          description: 'Invalid token'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message: { type: string, example: 'Token is invalid' }
                  relogin: { type: boolean, example: true }
                  status: { type: string, example: error }
              examples:
                'Invalid token':
                  value: { message: 'Token is invalid', relogin: true, status: error }
components: []
tags:
  -
    name: Authorization
    description: |-
      Endpoints within the `Authorization` folder do not require a JWT access token, but do require an integration API token.

      Users with API access enabled may authenticate using their username or email address and password.

      Successful authentication returns a JWT access token, which must be included in subsequent API requests.
  -
    name: 'Routes & tenders'
    description: 'List of endpoints that allow to work with the master entities, routes and tenders.'
  -
    name: 'Routes & tenders / Shippers'
    description: 'As list of endpoints specifically for shippers. These allow to create routes, initiate tenders, confirm or reject delivery offers, ratify and decline tender delivery bids, bargain in tenders, confirm loading, soft delete routes etc.'
  -
    name: 'Routes & tenders / Shippers / Tenders'
    description: 'A list of generic tender-specific endpoints for both carriers and shippers.'
  -
    name: 'Routes & tenders / Shippers / Routes'
  -
    name: 'Routes & tenders / Shippers / Shared Operations'
  -
    name: 'Routes & tenders / Shippers / Templates'
  -
    name: 'Routes & tenders / Shippers / Stops'
  -
    name: 'Routes & tenders / Carriers'
    description: 'A list of endpoints intended specifically for carriers. These allow to react on vacant routes, offer deliveries, place bids, deny deliveries, confirm delivery checkpoints, etc.'
  -
    name: 'Routes & tenders / Carriers / Tenders'
    description: 'A list of generic tender-specific endpoints for both carriers and shippers.'
  -
    name: 'Routes & tenders / Carriers / Routes'
  -
    name: 'Routes & tenders / Carriers / Shared Operations'
  -
    name: 'Routes & tenders / Common Operations'
  -
    name: 'Routes & tenders / Common Operations / Tenders'
    description: 'A list of generic tender-specific endpoints for both carriers and shippers.'
  -
    name: 'Routes & tenders / Common Operations / Routes'
  -
    name: 'Routes & tenders / Common Operations / Routes & Tenders'
  -
    name: 'Routes & tenders / Listings'
    description: 'A list of endpoints that allow retrieval of available routes/tenders lists for monitoring and further decision making.'
  -
    name: 'Routes & tenders / Listings / Routes'
  -
    name: 'Routes & tenders / Listings / Tenders'
    description: 'A list of generic tender-specific endpoints for both carriers and shippers.'
  -
    name: 'Routes & tenders / Listings / Routes & Tenders'
  -
    name: Fleet
    description: 'A list of endpoints dedicated to work with cars, drivers, trailers etc.'
  -
    name: 'Fleet / Carriers'
    description: 'A list of endpoints intended specifically for carriers. These allow to react on vacant routes, offer deliveries, place bids, deny deliveries, confirm delivery checkpoints, etc.'
  -
    name: Account
  -
    name: 'Account / Company Profile'
  -
    name: 'Fleet / Reference Data'
    description: 'An auxiliary list of endpoints that allows both carriers and shippers to get relevant data about the state of the system, account details, partners, reference entities, etc.'
  -
    name: Partners
  -
    name: 'Partners / Payment Requests'
  -
    name: 'Partners / Partnerships'
  -
    name: 'Account / Security'
  -
    name: 'Account / User Profile'
  -
    name: 'Account / Public Profile'
  -
    name: 'Account / Account Switching'
  -
    name: 'Account / User Management'
  -
    name: 'Account / Billing'
  -
    name: 'Account / Platform Configuration'
  -
    name: 'Account / Notifications & Messages'
  -
    name: 'Reference Data'
    description: 'An auxiliary list of endpoints that allows both carriers and shippers to get relevant data about the state of the system, account details, partners, reference entities, etc.'
  -
    name: 'Reference Data / Platform Data'
  -
    name: 'Reference Data / Lookup Data'
