{ "info": { "name": "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.\n\nThe API provides access to operational workflows including:\n\n- routes and tenders\n \n- transport assignments\n \n- carriers and partners\n \n- vehicles and drivers\n \n- messages and activity logs\n \n- status updates and event notifications\n \n# About Phleetto \n\nPhleetto is a freight collaboration platform developed for operational logistics workflows including transport procurement, carrier collaboration, fleet coordination and transport execution.\n\nTo request access to the platform, contact our sales team at [https://phleetto.co.uk](https://phleetto.co.uk).\n\nPhleetto is developed by a Ukrainian team. We continue to support humanitarian initiatives in Ukraine: [https://u24.gov.ua/](https://u24.gov.ua/)\n\n## Support\n\nEmail: [office@phleetto.co.uk](https://mailto:office@phleetto.co.uk) \nPhone number: +44(0)7555573310\n\nFor incident reports, include endpoint, request, response, timestamp and error details where possible.\n\n### Scheduled maintenance window\n\nThe 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.\n\n# User types\n\nThe following user types are supported.\n\n| Role | Description | API Coverage |\n| --- | --- | --- |\n| **Shipper** | Organisation that orders transport, creates routes and tenders. | ✅ Supported |\n| **Carrier** | Organisation that proposes vehicles, participates in tenders and executes transport operations. | ✅ Supported |\n| **Forwarder** | Oversight role operating above shipper and carrier workflows. | ⌛ Planned |\n| **Admin** | Internal administrative role. | Not supported |\n| **Accountant** | Limited operational role associated with shipper organisations. | Not supported |\n| **Warehouser** | Operational role responsible for warehouse and yard activities during vehicle arrival and departure. | Not supported |\n\nRole-based access control is planned for 2027.\n\n## User Groups\n\nUsers 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.\n\nTypical use case:\n\n- a company operating both as **shipper** and **carrier**\n \n- a shipper organisation operating its own fleet\n \n- shared operational management across multiple accounts\n \n# Getting started\n\nTo access the API, you must:\n\n- have an active Phleetto account\n \n- have API access enabled for your organisation\n \n- obtain the required integration settings from: `Settings → API`\n \n## Authentication\n\nAPI 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.\n\nAdditional integration parameters, including an integration token and a MAC signing key are available in: `Settings → API`.\n\n### Session behaviour\n\nSuccessful authentication invalidates existing active sessions associated with the same user account.\n\nThis applies across:\n\n- API sessions\n \n- Android app sessions\n \n- mobile web app sessions\n \n- classic web app sessions\n \n- V3 web app sessions\n \nIntegrations should avoid sharing interactive user credentials across multiple concurrent systems where uninterrupted session continuity is required.\n\nTo assign a manager or operational owner during creation, provide the user's email address in the `userclient_email` field when calling:\n\n- `POST createRoute`\n \n- `POST createTender`\n \n## Base URLs\n\nSandbox environment: `https://test.phleetto.co.uk` \nProduction environment: `https://phleetto.uk`\n\n## Language support\n\nPrimary platform languages: English (`en`) and Ukrainian (`ua`).\n\nAdditional localisations are available for selected modules. Coverage and terminology consistency may vary.\n\nThe `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.\n\n## Rate limiting\n\nAuthentication endpoints are protected against excessive request activity. Excessive authentication behaviour may result in IP address being blocked and following errors:\n\n| Code | Meaning |\n| --- | --- |\n| `429 Too Many Requests` | Request activity limit exceeded |\n| `403 Forbidden` | Access temporarily restricted or blocked |\n\n## Typical shipper integration flow\n\nHere is an example of a typical tender procurement workflow:\n\n| Step | Operation | Endpoint |\n| --- | --- | --- |\n| 1 | Create tender | `POST createTender` |\n| 2 | Retrieve carrier bids | `GET getPricequotes` |\n| 3 | Select winning bid | `POST pickTenderWinner` |\n| 4 | Publish route for winning carrier | `POST publishTenderChild` |\n| 5 | Confirm carrier assignment | `POST ratifyOperator` |\n| 6 | Retrieve assigned driver and vehicle details | `GET getRouteFleet` |\n\nWinner selection, child route publication and assignment confirmation may alternatively be performed automatically via platform settings.\n\n# API status\n\n⚠️ This API and this documentation are currently under active development. Minor inconsistencies between documentation and platform behaviour may exist during ongoing platform updates.\n\n## API versioning and compatibility\n\nPhleetto API v2 follows a backwards-compatible versioning approach.\n\nMinor platform releases may introduce:\n\n- new endpoints\n \n- additional response fields\n \n- optional parameters\n \n- new event types\n \n- additional operational workflows\n \nExisting integrations are designed to continue operating without modification wherever possible. Breaking changes are avoided within the same major API version.\n\n# Webhooks\n\nPhleetto 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.\n\nWebhook configuration is available in: `Settings → API` and `Settings → Notifications`.\n\n## Webhook behaviour\n\nWebhook payloads notify your system that an event has occurred. Webhook payloads intentionally do not contain full operational content.\n\nFor example:\n\n- if a new document is added, the webhook will notify your system that a new document exists\n \n- the actual document content must then be retrieved via the REST API\n \nThis approach helps maintain predictable payload structures and reduces unnecessary data transfer.\n\n## Example webhook payload\n\n``` json\n{\n \"body\": {\n \"moment\": \"2025-05-10 19:15:04\",\n \"event\": 12,\n \"message\": \"Attention! New message received in route #12345-05-25 (Ukraine -> Germany).\",\n \"route\": {\n \"periodic\": \"12345-05-25\",\n \"apicode\": \"880-19100-052025\",\n \"guiurl\": \"https://phleetto.uk/a/index.php?p=view&id=12345-05-25&m=shipping\",\n \"apiurl\": \"https://phleetto.uk/a/v2/rest/public/singleRoute?route=12345-05-25\"\n }\n },\n \"signature\": \"d0c80fc9279b63f93a5b03g1d8a833de719f5766b30aad718ac58a39bbfa63c7\"\n}\n\n ```\nPayload fields:\n\n- `body.moment` Timestamp of the event in the application timezone. Default timezone: Europe/London.\n \n- `body.event` Internal identifier of the event type. See _Event reference_ below.\n \n- `body.message` Human-readable event description.\n \n- `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\n \n- `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`\n \n## Event reference\n\nEvents for shippers:\n\n| ID | Event |\n| --- | --- |\n| 2 | Transport proposal received |\n| 3 | Tender bid received |\n| 114 | Carrier accepted counteroffer |\n| 115 | Carrier declined counteroffer |\n| 107 | Tender ended |\n| 18 | Carrier confirmed assignment |\n| 8 | Selected carrier refused route execution |\n| 106 | Winning carrier refused transport execution |\n| 10 | Vehicle arrived at loading |\n| 19 | Warehouse confirmed loading |\n| 12 | Route updates requested |\n| 13 | New route message received |\n| 101 | Vehicle arrived at customs |\n| 102 | Vehicle cleared customs |\n| 103 | Vehicle arrived at the border |\n| 104 | Vehicle crossed the border |\n| 15 | Vehicle arrived at unloading |\n| 20 | Warehouse confirmed unloading |\n| 120 | Carrier confirmed unloading |\n| 25 | Partner uploaded a document to the route |\n| 113 | Delivery accepted with issues |\n\nEvents for carriers:\n\n| ID | Event |\n| --- | --- |\n| 1 | New route available |\n| 29 | New private tender received |\n| 30 | New open tender received |\n| 108 | Tender scheduled |\n| 23 | New route available under your tender |\n| 26 | Route price updated |\n| 105 | New route published exclusively for you |\n| 4 | Another carrier placed a lower bid |\n| 5 | Customer selected your bid |\n| 6 | Customer approved your transport proposal |\n| 7 | Customer declined your transport proposal |\n| 9 | Time for loading |\n| 11 | Vehicle loaded |\n| 12 | Route updated |\n| 13 | New route message received |\n| 14 | Time for unloading |\n| 16 | Vehicle unloaded |\n| 109 | Customer extended the tender |\n| 121 | Tender starting bid updated |\n| 22 | Tender you won has been completed |\n| 25 | Partner uploaded a document to the route |\n| 110 | Customer approved vehicle replacement |\n| 111 | Driver delayed at unloading |\n| 112 | Driver confirmed route completion |\n| 113 | Delivery accepted with issues |\n\n# Response codes\n\nThe API uses standard HTTP response codes to indicate the result of a request.\n\n## Success responses\n\n| Code | Meaning |\n| --- | --- |\n| `200 OK` | Request completed successfully |\n| `201 Created` | Resource created successfully |\n| `202 Accepted` | Request accepted and awaiting further action |\n| `204 No Content` | Request completed successfully with no response body |\n\n## Error responses\n\n| Code | Meaning |\n| --- | --- |\n| `400 Bad Request` | Invalid request data or validation failure |\n| `401 Unauthorized` | Missing or invalid authentication token |\n| `402 Payment Required` | An outstanding invoice is past due |\n| `403 Forbidden` | Access denied by scopes, ownership etc |\n| `406 Not Acceptable` | Request could not be processed in the requested format |\n| `424 Failed Dependency` | Upstream dependency or internal processing failure |\n| `429 Too Many Requests` | Request rate limit exceeded or too many login attempts |\n\n### Error response format\n\nError responses are returned in JSON format.\n\n``` json\n{\n \"status\": \"error\",\n \"message\": \"Invalid token\"\n}\n\n ```\n### Error response fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `status` | string | Response status (`error`) |\n| `message` | string | Human-readable error description |\n\n### `Data is corrupt` error\n\n`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.\n\n# Changelog\n\n| Version | Release Date | Highlights |\n| --- | --- | --- |\n| **v2.9.99123** | 14 May 2026 | Tender list refinements, timezone display fixes, targeted route updates, safer session handling |\n| **v2.9.99122** | 24 Apr 2026 | Route deletion compatibility, tender extension accuracy |\n| **v2.9.99121** | 17 Apr 2026 | Billing grace-period support, tender archive corrections, reference data consistency, customs data retention |\n| **v2.9.99120** | 7 Apr 2026 | Improved route time accuracy, blind tender bid counts, expanded location search, more reliable sorting |\n| **v2.9.99119** | 20 Mar 2026 | Stronger data validation, cleaner tender results, better winner chronology, expanded checkpoint details |\n| **v2.9.99118** | 12 Mar 2026 | Consistent timezone handling, message count visibility, better checkpoint tracking, blind tender note fixes |\n| **v2.9.99117** | 20 Feb 2026 | Miles-based distance support, more accurate route distance, safer token sessions, stronger tender privacy |\n| **v2.9.99116** | 9 Feb 2026 | Flexible profile settings, reliable document downloads, improved tender statuses, stronger access controls |\n| **v2.9.99115** | 25 Jan 2026 | Payment status visibility, smoother invite acceptance, more reliable uploads, more accurate route pricing |\n| **v2.9.99114** | 20 Jan 2026 | Payment request workflows, invoice and tariff tools, online payment support, profile and message updates |\n| **v2.9.99113** | 26 Dec 2025 | Webhook and notification controls, vehicle and geography tools, Telegram connection options, payment request exports |\n| **v2.9.99112** | 17 Dec 2025 | User and document setup, company profile controls, partner access management, feedback and service agreement |\n| **v2.9.99111** | 2 Dec 2025 | Partner discovery and invites, route and tender search, route change workflows, arrival estimate support |\n| **v2.9.99110** | 18 Nov 2025 | Application file downloads, partner workflow fixes, clearer award traceability, Sigfox integration |\n| **v2.9.99108** | 17 Oct 2025 | Proof-of-delivery support, open partner discovery, vehicle record updates, clearer route action labels |\n| **v2.9.99107** | 2 Oct 2025 | Accurate tender ownership, cleaner text presentation, improved opt-out handling |\n| **v2.9.99106** | 22 Sep 2025 | Stronger tender confidentiality, more reliable route lists, settings-driven behaviour, general stability improvements |\n| **v2.9.99105** | 12 Sep 2025 | Partner detail access, fleet management improvements, document add/remove support, customer-specific behaviour |\n| **v2.9.99104** | 29 Jul 2025 | Route detail enhancements, route action visibility, fleet endpoint expansion |\n| **v2.9.99103** | 21 Jul 2025 | Route grouping support, better workload organisation |\n| **v2.9.99102** | 1 Jul 2025 | Richer route detail views, more secure blind tenders, improved bookmarked tenders, better password recovery |\n| **v2.9.99101** | 16 Jun 2025 | Friendlier error messages, tender bookmarking, better bid history, token-based sign-in |\n| **v2.9.97** | 11 Jun 2025 | Current tender visibility, duplicate order prevention, tighter carrier privacy, more accurate pricing views |\n| **v2.9.99100** | 28 May 2025 | Updated tender groupings, richer route detail responses, tender deadline visibility, tender bookmarking |\n| **v2.9.99** | 12 May 2025 | New routing endpoints, distance detail visibility, better address handling, more reliable location logic |\n| **v2.9.98** | 21 Apr 2025 | Customs workflow improvements, surcharge and penalty support, clearer route deletion errors, sign-in response consistency |\n| **v2.9.96** | 28 Mar 2025 | Stronger order audit trail, safer shipment status handling |\n| **v2.9.95** | 29 Jan 2025 | Richer route list context, better booking visibility |\n| **v2.9.94** | 20 Jan 2025 | Correct tender contacts, cleaner partner communication |\n| **v2.9.93** | 13 Jan 2025 | Tender restart refinements, more accurate child budgets, legacy route creation fixes, vehicle type data support |\n| **v2.9.91** | 20 Nov 2024 | Expanded route chronology, lookup by API code |\n| **v2.9.52** | 11 Oct 2024 | Tender winner visibility, carrier details in results |\n| **v2.9.4** | 18 Sep 2024 | Recipient lookup support, simpler message addressing |\n| **v2.9.2** | 21 Aug 2024 | New companies in filters, better partner discoverability |", "version": "v2.9.99122", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Account", "item": [ { "name": "Account Switching", "item": [ { "name": "Linked Accounts", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getUserWeb", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getUserWeb" ], "query": [], "variable": [] }, "description": "Linked Accounts" }, "response": [] }, { "name": "Account Switching Token", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getUserWebToken", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getUserWebToken" ], "query": [ { "key": "token", "value": "", "description": "", "disabled": true } ], "variable": [] }, "description": "Account Switching Token" }, "response": [] } ] }, { "name": "Billing", "item": [ { "name": "Get Subscription Plans", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/tariffs", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "tariffs" ], "query": [], "variable": [] }, "description": "Get Subscription Plans" }, "response": [] }, { "name": "Change Subscription Plan", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/setTariff", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "setTariff" ], "query": [ { "key": "tariff", "value": "1", "description": "", "disabled": true } ], "variable": [] }, "description": "Change Subscription Plan", "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Start Trial", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/setTrial", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "setTrial" ], "query": [ { "key": "tariff", "value": "3", "description": "", "disabled": true } ], "variable": [] }, "description": "Start Trial", "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Unpaid Invoices", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/invoicesUnpaid", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "invoicesUnpaid" ], "query": [], "variable": [] }, "description": "Get Unpaid Invoices" }, "response": [] }, { "name": "Initiate Payment", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/payment", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "payment" ], "query": [ { "key": "tariff", "value": "3", "description": "", "disabled": true }, { "key": "pack", "value": "3", "description": "", "disabled": true } ], "variable": [] }, "description": "Initiate Payment", "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Payment Status", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/paymentStatus", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "paymentStatus" ], "query": [ { "key": "payment", "value": "orderID", "description": "", "disabled": true } ], "variable": [] }, "description": "Get Payment Status" }, "response": [] }, { "name": "Get Payment Checkout Data", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/onlinePaymentForm", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "onlinePaymentForm" ], "query": [ { "key": "payment", "value": "orderID", "description": "", "disabled": true } ], "variable": [] }, "description": "Get Payment Checkout Data" }, "response": [] }, { "name": "Create Invoice", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/makeInvoice", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "makeInvoice" ], "query": [ { "key": "payment", "value": "orderID", "description": "", "disabled": true } ], "variable": [] }, "description": "Create Invoice", "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Invoice", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/invoice", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "invoice" ], "query": [ { "key": "invoice", "value": "invoicePeriodic", "description": "", "disabled": true } ], "variable": [] }, "description": "Get Invoice" }, "response": [] }, { "name": "Get Invoice Document", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/invoiceDocument", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "invoiceDocument" ], "query": [ { "key": "invoice", "value": "invoicePeriodic", "description": "", "disabled": true } ], "variable": [] }, "description": "Get Invoice Document" }, "response": [] }, { "name": "Get Paid Invoices", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/invoicesPaid", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "invoicesPaid" ], "query": [], "variable": [] }, "description": "Get Paid Invoices" }, "response": [] }, { "name": "Delete Invoice", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/invoiceDelete", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "invoiceDelete" ], "query": [ { "key": "invoice", "value": "invoicePeriodic", "description": "", "disabled": true } ], "variable": [] }, "description": "Delete Invoice", "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Company Profile", "item": [ { "name": "Upload Document", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/addGenericDocument", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "addGenericDocument" ], "query": [], "variable": [] }, "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).\n\nNo more than 5 files can be uploaded in a single request.", "body": { "mode": "formdata", "formdata": [ { "key": "documents[]", "value": "", "description": "", "type": "text" }, { "key": "entity", "value": "company", "description": "", "type": "text" }, { "key": "entityid", "value": "hash", "description": "", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"documents\": {\n \"0-02-0a-4f9bdbbac9084f6a3e726f30462e500aaf2ae740f4d8aa924e9e7a05d08e841d_2709ed6caa8.jpg\": {\n \"size\": \"250493\",\n \"url\": \"https://test.phleetto.co.uk/uploads/Phleetto-route-43759-43a4af-0-02-0a-4f9bdbbac9084f6a3e726f30462e500aaf2ae740f4d8aa924e9e7a05d08e841d_2709ed6caa8.jpg\"\n },\n \"856 (1).pdf\": {\n \"size\": \"189441\",\n \"url\": \"https://test.phleetto.co.uk/uploads/Phleetto-route-71884-3dcba3-856 (1).pdf\"\n }\n },\n \"route\": 32676307200\n },\n \"status\": \"success\"\n}" }, { "name": "Invalid file type passed / Supplied file is infected / Too many documents supplied / Supplied document is too big", "originalRequest": [], "status": "Invalid file type passed / Supplied file is infected / Too many documents supplied / Supplied document is too big", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"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.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Company Documents", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/myDocuments", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "myDocuments" ], "query": [], "variable": [] }, "description": "Company Documents", "body": { "mode": "formdata", "formdata": [ { "key": "login", "value": "{{username}}", "description": "your username or email from the app", "type": "text" }, { "key": "password", "value": "{{password}}", "description": "your password from the app", "type": "text" } ] } }, "response": [] }, { "name": "Company Details", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/myRequisites", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "myRequisites" ], "query": [], "variable": [] }, "description": "Company Details", "body": { "mode": "formdata", "formdata": [ { "key": "login", "value": "{{username}}", "description": "your username or email from the app", "type": "text" }, { "key": "password", "value": "{{password}}", "description": "your password from the app", "type": "text" } ] } }, "response": [] }, { "name": "Update Company Details", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/updateMyRequisites", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "updateMyRequisites" ], "query": [], "variable": [] }, "description": "Update Company Details", "body": { "mode": "raw", "raw": "{\n \"actsonbaseof\": \"устава\",\n \"bankaccount\": \"5896742345\",\n \"bankname\": \"Приватбанк\",\n \"country\": \"215\",\n \"director\": \"Руденко\",\n \"directorfirstname\": \"Георгий\",\n \"directorpatronymic\": \"Владимирович\",\n \"email\": \"m.sevostianov@phleetto.uk\",\n \"factaddress\": \"г. Киев, ул. Симиренка, 8а, оф. 501\",\n \"gln\": \"0\",\n \"ifoid\": \"320569\",\n \"legaladdress\": \"02068, м.Київ, Дарницький район ВУЛИЦЯ ДРАГОМАНОВА буд. 1Б кв. 51\",\n \"natcomid\": \"3648901827\",\n \"othercontactinfo\": \"ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ!\",\n \"replaced_country_select_primary_key\": \"215\",\n \"signer\": \"Директор\",\n \"taxid\": \"987456123997\",\n \"telnum\": \"+380445689887\",\n \"title_full_ru\": \"Берг Денис Олегович\",\n \"title_ru\": \"Берг Денис Олегович 180\",\n \"vatid\": \"869788\",\n \"website\": \"http://logist.ua\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Payer Legal Entities", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getPayor", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getPayor" ], "query": [], "variable": [] }, "description": "The method shows available payor legal entities. Available only to shipper user type (usertype 1). \n\nEvery 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.\n\n- If successful, you will receive the list payor legal entities\n- 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", "body": { "mode": "formdata", "formdata": [] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"natcomid\": \"54839217\",\n \"title\": \"Northwind Logistics Ltd\"\n },\n {\n \"natcomid\": \"11223344\",\n \"title\": \"BlueRiver Transport\"\n },\n {\n \"natcomid\": \"9988776655\",\n \"title\": \"Atlas Freight Solutions\"\n },\n {\n \"natcomid\": \"\",\n \"title\": \"GreenLine Haulage\"\n },\n {\n \"natcomid\": \"6739201458\",\n \"title\": \"Redwood Supply Chain\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Carrier request error", "originalRequest": [], "status": "Carrier request error", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Action not allowed\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] } ] }, { "name": "Notifications & Messages", "item": [ { "name": "Get Notification Summary", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getNotificationStatus", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getNotificationStatus" ], "query": [], "variable": [] }, "description": "Returns the summary of notifications. Includes unread messages and routes, in which actions are required.\n\n- if successful you will receive all your notifications\n- 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\n\n(!) 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." }, "response": [ { "name": "Success / Success, but no new notifications", "originalRequest": [], "status": "Success / Success, but no new notifications", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"attentionRoutes\": 5,\n \"unreadMessages\": 0\n },\n \"status\": \"success\"\n}" } ] }, { "name": "Get All Messages", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/allMessages", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "allMessages" ], "query": [], "variable": [] }, "description": "Get All Messages" }, "response": [] }, { "name": "Get Notification Settings", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/myNotifications", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "myNotifications" ], "query": [], "variable": [] }, "description": "Get Notification Settings" }, "response": [] }, { "name": "Update Notification Settings", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/setMyNotifications", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "setMyNotifications" ], "query": [], "variable": [] }, "description": "Update Notification Settings", "body": { "mode": "raw", "raw": "{\n \"notifications\": [\n {\n \"id\": 113,\n \"media\": {\n \"api\": false,\n \"email\": true,\n \"telegram\": false\n },\n \"title\": \"Вантаж прийнято з зауваженнями\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Unsubscribe from All Notifications", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/unsubscribe/:unsubscribeToken", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "unsubscribe", ":unsubscribeToken" ], "query": [], "variable": [ { "key": "unsubscribeToken", "value": "", "description": "" } ] }, "description": "Unsubscribe from All Notifications", "body": { "mode": "raw", "raw": "{\n \"actsonbaseof\": \"устава\",\n \"bankaccount\": \"5896742345\",\n \"bankname\": \"Приватбанк\",\n \"country\": \"215\",\n \"director\": \"Руденко\",\n \"directorfirstname\": \"Георгий\",\n \"directorpatronymic\": \"Владимирович\",\n \"email\": \"m.sevostianov@phleetto.uk\",\n \"factaddress\": \"г. Киев, ул. Симиренка, 8а, оф. 501\",\n \"gln\": \"0\",\n \"ifoid\": \"320569\",\n \"legaladdress\": \"02068, м.Київ, Дарницький район ВУЛИЦЯ ДРАГОМАНОВА буд. 1Б кв. 51\",\n \"natcomid\": \"3648901827\",\n \"othercontactinfo\": \"ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ!\",\n \"replaced_country_select_primary_key\": \"215\",\n \"signer\": \"Директор\",\n \"taxid\": \"987456123997\",\n \"telnum\": \"+380445689887\",\n \"title_full_ru\": \"Берг Денис Олегович\",\n \"title_ru\": \"Берг Денис Олегович 180\",\n \"vatid\": \"869788\",\n \"website\": \"http://logist.ua\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Webhook URL", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/setWebHook", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "setWebHook" ], "query": [], "variable": [] }, "description": "Update Webhook URL", "body": { "mode": "raw", "raw": "{\n \"webhookurl\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Notification Geography Options", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getPotentialGeographies", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getPotentialGeographies" ], "query": [], "variable": [] }, "description": "Get Notification Geography Options" }, "response": [] }, { "name": "Get Notification Filter", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getNotificationFilter", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getNotificationFilter" ], "query": [], "variable": [] }, "description": "Get Notification Filter" }, "response": [] }, { "name": "Update Notification Filter", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getNotificationFilter", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getNotificationFilter" ], "query": [], "variable": [] }, "description": "Update Notification Filter" }, "response": [] } ] }, { "name": "Platform Configuration", "item": [ { "name": "Get Configuration", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getSettings", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getSettings" ], "query": [], "variable": [] }, "description": "Returns your company-level settings list. \n\n- if successful you will receive your company-level settings list\n- 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" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"acceptinvitations\": {\n \"explanation\": \"Allows carriers to invite your company to cooperation.\",\n \"title\": \"Accept Partnership Invitations\",\n \"values\": [\n false\n ]\n },\n \"acceptinvitationsemailtext\": {\n \"explanation\": \"Specify requirements for carriers. This message will be automatically sent to potential partners requesting cooperation.\",\n \"title\": \"Invitation Email Text\",\n \"values\": [\n \"\"\n ]\n },\n \"addionalcarexpences\": {\n \"explanation\": \"Allows accounting for additional vehicle operating costs.\",\n \"title\": \"Additional Vehicle Expenses\",\n \"values\": [\n false\n ]\n },\n \"allowautobook\": {\n \"explanation\": \"Allows automatic booking when a published route matches carrier vehicle availability criteria.\",\n \"title\": \"Allow Auto Booking\",\n \"values\": [\n false\n ]\n },\n \"allowdistanceedit\": {\n \"explanation\": \"Allows manual correction of route distance values stored for future reuse.\",\n \"title\": \"Allow Distance Adjustment\",\n \"values\": [\n false\n ]\n },\n \"allowunchargeoperatorconfirm\": {\n \"explanation\": \"If enabled, carriers are allowed to confirm unloading completion.\",\n \"title\": \"Allow Carrier Unloading Confirmation\",\n \"values\": [\n true\n ]\n },\n \"bookingtime\": {\n \"explanation\": \"Defines how long a booking remains reserved.\",\n \"title\": \"Booking Time\",\n \"values\": [\n 10\n ]\n },\n \"copycategorytoload\": {\n \"explanation\": \"Automatically copies the selected cargo category into load details.\",\n \"title\": \"Copy Category to Load\",\n \"values\": [\n false\n ]\n },\n \"deadpathallow\": {\n \"explanation\": \"Enables tracking of empty mileage before loading.\",\n \"title\": \"Empty Mileage Tracking\",\n \"values\": [\n false\n ]\n },\n \"factfuelprice\": {\n \"explanation\": \"Stores actual average fuel price for a selected period.\",\n \"title\": \"Average Fuel Price (Actual)\",\n \"values\": [\n 0\n ]\n },\n \"forcemaxquote\": {\n \"explanation\": \"Rejects bids exceeding the starting price if defined.\",\n \"title\": \"Limit Bids by Starting Price\",\n \"values\": [\n false\n ]\n },\n \"forcestepquotes\": {\n \"explanation\": \"Accepts only bids matching the defined tender step increment.\",\n \"title\": \"Enforce Bid Step\",\n \"values\": [\n true\n ]\n },\n \"fuelprice\": {\n \"explanation\": \"Defines fuel price used for calculations.\",\n \"title\": \"Fuel Price\",\n \"values\": [\n 0\n ]\n },\n \"fuelpriceallow\": {\n \"explanation\": \"Enables fuel cost accounting.\",\n \"title\": \"Fuel Cost Tracking\",\n \"values\": [\n false\n ]\n },\n \"lastissuedinvoicenumber\": {\n \"explanation\": \"Stores the last issued invoice number used for automatic numbering.\",\n \"title\": \"Last Issued Invoice Number\",\n \"values\": [\n false\n ]\n },\n \"nds\": {\n \"explanation\": \"Indicates whether VAT is applied.\",\n \"title\": \"VAT Enabled\",\n \"values\": [\n true\n ]\n },\n \"operatorselect\": {\n \"explanation\": \"Allows selecting an operator during route creation.\",\n \"title\": \"Operator Selection\",\n \"values\": [\n true\n ]\n },\n \"paymenttype\": {\n \"explanation\": \"Defines the default payment method.\",\n \"title\": \"Payment Method\",\n \"values\": [\n 2\n ]\n },\n \"premiumindicate\": {\n \"explanation\": \"Displays premium indicators for routes and tenders.\",\n \"title\": \"Premium Indicator\",\n \"values\": [\n true\n ]\n },\n \"priceriseby\": {\n \"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.\",\n \"title\": \"Automatic Price Increase Amount\",\n \"values\": [\n \"\"\n ]\n },\n \"priceriseevery\": {\n \"explanation\": \"Defines how often the automatic price increase is applied.\",\n \"title\": \"Price Increase Interval\",\n \"values\": [\n 0\n ]\n },\n \"prolongtenders\": {\n \"explanation\": \"Extends tender duration automatically if a bid is received shortly before completion.\",\n \"title\": \"Automatic Tender Extension\",\n \"values\": [\n true\n ]\n },\n \"routereturnrequired\": {\n \"explanation\": \"Requires specifying return route information when creating a route.\",\n \"title\": \"Return Route Required\",\n \"values\": [\n true\n ]\n },\n \"seekchargedetails\": {\n \"explanation\": \"Requires carriers to provide planned vehicle arrival time during route confirmation and allows shippers to record actual loading times.\",\n \"title\": \"Require Loading Time Details\",\n \"values\": [\n true\n ]\n },\n \"showapicodeinlist\": {\n \"explanation\": \"Displays user-defined route API codes within route lists.\",\n \"title\": \"Display API Code in Lists\",\n \"values\": [\n false\n ]\n },\n \"usercategoryrequired\": {\n \"explanation\": \"Requires cargo category selection during route creation.\",\n \"title\": \"Cargo Category Required\",\n \"values\": [\n true\n ]\n },\n \"userroutenumberrequired\": {\n \"explanation\": \"Requires users to specify a route number when creating a route.\",\n \"title\": \"Route Number Required\",\n \"values\": [\n false\n ]\n }\n },\n \"status\": \"success\"\n}" }, { "name": "Invalid Token", "originalRequest": [], "status": "Invalid Token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "API Settings", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/apiSettings", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "apiSettings" ], "query": [], "variable": [] }, "description": "API Settings", "body": { "mode": "formdata", "formdata": [ { "key": "login", "value": "{{username}}", "description": "your username or email from the app", "type": "text" }, { "key": "password", "value": "{{password}}", "description": "your password from the app", "type": "text" } ] } }, "response": [] }, { "name": "Get Advanced Settings", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getAdvancedSettings", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getAdvancedSettings" ], "query": [], "variable": [] }, "description": "Get Advanced Settings" }, "response": [] }, { "name": "Update Advanced Settings", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/saveAdvancedSettings", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "saveAdvancedSettings" ], "query": [], "variable": [] }, "description": "Update Advanced Settings", "body": { "mode": "raw", "raw": "{\n \"addionalcarexpences\": \"false\",\n \"autosignFreeTransportPublish\": \"true\",\n \"deadpathallow\": true,\n \"freeTrDurationHours\": 2,\n \"fuelpriceallow\": true,\n \"onlyPartnerOpenTenders\": \"true\",\n \"orderlist\": \"true\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Public Profile", "item": [ { "name": "Get Public Website", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/publicWebsite", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "publicWebsite" ], "query": [], "variable": [] }, "description": "Get Public Website" }, "response": [] }, { "name": "Update Public Website", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/updatePublicWebsite", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "updatePublicWebsite" ], "query": [], "variable": [] }, "description": "Update Public Website", "body": { "mode": "raw", "raw": "{\n \"cartype\": [\n 1,\n 2\n ],\n \"companyaboutphoto1label\": \"asdasd\",\n \"companyaboutphoto2label\": \"companyaboutphoto2label\",\n \"companyaboutphoto3label\": \"companyaboutphoto3label\",\n \"companydescription\": \"companydescription\",\n \"companyfoundingyear\": \"2990\",\n \"companysize\": \"1\",\n \"companytitle\": \"Test\",\n \"della\": \"della\",\n \"expeditorinsurancelimit\": \"asdasd\",\n \"facebook\": \"asdasd\",\n \"inceptionyear\": \"2222\",\n \"larditrans\": \"larditrans\",\n \"linkedin\": \"asdas\",\n \"maincellphone\": \"+380500000000\",\n \"slogan\": \"slogan\",\n \"sovtesadvantages\": \"dasdas\",\n \"sovtesdisadvantages\": \"asdasd\",\n \"telnum\": \"+380500000000\",\n \"website\": \"website\",\n \"youtube\": \"youtube\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Publish Public Website", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/publishPublicWebsite", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "publishPublicWebsite" ], "query": [], "variable": [] }, "description": "Publish Public Website", "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Security", "item": [ { "name": "Update password", "request": { "method": "PUT", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/updatePassword", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "updatePassword" ], "query": [], "variable": [] }, "description": "Update password", "body": { "mode": "raw", "raw": "{\n \"oldpassword\": \"old password\",\n \"password1\": \"new password\",\n \"password2\": \"new password\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get MFA Settings", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/userMfaSettings", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "userMfaSettings" ], "query": [], "variable": [] }, "description": "Get MFA Settings" }, "response": [] }, { "name": "Enable MFA", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/userMfaEnable", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "userMfaEnable" ], "query": [], "variable": [] }, "description": "Enable MFA", "body": { "mode": "raw", "raw": "{\n \"mfa_method\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Confirm MFA", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/userMfaConfirm", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "userMfaConfirm" ], "query": [], "variable": [] }, "description": "Confirm MFA", "body": { "mode": "raw", "raw": "{\n \"code\": \"980756\",\n \"mfa_method\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Disable MFA", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/userMfaDisable", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "userMfaDisable" ], "query": [], "variable": [] }, "description": "Disable MFA", "body": { "mode": "formdata", "formdata": [] } }, "response": [] } ] }, { "name": "User Management", "item": [ { "name": "Get Users", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/myUsers", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "myUsers" ], "query": [], "variable": [] }, "description": "Get Users", "body": { "mode": "formdata", "formdata": [ { "key": "login", "value": "{{username}}", "description": "your username or email from the app", "type": "text" }, { "key": "password", "value": "{{password}}", "description": "your password from the app", "type": "text" } ] } }, "response": [] }, { "name": "Create User", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/addUser", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "addUser" ], "query": [], "variable": [] }, "description": "Create User", "body": { "mode": "raw", "raw": "{\n \"cellnum\": \"+3805000000\",\n \"confirmation_password\": \"123456\",\n \"email\": \"addUserTest2@gmail.com\",\n \"name\": \"addUserTest5\",\n \"password\": \"123456\",\n \"username\": \"addUserTest5\",\n \"v3_frontend\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Customer Access Filters", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/partnersForUser", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "partnersForUser" ], "query": [ { "key": "id", "value": "", "description": "", "disabled": true } ], "variable": [] }, "description": "Get Customer Access Filters", "body": { "mode": "formdata", "formdata": [ { "key": "login", "value": "{{username}}", "description": "your username or email from the app", "type": "text" }, { "key": "password", "value": "{{password}}", "description": "your password from the app", "type": "text" } ] } }, "response": [] }, { "name": "Update Customer Access Filters", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/setPartnersForUser", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "setPartnersForUser" ], "query": [ { "key": "id", "value": "", "description": "", "disabled": true } ], "variable": [] }, "description": "Update Customer Access Filters", "body": { "mode": "raw", "raw": "{\n \"clienthashes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "User Profile", "item": [ { "name": "Get Current User Profile", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getUserProfile", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getUserProfile" ], "query": [], "variable": [] }, "description": "Allows you to see basic details of current user profile.\n\n- If successful you will receive details of your profile such as: avatar, client, company, country, id, language, mackey, name, usertype\n- If unsuccessful you will receive an error explaining the problem in the language you supplied with the header", "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Invalid JWT token", "originalRequest": [], "status": "Invalid JWT token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Update Personal Details", "request": { "method": "PUT", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/personalDetails", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "personalDetails" ], "query": [], "variable": [] }, "description": "Update Personal Details", "body": { "mode": "raw", "raw": "{\n \"name\": \"Harry Potter\",\n \"systemlanguage\": \"ua\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Regional Settings", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/userMeasureSettings", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "userMeasureSettings" ], "query": [], "variable": [] }, "description": "Get Regional Settings" }, "response": [] }, { "name": "Update Regional Settings", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/updateUserMeasureSettings", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "updateUserMeasureSettings" ], "query": [], "variable": [] }, "description": "Update Regional Settings", "body": { "mode": "raw", "raw": "{\n \"distance_unit\": \"km\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] } ] }, { "name": "Authorization", "item": [ { "name": "Authenticate User", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "http_origin", "value": "phleet.to", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{staticToken}}", "description": "Static API token from the API section in the application.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/auth", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "auth" ], "query": [], "variable": [] }, "description": "Primary authentication endpoint.\n\nAuthenticates a user and returns a JWT access token.\n\nSupply 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`).\n\n- On success, the authentication token is returned in `data.token`.\n \n- On failure, an error response is returned in the language specified by the `Language` request header.\n \nThe token is valid for **10 hours**. Integrations should reuse the active token and only request a new token when re-authentication is required.", "body": { "mode": "formdata", "formdata": [ { "key": "login", "value": "{{username}}", "description": "your username or email from the app", "type": "text" }, { "key": "password", "value": "{{password}}", "description": "your password from the app", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"token\": \"{{vault:json-web-token}}\"\n },\n \"status\": \"success\"\n}" }, { "name": "Incorrect user credentials / User blocked", "originalRequest": [], "status": "Incorrect user credentials / User blocked", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \" Login failed. Login / email or password entered incorrectly.\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Request Password Reset", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{staticToken}}", "description": "Static API token from the API section in the application.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/requestPasswordReset", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "requestPasswordReset" ], "query": [], "variable": [] }, "description": "Allows you to request a password reset, you will need your static token, email and phone number.\n\nSupply your email and phone number to get a recovery link at your email.\n\n- If successful, you will receive a temporary reset link to your email with a 1 time code\n- If unsuccessful, you will receive an error explaining the problem in the language you supplied with the header\n\n(!) NOTE: you can make a password reset request only once per 24 hours.", "body": { "mode": "formdata", "formdata": [ { "key": "cellnum", "value": "{{cellnum}}", "description": "your phone number from the app", "type": "text" }, { "key": "email", "value": "{{email}}", "description": "your email from the app", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"message\": \"A password reset link has been sent to your email address.\"\n },\n \"status\": \"success\"\n}" }, { "name": "User not found", "originalRequest": [], "status": "User not found", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"No such user found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Reset Password", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{staticToken}}", "description": "Static API token from the API section in the application.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/resetPassword", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "resetPassword" ], "query": [ { "key": "token", "value": "{{oneTimeCode}}", "description": "one-time code sent to your email", "disabled": true } ], "variable": [] }, "description": "Allows you to reset your password.\n\n(!) NOTE: values of `password1` and `password2` parameters must be exactly identical.\n\n- If successful, you will have reset your password and will be able to authenticate with it\n- If unsuccessful, you will receive an error explaining the problem in the language you supplied with the header", "body": { "mode": "formdata", "formdata": [ { "key": "password1", "value": "{{newPassword}}", "description": "new password", "type": "text" }, { "key": "password2", "value": "{{newPassword}}", "description": "the same new password", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"message\": \"The password has been changed successfully.\"\n },\n \"status\": \"success\"\n}" }, { "name": "Something went wrong", "originalRequest": [], "status": "Something went wrong", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Data not found.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Validate MFA", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/authValidateMfa", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "authValidateMfa" ], "query": [], "variable": [] }, "description": "Validate MFA", "body": { "mode": "raw", "raw": "{\n \"code\": \"811315\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Fleet", "item": [ { "name": "Carriers", "item": [ { "name": "Get My Drivers", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getMyDrivers", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getMyDrivers" ], "query": [], "variable": [] }, "description": "Returns the information about all the drivers within your company (name, phone number, license number, etc.) \n\n- if successful you will receive information about all the drivers within your company \n- 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\n\n(!) NOTE: Can be only used by carriers" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"car\": 3687,\n \"driverlicenseissued\": 1568246400,\n \"driverlicenseissuedby\": \"DVLA Swansea\",\n \"driverlicensenumber\": \"420335\",\n \"driverlicenseserial\": \"DVLA\",\n \"firstname\": \"Walter\",\n \"id\": 3653,\n \"inblacklist\": 0,\n \"lastname\": \"White\",\n \"maincellphone\": \"+447700900001\",\n \"passportserial\": \"UK 123321\",\n \"patronymic\": \"Hartwell\",\n \"taxid\": \"\"\n },\n {\n \"car\": 8062,\n \"driverlicenseissued\": \"DVLA London\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKA123\",\n \"firstname\": \"Jesse\",\n \"id\": 7953,\n \"inblacklist\": 0,\n \"lastname\": \"Pinkman\",\n \"maincellphone\": \"+447700900002\",\n \"passportserial\": \"UK 123456\",\n \"patronymic\": \"Bruce\",\n \"taxid\": \"\"\n },\n {\n \"car\": 8356,\n \"driverlicenseissued\": \"DVLA Manchester\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKB989\",\n \"firstname\": \"Hank\",\n \"id\": 8244,\n \"inblacklist\": 0,\n \"lastname\": \"Schrader\",\n \"maincellphone\": \"+447700900003\",\n \"passportserial\": \"\",\n \"patronymic\": \"Douglas\",\n \"taxid\": \"\"\n },\n {\n \"car\": 8357,\n \"driverlicenseissued\": \"DVLA Birmingham\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKC889\",\n \"firstname\": \"Saul\",\n \"id\": 8245,\n \"inblacklist\": 0,\n \"lastname\": \"Goodman\",\n \"maincellphone\": \"+447700900004\",\n \"passportserial\": \"\",\n \"patronymic\": \"James\",\n \"taxid\": \"\"\n },\n {\n \"car\": 8358,\n \"driverlicenseissued\": \"DVLA Leeds\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKD998\",\n \"firstname\": \"Mike\",\n \"id\": 8246,\n \"inblacklist\": 0,\n \"lastname\": \"Ehrmantraut\",\n \"maincellphone\": \"+447700900005\",\n \"passportserial\": \"\",\n \"patronymic\": \"Jonathan\",\n \"taxid\": \"\"\n },\n {\n \"car\": 9820,\n \"driverlicenseissued\": \"DVLA Bristol\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKE111\",\n \"firstname\": \"Gustavo\",\n \"id\": 9501,\n \"inblacklist\": 0,\n \"lastname\": \"Fring\",\n \"maincellphone\": \"+447700900006\",\n \"passportserial\": \"\",\n \"patronymic\": \"Alberto\",\n \"taxid\": \"\"\n },\n {\n \"car\": 13535,\n \"driverlicenseissued\": \"DVLA Liverpool\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKF222\",\n \"firstname\": \"Tuco\",\n \"id\": 12715,\n \"inblacklist\": 0,\n \"lastname\": \"Salamanca\",\n \"maincellphone\": \"+447700900007\",\n \"passportserial\": \"\",\n \"patronymic\": \"\",\n \"taxid\": \"\"\n },\n {\n \"car\": 13538,\n \"driverlicenseissued\": \"DVLA Sheffield\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKG333\",\n \"firstname\": \"Nacho\",\n \"id\": 12716,\n \"inblacklist\": 0,\n \"lastname\": \"Varga\",\n \"maincellphone\": \"+447700900008\",\n \"passportserial\": \"\",\n \"patronymic\": \"\",\n \"taxid\": \"\"\n },\n {\n \"car\": 13540,\n \"driverlicenseissued\": \"DVLA Nottingham\",\n \"driverlicenseissuedby\": \"DVLA Office\",\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKH444\",\n \"firstname\": \"Jimmy\",\n \"id\": 12717,\n \"inblacklist\": 0,\n \"lastname\": \"McGill\",\n \"maincellphone\": \"+447700900009\",\n \"passportserial\": \"\",\n \"patronymic\": \"\",\n \"taxid\": \"\"\n },\n {\n \"car\": 13541,\n \"driverlicenseissued\": 1567382400,\n \"driverlicenseissuedby\": \"DVLA Swansea\",\n \"driverlicensenumber\": \"AS789654\",\n \"driverlicenseserial\": \"UKI555\",\n \"firstname\": \"Kim\",\n \"id\": 12718,\n \"inblacklist\": 0,\n \"lastname\": \"Wexler\",\n \"maincellphone\": \"+447700900010\",\n \"passportserial\": \"\",\n \"patronymic\": \"\",\n \"taxid\": \"\"\n },\n {\n \"car\": 13543,\n \"driverlicenseissued\": \"DVLA Oxford\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKJ666\",\n \"firstname\": \"Gale\",\n \"id\": 12719,\n \"inblacklist\": 0,\n \"lastname\": \"Boetticher\",\n \"maincellphone\": \"+447700900011\",\n \"passportserial\": \"\",\n \"patronymic\": \"\",\n \"taxid\": \"\"\n },\n {\n \"car\": 13546,\n \"driverlicenseissued\": \"DVLA Reading\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKK777\",\n \"firstname\": \"Andrea\",\n \"id\": 12720,\n \"inblacklist\": 0,\n \"lastname\": \"Cantillo\",\n \"maincellphone\": \"+447700900012\",\n \"passportserial\": \"\",\n \"patronymic\": \"\",\n \"taxid\": \"\"\n },\n {\n \"car\": 13555,\n \"driverlicenseissued\": \"DVLA Cardiff\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKL888\",\n \"firstname\": \"Brock\",\n \"id\": 12724,\n \"inblacklist\": 0,\n \"lastname\": \"Molina\",\n \"maincellphone\": \"+447700900013\",\n \"passportserial\": \"\",\n \"patronymic\": \"\",\n \"taxid\": \"\"\n },\n {\n \"car\": 13559,\n \"driverlicenseissued\": \"DVLA Glasgow\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKM999\",\n \"firstname\": \"Patrick\",\n \"id\": 12727,\n \"inblacklist\": 0,\n \"lastname\": \"Kuby\",\n \"maincellphone\": \"+447700900014\",\n \"passportserial\": \"\",\n \"patronymic\": \"\",\n \"taxid\": \"\"\n },\n {\n \"car\": 13572,\n \"driverlicenseissued\": \"DVLA Edinburgh\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKN101\",\n \"firstname\": \"Bill\",\n \"id\": 12738,\n \"inblacklist\": 0,\n \"lastname\": \"Hu\",\n \"maincellphone\": \"+447700900015\",\n \"passportserial\": \"\",\n \"patronymic\": \"\",\n \"taxid\": \"\"\n },\n {\n \"car\": 13576,\n \"driverlicenseissued\": \"DVLA Newcastle\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"UKP747\",\n \"firstname\": \"Francesca\",\n \"id\": 12742,\n \"inblacklist\": 0,\n \"lastname\": \"Babineaux\",\n \"maincellphone\": \"+447700900016\",\n \"passportserial\": \"\",\n \"patronymic\": \"\",\n \"taxid\": \"\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Request by shipper", "originalRequest": [], "status": "Request by shipper", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this data\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Get My Trailers", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getMyTrailers", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getMyTrailers" ], "query": [], "variable": [] }, "description": "Returns the information about all the trailers of your company (registration number, load capacity, model, etc.)\n\n- if successful you will receive information about all the trailers within your company\n- 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\n\n(!) NOTE: Can be only used by carriers" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"axes\": 0,\n \"id\": 3709,\n \"length\": 21,\n \"loadcapacity\": 19,\n \"model\": \"SCHWARZMULLER PA-2E\",\n \"number\": \"BN08XHR\",\n \"volume\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 8120,\n \"length\": 13.6,\n \"loadcapacity\": 22,\n \"model\": null,\n \"number\": \"AA22XXH\",\n \"volume\": 86,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 8416,\n \"length\": 12,\n \"loadcapacity\": 22,\n \"model\": null,\n \"number\": \"LL99SSQ\",\n \"volume\": 89,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 8417,\n \"length\": 12,\n \"loadcapacity\": 189,\n \"model\": null,\n \"number\": \"OO77OOO\",\n \"volume\": 90,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 9704,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"model\": null,\n \"number\": \"666\",\n \"volume\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 12932,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"model\": null,\n \"number\": \"CCC\",\n \"volume\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 12933,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"model\": null,\n \"number\": \"FYVYF\",\n \"volume\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 12934,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"model\": null,\n \"number\": \"FYAP\",\n \"volume\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 12935,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"model\": null,\n \"number\": \"666\",\n \"volume\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 12936,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"model\": null,\n \"number\": \"777\",\n \"volume\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 12937,\n \"length\": 0,\n \"loadcapacity\": 20,\n \"model\": null,\n \"number\": \"YVAV\",\n \"volume\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 12941,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"model\": null,\n \"number\": \"UKPUKP\",\n \"volume\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 12944,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"model\": null,\n \"number\": \"TEST\",\n \"volume\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 12955,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"model\": null,\n \"number\": \"123\",\n \"volume\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 12959,\n \"length\": 0,\n \"loadcapacity\": 21,\n \"model\": null,\n \"number\": \"BK56NBV\",\n \"volume\": 86,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 12960,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"model\": null,\n \"number\": \"OOO\",\n \"volume\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"id\": 34906,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"model\": null,\n \"number\": \"BC\",\n \"volume\": 0,\n \"width\": 0\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Request by shipper", "originalRequest": [], "status": "Request by shipper", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this data\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Get My Trucks", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getMyCars", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getMyCars" ], "query": [], "variable": [] }, "description": "Returns information about all the trucks within your company (brand, model, registration number, etc.).\n\n- if successful you will receive information about all the trucks within your company\n- 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\n\n(!) NOTE: Can be only used by carriers." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 3687,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0.999,\n \"make\": {\n \"id\": 43,\n \"title_ru\": \"Renault\"\n },\n \"model\": \"MAGNUM 430\",\n \"number\": \"BN2582BO\",\n \"remark\": \"\",\n \"trailer\": 3709,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 8062,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 8,\n \"title_ru\": \"DAF\"\n },\n \"model\": null,\n \"number\": \"AA1122EE\",\n \"remark\": \"\",\n \"trailer\": 8120,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 8356,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 5,\n \"title_ru\": \"Chevrolet\"\n },\n \"model\": null,\n \"number\": \"RR9988GG\",\n \"remark\": \"lights too bright\",\n \"trailer\": 8416,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"optionalsplitcarstyle\",\n \"cartype\": 31,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 8357,\n \"insuredTil\": -62169984000,\n \"length\": 0.999,\n \"loadcapacity\": 0.999,\n \"make\": {\n \"id\": 7,\n \"title_ru\": \"Daewoo\"\n },\n \"model\": null,\n \"number\": \"FF6767YY\",\n \"remark\": \"\",\n \"trailer\": 8417,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0.999,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 30,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 8358,\n \"insuredTil\": -62169984000,\n \"length\": 0.999,\n \"loadcapacity\": 0.999,\n \"make\": {\n \"id\": 14,\n \"title_ru\": \"Ford\"\n },\n \"model\": null,\n \"number\": \"AA0909AO\",\n \"remark\": \"nice truck\",\n \"trailer\": null,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0.999,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 9820,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 11,\n \"title_ru\": \"ERF\"\n },\n \"model\": null,\n \"number\": \"444\",\n \"remark\": \"\",\n \"trailer\": 9704,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"optionalsplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13534,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 3,\n \"title_ru\": \"BAW\"\n },\n \"model\": null,\n \"number\": \"CCC\",\n \"remark\": \"ccc\",\n \"trailer\": 12932,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"optionalsplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13535,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 3,\n \"title_ru\": \"BAW\"\n },\n \"model\": null,\n \"number\": \"CCC\",\n \"remark\": \"ccc\",\n \"trailer\": 12932,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"optionalsplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13536,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 3,\n \"title_ru\": \"BAW\"\n },\n \"model\": null,\n \"number\": \"CCC\",\n \"remark\": \"ccc\",\n \"trailer\": 12932,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"optionalsplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13537,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 3,\n \"title_ru\": \"BAW\"\n },\n \"model\": null,\n \"number\": \"CCC\",\n \"remark\": \"ccc\",\n \"trailer\": 12932,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13538,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 6,\n \"title_ru\": \"Citroen\"\n },\n \"model\": null,\n \"number\": \"FYVAFY\",\n \"remark\": \"\",\n \"trailer\": 12933,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13539,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 5,\n \"title_ru\": \"Chevrolet\"\n },\n \"model\": null,\n \"number\": \"FYAP\",\n \"remark\": \"\",\n \"trailer\": 12934,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13540,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 5,\n \"title_ru\": \"Chevrolet\"\n },\n \"model\": null,\n \"number\": \"FYAP\",\n \"remark\": \"\",\n \"trailer\": 12934,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13541,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 3,\n \"title_ru\": \"BAW\"\n },\n \"model\": null,\n \"number\": \"666\",\n \"remark\": \"\",\n \"trailer\": 12935,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13542,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 4,\n \"title_ru\": \"CAMC\"\n },\n \"model\": null,\n \"number\": \"777\",\n \"remark\": \"\",\n \"trailer\": 12936,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13543,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 4,\n \"title_ru\": \"CAMC\"\n },\n \"model\": null,\n \"number\": \"777\",\n \"remark\": \"\",\n \"trailer\": 12936,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13544,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 4,\n \"title_ru\": \"CAMC\"\n },\n \"model\": null,\n \"number\": \"777\",\n \"remark\": \"\",\n \"trailer\": 12936,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13545,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 4,\n \"title_ru\": \"CAMC\"\n },\n \"model\": null,\n \"number\": \"777\",\n \"remark\": \"\",\n \"trailer\": 12936,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13546,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 8,\n \"title_ru\": \"DAF\"\n },\n \"model\": null,\n \"number\": \"BAY\",\n \"remark\": \"\",\n \"trailer\": 12937,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13555,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 3,\n \"title_ru\": \"BAW\"\n },\n \"model\": null,\n \"number\": \"UKPUKP\",\n \"remark\": \"\",\n \"trailer\": 12941,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13558,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 5,\n \"title_ru\": \"Chevrolet\"\n },\n \"model\": null,\n \"number\": \"TEST\",\n \"remark\": \"\",\n \"trailer\": 12944,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13559,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 5,\n \"title_ru\": \"Chevrolet\"\n },\n \"model\": null,\n \"number\": \"TEST\",\n \"remark\": \"\",\n \"trailer\": 12944,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13572,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 8,\n \"title_ru\": \"DAF\"\n },\n \"model\": null,\n \"number\": \"11221\",\n \"remark\": \"\",\n \"trailer\": 12955,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13576,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 45,\n \"title_ru\": \"Scania\"\n },\n \"model\": null,\n \"number\": \"BK5865NB\",\n \"remark\": \"\",\n \"trailer\": 12959,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 13577,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 8,\n \"title_ru\": \"DAF\"\n },\n \"model\": null,\n \"number\": \"112121\",\n \"remark\": \"\",\n \"trailer\": 12960,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"singlecarstyle\",\n \"cartype\": 14,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 15660,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0.999,\n \"make\": {\n \"id\": 12,\n \"title_ru\": \"FAW\"\n },\n \"model\": null,\n \"number\": \"AA5748BK\",\n \"remark\": \"\",\n \"trailer\": null,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"singlecarstyle\",\n \"cartype\": 18,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 15662,\n \"insuredTil\": -62169984000,\n \"length\": 0.999,\n \"loadcapacity\": 0.999,\n \"make\": {\n \"id\": 14,\n \"title_ru\": \"Ford\"\n },\n \"model\": null,\n \"number\": \"AP3455AK\",\n \"remark\": \"\",\n \"trailer\": null,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0.999,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"singlecarstyle\",\n \"cartype\": 12,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 15663,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0.999,\n \"make\": {\n \"id\": 16,\n \"title_ru\": \"Foton\"\n },\n \"model\": null,\n \"number\": \"AP3456BV\",\n \"remark\": \"\",\n \"trailer\": null,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"singlecarstyle\",\n \"cartype\": 10,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 15677,\n \"insuredTil\": -62169984000,\n \"length\": 0.999,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 6,\n \"title_ru\": \"Citroen\"\n },\n \"model\": null,\n \"number\": \"123\",\n \"remark\": \"\",\n \"trailer\": null,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0.999,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"singlecarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 15680,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 7,\n \"title_ru\": \"Daewoo\"\n },\n \"model\": null,\n \"number\": \"FYV\",\n \"remark\": \"\",\n \"trailer\": null,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"singlecarstyle\",\n \"cartype\": 4,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 15741,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0.999,\n \"make\": {\n \"id\": 8,\n \"title_ru\": \"DAF\"\n },\n \"model\": null,\n \"number\": \"AA4543BA\",\n \"remark\": \"\",\n \"trailer\": null,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"singlecarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 16039,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0.999,\n \"make\": {\n \"id\": 8,\n \"title_ru\": \"DAF\"\n },\n \"model\": null,\n \"number\": \"AP4567BK\",\n \"remark\": \"\",\n \"trailer\": null,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n },\n {\n \"axes\": 0,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": 35,\n \"cellnum\": \"380\",\n \"height\": 0,\n \"id\": 36431,\n \"insuredTil\": -62169984000,\n \"length\": 0,\n \"loadcapacity\": 0,\n \"make\": {\n \"id\": 4,\n \"title_ru\": \"CAMC\"\n },\n \"model\": null,\n \"number\": \"BYA\",\n \"remark\": \"\",\n \"trailer\": 34906,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0,\n \"weight\": 0,\n \"width\": 0\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Request by shipper", "originalRequest": [], "status": "Request by shipper", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this data\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Update Driver", "request": { "method": "PUT", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/driver/:driverId", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "driver", ":driverId" ], "query": [], "variable": [ { "key": "driverId", "value": "", "description": "" } ] }, "description": "Allow carriers to update the data of a single driver.\n\nThe actual data is passed as an object of the request body. All body params are optional.\n\n* if successful you will receive a 200 response and data will be immediately changed\n* If unsuccessful you will receive an error explaining \n the problem in the language you supplied with the header or the language \n set in the app\n\n \nRequest body params explained:\n\n| param | explanation | type |\n| --- | --- | --- |\n| lastname | Last name | string |\n| firstname | First name | string |\n| patronymic | Patronymic | string |\n| maincellphone | Direct phone number | string |\n| passportserial | Series of passport or ID | string |\n| passportnumber | Number of passport or ID | string |\n| passportissued | Date of issue of passport or id | string |\n| passportissuedby | Issuing entity of driver's license | string |\n| driverlicenseserial | Series of driver's license | string |\n| driverlicensenumber | Number of driver's license | string |\n| driverlicenseissued | Date of issue of passport or id | string |\n| driverlicenseissuedby | Issuing entity of driver's license | string |\n| taxid | National tax number | string |\n| inblacklist | Flag indicating that the driver is marked as irresponsible | bool |\n| car | ID of the car that relates to this driver | int |\n| birthdate | Date of birth in whatever format | string |\n| remark | A company-wide remark or comment | string |", "body": { "mode": "raw", "raw": "{\n \"car\": null,\n \"driverlicenseissued\": \"цу\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"УК\",\n \"firstname\": \"Тест 1\",\n \"inblacklist\": false,\n \"lastname\": \"Снова 1\",\n \"maincellphone\": \"+380637479032d\",\n \"passportissued\": \"\",\n \"passportissuedby\": \"\",\n \"passportnumber\": \"asd\",\n \"passportserial\": \"\",\n \"patronymic\": \"Водителя 1\",\n \"taxid\": \"asd\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Driver not found", "originalRequest": [], "status": "Driver not found", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Driver not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Delete Driver", "request": { "method": "DELETE", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/driver/:driverId", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "driver", ":driverId" ], "query": [], "variable": [ { "key": "driverId", "value": "", "description": "" } ] }, "description": "Allow carriers to soft delete a driver.\n\n- if successful you will receive a 200 response and data will be immediately changed\n \n- If unsuccessful you will receive an error explaining \n the problem in the language you supplied with the header or the language \n set in the app", "body": { "mode": "raw", "raw": "{\n \"car\": null,\n \"driverlicenseissued\": \"цу\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"УК\",\n \"firstname\": \"Тест 1\",\n \"inblacklist\": false,\n \"lastname\": \"Снова 1\",\n \"maincellphone\": \"+380637479032d\",\n \"passportissued\": \"\",\n \"passportissuedby\": \"\",\n \"passportnumber\": \"asd\",\n \"passportserial\": \"\",\n \"patronymic\": \"Водителя 1\",\n \"taxid\": \"asd\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Driver not found", "originalRequest": [], "status": "Driver not found", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Driver not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Update Truck", "request": { "method": "PUT", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/car/:carId", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "car", ":carId" ], "query": [], "variable": [ { "key": "carId", "value": "", "description": "" } ] }, "description": "Allow carriers to update the data of a single driver.\n\nThe actual data is passed as an object of the request body. All body params are optional.\n\n* if successful you will receive a 200 response and data will be immediately changed\n* If unsuccessful you will receive an error explaining \n the problem in the language you supplied with the header or the language \n set in the app\n\n \nRequest body params explained:\n\n| param | explanation | type |\n| --- | --- | --- |\n| lastname | Last name | string |\n| firstname | First name | string |\n| patronymic | Patronymic | string |\n| maincellphone | Direct phone number | string |\n| passportserial | Series of passport or ID | string |\n| passportnumber | Number of passport or ID | string |\n| passportissued | Date of issue of passport or id | string |\n| passportissuedby | Issuing entity of driver's license | string |\n| driverlicenseserial | Series of driver's license | string |\n| driverlicensenumber | Number of driver's license | string |\n| driverlicenseissued | Date of issue of passport or id | string |\n| driverlicenseissuedby | Issuing entity of driver's license | string |\n| taxid | National tax number | string |\n| inblacklist | Flag indicating that the driver is marked as irresponsible | bool |\n| car | ID of the car that relates to this driver | int |\n| birthdate | Date of birth in whatever format | string |\n| remark | A company-wide remark or comment | string |", "body": { "mode": "raw", "raw": "{\n \"car\": null,\n \"driverlicenseissued\": \"цу\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"УК\",\n \"firstname\": \"Тест 1\",\n \"inblacklist\": false,\n \"lastname\": \"Снова 1\",\n \"maincellphone\": \"+380637479032d\",\n \"passportissued\": \"\",\n \"passportissuedby\": \"\",\n \"passportnumber\": \"asd\",\n \"passportserial\": \"\",\n \"patronymic\": \"Водителя 1\",\n \"taxid\": \"asd\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Driver not found", "originalRequest": [], "status": "Driver not found", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Truck not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Delete Truck", "request": { "method": "DELETE", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/car/:carId", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "car", ":carId" ], "query": [], "variable": [ { "key": "carId", "value": "", "description": "" } ] }, "description": "Allow carriers to soft delete truck.\n\n- if successful you will receive a 200 response and data will be immediately changed\n \n- If unsuccessful you will receive an error explaining \n the problem in the language you supplied with the header or the language \n set in the app", "body": { "mode": "raw", "raw": "{\n \"car\": null,\n \"driverlicenseissued\": \"цу\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"УК\",\n \"firstname\": \"Тест 1\",\n \"inblacklist\": false,\n \"lastname\": \"Снова 1\",\n \"maincellphone\": \"+380637479032d\",\n \"passportissued\": \"\",\n \"passportissuedby\": \"\",\n \"passportnumber\": \"asd\",\n \"passportserial\": \"\",\n \"patronymic\": \"Водителя 1\",\n \"taxid\": \"asd\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Driver not found", "originalRequest": [], "status": "Driver not found", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Truck not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Update Trailer", "request": { "method": "PUT", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/trailer/:trailerId", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "trailer", ":trailerId" ], "query": [], "variable": [ { "key": "trailerId", "value": "", "description": "" } ] }, "description": "Allow carriers to update the data of a single driver.\n\nThe actual data is passed as an object of the request body. All body params are optional.\n\n* if successful you will receive a 200 response and data will be immediately changed\n* If unsuccessful you will receive an error explaining \n the problem in the language you supplied with the header or the language \n set in the app\n\n \nRequest body params explained:\n\n| param | explanation | type |\n| --- | --- | --- |\n| lastname | Last name | string |\n| firstname | First name | string |\n| patronymic | Patronymic | string |\n| maincellphone | Direct phone number | string |\n| passportserial | Series of passport or ID | string |\n| passportnumber | Number of passport or ID | string |\n| passportissued | Date of issue of passport or id | string |\n| passportissuedby | Issuing entity of driver's license | string |\n| driverlicenseserial | Series of driver's license | string |\n| driverlicensenumber | Number of driver's license | string |\n| driverlicenseissued | Date of issue of passport or id | string |\n| driverlicenseissuedby | Issuing entity of driver's license | string |\n| taxid | National tax number | string |\n| inblacklist | Flag indicating that the driver is marked as irresponsible | bool |\n| car | ID of the car that relates to this driver | int |\n| birthdate | Date of birth in whatever format | string |\n| remark | A company-wide remark or comment | string |", "body": { "mode": "raw", "raw": "{\n \"car\": null,\n \"driverlicenseissued\": \"цу\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"УК\",\n \"firstname\": \"Тест 1\",\n \"inblacklist\": false,\n \"lastname\": \"Снова 1\",\n \"maincellphone\": \"+380637479032d\",\n \"passportissued\": \"\",\n \"passportissuedby\": \"\",\n \"passportnumber\": \"asd\",\n \"passportserial\": \"\",\n \"patronymic\": \"Водителя 1\",\n \"taxid\": \"asd\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Driver not found", "originalRequest": [], "status": "Driver not found", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Авто не знайдено\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Delete Trailer", "request": { "method": "DELETE", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/trailer/:driverId", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "trailer", ":driverId" ], "query": [], "variable": [ { "key": "driverId", "value": "", "description": "" } ] }, "description": "Allow carriers to soft delete a trailer.\n\n- if successful you will receive a 200 response and data will be immediately changed\n \n- If unsuccessful you will receive an error explaining \n the problem in the language you supplied with the header or the language \n set in the app", "body": { "mode": "raw", "raw": "{\n \"car\": null,\n \"driverlicenseissued\": \"цу\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"УК\",\n \"firstname\": \"Тест 1\",\n \"inblacklist\": false,\n \"lastname\": \"Снова 1\",\n \"maincellphone\": \"+380637479032d\",\n \"passportissued\": \"\",\n \"passportissuedby\": \"\",\n \"passportnumber\": \"asd\",\n \"passportserial\": \"\",\n \"patronymic\": \"Водителя 1\",\n \"taxid\": \"asd\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Truck not found", "originalRequest": [], "status": "Truck not found", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Trailer not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Register Fleet Assets", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/addVehicle", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "addVehicle" ], "query": [], "variable": [] }, "description": "Allows carriers to add drivers, cars and trailers and fill up the data of those entities.\n\nThe endpoint works in 2 modes:\n\n1. **complex adding**: adding 3 entities at a time (driver, car and trailer) and linking them together (default mode)\n \n2. **entity specific**: adding a single entity (driver, car or trailer), is activated using a specific `only` param\n \n- if successful you will receive a 201 response and data will be immediately changed\n \n- If unsuccessful you will receive an error explaining \n the problem in the language you supplied with the header or the language \n set in the app\n\n \n`driver` object params:\n\n| param | required | explanation | type |\n| --- | --- | --- | --- |\n| lastname | yes | Last name | string |\n| firstname | yes | First name | string |\n| patronymic | | Patronymic | string |\n| maincellphone | yes | Direct phone number | string (>7) |\n| passportserial | | Series of passport or ID | string |\n| passportnumber | | Number of passport or ID | string |\n| passportissued | | Date of issue of passport or id | string |\n| passportissuedby | | Issuing entity of driver's license | string |\n| driverlicenseserial | yes | Series of driver's license | string |\n| driverlicensenumber | yes | Number of driver's license | string |\n| driverlicenseissued | | Date of issue of passport or id | YYYY-MM-DD |\n| driverlicenseissuedby | | Issuing entity of driver's license | string |\n| demographicid | | National demographic id | string |\n| taxid | | National tax number | string |\n| inblacklist | | Flag indicating that the driver is marked as irresponsible | bool |\n| car | | ID of the car that relates to this driver | int |\n| birthdate | | Date of birth in whatever format | string |\n| remark | | A company-wide remark or comment | string |\n\n`car` object params:\n\n| param | required | explanation | type |\n| --- | --- | --- | --- |\n| number | yes | License plate number | string |\n| 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 |\n| carbodytype | yes | ID of national registry truck types | int |\n| year_of_manufact | yes | Truck manufacturing year | YYYY |\n| vin | yes | VIN number | string |\n| weight | | Truck weight in kg | float |\n| width | yes | Truck width, in m | float |\n| length | yes | Truck length in m | |\n| height | yes | Truck height in m | float |\n| total_weight | yes | Maximum loaded truck weight, in tonns | float |\n| axes | | Number of axes | int |\n| cellnum | | Direct phone number in the truck | string |\n| make | yes | ID of the make of the truck | int |\n| make-new-form | yes | Duplicate of `make` | int |\n| model | yes | Model | string |\n| cartype | | ID of the type of truck | int |\n| insuredTil | | Insurance expiration date | YYYY-MM-DD |\n| carbase | | ID of the base point of the truck | int |\n| gpsid | | Internal GPS identifier for location tracking | string |\n| deadpath | | Minimum price of dead path, in local currency | float |\n| fullpath | | Minimum price of loaded path, in local currency | float |\n| minRoutePrice | | Minimum price of delivery, in local currency | float |\n| vehicleclass | | ID of internal user supplied truck category | int |\n| 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 |\n| 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 |\n| quantity-ferryproperty-N | | Additional data for a box property of ID N, for example, temperature requirments. Example: `quantity-ferryproperty-11: \"-5\"` | string |\n| remark | | Company-wide remark or comment about the truck. | string |\n\n`trailer` object params:\n\n| param | required | explanation | type |\n| --- | --- | --- | --- |\n| number | yes | License plate number | string |\n| loadcapacity | yes | Load capacity in tonns | float |\n| cartype | yes | ID of the trailer type | int |\n| model | yes | Model title | string |\n| make | yes | User supplied trailer make | string |\n| total_weight | yes | Maximum loaded trailer weight, in tonns | float |\n| trailerbodytype | yes | ID of national registry box type | int |\n| vin | yes | VIN number | string |\n| year_of_manufact | yes | Trailer manufacturing year | YYYY |\n| width | yes | Width in m | float |\n| height | yes | Height in m | float |\n| volume | | Volume in cubic m | float |\n| length | yes | Length in m | float |\n| weight | yes | Trailer weight in tonns | float |\n| axes | | Number of axes | int |\n| 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 |\n| 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 |\n| quantity-ferryproperty-N | | Additional data for a box property of ID N, for example, temperature requirments. Example: `quantity-ferryproperty-11: \"-5\"` | string |\n| remark | | Company-wide remark or comment about the truck. | string |", "body": { "mode": "raw", "raw": "{\n \"car\": {\n \"axes\": \"\",\n \"carbase\": \"\",\n \"carstyle\": \"optionalsplitcarstyle\",\n \"cartype\": 1,\n \"cellnum\": \"\",\n \"chargetype-0\": 1,\n \"chargetype-1\": 1,\n \"chargetype-2\": 1,\n \"chargetype-7\": 1,\n \"craft\": \"\",\n \"deadpath\": \"\",\n \"ferryproperty-0\": \"5\",\n \"ferryproperty-13\": 1,\n \"ferryproperty-14\": 1,\n \"ferryproperty-7\": 1,\n \"ferryproperty-8\": 1,\n \"fullpath\": \"\",\n \"gpsid\": \"\",\n \"insuredTil\": \"\",\n \"make-new-form\": 41,\n \"minRoutePrice\": \"\",\n \"model\": \"Consectetur volupta\",\n \"number\": 103,\n \"quantity-ferryproperty-13\": 5,\n \"remark\": \"\",\n \"vehicleclass\": \"\",\n \"vin\": \"\",\n \"weight\": \"\"\n },\n \"driver\": {\n \"birthdate\": \"\",\n \"driverlicenseissued\": \"15.06.2021\",\n \"driverlicenseissuedby\": \"Impedit sed nemo si\",\n \"driverlicensenumber\": 590,\n \"driverlicenseserial\": \"Harum repellendus Q\",\n \"firstname\": \"Stephanie\",\n \"lastname\": \"Frank 1\",\n \"maincellphone\": \"+12551452087\",\n \"passportissued\": \"\",\n \"passportissuedby\": \"\",\n \"passportnumber\": \"\",\n \"passportserial\": \"\",\n \"patronymic\": \"Perferendis aspernat\",\n \"remark\": \"\",\n \"taxid\": \"\"\n },\n \"trailer\": {\n \"axes\": \"\",\n \"cartype\": 38,\n \"chargetype-0\": \"\",\n \"chargetype-1\": 1,\n \"chargetype-2\": 1,\n \"chargetype-3\": 1,\n \"chargetype-7\": 1,\n \"ferryproperty-0\": \"\",\n \"ferryproperty-11\": 1,\n \"ferryproperty-5\": 1,\n \"ferryproperty-6\": 1,\n \"height\": \"\",\n \"length\": \"\",\n \"loadcapacity\": 50,\n \"model\": \"Numquam eu commodi u\",\n \"number\": 543,\n \"quantity-ferryproperty-11\": \"-4\",\n \"remark\": \"\",\n \"vin\": \"\",\n \"volume\": \"\",\n \"weight\": \"\",\n \"width\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success / Success (only driver)", "originalRequest": [], "status": "Success / Success (only driver)", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"allowPush\": null,\n \"birthdate\": -62169984000,\n \"car\": 39196,\n \"car_relation\": {\n \"ImeiInviteAndroid\": null,\n \"available\": null,\n \"availabledatetime\": null,\n \"availablenextroute\": 0,\n \"availableregion\": null,\n \"availabletown\": null,\n \"axes\": 0,\n \"body_type\": 1,\n \"bookedNextRouteStatus\": 0,\n \"car_id_1C\": null,\n \"carbase\": null,\n \"carmodel_id_1C\": null,\n \"carstyle\": \"optionalsplitcarstyle\",\n \"cartype\": 1,\n \"cellnum\": \"\",\n \"client\": 180,\n \"consumptionempty\": \"0.000\",\n \"consumptiongt10lte15\": \"0.000\",\n \"consumptiongt15lte20\": \"0.000\",\n \"consumptiongt20\": \"0.000\",\n \"consumptiongt5lte10\": \"0.000\",\n \"consumptionlte5\": \"0.000\",\n \"craft\": \"\",\n \"currentrouteperiodic\": \"\",\n \"dateAcceptInviteAndroid\": -62169984000,\n \"dateInviteAndroid\": -62169984000,\n \"deadpath\": \"0.00\",\n \"deleted\": 0,\n \"driver\": null,\n \"expeditorClient\": null,\n \"expense10descr\": \"\",\n \"expense10sum\": \"0.00\",\n \"expense1descr\": \"\",\n \"expense1sum\": \"0.00\",\n \"expense2descr\": \"\",\n \"expense2sum\": \"0.00\",\n \"expense3descr\": \"\",\n \"expense3sum\": \"0.00\",\n \"expense4descr\": \"\",\n \"expense4sum\": \"0.00\",\n \"expense5descr\": \"\",\n \"expense5sum\": \"0.00\",\n \"expense6descr\": \"\",\n \"expense6sum\": \"0.00\",\n \"expense7descr\": \"\",\n \"expense7sum\": \"0.00\",\n \"expense8descr\": \"\",\n \"expense8sum\": \"0.00\",\n \"expense9descr\": \"\",\n \"expense9sum\": \"0.00\",\n \"factclient\": null,\n \"forbidedit\": 0,\n \"fullpath\": \"0.00\",\n \"gpsid\": null,\n \"gpsprovider\": 0,\n \"gpsstatus\": \"\",\n \"height\": \"5.000\",\n \"id\": 39196,\n \"idhash\": \"e6659b3056627af11246faa24c164e5a\",\n \"insuredTil\": -62169984000,\n \"latit\": \"0.000000000000000\",\n \"length\": \"20.000\",\n \"loadcapacity\": \"0.000\",\n \"longit\": \"0.000000000000000\",\n \"make\": 41,\n \"minrouteprice\": \"0.00\",\n \"model\": \"Consectetur volupta\",\n \"nextrouteid\": null,\n \"number\": \"AA1033BB\",\n \"ratify\": 1,\n \"remark\": \"\",\n \"seenbyadmin\": 0,\n \"telnum\": \"\",\n \"total_weight\": \"20.000\",\n \"trailer\": 37347,\n \"trailer_relation\": {\n \"axes\": 0,\n \"body_type\": 1,\n \"cartype\": 38,\n \"client\": 180,\n \"deleted\": 0,\n \"forbidedit\": 0,\n \"height\": \"5.000\",\n \"id\": 37347,\n \"insuredTil\": -62169984000,\n \"length\": \"20.000\",\n \"loadcapacity\": \"50.000\",\n \"make\": \"1\",\n \"model\": \"Numquam eu commodi u\",\n \"number\": \"543\",\n \"ratify\": 1,\n \"remark\": \"\",\n \"seenbyadmin\": 0,\n \"total_weight\": \"12.000\",\n \"trailer_id_1C\": null,\n \"trailermodel_id_1C\": null,\n \"vin\": \"09876890\",\n \"volume\": \"0.000\",\n \"weight\": \"0.000\",\n \"width\": \"4.000\",\n \"year_of_manufact\": 2000\n },\n \"userInviteAndroid\": null,\n \"vehicleclass\": null,\n \"vin\": \"123123\",\n \"volume\": \"0.000\",\n \"weight\": \"0.000\",\n \"width\": \"4.000\",\n \"year_of_manufact\": 2000\n },\n \"client\": 180,\n \"contactinfo\": \"\",\n \"deleted\": 0,\n \"driver_id_1C\": null,\n \"driverlicenseissued\": 1620172800,\n \"driverlicenseissuedby\": \"Impedit sed nemo si\",\n \"driverlicensenumber\": \"590\",\n \"driverlicenseserial\": \"Harum repellendus Q\",\n \"firstname\": \"Stephanie\",\n \"forbidedit\": 0,\n \"hired\": 0,\n \"id\": 37033,\n \"inblacklist\": null,\n \"invitationdetails\": null,\n \"invitationstatus\": null,\n \"language\": null,\n \"lastname\": \"Frank 1\",\n \"maincellphone\": \"+380501112233\",\n \"passportissued\": \"\",\n \"passportissuedby\": \"\",\n \"passportnumber\": \"\",\n \"passportserial\": \"\",\n \"patronymic\": \"\",\n \"ratify\": 1,\n \"seenbyadmin\": 0,\n \"taxid\": \"\",\n \"vacant\": 0\n },\n \"status\": \"success\"\n}" }, { "name": "Request by shipper / Incorrect \"only\" param / Missing required params", "originalRequest": [], "status": "Request by shipper / Incorrect \"only\" param / Missing required params", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Wrong param only\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Create Fleet Group", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/addVehicleClass", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "addVehicleClass" ], "query": [], "variable": [] }, "description": "Create Fleet Group", "body": { "mode": "raw", "raw": "{\n \"vehicleclass\": \"test2\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Fleet Groups", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getVehicleClasses", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getVehicleClasses" ], "query": [], "variable": [] }, "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\n\n- if successful you will receive your vehicle classes\n\n- 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" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": 63,\n \"title\": \"DesertEagle\"\n },\n {\n \"id\": 62,\n \"title\": \"Mustang\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Operation is not available (request by shipper)", "originalRequest": [], "status": "Operation is not available (request by shipper)", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Invalid action\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Create Home Depot", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/addCarbase", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "addCarbase" ], "query": [], "variable": [] }, "description": "Create Home Depot", "body": { "mode": "raw", "raw": "{\n \"address\": \"Hürriyet, 48439 Sk, 33000 Mezitli/Mersin\",\n \"carbase\": \"Test\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Home Depots", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getVehicleBases", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getVehicleBases" ], "query": [], "variable": [] }, "description": "Returns all vehicle bases of current user company that are set in the app in the settings section.\n\n- if successful you will receive your vehicle classes\n \n- 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" }, "response": [ { "name": "Operation is not available (request by shipper)", "originalRequest": [], "status": "Operation is not available (request by shipper)", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Invalid action\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Delete Documents", "request": { "method": "DELETE", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/document/", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "document" ], "query": [ { "key": "documentids", "value": "12663,12664", "description": "Int. Required.", "disabled": true } ], "variable": [] }, "description": "Allow carriers to soft delete a trailer.\n\n- if successful you will receive a 200 response and data will be immediately changed\n \n- If unsuccessful you will receive an error explaining \n the problem in the language you supplied with the header or the language \n set in the app", "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Not allowed", "originalRequest": [], "status": "Not allowed", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to delete one or more of the provided documents.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] } ] }, { "name": "Reference Data", "item": [ { "name": "Get Vehicle Types", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCartype", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCartype" ], "query": [], "variable": [] }, "description": "Returns the list of truck or trailer types available in the app.\n\n- if successful you will receive all truck or trailer types available in the app\n- 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", "body": { "mode": "formdata", "formdata": [] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"6\",\n \"title\": \"bus (passenger + freight)\"\n },\n {\n \"id\": \"7\",\n \"title\": \"luxury coach\"\n },\n {\n \"id\": \"8\",\n \"title\": \"car transporter\"\n },\n {\n \"id\": \"9\",\n \"title\": \"mobile crane\"\n },\n {\n \"id\": \"10\",\n \"title\": \"fuel tanker\"\n },\n {\n \"id\": \"11\",\n \"title\": \"bitumen tanker\"\n },\n {\n \"id\": \"12\",\n \"title\": \"flatbed\"\n },\n {\n \"id\": \"48\",\n \"title\": \"light van (Gazelle-type)\"\n },\n {\n \"id\": \"56\",\n \"title\": \"dual-zone refrigerated trailer\"\n },\n {\n \"id\": \"13\",\n \"title\": \"grain truck\"\n },\n {\n \"id\": \"14\",\n \"title\": \"isothermal box\"\n },\n {\n \"id\": \"15\",\n \"title\": \"container\"\n },\n {\n \"id\": \"16\",\n \"title\": \"container carrier\"\n },\n {\n \"id\": \"2\",\n \"title\": \"box / enclosed\"\n },\n {\n \"id\": \"54\",\n \"title\": \"low-loader trailer (bed trailer)\"\n },\n {\n \"id\": \"18\",\n \"title\": \"timber truck\"\n },\n {\n \"id\": \"19\",\n \"title\": \"any\"\n },\n {\n \"id\": \"21\",\n \"title\": \"furniture van\"\n },\n {\n \"id\": \"22\",\n \"title\": \"minibus\"\n },\n {\n \"id\": \"49\",\n \"title\": \"cargo van\"\n },\n {\n \"id\": \"23\",\n \"title\": \"flour tanker\"\n },\n {\n \"id\": \"24\",\n \"title\": \"oversize / abnormal load\"\n },\n {\n \"id\": \"25\",\n \"title\": \"open\"\n },\n {\n \"id\": \"26\",\n \"title\": \"panel carrier\"\n },\n {\n \"id\": \"27\",\n \"title\": \"platform\"\n },\n {\n \"id\": \"50\",\n \"title\": \"trailer with hydraulic tail lift\"\n },\n {\n \"id\": \"53\",\n \"title\": \"poultry truck\"\n },\n {\n \"id\": \"5\",\n \"title\": \"refrigerated (reefer)\"\n },\n {\n \"id\": \"29\",\n \"title\": \"tipper\"\n },\n {\n \"id\": \"30\",\n \"title\": \"livestock truck\"\n },\n {\n \"id\": \"31\",\n \"title\": \"special purpose vehicle\"\n },\n {\n \"id\": \"47\",\n \"title\": \"glass carrier\"\n },\n {\n \"id\": \"1\",\n \"title\": \"curtain sider\"\n },\n {\n \"id\": \"33\",\n \"title\": \"low-loader (step-frame)\"\n },\n {\n \"id\": \"34\",\n \"title\": \"pipe carrier\"\n },\n {\n \"id\": \"35\",\n \"title\": \"tractor unit\"\n },\n {\n \"id\": \"4\",\n \"title\": \"box van (all-metal)\"\n },\n {\n \"id\": \"37\",\n \"title\": \"plastic-bodied van\"\n },\n {\n \"id\": \"38\",\n \"title\": \"cement tanker\"\n },\n {\n \"id\": \"46\",\n \"title\": \"gas tanker\"\n },\n {\n \"id\": \"39\",\n \"title\": \"food-grade tanker\"\n },\n {\n \"id\": \"51\",\n \"title\": \"steam-jacketed tanker\"\n },\n {\n \"id\": \"40\",\n \"title\": \"chemical tanker\"\n },\n {\n \"id\": \"45\",\n \"title\": \"tipper\"\n },\n {\n \"id\": \"41\",\n \"title\": \"recovery truck\"\n },\n {\n \"id\": \"42\",\n \"title\": \"excavator\"\n },\n {\n \"id\": \"52\",\n \"title\": \"boat / yacht transporter\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Vehicle Manufacturers", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCarMake", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCarMake" ], "query": [], "variable": [] }, "description": "Returns the list of truck/trailer manufacturing companies available in the app.\n\n- if successful you will receive all truck/trailer manufacturing companies available in the app\n- 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" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"Avia\"\n },\n {\n \"id\": 2,\n \"title\": \"Barkas\"\n },\n {\n \"id\": 3,\n \"title\": \"BAW\"\n },\n {\n \"id\": 4,\n \"title\": \"CAMC\"\n },\n {\n \"id\": 5,\n \"title\": \"Chevrolet\"\n },\n {\n \"id\": 6,\n \"title\": \"Citroen\"\n },\n {\n \"id\": 7,\n \"title\": \"Daewoo\"\n },\n {\n \"id\": 8,\n \"title\": \"DAF\"\n },\n {\n \"id\": 9,\n \"title\": \"Dongfeng\"\n },\n {\n \"id\": 10,\n \"title\": \"Eagle\"\n },\n {\n \"id\": 11,\n \"title\": \"ERF\"\n },\n {\n \"id\": 12,\n \"title\": \"FAW\"\n },\n {\n \"id\": 13,\n \"title\": \"Fiat\"\n },\n {\n \"id\": 14,\n \"title\": \"Ford\"\n },\n {\n \"id\": 15,\n \"title\": \"Forland\"\n },\n {\n \"id\": 16,\n \"title\": \"Foton\"\n },\n {\n \"id\": 17,\n \"title\": \"Freightliner\"\n },\n {\n \"id\": 18,\n \"title\": \"GMC\"\n },\n {\n \"id\": 19,\n \"title\": \"Groz\"\n },\n {\n \"id\": 20,\n \"title\": \"Hino\"\n },\n {\n \"id\": 21,\n \"title\": \"Howo\"\n },\n {\n \"id\": 22,\n \"title\": \"Hyundai\"\n },\n {\n \"id\": 23,\n \"title\": \"IFA\"\n },\n {\n \"id\": 24,\n \"title\": \"International\"\n },\n {\n \"id\": 25,\n \"title\": \"Isuzu\"\n },\n {\n \"id\": 26,\n \"title\": \"Iveco\"\n },\n {\n \"id\": 27,\n \"title\": \"JAC\"\n },\n {\n \"id\": 28,\n \"title\": \"Kenworth\"\n },\n {\n \"id\": 29,\n \"title\": \"KIA\"\n },\n {\n \"id\": 30,\n \"title\": \"LDV\"\n },\n {\n \"id\": 31,\n \"title\": \"LIAZ\"\n },\n {\n \"id\": 32,\n \"title\": \"Mack\"\n },\n {\n \"id\": 33,\n \"title\": \"Magnum\"\n },\n {\n \"id\": 34,\n \"title\": \"MAN\"\n },\n {\n \"id\": 35,\n \"title\": \"Mazda\"\n },\n {\n \"id\": 36,\n \"title\": \"Mercedes-Benz\"\n },\n {\n \"id\": 37,\n \"title\": \"Mitsubishi\"\n },\n {\n \"id\": 38,\n \"title\": \"Mudan\"\n },\n {\n \"id\": 39,\n \"title\": \"Nissan\"\n },\n {\n \"id\": 40,\n \"title\": \"Opel\"\n },\n {\n \"id\": 67,\n \"title\": \"Peterbilt\"\n },\n {\n \"id\": 41,\n \"title\": \"Peugeot\"\n },\n {\n \"id\": 42,\n \"title\": \"Praga\"\n },\n {\n \"id\": 43,\n \"title\": \"Renault\"\n },\n {\n \"id\": 44,\n \"title\": \"Robur\"\n },\n {\n \"id\": 45,\n \"title\": \"Scania\"\n },\n {\n \"id\": 71,\n \"title\": \"Skoda\"\n },\n {\n \"id\": 72,\n \"title\": \"Sterling\"\n },\n {\n \"id\": 46,\n \"title\": \"Steyr\"\n },\n {\n \"id\": 47,\n \"title\": \"Tata\"\n },\n {\n \"id\": 48,\n \"title\": \"Tatra\"\n },\n {\n \"id\": 49,\n \"title\": \"Toyota\"\n },\n {\n \"id\": 50,\n \"title\": \"Volkswagen\"\n },\n {\n \"id\": 51,\n \"title\": \"Volvo\"\n },\n {\n \"id\": 66,\n \"title\": \"Western Star\"\n },\n {\n \"id\": 52,\n \"title\": \"Yuejin\"\n },\n {\n \"id\": 53,\n \"title\": \"Zuk\"\n },\n {\n \"id\": 69,\n \"title\": \"Алтай\"\n },\n {\n \"id\": 54,\n \"title\": \"БЕЛАЗ\"\n },\n {\n \"id\": 74,\n \"title\": \"Бычок\"\n },\n {\n \"id\": 55,\n \"title\": \"ГАЗ\"\n },\n {\n \"id\": 73,\n \"title\": \"Газель\"\n },\n {\n \"id\": 56,\n \"title\": \"ЗАЗ\"\n },\n {\n \"id\": 57,\n \"title\": \"ЗИЛ\"\n },\n {\n \"id\": 58,\n \"title\": \"ЗИС\"\n },\n {\n \"id\": 60,\n \"title\": \"КАЗ\"\n },\n {\n \"id\": 59,\n \"title\": \"КамАЗ\"\n },\n {\n \"id\": 61,\n \"title\": \"КРАЗ\"\n },\n {\n \"id\": 62,\n \"title\": \"МАЗ\"\n },\n {\n \"id\": 63,\n \"title\": \"РАФ\"\n },\n {\n \"id\": 64,\n \"title\": \"УАЗ\"\n },\n {\n \"id\": 65,\n \"title\": \"УРАЛ\"\n },\n {\n \"id\": 70,\n \"title\": \"Шаанхи\"\n },\n {\n \"id\": 68,\n \"title\": \"Шеньци\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] } ] } ] }, { "name": "Partners", "item": [ { "name": "Partnerships", "item": [ { "name": "Get Current Partners", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getPartners", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getPartners" ], "query": [], "variable": [] }, "description": "Get the list of legal entities with which the legal entity of the current user has direct contracts for cargo deliveries.\n\nEach element of the list contains basic details of each partner, including the hash, by which full details can be queried using the `getCompany` endpoint.\n\nIf queried by a shipper, the method will return the list of carriers, and vice versa. \n\n- If successful, you will receive the list of partner legal entities\n- 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", "body": { "mode": "formdata", "formdata": [] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"blocked\": true,\n \"clientHash\": \"588a6b0ff42a6c39834c80dfc9fb38ba\",\n \"company\": 49,\n \"contract\": \"\",\n \"date\": 1472774400,\n \"dateend\": \"\",\n \"natcomid\": \"6722356984\",\n \"title\": \"Northern Freight Solutions Ltd\",\n \"type\": \"operator\"\n },\n {\n \"blocked\": false,\n \"clientHash\": \"a65e7164cbc4d08fc2f9d0a164a6dc84\",\n \"company\": 405,\n \"contract\": \"\",\n \"date\": -62169984000,\n \"dateend\": \"\",\n \"natcomid\": \"4722356984\",\n \"title\": \"Red Fox Transport Ltd\",\n \"type\": \"operator\"\n },\n {\n \"blocked\": false,\n \"clientHash\": \"321c3857d663d927239e33d87869197b\",\n \"company\": 2704,\n \"contract\": \"GH-1/2\",\n \"date\": 1422403200,\n \"dateend\": \"\",\n \"natcomid\": \"6722356984\",\n \"title\": \"Diamond Logistics Group plc\",\n \"type\": \"expeditor\"\n },\n {\n \"blocked\": false,\n \"clientHash\": \"21a797775797725b9cc5925a722e2746\",\n \"company\": 3458,\n \"contract\": \"\",\n \"date\": -62169984000,\n \"dateend\": \"\",\n \"natcomid\": \"6722356984\",\n \"title\": \"Cosmos Logistics Ltd\",\n \"type\": \"operator\"\n },\n {\n \"blocked\": false,\n \"clientHash\": \"302482b88fbe4901c7a773bcc4c5d124\",\n \"company\": 779709,\n \"contract\": \"5\",\n \"date\": 1616371200,\n \"dateend\": \"\",\n \"natcomid\": \"6722356984\",\n \"title\": \"Prime Haulage Services Ltd\",\n \"type\": \"\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Partner Company Details", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/showCompany", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "showCompany" ], "query": [ { "key": "hash", "value": "{{companyHash}}", "description": "Internal unique hash of the legal entity.", "disabled": true } ], "variable": [] }, "description": "Return the data about a legal entity, identified by the `companyHash`.\n\n- If successful, you will receive the details of the legal entity passed\n- 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\n\n(!) 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." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"actsonbaseof\": \"power of attorney\",\n \"apikeyNP\": \"\",\n \"bankAccount\": \"GB29NWBK60161331926819\",\n \"bankname\": \"NatWest Bank plc\",\n \"country\": \"United Kingdom\",\n \"created\": 1394064000,\n \"director\": \"Thompson\",\n \"directorCase\": \"\",\n \"directorFirstName\": \"Michael\",\n \"directorPatronymic\": \"\",\n \"email\": \"operations@logisticanova.co.uk\",\n \"factAddress\": \"Warehouse B, Dock Gate 3, Southampton Docks, SO15 1HJ, United Kingdom\",\n \"faxnum\": \"+442380654321\",\n \"hash\": \"518a6b0fg42a6c39834c80dfc9fb38ba\",\n \"ifoid\": \"305749\",\n \"korraccount\": \"\",\n \"legalAddress\": \"Unit 4, Meridian Business Park, Southampton, SO14 5QF, United Kingdom\",\n \"logisticsRatified\": 0,\n \"logisticsRatifiedByUser\": 0,\n \"logisticsRatifiedMoment\": -62169984000,\n \"natcomid\": \"09876543\",\n \"otherContactInfo\": \"\",\n \"ownership\": \"\",\n \"registryValidated\": null,\n \"signer\": \"Head of Road Transport Operations\",\n \"signerCase\": \"\",\n \"swift\": \"NWBKGB2L\",\n \"taxid\": \"GB123456789\",\n \"telnum\": \"+442380123456\",\n \"titleFull\": \"LogisticaNova Limited\",\n \"titleRu\": \"LogisticaNova Ltd\",\n \"vatid\": \"GB123456789\",\n \"website\": \"www.logisticanova.co.uk\"\n },\n \"status\": \"success\"\n}" }, { "name": "Invalid companyHash passed", "originalRequest": [], "status": "Invalid companyHash passed", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Cannot find the company\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Block Partner", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/blockPartner", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "blockPartner" ], "query": [], "variable": [] }, "description": "Block Partner", "body": { "mode": "raw", "raw": "{\n \"clienthash\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Find Carrier Partners", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCarriersOpenForCooperation", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCarriersOpenForCooperation" ], "query": [], "variable": [] }, "description": "Find Carrier Partners" }, "response": [] }, { "name": "Find Shipper Partners", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getShippersOpenForCooperation", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getShippersOpenForCooperation" ], "query": [], "variable": [] }, "description": "Returns the summary of notifications. Includes unread messages and routes, in which actions are required.\n\n- if successful you will receive all your notifications\n- 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\n\n(!) 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." }, "response": [] }, { "name": "Send Partnership Invitation", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/inviteForCooperation", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "inviteForCooperation" ], "query": [], "variable": [] }, "description": "Returns the summary of notifications. Includes unread messages and routes, in which actions are required.\n\n- if successful you will receive all your notifications\n- 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\n\n(!) 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.", "body": { "mode": "raw", "raw": "\"{\\n \\\"clienthash\\\":{{clientHash}}\\n}\"", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Invite Company to Join Platform", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/inviteForCooperationWithSpecificUser", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "inviteForCooperationWithSpecificUser" ], "query": [], "variable": [] }, "description": "Invite Company to Join Platform", "body": { "mode": "raw", "raw": "{\n \"cellnum\": \"+380500000000\",\n \"clienthash\": \"\",\n \"contractdate\": \"01.01.2025\",\n \"contractnumber\": \"contract#1\",\n \"email\": \"dddd@dd.com\",\n \"secretcode\": \"1\",\n \"username\": \"1\",\n \"v3_frontend\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Sent Invitations", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getMyInvites", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getMyInvites" ], "query": [], "variable": [] }, "description": "Get Sent Invitations" }, "response": [] }, { "name": "Get Received Invitations", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getIncomingInvites", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getIncomingInvites" ], "query": [], "variable": [] }, "description": "Get Received Invitations" }, "response": [] }, { "name": "Get Accepted Invitations", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getMyAcceptedInvites", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getMyAcceptedInvites" ], "query": [], "variable": [] }, "description": "Get Accepted Invitations" }, "response": [] }, { "name": "Send Invitation Reminders", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/remindInvites", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "remindInvites" ], "query": [], "variable": [] }, "description": "Send Invitation Reminders" }, "response": [] }, { "name": "Accept Invitation", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/acceptInvite", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "acceptInvite" ], "query": [], "variable": [] }, "description": "Accept Invitation", "body": { "mode": "raw", "raw": "{\n \"clienthash\": \"\",\n \"reason\": \"Перевірка API accept\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Reject Invitation", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/declineInvite", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "declineInvite" ], "query": [], "variable": [] }, "description": "Reject Invitation", "body": { "mode": "raw", "raw": "{\n \"clienthash\": \"3912aaebebbfc4b0b3dd2a1d6db9a114\",\n \"reason\": \"Перевірка API decline\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Blocked Partners", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getBlockedPartners", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getBlockedPartners" ], "query": [], "variable": [] }, "description": "Get Blocked Partners" }, "response": [] }, { "name": "Unblock Partner", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/unblockPartner", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "unblockPartner" ], "query": [], "variable": [] }, "description": "Unblock Partner", "body": { "mode": "raw", "raw": "{\n \"clienthash\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Payment Requests", "item": [ { "name": "Get Eligible Routes for Payment Request", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/paymentRequestPotentialRoutes", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "paymentRequestPotentialRoutes" ], "query": [ { "key": "client", "value": "clienthash", "description": "", "disabled": true } ], "variable": [] }, "description": "Get Eligible Routes for Payment Request" }, "response": [] }, { "name": "Create Payment Request", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/paymentRequestCreate", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "paymentRequestCreate" ], "query": [], "variable": [] }, "description": "Create Payment Request", "body": { "mode": "raw", "raw": "{\n \"client\": \"{{clienthash}}\",\n \"routes\": [\n \"111-04-15\",\n \"222-04-15\",\n \"333-04-15\"\n ],\n \"title\": \"1\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Payment Request Summaries", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getPaymentRequests", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getPaymentRequests" ], "query": [], "variable": [] }, "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.\n\n**Field Descriptions:**\n\n* **status**: Indicates the success of the API call.\n* **data**: An array of payment request objects.\n * **number**: Unique identifier of the payment request.\n * **state**: Current state of the payment request (e.g., new, paid, declined, ratified).\n * **moment**: Timestamp of the payment request.\n * **uuid**: Unique identifier for the request.\n * **sum**: Total amount requested.\n * **issuer**: Entity issuing the payment request.\n * **routes**: Array of route objects associated with the payment request.\n * **apicode**: Code associated with the API.\n * **budget**: Budget allocated for the route.\n * **hash**: Hash value for the route." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"issuer\": \"provider\",\n \"moment\": 1700246452,\n \"number\": \"asodmasdasd\",\n \"routes\": [\n {\n \"apicode\": \"test-api\",\n \"budget\": 2650,\n \"hash\": \"00e22611bcaf7f64d97a75aa8d074f99\"\n },\n {\n \"apicode\": \"0.9670328488266401\",\n \"budget\": 6000,\n \"hash\": \"350689b31d5f009b3ba341945cb12d81\"\n },\n {\n \"apicode\": \"0.6557187891152862\",\n \"budget\": 5000,\n \"hash\": \"b3671908c16817aee16697e5049c89f1\"\n },\n {\n \"apicode\": \"0.001982429066656557\",\n \"budget\": 5000,\n \"hash\": \"8392c5d2d73ca8e66e11e6d20bf5ac3b\"\n },\n {\n \"apicode\": \"0.947122911873388\",\n \"budget\": 5000,\n \"hash\": \"d193a5ec8e8d27023e3c95f695c5373f\"\n },\n {\n \"apicode\": \"0.7163089632208542\",\n \"budget\": 5000,\n \"hash\": \"35c643e29439c52502bf41e08d0b9efa\"\n },\n {\n \"apicode\": \"0.23221729996820661\",\n \"budget\": 5000,\n \"hash\": \"4a1db079f0e123bfa3f86822e6d149de\"\n },\n {\n \"apicode\": \"\",\n \"budget\": 0,\n \"hash\": \"83aad578d4e5a8294ef6a32d84ae46ba\"\n },\n {\n \"apicode\": \"0.17621022479255705\",\n \"budget\": 5000,\n \"hash\": \"af54562917dc5d00bf6ad1fd38e96f15\"\n },\n {\n \"apicode\": \"0.8608113144159423\",\n \"budget\": 13454,\n \"hash\": \"486ab2ad90f2632de1372ccd6c8fa628\"\n },\n {\n \"apicode\": \"0.10723068202587839\",\n \"budget\": 7548,\n \"hash\": \"e06d41cdd713c62ee3b6cb2dbd5742a2\"\n },\n {\n \"apicode\": \"\",\n \"budget\": 7841,\n \"hash\": \"c5eccbf76ae05674a4b673f35050621d\"\n },\n {\n \"apicode\": \"123\",\n \"budget\": 5000,\n \"hash\": \"87f583c8dcc6952d09523e94c8f10f77\"\n },\n {\n \"apicode\": \"0.08158724948911672\",\n \"budget\": 5000,\n \"hash\": \"d3b7854c2948696b34b71c4aa32b12da\"\n },\n {\n \"apicode\": \"0.01728116256862987\",\n \"budget\": 5000,\n \"hash\": \"c7dd120ba457b7455df640826e5464fa\"\n },\n {\n \"apicode\": \"asdasda\",\n \"budget\": 2650,\n \"hash\": \"7f133b2a86715674a6455989d2e5058f\"\n },\n {\n \"apicode\": \"1a12f2209281e1c\",\n \"budget\": 25000,\n \"hash\": \"389efc1d5aa91fe6c955c5a0f1de5927\"\n },\n {\n \"apicode\": \"ол\",\n \"budget\": 297000,\n \"hash\": \"c0ece27c0b0e995058f9252f201b2b7a\"\n },\n {\n \"apicode\": \"фи\",\n \"budget\": 600,\n \"hash\": \"577db620755b70be0f088e510846ba15\"\n },\n {\n \"apicode\": \"unique-external-id-11212\",\n \"budget\": 0,\n \"hash\": \"191e84a2c4555141928da10a0bb015fd\"\n },\n {\n \"apicode\": \"фивфив\",\n \"budget\": 5000,\n \"hash\": \"2a667ad3e1cabf5c99ab8b29f58ad5d8\"\n },\n {\n \"apicode\": \"asd\",\n \"budget\": 1000,\n \"hash\": \"d0d3df54657663b6683ea0cf8cc84cd1\"\n }\n ],\n \"state\": \"new\",\n \"sum\": \"413743.00\",\n \"uuid\": \"302ebf7c-8568-11ee-ab72-1eee848349a0\"\n },\n {\n \"issuer\": \"provider\",\n \"moment\": 1700503396,\n \"number\": \"11kjhgasad4553\",\n \"routes\": [\n {\n \"apicode\": \"456372\",\n \"budget\": 2650,\n \"hash\": \"087b904e9577eb643fa41b92cd287494\"\n },\n {\n \"apicode\": \"\",\n \"budget\": 3666,\n \"hash\": \"0d6be3b2a42c4ffa3b5dbd91ef7cb1f2\"\n },\n {\n \"apicode\": \"123\",\n \"budget\": 0,\n \"hash\": \"58e7aa4ae4b14f936c8d3c1ff4c448f0\"\n },\n {\n \"apicode\": \"0.03256814464234574\",\n \"budget\": 5000,\n \"hash\": \"ef39b5a90e5611474eafb4448244a6ce\"\n },\n {\n \"apicode\": \"0.041961475314536575\",\n \"budget\": 5000,\n \"hash\": \"5645eabd53f29db62b3f6b46b0a4ee9a\"\n },\n {\n \"apicode\": \"0.3684386716861638\",\n \"budget\": 5000,\n \"hash\": \"b653ef7b944b6ff8bc6ec1b819c6fb81\"\n },\n {\n \"apicode\": \"current1\",\n \"budget\": 5000,\n \"hash\": \"9c7a4379b985bf3634a5ad139367f2f2\"\n },\n {\n \"apicode\": \"0.4784866063655229\",\n \"budget\": 10,\n \"hash\": \"0edcca852b3e0de26dff7a10813ce2c5\"\n },\n {\n \"apicode\": \"8441356513\",\n \"budget\": 1000,\n \"hash\": \"5a21f0c91de0f8fbd40113920300accc\"\n },\n {\n \"apicode\": \"0.6827000097210519\",\n \"budget\": 5000,\n \"hash\": \"be71efd31cb899aa56ddf56b0e37db72\"\n },\n {\n \"apicode\": \"0.0035039428654163544\",\n \"budget\": 14121,\n \"hash\": \"f2c1f78ba69ccff34f71a8767b8840b1\"\n },\n {\n \"apicode\": \"876\",\n \"budget\": 5000,\n \"hash\": \"bc41f091ef5a25dd6d9438bbb1e0141c\"\n },\n {\n \"apicode\": \"0.7642754658723953\",\n \"budget\": 5000,\n \"hash\": \"9b3f80d8d665ae7b173783e9c3739f69\"\n },\n {\n \"apicode\": \"7829934231\",\n \"budget\": 17575,\n \"hash\": \"e55861eb4be354aae3fbe83ee20c0dfa\"\n },\n {\n \"apicode\": \"46e19ffc-6f6d-443b-bcb2-c9d530410a70\",\n \"budget\": 25000,\n \"hash\": \"37253dab0574eea7030b3b795343a701\"\n },\n {\n \"apicode\": \"114\",\n \"budget\": 20000,\n \"hash\": \"eba9b5a18ae64bfbd260fad858104f7f\"\n },\n {\n \"apicode\": \"фив\",\n \"budget\": 12000,\n \"hash\": \"f0f5fbbcf9ec1cf91d15893237d6a67c\"\n },\n {\n \"apicode\": \"asd\",\n \"budget\": 833.33,\n \"hash\": \"b26a7ff43a4bba713ee8fba040832051\"\n },\n {\n \"apicode\": \"asd\",\n \"budget\": 960,\n \"hash\": \"ff69467de7b7adee36c9f974ad8c8e6a\"\n },\n {\n \"apicode\": \"asd\",\n \"budget\": 180,\n \"hash\": \"8e4764d672dbc3faf1db53cb3f54fb6a\"\n }\n ],\n \"state\": \"paid\",\n \"sum\": \"132995.33\",\n \"uuid\": \"fe64b5e3-1fd9-476f-936a-1e47f98694c6\"\n },\n {\n \"issuer\": \"provider2\",\n \"moment\": 1700503429,\n \"number\": \"11kjhgasad5239\",\n \"routes\": [\n {\n \"apicode\": \"123213421343123443213\",\n \"budget\": 5000,\n \"hash\": \"0e9c48a40a6d183e81575211287297c9\"\n },\n {\n \"apicode\": \"123\",\n \"budget\": 0,\n \"hash\": \"78149e53be95ca6e535193b389c9867a\"\n },\n {\n \"apicode\": \"0.18076632561233483\",\n \"budget\": 5000,\n \"hash\": \"206c906176b19163cc029d5f541277ab\"\n },\n {\n \"apicode\": \"\",\n \"budget\": 100,\n \"hash\": \"a66ec3335bd24509d0274a3fbc40fbda\"\n },\n {\n \"apicode\": \"0.35819345466624336\",\n \"budget\": 5000,\n \"hash\": \"d55fa808a91c6218a7dd5228597f1b5d\"\n },\n {\n \"apicode\": \"\",\n \"budget\": 5000,\n \"hash\": \"8abb2f0d91a7d3f07d9279979d1a07b2\"\n },\n {\n \"apicode\": \"0.8310661360910778\",\n \"budget\": 5000,\n \"hash\": \"a469769adb3779f9822e34d83424fd4a\"\n },\n {\n \"apicode\": \"0.04295503258980348\",\n \"budget\": 14125,\n \"hash\": \"3dd722c23ecad004a78a5da3815109d7\"\n },\n {\n \"apicode\": \"0.3365506709893706\",\n \"budget\": 7544,\n \"hash\": \"b917ccb2a8137b2981d878251ab5e8b1\"\n },\n {\n \"apicode\": \"\",\n \"budget\": 7845,\n \"hash\": \"3bec55eae27babb1d8fa9e89479336fd\"\n },\n {\n \"apicode\": \"66\",\n \"budget\": 5000,\n \"hash\": \"d7028b6e881c432a4a33354120b9b363\"\n },\n {\n \"apicode\": \"0.33630321764974225\",\n \"budget\": 5000,\n \"hash\": \"b39f9f90e2ce24fb73be250bfa0a178e\"\n },\n {\n \"apicode\": \"7\",\n \"budget\": 5000,\n \"hash\": \"d1a1dd211c80133fa981128488338625\"\n },\n {\n \"apicode\": \"932352532523-gdfgfgf-4343-5353\",\n \"budget\": 25000,\n \"hash\": \"8fae6e6688cfc3c6cb44625a705ab097\"\n },\n {\n \"apicode\": \"6ca132f6-0904-4f48-9e29-2b9174541c4c\",\n \"budget\": 25000,\n \"hash\": \"5efeadf58926c4016cbfa84fef8aeeae\"\n },\n {\n \"apicode\": \"фив\",\n \"budget\": 12000,\n \"hash\": \"60e8be3580609f91986939f85a567574\"\n },\n {\n \"apicode\": \"asd\",\n \"budget\": 12000,\n \"hash\": \"dac27ada7ffc0e9cc4576d48c7205b72\"\n },\n {\n \"apicode\": \"asda\",\n \"budget\": 10000,\n \"hash\": \"baad44ba3e64695782395a90a197a473\"\n },\n {\n \"apicode\": \"asd\",\n \"budget\": 833.33,\n \"hash\": \"b3df4cdffa14e604bf9e1a6e9f754c46\"\n },\n {\n \"apicode\": \"asd\",\n \"budget\": 833.33,\n \"hash\": \"ba58532fe8f53fded9003d9c7037caea\"\n }\n ],\n \"state\": \"declined\",\n \"sum\": \"155280.66\",\n \"uuid\": \"5025145e-ed1f-47aa-a6dd-1dac5cbc9b91\"\n },\n {\n \"issuer\": \"Seifert Polska Sp.Z.o.p\",\n \"moment\": 1700503437,\n \"number\": \"11kjhgasad1826\",\n \"routes\": [\n {\n \"apicode\": \"0.8047545541122132\",\n \"budget\": 5000,\n \"hash\": \"27f1d7942632d86869896e84942f025d\"\n },\n {\n \"apicode\": \"0.1133978684557582\",\n \"budget\": 5000,\n \"hash\": \"5a9daf1a032c4cb8d068c391298874ac\"\n },\n {\n \"apicode\": \"0.5106133879261217\",\n \"budget\": 5000,\n \"hash\": \"f7404b05aa7b09616181d92e1560a015\"\n },\n {\n \"apicode\": \"\",\n \"budget\": 14517,\n \"hash\": \"361635f7d97576ac7b14ecd9f4b6446b\"\n },\n {\n \"apicode\": \"0.028826862600470765\",\n \"budget\": 21000,\n \"hash\": \"d0c9a279f95fe2fb6f2157da46339a55\"\n },\n {\n \"apicode\": \"0.22141165213790875\",\n \"budget\": 5000,\n \"hash\": \"f2e0ec3c7f42022a14dad81378f18242\"\n },\n {\n \"apicode\": \"213у\",\n \"budget\": 2800,\n \"hash\": \"406d6fad4c26161c770b0e587e9123b5\"\n },\n {\n \"apicode\": \"4373479240\",\n \"budget\": 23755,\n \"hash\": \"a686653f683620217423b0cdd08de499\"\n },\n {\n \"apicode\": \"unique-external-id-11212\",\n \"budget\": 0,\n \"hash\": \"83292a2ac21c4fe3759208d21520df07\"\n },\n {\n \"apicode\": \"asd\",\n \"budget\": 1000,\n \"hash\": \"c197d4f99c439f0ae669d1d0e9533517\"\n }\n ],\n \"state\": \"new\",\n \"sum\": \"83072.00\",\n \"uuid\": \"80c7822b-a347-4a90-98d2-b6b0b05e73aa\"\n },\n {\n \"issuer\": \"Seifert Polska Sp.Z.o.p\",\n \"moment\": 1700503589,\n \"number\": \"11kjhgasad3741\",\n \"routes\": [\n {\n \"apicode\": \"0.3625902266824527\",\n \"budget\": 5000,\n \"hash\": \"b2400c08318741f252afc3c47a5a8d11\"\n },\n {\n \"apicode\": \"0.4762288317794249\",\n \"budget\": 5000,\n \"hash\": \"c00e0ab13cf29ef43bbdad0220255f33\"\n },\n {\n \"apicode\": \"0.8930831476050272\",\n \"budget\": 5789,\n \"hash\": \"5f2339fd3fd66e8b6237bd0634c745ee\"\n }\n ],\n \"state\": \"ratified\",\n \"sum\": \"15789.00\",\n \"uuid\": \"738b625f-99c9-4a48-abd7-b6554ced405d\"\n },\n {\n \"issuer\": \"Seifert Polska Sp.Z.o.p\",\n \"moment\": 1700503653,\n \"number\": \"1112312313833\",\n \"routes\": [\n {\n \"apicode\": \"1878106341\",\n \"budget\": 34361.37,\n \"hash\": \"c3a48e5ab83cf25e84ae34148816302a\"\n },\n {\n \"apicode\": \"status5route\",\n \"budget\": 14000,\n \"hash\": \"f05b06a60817c9d4951212a89778ef18\"\n },\n {\n \"apicode\": \"asda\",\n \"budget\": 10000,\n \"hash\": \"5e4fc189e7722906028323b33f7b3ca9\"\n },\n {\n \"apicode\": \"asd\",\n \"budget\": 1000,\n \"hash\": \"fa7fb75a84bfb1bb49597cafda0a7114\"\n }\n ],\n \"state\": \"new\",\n \"sum\": \"59361.37\",\n \"uuid\": \"f606852c-9597-4282-bbdd-4e4c186492e9\"\n },\n {\n \"issuer\": \"Агротеп, ООО\",\n \"moment\": 1700675321,\n \"number\": \"9988895079\",\n \"routes\": [\n {\n \"apicode\": \"0.07540218166578765\",\n \"budget\": 5000,\n \"hash\": \"9057e606af4ed0bb775e1206bec1022f\"\n },\n {\n \"apicode\": \"0.5668147444415975\",\n \"budget\": 5000,\n \"hash\": \"51f0b0458d87c9ef8c103b7fde061014\"\n },\n {\n \"apicode\": \"0.3388918371302\",\n \"budget\": 5000,\n \"hash\": \"7c0dd3fba6d384e7f3c157b795167abb\"\n },\n {\n \"apicode\": \"0.07548966358927048\",\n \"budget\": 5000,\n \"hash\": \"ab4c17577f301db3a49d8107293d3953\"\n },\n {\n \"apicode\": \"0.8890950827757782\",\n \"budget\": 5000,\n \"hash\": \"005d6ffc9d32c9236face835d7a2f422\"\n },\n {\n \"apicode\": \"0.8226471485780991\",\n \"budget\": 5000,\n \"hash\": \"ebee917dfcc13a35ca7aa3a903e869e9\"\n },\n {\n \"apicode\": \"0.8978843715953495\",\n \"budget\": 5000,\n \"hash\": \"510f42035c9aed2ee85675467150b0e9\"\n },\n {\n \"apicode\": \"0.09345130537958006\",\n \"budget\": 5000,\n \"hash\": \"1bf416f127ac104f61bcdea39d88baaf\"\n },\n {\n \"apicode\": \"0.8675047055515505\",\n \"budget\": 5000,\n \"hash\": \"5f35f4c62837cbb9557a98053b7a7ddd\"\n }\n ],\n \"state\": \"paid\",\n \"sum\": \"45000.00\",\n \"uuid\": \"121766cf-3118-4d27-b08e-acbf950ed40e\"\n },\n {\n \"issuer\": \"Агротеп, ООО\",\n \"moment\": 1700752276,\n \"number\": \"kljhvg\",\n \"routes\": [\n {\n \"apicode\": \"123\",\n \"budget\": 0,\n \"hash\": \"35b62927a596bc654c68e020af92b048\"\n },\n {\n \"apicode\": \"0.3646109023733166\",\n \"budget\": 5000,\n \"hash\": \"532c3d7623bbd7c37d0f6d70a3d65fd7\"\n },\n {\n \"apicode\": \"0.7557448621427126\",\n \"budget\": 5000,\n \"hash\": \"e45644c2c1e1f49a915773aacb3e91f3\"\n }\n ],\n \"state\": \"new\",\n \"sum\": \"10000.00\",\n \"uuid\": \"b4625416-3abf-4c5a-b789-998bb7e0cbd2\"\n },\n {\n \"issuer\": \"Seifert Polska Sp.Z.o.p\",\n \"moment\": 1700752951,\n \"number\": \"number\",\n \"state\": \"new\",\n \"sum\": \"0.00\",\n \"uuid\": \"f2f45f7f-185c-4540-901e-fbecfadf6626\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Missing token", "originalRequest": [], "status": "Missing token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is required\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Payment Requests", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/paymentRequests", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "paymentRequests" ], "query": [], "variable": [] }, "description": "Get Payment Requests" }, "response": [] }, { "name": "Get Payment Request", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/paymentRequest", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "paymentRequest" ], "query": [ { "key": "request", "value": "uuid", "description": "", "disabled": true } ], "variable": [] }, "description": "Get Payment Request" }, "response": [] }, { "name": "Export Payment Request XLS", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/paymentRequestXlsExport", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "paymentRequestXlsExport" ], "query": [ { "key": "request", "value": "uuid", "description": "", "disabled": true } ], "variable": [] }, "description": "Export Payment Request XLS" }, "response": [] }, { "name": "Update Payment Request", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/paymentRequestUpdate", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "paymentRequestUpdate" ], "query": [], "variable": [] }, "description": "Update Payment Request", "body": { "mode": "raw", "raw": "{\n \"request\": \"uuid\",\n \"routes\": [\n \"111-11-25\",\n \"222-02-20\",\n \"333-02-20\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Mark Payment Request as Paid", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/paymentRequestPaid", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "paymentRequestPaid" ], "query": [], "variable": [] }, "description": "Mark Payment Request as Paid", "body": { "mode": "raw", "raw": "{\n \"date\": 1766102400,\n \"request\": \"uuid\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Payment Request", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/paymentRequestDelete", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "paymentRequestDelete" ], "query": [ { "key": "request", "value": "uuid", "description": "", "disabled": true } ], "variable": [] }, "description": "Delete Payment Request" }, "response": [] } ] } ] }, { "name": "Reference Data", "item": [ { "name": "Lookup Data", "item": [ { "name": "Get Languages", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/listLanguages", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "listLanguages" ], "query": [], "variable": [] }, "description": "Returns the list of languages, supported by the app.\n\n(!) NOTE: Does not require JWT or static token." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"ua\",\n \"title\": \"Українська\",\n \"title_iso2\": \"ukr\"\n },\n {\n \"id\": \"en\",\n \"title\": \"English\",\n \"title_iso2\": \"eng\"\n },\n {\n \"id\": \"de\",\n \"title\": \"Deutsch\",\n \"title_iso2\": \"deu\"\n },\n {\n \"id\": \"pl\",\n \"title\": \"Polski\",\n \"title_iso2\": \"pol\"\n },\n {\n \"id\": \"sl\",\n \"title\": \"Slovenščina\",\n \"title_iso2\": \"slv\"\n },\n {\n \"id\": \"fr\",\n \"title\": \"Français\",\n \"title_iso2\": \"fra\"\n },\n {\n \"id\": \"et\",\n \"title\": \"Eesti\",\n \"title_iso2\": \"est\"\n },\n {\n \"id\": \"ru\",\n \"title\": \"Русский\",\n \"title_iso2\": \"rus\"\n }\n ],\n \"status\": \"success\"\n}" } ] }, { "name": "Get Measurement Units", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getMeasureUnit", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getMeasureUnit" ], "query": [], "variable": [] }, "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.\n\n- if successful you will receive your company's unique measure units\n- 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\n\n(!) NOTE: Can be used only by shipper.", "body": { "mode": "formdata", "formdata": [] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": 7,\n \"title\": \"box\"\n },\n {\n \"id\": 9,\n \"title\": \"pallet\"\n },\n {\n \"id\": 773,\n \"title\": \"GFKKTNF\"\n },\n {\n \"id\": 774,\n \"title\": \"12345/.,l\"\n },\n {\n \"id\": 775,\n \"title\": \"box plastic\"\n },\n {\n \"id\": 776,\n \"title\": \"metal GPS box\"\n },\n {\n \"id\": 779,\n \"title\": \"custom unit\"\n },\n {\n \"id\": 780,\n \"title\": \"custom unit\"\n },\n {\n \"id\": 781,\n \"title\": \"custom unit\"\n },\n {\n \"id\": 782,\n \"title\": \"case\"\n },\n {\n \"id\": 783,\n \"title\": \"custom unit\"\n },\n {\n \"id\": 784,\n \"title\": \"unit\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Loading Types", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getChargetype", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getChargetype" ], "query": [], "variable": [] }, "description": "Returns the available loading types.\n\nThis 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.\n\nThis list is useful in addition with `createRoute`/`createTender` endpoints for shipper, or `addVehicle` endpoint for carriers.\n\n- If successful, you will receive the list of loading types\n- 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" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": 7,\n \"title\": \"without rear doors\"\n },\n {\n \"id\": 2,\n \"title\": \"side loading\"\n },\n {\n \"id\": 1,\n \"title\": \"top loading\"\n },\n {\n \"id\": 3,\n \"title\": \"rear loading\"\n },\n {\n \"id\": 4,\n \"title\": \"full curtain opening\"\n },\n {\n \"id\": 5,\n \"title\": \"with crossbars removed\"\n },\n {\n \"id\": 6,\n \"title\": \"with side posts removed\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Vehicle Properties", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getFerryproperty", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getFerryproperty" ], "query": [], "variable": [] }, "description": "Returns the available properties of the vehicle.\n\nThis 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.\n\nThis list is useful in addition with `createRoute`/`createTender` endpoints for shipper, or `addVehicle` endpoint for carriers.\n\n- If successful, you will receive the list of truck properties\n- 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" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"5\",\n \"quantifiable\": \"\",\n \"title\": \"load supports (stakes)\"\n },\n {\n \"id\": \"6\",\n \"quantifiable\": \"\",\n \"title\": \"removable side posts\"\n },\n {\n \"id\": \"7\",\n \"quantifiable\": \"\",\n \"title\": \"rigid side walls\"\n },\n {\n \"id\": \"8\",\n \"quantifiable\": \"\",\n \"title\": \"wooden floor\"\n },\n {\n \"id\": \"9\",\n \"quantifiable\": \"\",\n \"title\": \"clean vehicle\"\n },\n {\n \"id\": \"10\",\n \"quantifiable\": \"pcs\",\n \"title\": \"pallets\"\n },\n {\n \"id\": \"11\",\n \"quantifiable\": \"°C\",\n \"title\": \"temperature\"\n },\n {\n \"id\": \"12\",\n \"quantifiable\": \"pcs\",\n \"title\": \"straps\"\n },\n {\n \"id\": \"13\",\n \"quantifiable\": \"class\",\n \"title\": \"ADR\"\n },\n {\n \"id\": \"14\",\n \"quantifiable\": \"\",\n \"title\": \"TIR\"\n },\n {\n \"id\": \"18\",\n \"quantifiable\": \"\",\n \"title\": \"max length\"\n },\n {\n \"id\": \"19\",\n \"quantifiable\": \"\",\n \"title\": \"max width\"\n },\n {\n \"id\": \"20\",\n \"quantifiable\": \"\",\n \"title\": \"max height\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Pricing Modes", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getPricefor", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getPricefor" ], "query": [], "variable": [] }, "description": "Get the options, for which the price for route or tender can be set. Default is for `ride` (id: 3). \n\nThis endpoint is useful in addition with the `createRoute`/`createTender` endpoints, because you can supply the price for kilometers, cubic meters, tons or rides. \n\nThis endpoint returns the list of valid options for those pricing modes.\n\n- If successful, you will receive the list of pricing modes\n- 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", "body": { "mode": "formdata", "formdata": [] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"code\": \"tonn\",\n \"id\": 1,\n \"title\": \"per tonne\"\n },\n {\n \"code\": \"mcube\",\n \"id\": 2,\n \"title\": \"per cubic meter\"\n },\n {\n \"code\": \"ride\",\n \"id\": 3,\n \"title\": \"per trip\"\n },\n {\n \"code\": \"km\",\n \"id\": 4,\n \"title\": \"per km\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Currencies", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCurrency", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCurrency" ], "query": [], "variable": [] }, "description": "The method shows the currencies available to the current user.\n\nThe contents differ depending on the country of the user.\n\n- If successful, you will receive the list of currencies\n- 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", "body": { "mode": "formdata", "formdata": [] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"currencycode\": \"uah\",\n \"key\": \"uah\",\n \"symbol\": \"₴\",\n \"title\": \"грн\"\n },\n {\n \"currencycode\": \"eur\",\n \"key\": \"eur\",\n \"symbol\": \"€\",\n \"title\": \"eur\"\n },\n {\n \"currencycode\": \"usd\",\n \"key\": \"usd\",\n \"symbol\": \"$\",\n \"title\": \"usd\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Payment Types", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getPaymenttype", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getPaymenttype" ], "query": [], "variable": [] }, "description": "The method shows available payment types.\n\n- If successful, you will receive the list of payment types\n- 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", "body": { "mode": "formdata", "formdata": [] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": 2,\n \"title\": \"Bank transfer\"\n },\n {\n \"id\": 3,\n \"title\": \"Cash\"\n },\n {\n \"id\": 6,\n \"title\": \"Simplified tax scheme\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Upload Requirements", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getFileUploadRequirements", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getFileUploadRequirements" ], "query": [], "variable": [] }, "description": "The method shows the requirements for file upload. Note the `maxSize` and `types` parameters.\n\n- If successful, you will receive the requirements list \n- 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", "body": { "mode": "formdata", "formdata": [] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"maxSize\": 8388608,\n \"types\": [\n \"jpg\",\n \"jpeg\",\n \"png\",\n \"bmp\",\n \"gif\",\n \"tif\",\n \"pdf\",\n \"doc\",\n \"docx\",\n \"xls\",\n \"xlsx\"\n ]\n },\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] } ] }, { "name": "Platform Data", "item": [ { "name": "Get Platform Legal Documents", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/systemDocuments", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "systemDocuments" ], "query": [], "variable": [] }, "description": "Get Platform Legal Documents", "body": { "mode": "formdata", "formdata": [ { "key": "login", "value": "{{username}}", "description": "your username or email from the app", "type": "text" }, { "key": "password", "value": "{{password}}", "description": "your password from the app", "type": "text" } ] } }, "response": [] }, { "name": "Get Platform Information", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/systemData", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "systemData" ], "query": [], "variable": [] }, "description": "Get Platform Information", "body": { "mode": "formdata", "formdata": [ { "key": "login", "value": "{{username}}", "description": "your username or email from the app", "type": "text" }, { "key": "password", "value": "{{password}}", "description": "your password from the app", "type": "text" } ] } }, "response": [] }, { "name": "Get Platform Billing Details", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/systemRequisites", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "systemRequisites" ], "query": [], "variable": [] }, "description": "Get Platform Billing Details", "body": { "mode": "formdata", "formdata": [ { "key": "login", "value": "{{username}}", "description": "your username or email from the app", "type": "text" }, { "key": "password", "value": "{{password}}", "description": "your password from the app", "type": "text" } ] } }, "response": [] }, { "name": "Submit Feedback", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/systemFeedback", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "systemFeedback" ], "query": [], "variable": [] }, "description": "Submit Feedback", "body": { "mode": "raw", "raw": "{\n \"message\": \"Some message 1.12.25 14 49\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Subscription Terms", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/publicOffer", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "publicOffer" ], "query": [], "variable": [] }, "description": "Get Subscription Terms" }, "response": [] }, { "name": "Accept Subscription Terms", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/agreePublicOffer", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "agreePublicOffer" ], "query": [], "variable": [] }, "description": "Accept Subscription Terms", "body": { "mode": "formdata", "formdata": [ { "key": "agree", "value": "true", "description": "", "type": "text" } ] } }, "response": [] }, { "name": "Get Terms of Service", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/userAgreement", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "userAgreement" ], "query": [], "variable": [] }, "description": "Get Terms of Service", "body": { "mode": "formdata", "formdata": [ { "key": "login", "value": "{{username}}", "description": "your username or email from the app", "type": "text" }, { "key": "password", "value": "{{password}}", "description": "your password from the app", "type": "text" } ] } }, "response": [] }, { "name": "Contact Data", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/contactData", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "contactData" ], "query": [], "variable": [] }, "description": "Contact Data" }, "response": [] } ] } ] }, { "name": "Routes & tenders", "item": [ { "name": "Carriers", "item": [ { "name": "Routes", "item": [ { "name": "Book Route", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/bookRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "bookRoute" ], "query": [], "variable": [] }, "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\n\n- if successful you will book a single route\n- 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\n \n(!) NOTE: Can be only used by carriers, \nonly routes with status 2 (vacant) can be booked", "body": { "mode": "formdata", "formdata": [ { "key": "route", "value": "{{singleRoute}}", "description": "Required string. Id of the tender.", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"true\"\n}" }, { "name": "Not allowed to book a route", "originalRequest": [], "status": "Not allowed to book a route", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Cancel Booking", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/cancelBook", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "cancelBook" ], "query": [], "variable": [] }, "description": "With this endpoint you can cancel route booking, which was done in POST bookRoute endpoint.\n\n- if successful you will cancel the booking and make the route available to other carriers\n \n- 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\n \n(!) NOTE: Can be only used by carriers on routes that were previously booked via POST bookRoute endpoint or other UI.", "body": { "mode": "formdata", "formdata": [ { "key": "route", "value": "{{singleRoute}}", "description": "Required string. Id of the tender.", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "No such route / Reques from shipper", "originalRequest": [], "status": "No such route / Reques from shipper", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Route not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Propose Vehicle Assignment", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/offerAuto", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "offerAuto" ], "query": [], "variable": [] }, "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.\n\nThe availability dates for different parts of the route, along with details of the car, driver, and trailer, should be provided in the request.\n\nThe 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.\n\n- if success you will offer an auto for a route\n- 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\n \nOnce the vehicle is offered for the order, the shipper will receive notification and will be enabled to either accept or decline your offer.\n\n#### Request Body\n\nThe request body must be in JSON format and contain the following fields:\n\n- **route** (string): The identifier for the specific route.\n- **routepartsDates** (object): An object where keys are route part IDs and values are the availability dates for those parts.\n- **car** (int): The ID of the car being offered.\n \n- **driver** (int): The ID of the driver being proposed.\n \n- **trailer** (int): The ID of the trailer being used.", "body": { "mode": "raw", "raw": "{\n \"car\": \"41068\",\n \"driver\": \"40034\",\n \"route\": 113549040000,\n \"routepartsDates\": {\n \"111376785\": 1734480000,\n \"111376786\": 1734566400\n },\n \"trailer\": \"38962\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Invalid route number / Invalid driver / Invalid trailer / Changes occurred, retry needed", "originalRequest": [], "status": "Invalid route number / Invalid driver / Invalid trailer / Changes occurred, retry needed", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Changes have been made to the route—please refresh the page.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Confirm Assignment", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/confirmWorkOnRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "confirmWorkOnRoute" ], "query": [], "variable": [] }, "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.\n\n* if success you will confirm your commitment to do the delivery\n* 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\n \nThe *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.\n\n#### Request Body\n\nThe request body must be in JSON format and contain the following fields:\n\n* **route** (string): The identifier for the specific route.\n* **routepartsDates** (object): An object where keys are route part IDs and values are the estimated dates of arrival.\n* **routepartsTimes** (object): An object where keys are route part IDs and values are the estimated times of arrival.", "body": { "mode": "raw", "raw": "{\n \"route\": \"{{singleRoute}}\",\n \"routepartsDates\": {\n \"111381491\": 1609545600\n },\n \"routepartsTimes\": {\n \"111381491\": \"12:00\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Not allowed to work on this route", "originalRequest": [], "status": "Not allowed to work on this route", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Arrived at Loading Point", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/arrivedAtCharge", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "arrivedAtCharge" ], "query": [], "variable": [] }, "description": "Allows carriers to confirm arrival at loading.\n\n(!) IMPORTANT: although this endpoint is intended for carriers, shippers can also use it.\n\nIf the car has the GPS tracker, the event is triggered automatically upon arrival.\n\nBy 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.\n\nIf routepart ID is passed, the endpoint will mark all preceding routeparts as complete and trigger change in the passed one.\n\n- If successful, you will receive the success message, state of the route will change, loading will be marked as \"started\"\n- 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\n \nThe routepart ID can be found in GET singleRoute", "body": { "mode": "formdata", "formdata": [ { "key": "route", "value": "{{singleRoute}}", "description": "Periodic of the route. Required. String", "type": "text" }, { "key": "routepart", "value": "{{badRoutePartId}}", "description": "ID of the routepart. Optional. Int", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Bad route passed / Route is not in proper state to confirm loading / Bad routepart ID passed", "originalRequest": [], "status": "Bad route passed / Route is not in proper state to confirm loading / Bad routepart ID passed", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Force Vehicle Reassignment", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/forceChangeVehicle", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "forceChangeVehicle" ], "query": [], "variable": [] }, "description": "Force Vehicle Reassignment", "body": { "mode": "raw", "raw": "{\n \"car\": 111,\n \"driver\": 111,\n \"driver2\": 111,\n \"periodic\": \"1-12-23\",\n \"reason\": \"reason\",\n \"trailer\": 111\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Withdraw from Route", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/denyRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "denyRoute" ], "query": [], "variable": [] }, "description": "Withdraw from Route", "body": { "mode": "raw", "raw": "{\n \"periodic\": -27105321600\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Border Crossing Point", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/changeBorderCrossingTown", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "changeBorderCrossingTown" ], "query": [], "variable": [] }, "description": "Allows carriers to change the border crossing points for international routes.\n\nRoutepart ID's can be found in the GET singleRoute and the town ID's can be found in GET getTown\n\n* if successful you will have successfully changed the border crossings\n* 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\n \n#### Request Body\n\nThe request body must be in form-data format and contain the following fields:\n\n* **route** (string): The identifier of the route. (Required)\n* **borders** (array of objects): An array of objects where each object contains a `routepartId` and a `townId`. (Required)", "body": { "mode": "formdata", "formdata": [ { "key": "borders", "value": "[\n {\n \"routepartId\":111384004,\n \"townId\":7\n },\n {\n \"routepartId\":111384006,\n \"townId\":9\n }\n]", "description": "Required. Object.", "type": "text" }, { "key": "route", "value": "{{singleRoute}}", "description": "String. Required. The identifier of the route.", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Route in wrong status", "originalRequest": [], "status": "Route in wrong status", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The route status doesn’t allow specifying a border crossing.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Request Assignment Change", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/requestChangeFleet", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "requestChangeFleet" ], "query": [], "variable": [] }, "description": "Request Assignment Change", "body": { "mode": "raw", "raw": "{\n \"car\": 111,\n \"driver\": 111,\n \"driver2\": 111,\n \"periodic\": \"1-12-23\",\n \"reason\": \"reason\",\n \"trailer\": 111\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Arrived at Border", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/arrivedAtBorder", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "arrivedAtBorder" ], "query": [], "variable": [] }, "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.\n\n* if success you will update route status and confirm that the vehicle arrived at the border\n* 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", "body": { "mode": "formdata", "formdata": [ { "key": "route", "value": "{{singleRoute}}", "description": "String. Required. The identifier of the route.", "type": "text" }, { "key": "routepart", "value": "{{routepartId}}", "description": "Int. Optional. Specific routepart of type \"border\" (3).", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Invalid route number", "originalRequest": [], "status": "Invalid route number", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Border Crossing Complete", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/borderComplete", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "borderComplete" ], "query": [], "variable": [] }, "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.\n\n- if success you will update route status and confirm that the vehicle passed the border checkpoint\n- 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\n \nThe routepart ID can be found in GET singleRoute", "body": { "mode": "formdata", "formdata": [ { "key": "route", "value": "{{singleRoute}}", "description": "String. Required. The identifier of the route.", "type": "text" }, { "key": "routepart", "value": "{{routepartId}}", "description": "Int. Optional. Specific routepart of type \"border\" (3).", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Invalid route number", "originalRequest": [], "status": "Invalid route number", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Arrived at Customs", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/arrivedAtCustoms", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "arrivedAtCustoms" ], "query": [], "variable": [] }, "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.\n\n* if successful you will confirm that the vehicle arrived at customs\n* 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\n \nUpon 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.", "body": { "mode": "formdata", "formdata": [ { "key": "route", "value": "{{singleRoute}}", "description": "String. Required. The identifier of the route.", "type": "text" }, { "key": "routepart", "value": "{{routepartId}}", "description": "Int. Optional. Specific routepart of type \"customs\" (3).", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Invalid token / Token not supplied", "originalRequest": [], "status": "Invalid token / Token not supplied", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Customs Clearance Complete", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/customsComplete", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "customsComplete" ], "query": [], "variable": [] }, "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.\n\n* if successful you will confirm that the vehicle is passed the customs\n* 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\n \nUpon 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.", "body": { "mode": "formdata", "formdata": [ { "key": "route", "value": "{{singleRoute}}", "description": "String. Required. The identifier of the route.", "type": "text" }, { "key": "routepart", "value": "{{routepartId}}", "description": "Int. Optional. Specific routepart of type \"customs\" (3).", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Invalid route number", "originalRequest": [], "status": "Invalid route number", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Arrived at Unloading Point", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/arrivedAtUncharge", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "arrivedAtUncharge" ], "query": [], "variable": [] }, "description": "Allows carriers to confirm arrival at unloading.\n\n(!) IMPORTANT: although this endpoint is intended for carriers, shippers can also use it.\n\nIf the car has the GPS tracker, the event is triggered automatically upon arrival.\n\nBy 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.\n\nIf routepart ID is passed, the endpoint will mark all preceding routeparts as complete and trigger change in the passed one.\n\n- If successful, you will receive the success message, state of the route will change, unloading will be marked as \"started\"\n- 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\n \nThe routepart ID can be found in GET singleRoute.", "body": { "mode": "formdata", "formdata": [ { "key": "route", "value": "{{singleRoute}}", "description": "Periodic of the route. Required. String", "type": "text" }, { "key": "routepart", "value": "{{routePartId}}", "description": "ID of the unloading routepart. Optional. Int ", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Not allowed to update this route / Route is not in propert state / Bad routepart ID passed", "originalRequest": [], "status": "Not allowed to update this route / Route is not in propert state / Bad routepart ID passed", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Point not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Confirm POD", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/confirmUnchargePOD", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "confirmUnchargePOD" ], "query": [], "variable": [] }, "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.\n\n* if successful you will confirm that the vehicle is passed the customs\n* 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\n \nUpon 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.", "body": { "mode": "raw", "raw": "{\n \"comment\": \"Cum sint cum commodi sunt excepturi ut.\",\n \"lateness\": \"0013\",\n \"products\": [\n {\n \"order\": \"0987689984\",\n \"product\": 196,\n \"quantity\": 12,\n \"variance\": \"A009\"\n },\n {\n \"order\": \"0987689984\",\n \"product\": 197,\n \"quantity\": 2.2,\n \"variance\": \"A009\"\n }\n ],\n \"route\": \"117-01-25\",\n \"routepart\": 111391782\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Invalid route number", "originalRequest": [], "status": "Invalid route number", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] } ] }, { "name": "Shared Operations", "item": [ { "name": "Mark as Not Interested", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/notInterested", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "notInterested" ], "query": [], "variable": [] }, "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.\n\n* if successful you won't see the passed route in vacant routes\n* 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\n \n(!) NOTE: Can be only used by carriers", "body": { "mode": "formdata", "formdata": [ { "key": "route", "value": "{{singleRoute}}", "description": "Required string. Id of the tender.", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "No such route / Request from shipper", "originalRequest": [], "status": "No such route / Request from shipper", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Route not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Bookmark Route or Tender", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/bookmark", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "bookmark" ], "query": [], "variable": [] }, "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.\n\n- if successful you won't see the passed route in vacant routes\n \n- 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\n \n(!) NOTE: Can be only used by carriers", "body": { "mode": "formdata", "formdata": [ { "key": "route", "value": "{{singleRoute}}", "description": "Required string. Id of the tender.", "type": "text" } ] } }, "response": [ { "name": "Success (mark set) / Success (mark unset)", "originalRequest": [], "status": "Success (mark set) / Success (mark unset)", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"bookmarkSet\": true,\n \"route\": 38795932800\n },\n \"status\": \"success\"\n}" }, { "name": "No such route / Request from shipper", "originalRequest": [], "status": "No such route / Request from shipper", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Route not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] } ] }, { "name": "Tenders", "item": [ { "name": "Submit Tender Bid", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/pricequote", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "pricequote" ], "query": [], "variable": [] }, "description": "This endpoint is used to submit a price quote for a tender. It allows users to provide pricing information for a specific route.\n\n \nUpon receiving the request, the system generates a price quote based on the provided details.\n\n- Upon successful submission of the price quote, the system processes the request and generates the corresponding price quote.\n- If any required parameter is missing or invalid, the system returns an error response indicating the specific issue.\n- 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.", "body": { "mode": "formdata", "formdata": [ { "key": "loadquote", "value": "1", "description": "String. Required. The loadquote.", "type": "text" }, { "key": "pricequote", "value": "3000", "description": "String. Required. The pricequote.", "type": "text" }, { "key": "route", "value": "{{singleRoute}}", "description": "String. Required. The identifier of the route.", "type": "text" } ] } }, "response": [ { "name": "Succeess", "originalRequest": [], "status": "Succeess", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Missing pricequote", "originalRequest": [], "status": "Missing pricequote", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The bid is empty.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Missing token", "originalRequest": [], "status": "Missing token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is required\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Cancel Sealed Bid", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/cancelPricequote", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "cancelPricequote" ], "query": [], "variable": [] }, "description": "This endpoint is used to cancel a price quote previously made in a single shot tender (blind tender).\n\nCancelled bids cannot be chosen as winning. Cancelled bids can be later revived.", "body": { "mode": "formdata", "formdata": [ { "key": "loadquote", "value": "1", "description": "String. Required. The loadquote.", "type": "text" }, { "key": "pricequote", "value": "3000", "description": "String. Required. The pricequote.", "type": "text" }, { "key": "route", "value": "{{singleRoute}}", "description": "String. Required. The identifier of the route.", "type": "text" } ] } }, "response": [ { "name": "Succeess", "originalRequest": [], "status": "Succeess", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Missing pricequote", "originalRequest": [], "status": "Missing pricequote", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The bid is empty.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Missing token", "originalRequest": [], "status": "Missing token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is required\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Reopen Sealed Bid", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/revivePricequote", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "revivePricequote" ], "query": [], "variable": [] }, "description": "This endpoint is used to revive the cancelled price quote previously made in a single shot tender (blind tender).", "body": { "mode": "formdata", "formdata": [ { "key": "loadquote", "value": "1", "description": "String. Required. The loadquote.", "type": "text" }, { "key": "pricequote", "value": "3000", "description": "String. Required. The pricequote.", "type": "text" }, { "key": "route", "value": "{{singleRoute}}", "description": "String. Required. The identifier of the route.", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Missing pricequote", "originalRequest": [], "status": "Missing pricequote", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The bid is empty.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Missing token", "originalRequest": [], "status": "Missing token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is required\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Respond to Counteroffer", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful.", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/oppositeOfferDecision", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "oppositeOfferDecision" ], "query": [], "variable": [] }, "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.\n\nOpposite offer ID can be found in the GET getPriceQuotes.", "body": { "mode": "formdata", "formdata": [ { "key": "decision", "value": "yes", "description": "yes / no", "type": "text" }, { "key": "oppositeoffer", "value": "", "description": "String. Required. Opposite offer id.", "type": "text" }, { "key": "route", "value": "{{singleRoute}}", "description": "Required int. Periodic of the tender", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Missing route number/opposite offer id/decision", "originalRequest": [], "status": "Missing route number/opposite offer id/decision", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"No arguments were provided.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] } ] } ] }, { "name": "Common Operations", "item": [ { "name": "Routes", "item": [ { "name": "Get Assigned Fleet", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getRouteFleet", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getRouteFleet" ], "query": [ { "key": "route", "value": "{{singleRoute}}", "description": "Single route periodic", "disabled": true } ], "variable": [] }, "description": "Returns the information about the confirmed carrier, truck, drivers and trailer for the specified route.\n\n- If successful you will receive information about the vehicle and the drivers on the route\n- 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" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"car\": {\n \"actual_provider_natcomid\": null,\n \"actual_provider_title\": null,\n \"availabledatetime\": 1669248000,\n \"axes\": 0,\n \"body_type\": \"Tractor unit (semi-truck)\",\n \"body_type_unique_id\": 113,\n \"carstyle\": \"forcesplitcarstyle\",\n \"cartype\": \"тягач\",\n \"cellnum\": \"\",\n \"gpsid\": null,\n \"height\": \"3.500\",\n \"insuredTil\": -62169984000,\n \"length\": \"5.000\",\n \"loadcapacity\": \"0.000\",\n \"make\": \"Iveco\",\n \"model\": \"STRALIS\",\n \"number\": \"CС9147EЕ\",\n \"total_weight\": \"20.500\",\n \"vin\": \"WJMM1VTH904984751\",\n \"volume\": \"0.000\",\n \"weight\": \"7.870\",\n \"width\": \"2.500\",\n \"year_of_manufact\": 2011\n },\n \"driver\": {\n \"demographicid\": \"123123123\",\n \"driverlicensenumber\": \"673329\",\n \"driverlicenseserial\": \"GGG\",\n \"firstname\": \"Walter\",\n \"inblacklist\": 0,\n \"lastname\": \"White\",\n \"maincellphone\": null,\n \"passportnumber\": \"\",\n \"passportserial\": \"\",\n \"patronymic\": \"\"\n },\n \"driver2\": null,\n \"operator\": \"Carrier LTD\",\n \"operatorContractDate\": -62169984000,\n \"operatorContractNumber\": \"\",\n \"operatorNatcomid\": \"6722356984\",\n \"operatorhash\": \"a919ffa2c7a3be99212d75a631a46d4c\",\n \"trailer\": {\n \"axes\": 0,\n \"body_type\": \"Flatbed truck with a tarpaulin (curtain-sided)\",\n \"body_type_unique_id\": 213,\n \"cartype\": \"тент\",\n \"height\": \"2.750\",\n \"length\": \"13.000\",\n \"loadcapacity\": \"23.000\",\n \"make\": \"Kogel\",\n \"model\": \"sn24\",\n \"number\": \"ВВ1789ХА\",\n \"total_weight\": \"35.000\",\n \"vin\": \"wk0s0001401796987\",\n \"volume\": \"0.000\",\n \"weight\": \"7.000\",\n \"width\": \"2.000\",\n \"year_of_manufact\": 2008\n },\n \"useroperator\": {\n \"cellnum\": \"+380692675706\",\n \"email\": \"ktsom@some.com\",\n \"name\": \"Carrier Manager\"\n }\n },\n \"status\": \"success\"\n}" }, { "name": "Not allowed to view route", "originalRequest": [], "status": "Not allowed to view route", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Route Orders", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getOrders", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getOrders" ], "query": [ { "key": "route", "value": "{{routePeriodic}}", "description": "", "disabled": true } ], "variable": [] }, "description": "This endpoint retrieves all orders associated with a specific route.\n\n* 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." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"orders\": [\n {\n \"aux\": \"some technical data\",\n \"number\": \"0987689987\",\n \"products\": [\n {\n \"aux\": null,\n \"extra1\": \"9.000000\",\n \"extra2\": \"2901.550000\",\n \"extra3\": \"0.212000\",\n \"extra4\": \"0.000000\",\n \"measure_unit\": \"box\",\n \"order\": 31,\n \"position\": \"1\",\n \"product\": 3,\n \"product_relation\": {\n \"aux\": null,\n \"code\": \"12312223\",\n \"id\": 3,\n \"title\": \"smittles\"\n },\n \"quantity\": \"9.000000\",\n \"total_price\": \"2901.550000\",\n \"unit_price\": \"10.660000\",\n \"vat\": \"60.000000\",\n \"volume\": \"0.408900\",\n \"weight\": \"0.212009\"\n },\n {\n \"aux\": null,\n \"extra1\": \"223.000000\",\n \"extra2\": \"600.000000\",\n \"extra3\": \"0.933000\",\n \"extra4\": \"0.000000\",\n \"measure_unit\": \"pcs\",\n \"order\": 31,\n \"position\": \"2\",\n \"product\": 4,\n \"product_relation\": {\n \"aux\": null,\n \"code\": \"m112323\",\n \"id\": 4,\n \"title\": \"wiskas\"\n },\n \"quantity\": \"223.000009\",\n \"total_price\": \"600.000009\",\n \"unit_price\": \"19.890000\",\n \"vat\": \"125.000000\",\n \"volume\": \"8.028900\",\n \"weight\": \"0.933009\"\n }\n ],\n \"total_weight\": \"1.145000\"\n }\n ],\n \"route\": -25480656000\n },\n \"status\": \"success\"\n}" }, { "name": "Invalid route number", "originalRequest": [], "status": "Invalid route number", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Route not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Route Delay Reasons", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getVarianceLatenessReasons", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getVarianceLatenessReasons" ], "query": [ { "key": "route", "value": "117-01-25", "description": "", "disabled": true } ], "variable": [] }, "description": "This endpoint retrieves all variance or lateness reasons associated with a specific route.\n\n- 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." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n [\n {\n \"code\": \"A\",\n \"title\": \"Late delivery\",\n \"type\": \"variance\"\n },\n {\n \"code\": \"B\",\n \"title\": \"Bad delivery date\",\n \"type\": \"variance\"\n },\n {\n \"code\": \"C\",\n \"title\": \"Stop failed\",\n \"type\": \"lateness\"\n },\n {\n \"code\": \"D\",\n \"title\": \"Weather conditions -- \",\n \"type\": \"lateness\"\n }\n ]\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid route number", "originalRequest": [], "status": "Invalid route number", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Route not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Arrival Estimate", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getArrivalEstimate", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getArrivalEstimate" ], "query": [ { "key": "route", "value": "", "description": "", "disabled": true } ], "variable": [] }, "description": "Get Arrival Estimate" }, "response": [] }, { "name": "Request Driver Location", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/requestDriverLocation", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "requestDriverLocation" ], "query": [], "variable": [] }, "description": "Request Driver Location", "body": { "mode": "raw", "raw": "{\n \"route\": 33226243200\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Approve Route Change Request", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/confirmRouteChanges", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "confirmRouteChanges" ], "query": [], "variable": [] }, "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.\n\nRequested changes can be viewed via the `getRouteMessageGroups` endpoint.\n\n- if successful you will have successfully ratified or declined the change request\n- 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\n \nParams:\n\n- `verdict` : string, required. Supports only \"yes\" and \"no\". Indicates whether you ratify the requested changes or not.\n- `periodic` : string, required. The unique periodic of the route/order in question.\n- `routechange` : int, requried. The ID of the routechange, i.e. entity that corresponds to the change request.", "body": { "mode": "raw", "raw": "{\n \"periodic\": \"12-01-24\",\n \"routechange\": 26842,\n \"verdict\": \"yes\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": true\n}" }, { "name": "Bad routechange id supplied", "originalRequest": [], "status": "Bad routechange id supplied", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"routechange\": \"The following value must be valid routechange id initiated by provider\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Request Schedule Change", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/requestChangeDates", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "requestChangeDates" ], "query": [], "variable": [] }, "description": "Allows shippers to request a change of dates for a given routepart of a given route.\n\n- if successful, the carrier will receive a notification about the date change request with details\n- 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\n \nNOTE: 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.\n\nParams:\n\n- `periodic`: string, required\n- `routepart`: int, required\n- `newDate`: string, date format expected: YYYY-MM-DD\n \nReturns the ID of the routechange entity, which the carrier is expected to react upon.", "body": { "mode": "raw", "raw": "\"{ \\n \\\"periodic\\\": \\\"{{routePeriodic}}\\\", \\n \\\"routepart\\\": {{routepartId}},\\n \\\"newDate\\\": \\\"{{newDate}}\\\"\\n}\"", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"routechange\": 115568\n}" }, { "name": "Bad routepart supplied", "originalRequest": [], "status": "Bad routepart supplied", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Wrong routepart number\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "invalid token supplied", "originalRequest": [], "status": "invalid token supplied", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Request Reopening of Route", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/requestVacantizeRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "requestVacantizeRoute" ], "query": [], "variable": [] }, "description": "Request Reopening of Route", "body": { "mode": "raw", "raw": "{\n \"periodic\": \"{{singleRoute}}\",\n \"reason\": \"reason\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Request General Changes", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/requestGenericChanges", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "requestGenericChanges" ], "query": [], "variable": [] }, "description": "Request General Changes", "body": { "mode": "raw", "raw": "{\n \"periodic\": \"1-11-11\",\n \"reason\": \"Some reason\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Request Cancellation", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/requestCancel", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "requestCancel" ], "query": [], "variable": [] }, "description": "Request Cancellation", "body": { "mode": "raw", "raw": "{\n \"periodic\": \"11-11-11\",\n \"reason\": \"Some reason\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Routes & Tenders", "item": [ { "name": "Get Route or Tender Details", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/singleRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "singleRoute" ], "query": [ { "key": "route", "value": "{{singleRoute}}", "description": "Single route/tender periodic", "disabled": true } ], "variable": [] }, "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`.\n\n- if successful you will receive the details of the route or tender\n- 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", "body": { "mode": "urlencoded", "urlencoded": [] } }, "response": [ { "name": "Success / Success (tender)", "originalRequest": [], "status": "Success / Success (tender)", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"route\": {\n \"autosubscribe\": false,\n \"blindtender\": false,\n \"bookedbyme\": false,\n \"bookedsince\": 1575638584,\n \"bookedtill\": -62169984000,\n \"booktime\": 30,\n \"budget\": 15230,\n \"cartype\": null,\n \"chargetype\": null,\n \"clientdata\": {\n \"hash\": \"3c5e448b11f15293807d9cfdedf21582\"\n },\n \"companydata\": {\n \"natcomid\": \"1231231231231\",\n \"title_ru\": \"ОрджМеталлПромИнweightт, АО\"\n },\n \"complete\": false,\n \"context\": {\n \"iconTitle\": null,\n \"title\": null\n },\n \"defaultcurrency\": null,\n \"deleted\": false,\n \"distance\": 47,\n \"ferryproperty\": [\n \"Pallets 15 pcs\",\n \"Temperature 0 ° C\",\n \"Belts 5 pcs\"\n ],\n \"istender\": false,\n \"kmprice\": 0,\n \"maxquotewithcommission\": 0,\n \"mcubeprice\": 0,\n \"nds\": false,\n \"newMessages\": 0,\n \"operatordata\": {\n \"contract_date\": 1722470400,\n \"contract_number\": \"CSW-11\",\n \"hash\": \"77f085a461d24c90296abcd5ff4cf62f\",\n \"natcomid\": \"88888888\",\n \"title_ru\": \"Carrier 1, LTD\"\n },\n \"paymenttype\": {\n \"id\": 3,\n \"title\": \"Cash\"\n },\n \"payorcompany\": {\n \"id\": 0,\n \"natcomid\": null,\n \"title\": null\n },\n \"periodic\": \"243-06-16\",\n \"remark\": \"\",\n \"response\": {\n \"73702\": {\n \"cancelled\": \"0\",\n \"car\": {\n \"actual_provider_natcomid\": \"37534432\",\n \"actual_provider_title\": \"Phleetto, LTD\",\n \"axes\": 0,\n \"body_type\": \"TIPPER\",\n \"body_type_unique_id\": 113,\n \"carstyle\": \"singlecarstyle\",\n \"cartype\": 10,\n \"cellnum\": \"\",\n \"height\": 0,\n \"id\": 15677,\n \"insuredTil\": -62169984000,\n \"length\": 0.999,\n \"loadcapacity\": \"0.000\",\n \"make\": {\n \"id\": 6,\n \"title_ru\": \"Citroen\"\n },\n \"model\": null,\n \"number\": \"123\",\n \"remark\": \"\",\n \"total_weight\": \"20.500\",\n \"trailer\": 180256,\n \"vehicleclass\": null,\n \"vin\": \"\",\n \"volume\": 0.999,\n \"weight\": 0,\n \"width\": 0\n },\n \"checkedtender\": \"0\",\n \"companytitle\": null,\n \"companytitlewing\": null,\n \"driver\": {\n \"car\": 15677,\n \"demographicid\": \"123123123123-123123123\",\n \"driverlicenseissued\": \"123\",\n \"driverlicenseissuedby\": null,\n \"driverlicensenumber\": null,\n \"driverlicenseserial\": \"/0\",\n \"firstname\": \"123\",\n \"id\": 14793,\n \"inblacklist\": \"0\",\n \"lastname\": \"/0\",\n \"maincellphone\": \"123\",\n \"passportserial\": \"\",\n \"patronymic\": \"\",\n \"taxid\": \"\"\n },\n \"driver2\": null,\n \"id\": 73702,\n \"isMine\": true,\n \"loadquote\": null,\n \"moment\": 1466096342,\n \"operator\": 180,\n \"operatorispartnerwithclient\": \"0\",\n \"operatorsupervisorid\": null,\n \"orderlist\": null,\n \"paymenttype\": \"0\",\n \"pricequote\": 0,\n \"pricequoteavailableuntil\": \"\",\n \"pricequoteavailableuntilmoment\": -62169984000,\n \"pricequotewing\": null,\n \"pricequotewithcommission\": null,\n \"remark\": \"\",\n \"route\": 94352,\n \"selected\": \"0\",\n \"status\": \"\",\n \"trailer\": {\n \"axes\": \"0\",\n \"body_type\": \"11-TIPPER\",\n \"body_type_unique_id\": 213,\n \"height\": \"4.000\",\n \"id\": \"180256\",\n \"length\": \"13.000\",\n \"loadcapacity\": \"0.000\",\n \"make\": \"KRONE\",\n \"model\": \"SDR 27\",\n \"number\": \"АА0000РІ\",\n \"total_weight\": \"35.000\",\n \"volume\": \"0.000\",\n \"weight\": \"10.540\",\n \"width\": \"2.000\"\n },\n \"user\": 269\n }\n },\n \"routeparts\": [\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"Pallets\",\n \"checkpoint\": {\n \"address\": \"1, High Street\",\n \"apicode\": \"3941\",\n \"badcoords\": \"0\",\n \"classic\": \"1\",\n \"client\": \"760\",\n \"company\": {\n \"actsonbaseof\": \"\",\n \"apikeyNP\": \"\",\n \"bankaccount\": \"\",\n \"bankname\": \"\",\n \"cardholdercode\": \"\",\n \"cardholdername\": \"\",\n \"cardnum\": \"\",\n \"country\": \"215\",\n \"director\": \"\",\n \"director_case\": \"\",\n \"directorfirstname\": \"\",\n \"directorpatronymic\": \"\",\n \"email\": \"\",\n \"factaddress\": \"\",\n \"faxnum\": \"\",\n \"id\": \"3463\",\n \"ifoid\": \"\",\n \"korraccount\": \"\",\n \"legaladdress\": \"\",\n \"logisticsratified\": \"0\",\n \"logisticsratifiedbyuser\": \"0\",\n \"logisticsratifiedmoment\": -62169984000,\n \"natcomid\": \"\",\n \"othercontactinfo\": \"\",\n \"ownership\": \"\",\n \"registryvalidated\": null,\n \"signer\": \"\",\n \"signer_case\": \"\",\n \"swift\": null,\n \"taxid\": \"\",\n \"telnum\": \"\",\n \"title_full_ru\": \"\",\n \"title_ru\": \"Loader, LTD\",\n \"vatid\": \"\",\n \"website\": \"\"\n },\n \"customs\": \"0\",\n \"duration\": \"120\",\n \"end-workinghours\": \"\",\n \"googleplaceid\": \"\",\n \"harbor\": null,\n \"id\": \"3941\",\n \"json\": \"\",\n \"latit\": \"46.762989000000000\",\n \"longit\": \"36.793458000000000\",\n \"radius_km\": \"0.5\",\n \"remark\": \"\",\n \"service\": \"0\",\n \"start-workinghours\": \"\",\n \"technote\": null,\n \"town\": {\n \"borderswith\": \"0\",\n \"country\": {\n \"continent\": \"Europe\",\n \"currency\": \"грн\",\n \"currencycode\": \"uah\",\n \"domainname\": \"UA\",\n \"id\": \"215\",\n \"iso_code\": \"UKR\",\n \"iso_num\": \"804\",\n \"subcontinent\": \"East Europe\",\n \"timezone\": \"+2\",\n \"title_alphabeta\": \"Ukraine\",\n \"title_en\": \"Ukraine\",\n \"title_full_ru\": \" \",\n \"title_ru\": \"Ukraine\",\n \"title_ua\": \"Ukraine\",\n \"vat\": \"20\",\n \"webdomain\": \"phleetto.uk\"\n },\n \"district\": \"\",\n \"googleplaceid\": \"\",\n \"id\": \"7556\",\n \"latit\": \"46.7636100000\",\n \"longit\": \"36.7986100000\",\n \"nationalid\": \"2310400000\",\n \"nationaltitle\": \"Berdiansk\",\n \"region\": {\n \"country\": \"215\",\n \"id\": \"7\",\n \"timezone\": \"\",\n \"title_ru\": \"Zaporizhzha oblast\",\n \"title_ua\": \"Zaporizhzha oblast\"\n },\n \"title_ru\": \"Berdiansk\",\n \"title_ua\": \"Berdiansk\"\n },\n \"townstring\": \"\",\n \"zip\": null\n },\n \"checkpointcontacts\": {\n \"cellnum\": \"\",\n \"contactperson\": \"3067\",\n \"id\": 1111,\n \"remark\": \"\"\n },\n \"complete\": false,\n \"date1\": 1466035200,\n \"date2\": 1466467200,\n \"dimensions\": [\n {\n \"title\": \"t weight\",\n \"value\": 45\n },\n {\n \"title\": \"mcub volume\",\n \"value\": 0\n },\n {\n \"title\": \"m length\",\n \"value\": 0\n },\n {\n \"title\": \"m width\",\n \"value\": 0\n },\n {\n \"title\": \"m height\",\n \"value\": 0\n },\n {\n \"title\": null,\n \"value\": 0\n }\n ],\n \"factarrivaldate\": -62169984000,\n \"factarrivaltime\": \"00:00:00\",\n \"id\": 111365645,\n \"plannedarrivaldate\": -62169984000,\n \"plannedarrivaltime\": \"00:00:00\",\n \"suggestedOrder\": null,\n \"time1\": \"08:30:00\",\n \"time2\": \"14:00:00\",\n \"triggered\": true,\n \"workaction\": 1,\n \"workaction_data\": {\n \"classic\": \"1\",\n \"doer_ru\": \"shipper\",\n \"id\": \"1\",\n \"instance_accus_case\": \"point of loading\",\n \"title\": \"charge\",\n \"title_ru\": \"loading\",\n \"title_ru_accus_case\": \"loading\",\n \"title_ru_rod_case\": \"loading\",\n \"title_ua\": \"loading\",\n \"title_ua_rod_case\": \"loading\"\n },\n \"workcompletedate\": -62169984000,\n \"workcompletetime\": \"00:00:00\",\n \"workstartdate\": -62169984000,\n \"workstarttime\": \"00:00:00\"\n },\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"А\",\n \"checkpoint\": {\n \"address\": \"1, Low Street\",\n \"apicode\": \"4518\",\n \"badcoords\": \"0\",\n \"classic\": \"1\",\n \"client\": \"760\",\n \"company\": {\n \"actsonbaseof\": \"\",\n \"apikeyNP\": \"\",\n \"bankaccount\": \"\",\n \"bankname\": \"\",\n \"cardholdercode\": \"\",\n \"cardholdername\": \"\",\n \"cardnum\": \"\",\n \"country\": \"215\",\n \"director\": \"\",\n \"director_case\": \"\",\n \"directorfirstname\": \"\",\n \"directorpatronymic\": \"\",\n \"email\": \"\",\n \"factaddress\": \"\",\n \"faxnum\": \"\",\n \"id\": \"170\",\n \"ifoid\": \"\",\n \"korraccount\": \"\",\n \"legaladdress\": \"\",\n \"logisticsratified\": \"0\",\n \"logisticsratifiedbyuser\": \"0\",\n \"logisticsratifiedmoment\": -62169984000,\n \"natcomid\": \"\",\n \"othercontactinfo\": \"\",\n \"ownership\": \"\",\n \"registryvalidated\": null,\n \"signer\": \"\",\n \"signer_case\": \"\",\n \"swift\": null,\n \"taxid\": \"\",\n \"telnum\": \"\",\n \"title_full_ru\": \"\",\n \"title_ru\": \"ооо\",\n \"vatid\": \"\",\n \"website\": \"\"\n },\n \"customs\": \"0\",\n \"duration\": \"120\",\n \"end-workinghours\": \"\",\n \"googleplaceid\": \"\",\n \"harbor\": null,\n \"id\": \"4518\",\n \"json\": \"\",\n \"latit\": \"50.550696000000000\",\n \"longit\": \"30.225138000000000\",\n \"radius_km\": \"0.5\",\n \"remark\": \"\",\n \"service\": \"0\",\n \"start-workinghours\": \"\",\n \"technote\": null,\n \"town\": {\n \"borderswith\": \"0\",\n \"country\": {\n \"continent\": \"Europe\",\n \"currency\": \"грн\",\n \"currencycode\": \"uah\",\n \"domainname\": \"UA\",\n \"id\": \"215\",\n \"iso_code\": \"UKR\",\n \"iso_num\": \"804\",\n \"subcontinent\": \"East Europe\",\n \"timezone\": \"+2\",\n \"title_alphabeta\": \"Ukraine\",\n \"title_en\": \"Ukraine\",\n \"title_full_ru\": \" \",\n \"title_ru\": \"Ukraine\",\n \"title_ua\": \"Ukraine\",\n \"vat\": \"20\",\n \"webdomain\": \"phleetto.uk\"\n },\n \"district\": \"Irpin\",\n \"googleplaceid\": \"\",\n \"id\": \"9327\",\n \"latit\": \"50.4461100000\",\n \"longit\": \"30.0652800000\",\n \"nationalid\": \"3222480802\",\n \"nationaltitle\": \"Bucha\",\n \"region\": {\n \"country\": \"215\",\n \"id\": \"9\",\n \"timezone\": \"\",\n \"title_ru\": \"Kyiv region\",\n \"title_ua\": \"Kyiv region\"\n },\n \"title_ru\": \"Bucha\",\n \"title_ua\": \"Bucha\"\n },\n \"townstring\": \"\",\n \"zip\": null\n },\n \"checkpointcontacts\": {\n \"cellnum\": \"0676227670\",\n \"contactperson\": \"Jenny\",\n \"id\": 1111,\n \"remark\": \"\"\n },\n \"complete\": false,\n \"date1\": 1466467200,\n \"date2\": -62169984000,\n \"dimensions\": [\n {\n \"title\": \"t weight\",\n \"value\": 1\n },\n {\n \"title\": \"mcub volume\",\n \"value\": 0\n },\n {\n \"title\": \"m length\",\n \"value\": 0\n },\n {\n \"title\": \"m width\",\n \"value\": 0\n },\n {\n \"title\": \"m height\",\n \"value\": 0\n },\n {\n \"title\": null,\n \"value\": 0\n }\n ],\n \"factarrivaldate\": -62169984000,\n \"factarrivaltime\": \"00:00:00\",\n \"id\": 111365646,\n \"plannedarrivaldate\": -62169984000,\n \"plannedarrivaltime\": \"00:00:00\",\n \"suggestedOrder\": null,\n \"time1\": \"00:00:00\",\n \"time2\": \"00:00:00\",\n \"triggered\": false,\n \"workaction\": 1,\n \"workaction_data\": {\n \"classic\": \"1\",\n \"doer_ru\": \"shipper\",\n \"id\": \"1\",\n \"instance_accus_case\": \"point of loading\",\n \"title\": \"charge\",\n \"title_ru\": \"loading\",\n \"title_ru_accus_case\": \"loading\",\n \"title_ru_rod_case\": \"loading\",\n \"title_ua\": \"loading\",\n \"title_ua_rod_case\": \"loading\"\n },\n \"workcompletedate\": -62169984000,\n \"workcompletetime\": \"00:00:00\",\n \"workstartdate\": -62169984000,\n \"workstarttime\": \"00:00:00\"\n },\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"\",\n \"checkpoint\": {\n \"address\": \"1, Low Street\",\n \"apicode\": \"4518\",\n \"badcoords\": \"0\",\n \"classic\": \"1\",\n \"client\": \"760\",\n \"company\": {\n \"actsonbaseof\": \"\",\n \"apikeyNP\": \"\",\n \"bankaccount\": \"\",\n \"bankname\": \"\",\n \"cardholdercode\": \"\",\n \"cardholdername\": \"\",\n \"cardnum\": \"\",\n \"country\": \"215\",\n \"director\": \"\",\n \"director_case\": \"\",\n \"directorfirstname\": \"\",\n \"directorpatronymic\": \"\",\n \"email\": \"\",\n \"factaddress\": \"\",\n \"faxnum\": \"\",\n \"id\": \"170\",\n \"ifoid\": \"\",\n \"korraccount\": \"\",\n \"legaladdress\": \"\",\n \"logisticsratified\": \"0\",\n \"logisticsratifiedbyuser\": \"0\",\n \"logisticsratifiedmoment\": -62169984000,\n \"natcomid\": \"\",\n \"othercontactinfo\": \"\",\n \"ownership\": \"\",\n \"registryvalidated\": null,\n \"signer\": \"\",\n \"signer_case\": \"\",\n \"swift\": null,\n \"taxid\": \"\",\n \"telnum\": \"\",\n \"title_full_ru\": \"\",\n \"title_ru\": \"ооо\",\n \"vatid\": \"\",\n \"website\": \"\"\n },\n \"customs\": \"0\",\n \"duration\": \"120\",\n \"end-workinghours\": \"\",\n \"googleplaceid\": \"\",\n \"harbor\": null,\n \"id\": \"4518\",\n \"json\": \"\",\n \"latit\": \"50.550696000000000\",\n \"longit\": \"30.225138000000000\",\n \"radius_km\": \"0.5\",\n \"remark\": \"\",\n \"service\": \"0\",\n \"start-workinghours\": \"\",\n \"technote\": null,\n \"town\": {\n \"borderswith\": \"0\",\n \"country\": {\n \"continent\": \"Europe\",\n \"currency\": \"грн\",\n \"currencycode\": \"uah\",\n \"domainname\": \"UA\",\n \"id\": \"215\",\n \"iso_code\": \"UKR\",\n \"iso_num\": \"804\",\n \"subcontinent\": \"East Europe\",\n \"timezone\": \"+2\",\n \"title_alphabeta\": \"Ukraine\",\n \"title_en\": \"Ukraine\",\n \"title_full_ru\": \" \",\n \"title_ru\": \"Ukraine\",\n \"title_ua\": \"Ukraine\",\n \"vat\": \"20\",\n \"webdomain\": \"phleetto.uk\"\n },\n \"district\": \"Irpin\",\n \"googleplaceid\": \"\",\n \"id\": \"9327\",\n \"latit\": \"50.4461100000\",\n \"longit\": \"30.0652800000\",\n \"nationalid\": \"3222480802\",\n \"nationaltitle\": \"Bucha\",\n \"region\": {\n \"country\": \"215\",\n \"id\": \"9\",\n \"timezone\": \"\",\n \"title_ru\": \"Kyiv region\",\n \"title_ua\": \"Kyiv region\"\n },\n \"title_ru\": \"Bucha\",\n \"title_ua\": \"Bucha\"\n },\n \"townstring\": \"\",\n \"zip\": null\n },\n \"checkpointcontacts\": {\n \"cellnum\": \"0676227670\",\n \"contactperson\": \"Jenny\",\n \"id\": 1111,\n \"remark\": \"\"\n },\n \"complete\": false,\n \"date1\": 1467244800,\n \"date2\": 1466640000,\n \"dimensions\": [\n {\n \"title\": \"t weight\",\n \"value\": 0\n },\n {\n \"title\": \"mcub volume\",\n \"value\": 0\n },\n {\n \"title\": \"m length\",\n \"value\": 0\n },\n {\n \"title\": \"m width\",\n \"value\": 0\n },\n {\n \"title\": \"m height\",\n \"value\": 0\n },\n {\n \"title\": null,\n \"value\": 0\n }\n ],\n \"id\": 111365647,\n \"plannedarrivaldate\": -62169984000,\n \"plannedarrivaltime\": \"00:00:00\",\n \"time1\": \"08:30:00\",\n \"time2\": \"22:00:00\",\n \"triggered\": false,\n \"workaction\": 2,\n \"workaction_data\": {\n \"classic\": \"1\",\n \"doer_ru\": \"consignee\",\n \"id\": \"2\",\n \"instance_accus_case\": \"point of unloading\",\n \"title\": \"uncharge\",\n \"title_ru\": \"Unloading\",\n \"title_ru_accus_case\": \"unloading\",\n \"title_ru_rod_case\": \"unloading\",\n \"title_ua\": \"unloading\",\n \"title_ua_rod_case\": \"unloading\"\n }\n }\n ],\n \"routeresponse\": 73702,\n \"routestatus\": 6,\n \"tonnprice\": 331.09,\n \"totalweight\": 46,\n \"unitPrices\": [\n {\n \"title\": \"UAH/tonn\",\n \"value\": \"331.09\"\n },\n {\n \"title\": \"UAH/mcub\",\n \"value\": \"0.00\"\n },\n {\n \"title\": \"UAH/km\",\n \"value\": \"0.00\"\n }\n ],\n \"userclientdata\": {\n \"cellnum\": \"+380991231212\",\n \"email\": \"email@gmail.com\",\n \"name\": \"John\"\n },\n \"useroperatordata\": {\n \"cellnum\": \"0671231212\",\n \"email\": \"email@gmail.com\",\n \"name\": \"Josh Potter\"\n }\n }\n },\n \"status\": \"success\"\n}" }, { "name": "Missing route number", "originalRequest": [], "status": "Missing route number", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"We couldn’t find such a route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Missing token", "originalRequest": [], "status": "Missing token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is required\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Conversation Groups", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getRouteMessageGroups", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getRouteMessageGroups" ], "query": [ { "key": "route", "value": "{{periodic}}", "description": "Periodic of route/tender", "disabled": true }, { "key": "collocutor", "value": "{{companyHash}}", "description": "Optional. If passed, shows all messages from the passed collocutor within the passed route/tender.", "disabled": true } ], "variable": [] }, "description": "The method returns groups of messages for a given route/tender. Groups are grouped by collocutor, with last message included.\n\nIf a certain collocutor company passed as `collocutor` param, then _all_ messages from that collocutor are listed.\n\n- if successful you will receive message groups or all messages of a collocutor\n- 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" }, "response": [ { "name": "Two companies (collocutors) in route/tender / All messages from one company (collocutor) in route/tender / No messages for you in route/tender", "originalRequest": [], "status": "Two companies (collocutors) in route/tender / All messages from one company (collocutor) in route/tender / No messages for you in route/tender", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"158030\": {\n \"authorCompanyTitle\": \"Partner, LTD\",\n \"authorHash\": \"a88a8888aaa8d88aa8a8d8a888a8aa88\",\n \"authorName\": \"Sender\",\n \"authorNatcomid\": \"6722356984\",\n \"content\": \"Please inform us in advance about the vehicle’s arrival.\",\n \"content_plaintext\": \"content\",\n \"moment\": 1630270847,\n \"new\": true,\n \"priority\": \"normal\",\n \"userAvatar\": \"\"\n },\n \"158032\": {\n \"authorCompanyTitle\": \"Partner, LTD\",\n \"authorHash\": \"a88a8888aaa8d88aa8a8d8a888a8aa88\",\n \"authorName\": \"Sender\",\n \"authorNatcomid\": \"6712356984\",\n \"content\": \"second message\",\n \"content_plaintext\": \"content\",\n \"moment\": 1630271072,\n \"new\": true,\n \"priority\": \"normal\",\n \"userAvatar\": \"\"\n }\n },\n \"status\": \"success\"\n}" }, { "name": "Invalid collocutor for valid route/tender / Route not found / No permission to view route/tender", "originalRequest": [], "status": "Invalid collocutor for valid route/tender / Route not found / No permission to view route/tender", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Company not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Available Message Recipients", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getRouteMessageRecepients", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getRouteMessageRecepients" ], "query": [ { "key": "route", "value": "{{singleRoute}}", "description": "Periodic of route/tender", "disabled": true } ], "variable": [] }, "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.\n\n* if success response will include a list of potential message recipients" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"recepientCompany\": \"Shipper LTD\",\n \"recepientHash\": \"da9cc741ae2ca7e4adf596b773a7b187\",\n \"recepientNatcomid\": \"37534432223\"\n },\n {\n \"recepientCompany\": \"Shipper 2 LTD\",\n \"recepientHash\": \"316f03860bf020ffa01c50dceaaf7ba2\",\n \"recepientNatcomid\": \"47534432223\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Route not found / No permission to view route/tender", "originalRequest": [], "status": "Route not found / No permission to view route/tender", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Send Message", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/sendMessage", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "sendMessage" ], "query": [], "variable": [] }, "description": "Allows shipper to send a plain text message to the carrier that pertains to a particular route.\n\nParams:\n\n- **periodic**: string, required, periodic of the route in question\n- **recepient**: string, requried, hash of the carrier\n- **message**: string, required, plain text message", "body": { "mode": "raw", "raw": "{\n \"message\": \"test message https://phleet.to\",\n \"periodic\": \"18-07-21\",\n \"recipient\": \"316f03860bf020ffa01c50dceaaf7ba2\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": true\n}" }, { "name": "Token not supplied", "originalRequest": [], "status": "Token not supplied", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"token is required\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Activity Log", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/routeChronology", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "routeChronology" ], "query": [ { "key": "route", "value": "{{singleRoute}}", "description": "Single route periodic", "disabled": true } ], "variable": [] }, "description": "Returns the list of actions (changes) performed with a single route/tender.\n- if successful you will receive your route chronology \n- 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\n\n(!) NOTE: If requested by a shipper account the endpoint returns all information. If requested by a carrier account, some limitations apply." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"action\": \"Route published\",\n \"author\": \"John Doe\",\n \"date\": 1579478400,\n \"isMyCompany\": true,\n \"time\": \"10:16\"\n },\n {\n \"action\": \"The carrier proposed a vehicle.\",\n \"author\": \"\",\n \"date\": 1579478400,\n \"isMyCompany\": false,\n \"time\": \"10:17\"\n },\n {\n \"action\": \"The customer approved the proposal.\",\n \"author\": \"\",\n \"date\": 1579478400,\n \"isMyCompany\": false,\n \"time\": \"10:17\"\n },\n {\n \"action\": \"The carrier confirmed the work on the route.\",\n \"author\": \"\",\n \"date\": 1579478400,\n \"isMyCompany\": false,\n \"time\": \"10:17\"\n },\n {\n \"action\": \"The vehicle arrived for loading.\",\n \"author\": \"\",\n \"date\": 1579478400,\n \"isMyCompany\": false,\n \"time\": \"10:17\"\n },\n {\n \"action\": \"Loading confirmed successfully.\",\n \"author\": \"\",\n \"date\": 1579478400,\n \"isMyCompany\": false,\n \"time\": \"10:17\"\n },\n {\n \"action\": \"The vehicle arrived at customs.\",\n \"author\": \"\",\n \"date\": 1579478400,\n \"isMyCompany\": false,\n \"time\": \"10:17\"\n },\n {\n \"action\": \"The vehicle is back on the road.\",\n \"author\": \"\",\n \"date\": 1579478400,\n \"isMyCompany\": false,\n \"time\": \"10:18\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Not allowed to view route", "originalRequest": [], "status": "Not allowed to view route", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Distance", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getRouteDistance", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getRouteDistance" ], "query": [ { "key": "route", "value": "{{singleRoute}}", "description": "Single route periodic", "disabled": true } ], "variable": [] }, "description": "Returns the information about the total route distance, as well as the distance to border, and the detailed distance between all points.\n\n- If successful you will receive information about the vehicle and the drivers on the route\n \n- 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" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"distance\": 3575.65,\n \"distanceAfterBorder\": 2815.49,\n \"distanceToBorder\": 760.16,\n \"legs\": [\n {\n \"0\": {\n \"country\": \"UKR\",\n \"country_iso\": \"804\",\n \"latit\": 50.4167119,\n \"longit\": 30.539385,\n \"title\": \"Kyiv\"\n },\n \"1\": {\n \"country\": \"UKR\",\n \"country_iso\": \"804\",\n \"latit\": 50.4449244,\n \"longit\": 30.5069196,\n \"title\": \"Kyiv\"\n },\n \"distance\": 5.7\n },\n {\n \"0\": {\n \"country\": \"UKR\",\n \"country_iso\": \"804\",\n \"latit\": 50.4449244,\n \"longit\": 30.5069196,\n \"title\": \"Kyiv\"\n },\n \"1\": {\n \"country\": \"UKR\",\n \"country_iso\": \"804\",\n \"latit\": 45.46056,\n \"longit\": 28.28611,\n \"title\": \"Reni\"\n },\n \"distance\": 754.46\n },\n {\n \"0\": {\n \"country\": \"UKR\",\n \"country_iso\": \"804\",\n \"latit\": 45.46056,\n \"longit\": 28.28611,\n \"title\": \"Reni\"\n },\n \"1\": {\n \"country\": \"GBR\",\n \"country_iso\": \"826\",\n \"latit\": 50.9110102,\n \"longit\": -1.404417,\n \"title\": \"Southampton\"\n },\n \"distance\": 2815.49\n }\n ],\n \"unit\": \"km\"\n },\n \"status\": \"success\"\n}" }, { "name": "Not allowed to view route", "originalRequest": [], "status": "Not allowed to view route", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Documents", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getRouteDocuments", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getRouteDocuments" ], "query": [ { "key": "route", "value": "{{singleRoute}}", "description": "Single route periodic", "disabled": true } ], "variable": [] }, "description": "This endpoint allows you to retrieve documents related to a specific route.\n\n* if successful response will include the documents related to the specified route." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"authorCompany\": \"Something, LTD\",\n \"authorCompanyHash\": \"b1e411e6032a93bee5acfaff26173691\",\n \"authorNatcomid\": \"2722356984\",\n \"authorUser\": \"Robot Valera\",\n \"authorUserId\": \"10194\",\n \"extention\": \"png\",\n \"moment\": 1703076973,\n \"remark\": \"2013-12-15-в-21.26.55-e1387135740104\",\n \"route\": \"52-10-23\",\n \"url\": \"https://test.phleetto.co.uk:443/uploads/sovtes_uploadfile_6719_SPACE SPACE_6582c84b48b9f_.png\",\n \"urlEncoded\": \"https%3A%2F%2Ftest.phleetto.co.uk%3A443%2Fuploads%2Fsovtes_uploadfile_6719_SPACE+SPACE_6582c84b48b9f_.png\"\n },\n {\n \"authorCompany\": \"Something, LTD\",\n \"authorCompanyHash\": \"b1e411e6032a93bee5acfaff26173691\",\n \"authorNatcomid\": \"6722356984\",\n \"authorUser\": \"Super Oleg\",\n \"authorUserId\": \"11814\",\n \"extention\": \"png\",\n \"moment\": 1703078205,\n \"remark\": \"ttndraft.png\",\n \"route\": \"52-10-23\",\n \"url\": \"https://test.phleetto.co.uk/uploads/Phleetto-route-79669-a756fe-ttndraft.png\",\n \"urlEncoded\": \"https%3A%2F%2Ftest.phleetto.co.uk%2Fuploads%2FPhleetto-route-79669-a756fe-ttndraft.png\"\n },\n {\n \"authorCompany\": \"Something, LTD\",\n \"authorCompanyHash\": \"b1e411e6032a93bee5acfaff26173691\",\n \"authorNatcomid\": \"722356984\",\n \"authorUser\": \"Some User\",\n \"authorUserId\": \"11814\",\n \"extention\": \"png\",\n \"moment\": 1703078220,\n \"remark\": \"ttndraft.png\",\n \"route\": \"52-10-23\",\n \"url\": \"https://test.phleetto.co.uk/uploads/Phleetto-route-57346-ac3aa6-ttndraft.png\",\n \"urlEncoded\": \"https%3A%2F%2Ftest.phleetto.co.uk%2Fuploads%2FPhleetto-route-57346-ac3aa6-ttndraft.png\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid route number", "originalRequest": [], "status": "Invalid route number", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Upload Document", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/addDocument", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "addDocument" ], "query": [], "variable": [] }, "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).\n\nNo more than 5 files can be uploaded in a single request.", "body": { "mode": "formdata", "formdata": [ { "key": "documents[]", "value": "", "description": "", "type": "text" }, { "key": "periodic", "value": "32676307200", "description": "Periodic of the route. Required. String/tender", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"documents\": {\n \"0-02-0a-4f9bdbbac9084f6a3e726f30462e500aaf2ae740f4d8aa924e9e7a05d08e841d_2709ed6caa8.jpg\": {\n \"size\": \"250493\",\n \"url\": \"https://test.phleetto.co.uk/uploads/Phleetto-route-43759-43a4af-0-02-0a-4f9bdbbac9084f6a3e726f30462e500aaf2ae740f4d8aa924e9e7a05d08e841d_2709ed6caa8.jpg\"\n },\n \"856 (1).pdf\": {\n \"size\": \"189441\",\n \"url\": \"https://test.phleetto.co.uk/uploads/Phleetto-route-71884-3dcba3-856 (1).pdf\"\n }\n },\n \"route\": 32676307200\n },\n \"status\": \"success\"\n}" }, { "name": "Invalid route / Not allowed to view route / Invalid file type passed / Supplied file is infected / Too many documents supplied / Supplied document is too big", "originalRequest": [], "status": "Invalid route / Not allowed to view route / Invalid file type passed / Supplied file is infected / Too many documents supplied / Supplied document is too big", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"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.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Stop Towns", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getTown", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getTown" ], "query": [ { "key": "byCheckpoint", "value": "{{townsByCheckpoint}}", "description": "Optional int. True: Returns the list of cities in which checkpoints/warehouses of current user company are present. False: ignores the parameter", "disabled": true }, { "key": "byCompany", "value": "{{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.", "disabled": true }, { "key": "byCountry", "value": "{{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.", "disabled": true }, { "key": "byRegion", "value": "{{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.", "disabled": true }, { "key": "byCustoms", "value": "{{customsFlag}}", "description": "Optional int. Narrows the list given with `byCheckpoint` parameter to cities with customs checkpoints. Works only if `byCheckpoint` parameter is passed.", "disabled": true }, { "key": "byBorder", "value": "{{townsByCheckpointBorder}}", "description": "Optional int. Returns the list of cities with border checkpoints", "disabled": true }, { "key": "bordersWith", "value": "{{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.", "disabled": true } ], "variable": [] }, "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.\n\n* if successful you will receive list of towns, depending of the list parameters\n* 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" }, "response": [ { "name": "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)", "originalRequest": [], "status": "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)", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Ratne raion\",\n \"id\": 1707,\n \"latit\": 51.62556,\n \"longit\": 24.12639,\n \"nationalId\": \"0724282201\",\n \"region\": {\n \"id\": 2,\n \"title\": \"Volyn oblast\"\n },\n \"title\": \"Huta\"\n },\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Liubeshiv raion\",\n \"id\": 1735,\n \"latit\": 51.89306,\n \"longit\": 25.51722,\n \"nationalId\": \"0725580901\",\n \"region\": {\n \"id\": 2,\n \"title\": \"Volyn oblast\"\n },\n \"title\": \"Dolsk\"\n },\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Ratne raion\",\n \"id\": 1737,\n \"latit\": 51.82361,\n \"longit\": 24.34139,\n \"nationalId\": \"0724285504\",\n \"region\": {\n \"id\": 2,\n \"title\": \"Volyn oblast\"\n },\n \"title\": \"Domanove\"\n },\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Shatsk raion\",\n \"id\": 2207,\n \"latit\": 51.605,\n \"longit\": 23.81,\n \"nationalId\": \"0725783901\",\n \"region\": {\n \"id\": 2,\n \"title\": \"Volyn oblast\"\n },\n \"title\": \"Pishcha\"\n },\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Shatsk raion\",\n \"id\": 2257,\n \"latit\": 51.54194,\n \"longit\": 23.71056,\n \"nationalId\": \"0725784501\",\n \"region\": {\n \"id\": 2,\n \"title\": \"Volyn oblast\"\n },\n \"title\": \"Pulemets\"\n },\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Ratne raion\",\n \"id\": 2314,\n \"latit\": 51.865,\n \"longit\": 24.61694,\n \"nationalId\": \"0724286901\",\n \"region\": {\n \"id\": 2,\n \"title\": \"Volyn oblast\"\n },\n \"title\": \"Samary\"\n },\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Ratne raion\",\n \"id\": 2446,\n \"latit\": 51.675,\n \"longit\": 24.27833,\n \"nationalId\": \"0724287601\",\n \"region\": {\n \"id\": 2,\n \"title\": \"Volyn oblast\"\n },\n \"title\": \"Tur\"\n },\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Shatsk raion\",\n \"id\": 2487,\n \"latit\": 51.63833,\n \"longit\": 23.72722,\n \"nationalId\": \"0725785005\",\n \"region\": {\n \"id\": 2,\n \"title\": \"Volyn oblast\"\n },\n \"title\": \"Khrypsk\"\n },\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Ovruch raion\",\n \"id\": 5526,\n \"latit\": 51.56361,\n \"longit\": 29.07806,\n \"nationalId\": \"1824286709\",\n \"region\": {\n \"id\": 5,\n \"title\": \"Zhytomyr oblast\"\n },\n \"title\": \"Vystupovychi\"\n },\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Poliske raion\",\n \"id\": 9374,\n \"latit\": 51.36,\n \"longit\": 29.43111,\n \"nationalId\": \"3200000000\",\n \"region\": {\n \"id\": 9,\n \"title\": \"Kyiv oblast\"\n },\n \"title\": \"Vilcha\"\n },\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Dubrovytsia raion\",\n \"id\": 19439,\n \"latit\": 51.80361,\n \"longit\": 26.69889,\n \"nationalId\": \"5624683001\",\n \"region\": {\n \"id\": 17,\n \"title\": \"Rivne oblast\"\n },\n \"title\": \"Horodyshche\"\n },\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Dubrovytsia raion\",\n \"id\": 19939,\n \"latit\": 51.72444,\n \"longit\": 26.9775,\n \"nationalId\": \"5600000000\",\n \"region\": {\n \"id\": 17,\n \"title\": \"Rivne oblast\"\n },\n \"title\": \"Perebrody\"\n },\n {\n \"borderswith\": 20,\n \"country\": 215,\n \"district\": \"Chernihiv raion\",\n \"id\": 2138332,\n \"latit\": 51.53162,\n \"longit\": 30.7735551,\n \"nationalId\": \"7400000000\",\n \"region\": {\n \"id\": 24,\n \"title\": \"Chernihiv oblast\"\n },\n \"title\": \"Slavutych\"\n },\n {\n \"borderswith\": 36,\n \"country\": 215,\n \"district\": \"Vynohradiv raion\",\n \"id\": 6992,\n \"latit\": 48.11028,\n \"longit\": 22.83833,\n \"nationalId\": \"2121255300\",\n \"region\": {\n \"id\": 6,\n \"title\": \"Zakarpattia oblast\"\n },\n \"title\": \"Vylok\"\n },\n {\n \"borderswith\": 36,\n \"country\": 215,\n \"district\": \"Uzhhorod raion\",\n \"id\": 7488,\n \"latit\": 48.42972,\n \"longit\": 22.2175,\n \"nationalId\": \"2111000000\",\n \"region\": {\n \"id\": 6,\n \"title\": \"Zakarpattia oblast\"\n },\n \"title\": \"Chop\"\n },\n {\n \"borderswith\": 127,\n \"country\": 215,\n \"district\": \"\",\n \"id\": 824,\n \"latit\": 48.44917,\n \"longit\": 27.80306,\n \"nationalId\": \"0510400000\",\n \"region\": {\n \"id\": 1,\n \"title\": \"Vinnytsia oblast\"\n },\n \"title\": \"Mohyliv-Podilskyi\"\n },\n {\n \"borderswith\": 127,\n \"country\": 215,\n \"district\": \"Reni raion\",\n \"id\": 17084,\n \"latit\": 45.46056,\n \"longit\": 28.28611,\n \"nationalId\": \"5124110100\",\n \"region\": {\n \"id\": 15,\n \"title\": \"Odesa oblast\"\n },\n \"title\": \"Reni\"\n },\n {\n \"borderswith\": 127,\n \"country\": 215,\n \"district\": \"Kelmentsi raion\",\n \"id\": 29111,\n \"latit\": 48.46861,\n \"longit\": 26.82333,\n \"nationalId\": \"7322055100\",\n \"region\": {\n \"id\": 25,\n \"title\": \"Chernivtsi oblast\"\n },\n \"title\": \"Kelmentsi\"\n },\n {\n \"borderswith\": 191,\n \"country\": 215,\n \"district\": \"\",\n \"id\": 7448,\n \"latit\": 48.62111,\n \"longit\": 22.29694,\n \"nationalId\": \"2110100000\",\n \"region\": {\n \"id\": 6,\n \"title\": \"Zakarpattia oblast\"\n },\n \"title\": \"Uzhhorod\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is required\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] } ] }, { "name": "Tenders", "item": [ { "name": "Get Quotes", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getPricequotes", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getPricequotes" ], "query": [ { "key": "route", "value": "{{singleTender}}", "description": "Required int. Periodic of the tender", "disabled": true } ], "variable": [] }, "description": "Returns the list of price quotes of carriers\n\n- if successful you will receive all carrier price offers\n- 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\n\n(!) NOTE: If requested by carrier, authors of other quotes will be hidden" }, "response": [ { "name": "Success (shipper) / Success (carrier)", "originalRequest": [], "status": "Success (shipper) / Success (carrier)", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"cancelled\": false,\n \"id\": 657728,\n \"isMine\": true,\n \"loadqoute\": 1,\n \"moment\": 1625584292,\n \"oppositeoffer\": null,\n \"pricefor\": \"ride\",\n \"pricequote\": 15000,\n \"remark\": null\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Not allowed (carrier did not participate, or shipper requested other company's tender)", "originalRequest": [], "status": "Not allowed (carrier did not participate, or shipper requested other company's tender)", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Available Bid Values", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getTenderSteps", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getTenderSteps" ], "query": [ { "key": "route", "value": "{{tenderPeriodic}}", "description": "Required int. Periodic of the tender", "disabled": true } ], "variable": [] }, "description": "Returns the list of prices that can be offered by the carrier\n\n- if successful you will receive all prices that can be offered by the shipper\n- 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\n\n(!) NOTE: Endpoint works only on tenders with fixed price quote decrement set by the shipper" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n 100000,\n 99000,\n 98000,\n 97000,\n 96000,\n 95000,\n 94000,\n 93000,\n 92000,\n 91000,\n 90000,\n 89000,\n 88000,\n 87000,\n 86000,\n 85000,\n 84000,\n 83000,\n 82000,\n 81000,\n 80000,\n 79000,\n 78000,\n 77000,\n 76000,\n 75000,\n 74000,\n 73000,\n 72000,\n 71000,\n 70000,\n 69000,\n 68000,\n 67000,\n 66000,\n 65000,\n 64000,\n 63000,\n 62000,\n 61000,\n 60000,\n 59000,\n 58000,\n 57000,\n 56000,\n 55000,\n 54000,\n 53000,\n 52000,\n 51000,\n 50000,\n 49000,\n 48000,\n 47000,\n 46000,\n 45000,\n 44000,\n 43000,\n 42000,\n 41000,\n 40000,\n 39000,\n 38000,\n 37000,\n 36000,\n 35000,\n 34000,\n 33000,\n 32000,\n 31000,\n 30000,\n 29000,\n 28000,\n 27000,\n 26000,\n 25000,\n 24000,\n 23000,\n 22000,\n 21000,\n 20000,\n 19000,\n 18000,\n 17000,\n 16000,\n 15000,\n 14000,\n 13000,\n 12000,\n 11000,\n 10000,\n 9000,\n 8000,\n 7000,\n 6000,\n 5000,\n 4000,\n 3000,\n 2000,\n 1000\n ],\n \"status\": \"success\"\n}" }, { "name": "Not allowed to view the route", "originalRequest": [], "status": "Not allowed to view the route", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is required\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Tender Routes", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getTenderChildren", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getTenderChildren" ], "query": [ { "key": "tenderPeriodic", "value": "{{tenderPeriodic}}", "description": "Required int. Periodic of the tender", "disabled": true } ], "variable": [] }, "description": "Returns the list of routes of the single tender\n\n- if successful you will receive all routes of the single tender\n- 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" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": 649656,\n \"needAttention\": true,\n \"periodic\": 69881961600,\n \"routestatus\": 2\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid tender passed", "originalRequest": [], "status": "Invalid tender passed", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Route not found\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Tender Results", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getTenderResults", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getTenderResults" ], "query": [ { "key": "route", "value": "{{singleRoute}}", "description": "Single tender periodic", "disabled": true } ], "variable": [] }, "description": "Returns the results of the tender. Results include bids, winner, etc.\n\n(!) NOTE: If you are a carrier you won't see names of other carriers but you will see their bids.\n\n- if successful you will receive all the results of the tender\n- 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" }, "response": [ { "name": "Success (by carrier) / Success (by shipper)", "originalRequest": [], "status": "Success (by carrier) / Success (by shipper)", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"allQuotes\": [\n {\n \"datetime\": 1471561931,\n \"loadquote\": \"3 rides\",\n \"periodic\": 1,\n \"pricequote\": \"3450.00 UAH\",\n \"provider\": \"\"\n },\n {\n \"datetime\": 1471561931,\n \"loadquote\": \"5 rides\",\n \"periodic\": 2,\n \"pricequote\": \"3300.00 UAH\",\n \"provider\": \"Super carrier\"\n },\n {\n \"datetime\": 1471561931,\n \"loadquote\": \"5 rides\",\n \"periodic\": 3,\n \"pricequote\": \"3250.00 UAH\",\n \"provider\": \"\"\n }\n ],\n \"bargainResults\": [\n {\n \"contractdate\": 1343779200,\n \"contractnumber\": \"556-1/ZA5%\",\n \"periodic\": 1,\n \"pricequote\": \"3250.00\",\n \"provider\": \"\",\n \"winnerquote\": \"5 rides\"\n },\n {\n \"contractdate\": 1471478400,\n \"contractnumber\": \"336/1\",\n \"periodic\": 2,\n \"pricequote\": \"3300.00\",\n \"provider\": \"Super carrier\",\n \"winnerquote\": \"5 rides\"\n }\n ]\n },\n \"status\": \"success\"\n}" }, { "name": "Not allowed to view the results of the tender", "originalRequest": [], "status": "Not allowed to view the results of the tender", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] } ] } ] }, { "name": "Listings", "item": [ { "name": "Routes", "item": [ { "name": "Get Route Groups", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getRouteGroups", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getRouteGroups" ], "query": [], "variable": [] }, "description": "The method shows the groups or categories of routes available to the user.\n\nThe contents differ depending on the type of user (shipper or carrier).\n\nFor 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.\n\n- If successful, you will receive the groups of routes available to you\n- 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" }, "response": [ { "name": "Success for carrier / Success for shipper", "originalRequest": [], "status": "Success for carrier / Success for shipper", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"aux\": null,\n \"id\": 33,\n \"stati\": [\n 4\n ],\n \"title\": \"Commit to doing jobs\"\n },\n {\n \"aux\": \"{\\\"api\\\":\\\"required\\\"}\",\n \"id\": 31,\n \"stati\": [\n 2\n ],\n \"title\": \"Available\"\n },\n {\n \"aux\": \"{\\\"api\\\":\\\"required\\\"}\",\n \"id\": 34,\n \"stati\": [\n 5,\n 6,\n 8,\n 9,\n 11,\n 15,\n 16,\n 17\n ],\n \"title\": \"In progress\"\n },\n {\n \"aux\": \"{\\\"api\\\":\\\"required\\\"}\",\n \"id\": 36,\n \"stati\": [\n 7\n ],\n \"title\": \"At loading\"\n },\n {\n \"aux\": \"{\\\"api\\\":\\\"required\\\"}\",\n \"id\": 41,\n \"stati\": [\n 10\n ],\n \"title\": \"At unloading\"\n },\n {\n \"aux\": null,\n \"id\": 32,\n \"stati\": [\n 3\n ],\n \"title\": \"Vehicle in ratification\"\n },\n {\n \"aux\": \"{\\\"api\\\":\\\"required\\\"}\",\n \"id\": 65,\n \"stati\": [\n 14\n ],\n \"title\": \"Complete\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Available Route Actions", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getRouteActions", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getRouteActions" ], "query": [ { "key": "routes", "value": "{{routePeriodic1}},{{routePeriodic2}}", "description": "Required. String. Comma-separated lisf of routes or tenders.\n", "disabled": true } ], "variable": [] }, "description": "The method shows the available actions for the routes or tenders.\n\nFor each group of routes, you also receive a list of route stati, messages, and actions.\n\n- If successful, you will receive the groups of routes available to you\n \n- 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" }, "response": [ { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Active Routes", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getAllRoutes", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getAllRoutes" ], "query": [], "variable": [] }, "description": "Get the list of routes which are active at the moment for current user.\n\nThe list excludes complete/finished routes.\n\nThe list includes the routes that are:\n- vacant and available for delivery\n- in progress by current user\n- in negotiation phase\n\nFor each route within the list, you get id, route periodic (public route id), status and attention flag.\n\n- If successful, you will receive the list of routes\n- 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\n\n(!) NOTE: routes with `needAttention` set to `true` are the ones in which immediate action is required by the user." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"bookedbyclient\": null,\n \"id\": 99341,\n \"needAttention\": true,\n \"periodic\": \"33-11-24\",\n \"routestatus\": 4,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99366,\n \"needAttention\": true,\n \"periodic\": \"57-11-24\",\n \"routestatus\": 4,\n \"tenderparent\": \"56-11-24\"\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99398,\n \"needAttention\": true,\n \"periodic\": \"3-12-24\",\n \"routestatus\": 4,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99400,\n \"needAttention\": true,\n \"periodic\": \"5-12-24\",\n \"routestatus\": 17,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": true,\n \"id\": 99725,\n \"needAttention\": true,\n \"periodic\": \"175-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": \"171-01-25\"\n },\n {\n \"bookedbyclient\": true,\n \"id\": 99668,\n \"needAttention\": true,\n \"periodic\": \"118-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": \"37-01-25\"\n },\n {\n \"bookedbyclient\": true,\n \"id\": 99669,\n \"needAttention\": true,\n \"periodic\": \"119-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": \"37-01-25\"\n },\n {\n \"bookedbyclient\": true,\n \"id\": 99576,\n \"needAttention\": true,\n \"periodic\": \"26-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": \"25-01-25\"\n },\n {\n \"bookedbyclient\": true,\n \"id\": 99574,\n \"needAttention\": true,\n \"periodic\": \"24-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": \"21-01-25\"\n },\n {\n \"bookedbyclient\": true,\n \"id\": 99560,\n \"needAttention\": true,\n \"periodic\": \"10-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": \"5-01-25\"\n },\n {\n \"bookedbyclient\": true,\n \"id\": 99557,\n \"needAttention\": true,\n \"periodic\": \"7-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": \"5-01-25\"\n },\n {\n \"bookedbyclient\": true,\n \"id\": 99556,\n \"needAttention\": true,\n \"periodic\": \"6-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": \"5-01-25\"\n },\n {\n \"bookedbyclient\": true,\n \"id\": 99554,\n \"needAttention\": true,\n \"periodic\": \"4-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": \"3-01-25\"\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99706,\n \"needAttention\": true,\n \"periodic\": \"156-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99705,\n \"needAttention\": true,\n \"periodic\": \"155-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99701,\n \"needAttention\": true,\n \"periodic\": \"151-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99697,\n \"needAttention\": true,\n \"periodic\": \"147-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99626,\n \"needAttention\": true,\n \"periodic\": \"76-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99627,\n \"needAttention\": true,\n \"periodic\": \"77-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99628,\n \"needAttention\": true,\n \"periodic\": \"78-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99629,\n \"needAttention\": true,\n \"periodic\": \"79-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99630,\n \"needAttention\": true,\n \"periodic\": \"80-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99631,\n \"needAttention\": true,\n \"periodic\": \"81-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99632,\n \"needAttention\": true,\n \"periodic\": \"82-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99633,\n \"needAttention\": true,\n \"periodic\": \"83-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99634,\n \"needAttention\": true,\n \"periodic\": \"84-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99635,\n \"needAttention\": true,\n \"periodic\": \"85-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99642,\n \"needAttention\": true,\n \"periodic\": \"92-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99643,\n \"needAttention\": true,\n \"periodic\": \"93-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99644,\n \"needAttention\": true,\n \"periodic\": \"94-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99645,\n \"needAttention\": true,\n \"periodic\": \"95-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99646,\n \"needAttention\": true,\n \"periodic\": \"96-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99647,\n \"needAttention\": true,\n \"periodic\": \"97-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99648,\n \"needAttention\": true,\n \"periodic\": \"98-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99649,\n \"needAttention\": true,\n \"periodic\": \"99-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99650,\n \"needAttention\": true,\n \"periodic\": \"100-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99651,\n \"needAttention\": true,\n \"periodic\": \"101-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99652,\n \"needAttention\": true,\n \"periodic\": \"102-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99653,\n \"needAttention\": true,\n \"periodic\": \"103-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99654,\n \"needAttention\": true,\n \"periodic\": \"104-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99655,\n \"needAttention\": true,\n \"periodic\": \"105-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99656,\n \"needAttention\": true,\n \"periodic\": \"106-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99657,\n \"needAttention\": true,\n \"periodic\": \"107-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99658,\n \"needAttention\": true,\n \"periodic\": \"108-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99659,\n \"needAttention\": true,\n \"periodic\": \"109-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99660,\n \"needAttention\": true,\n \"periodic\": \"110-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99661,\n \"needAttention\": true,\n \"periodic\": \"111-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99662,\n \"needAttention\": true,\n \"periodic\": \"112-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99663,\n \"needAttention\": true,\n \"periodic\": \"113-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99664,\n \"needAttention\": true,\n \"periodic\": \"114-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99665,\n \"needAttention\": true,\n \"periodic\": \"115-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99666,\n \"needAttention\": true,\n \"periodic\": \"116-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99667,\n \"needAttention\": true,\n \"periodic\": \"117-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99670,\n \"needAttention\": true,\n \"periodic\": \"120-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99671,\n \"needAttention\": true,\n \"periodic\": \"121-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99672,\n \"needAttention\": true,\n \"periodic\": \"122-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99673,\n \"needAttention\": true,\n \"periodic\": \"123-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99674,\n \"needAttention\": true,\n \"periodic\": \"124-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99675,\n \"needAttention\": true,\n \"periodic\": \"125-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99676,\n \"needAttention\": true,\n \"periodic\": \"126-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99677,\n \"needAttention\": true,\n \"periodic\": \"127-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99678,\n \"needAttention\": true,\n \"periodic\": \"128-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99679,\n \"needAttention\": true,\n \"periodic\": \"129-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99714,\n \"needAttention\": false,\n \"periodic\": \"164-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99712,\n \"needAttention\": false,\n \"periodic\": \"162-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99713,\n \"needAttention\": false,\n \"periodic\": \"163-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99710,\n \"needAttention\": false,\n \"periodic\": \"160-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99708,\n \"needAttention\": false,\n \"periodic\": \"158-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99703,\n \"needAttention\": false,\n \"periodic\": \"153-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99696,\n \"needAttention\": false,\n \"periodic\": \"146-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99694,\n \"needAttention\": false,\n \"periodic\": \"144-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99693,\n \"needAttention\": false,\n \"periodic\": \"143-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99623,\n \"needAttention\": true,\n \"periodic\": \"73-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99620,\n \"needAttention\": true,\n \"periodic\": \"70-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99621,\n \"needAttention\": true,\n \"periodic\": \"71-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99622,\n \"needAttention\": true,\n \"periodic\": \"72-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99617,\n \"needAttention\": true,\n \"periodic\": \"67-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99618,\n \"needAttention\": true,\n \"periodic\": \"68-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99619,\n \"needAttention\": true,\n \"periodic\": \"69-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99614,\n \"needAttention\": true,\n \"periodic\": \"64-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99615,\n \"needAttention\": true,\n \"periodic\": \"65-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99616,\n \"needAttention\": true,\n \"periodic\": \"66-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99611,\n \"needAttention\": true,\n \"periodic\": \"61-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99612,\n \"needAttention\": true,\n \"periodic\": \"62-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99613,\n \"needAttention\": true,\n \"periodic\": \"63-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99608,\n \"needAttention\": true,\n \"periodic\": \"58-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99609,\n \"needAttention\": true,\n \"periodic\": \"59-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99610,\n \"needAttention\": true,\n \"periodic\": \"60-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99605,\n \"needAttention\": true,\n \"periodic\": \"55-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99606,\n \"needAttention\": true,\n \"periodic\": \"56-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99607,\n \"needAttention\": true,\n \"periodic\": \"57-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99602,\n \"needAttention\": true,\n \"periodic\": \"52-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99603,\n \"needAttention\": true,\n \"periodic\": \"53-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99604,\n \"needAttention\": true,\n \"periodic\": \"54-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99599,\n \"needAttention\": true,\n \"periodic\": \"49-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99600,\n \"needAttention\": true,\n \"periodic\": \"50-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99601,\n \"needAttention\": true,\n \"periodic\": \"51-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99596,\n \"needAttention\": true,\n \"periodic\": \"46-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99597,\n \"needAttention\": true,\n \"periodic\": \"47-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99598,\n \"needAttention\": true,\n \"periodic\": \"48-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99593,\n \"needAttention\": true,\n \"periodic\": \"43-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99594,\n \"needAttention\": true,\n \"periodic\": \"44-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99595,\n \"needAttention\": true,\n \"periodic\": \"45-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99590,\n \"needAttention\": true,\n \"periodic\": \"40-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99591,\n \"needAttention\": true,\n \"periodic\": \"41-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99592,\n \"needAttention\": true,\n \"periodic\": \"42-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99589,\n \"needAttention\": true,\n \"periodic\": \"39-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99637,\n \"needAttention\": false,\n \"periodic\": \"87-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99585,\n \"needAttention\": false,\n \"periodic\": \"35-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99583,\n \"needAttention\": false,\n \"periodic\": \"33-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99544,\n \"needAttention\": false,\n \"periodic\": \"109-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99542,\n \"needAttention\": false,\n \"periodic\": \"107-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99516,\n \"needAttention\": true,\n \"periodic\": \"92-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99511,\n \"needAttention\": true,\n \"periodic\": \"87-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99512,\n \"needAttention\": true,\n \"periodic\": \"88-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99513,\n \"needAttention\": true,\n \"periodic\": \"89-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99515,\n \"needAttention\": true,\n \"periodic\": \"91-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99518,\n \"needAttention\": false,\n \"periodic\": \"94-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99451,\n \"needAttention\": false,\n \"periodic\": \"32-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99450,\n \"needAttention\": false,\n \"periodic\": \"31-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99448,\n \"needAttention\": false,\n \"periodic\": \"29-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99447,\n \"needAttention\": false,\n \"periodic\": \"28-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99436,\n \"needAttention\": false,\n \"periodic\": \"17-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99437,\n \"needAttention\": false,\n \"periodic\": \"18-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99438,\n \"needAttention\": false,\n \"periodic\": \"19-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99439,\n \"needAttention\": false,\n \"periodic\": \"20-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99440,\n \"needAttention\": false,\n \"periodic\": \"21-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99441,\n \"needAttention\": false,\n \"periodic\": \"22-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99442,\n \"needAttention\": false,\n \"periodic\": \"23-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99443,\n \"needAttention\": false,\n \"periodic\": \"24-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99444,\n \"needAttention\": false,\n \"periodic\": \"25-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99445,\n \"needAttention\": false,\n \"periodic\": \"26-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99432,\n \"needAttention\": false,\n \"periodic\": \"14-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99431,\n \"needAttention\": false,\n \"periodic\": \"13-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99430,\n \"needAttention\": false,\n \"periodic\": \"12-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99429,\n \"needAttention\": false,\n \"periodic\": \"11-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99428,\n \"needAttention\": false,\n \"periodic\": \"10-12-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99335,\n \"needAttention\": false,\n \"periodic\": \"27-11-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": true,\n \"id\": 99328,\n \"needAttention\": true,\n \"periodic\": \"20-11-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99325,\n \"needAttention\": false,\n \"periodic\": \"19-11-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99317,\n \"needAttention\": false,\n \"periodic\": \"13-11-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99304,\n \"needAttention\": false,\n \"periodic\": \"87-10-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": true,\n \"id\": 99259,\n \"needAttention\": true,\n \"periodic\": \"47-10-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99260,\n \"needAttention\": false,\n \"periodic\": \"48-10-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99261,\n \"needAttention\": false,\n \"periodic\": \"49-10-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99264,\n \"needAttention\": false,\n \"periodic\": \"52-10-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99250,\n \"needAttention\": false,\n \"periodic\": \"38-10-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99209,\n \"needAttention\": false,\n \"periodic\": \"8-10-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99188,\n \"needAttention\": true,\n \"periodic\": \"66-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99175,\n \"needAttention\": false,\n \"periodic\": \"57-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99171,\n \"needAttention\": false,\n \"periodic\": \"53-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99145,\n \"needAttention\": true,\n \"periodic\": \"30-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99140,\n \"needAttention\": false,\n \"periodic\": \"28-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99138,\n \"needAttention\": false,\n \"periodic\": \"26-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99137,\n \"needAttention\": false,\n \"periodic\": \"25-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99134,\n \"needAttention\": true,\n \"periodic\": \"22-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99131,\n \"needAttention\": true,\n \"periodic\": \"19-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99132,\n \"needAttention\": true,\n \"periodic\": \"20-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99133,\n \"needAttention\": true,\n \"periodic\": \"21-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99130,\n \"needAttention\": true,\n \"periodic\": \"18-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99129,\n \"needAttention\": true,\n \"periodic\": \"17-09-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99106,\n \"needAttention\": false,\n \"periodic\": \"54-08-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99104,\n \"needAttention\": false,\n \"periodic\": \"52-08-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99103,\n \"needAttention\": false,\n \"periodic\": \"51-08-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99102,\n \"needAttention\": false,\n \"periodic\": \"50-08-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99101,\n \"needAttention\": false,\n \"periodic\": \"49-08-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99100,\n \"needAttention\": false,\n \"periodic\": \"48-08-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99099,\n \"needAttention\": false,\n \"periodic\": \"47-08-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99098,\n \"needAttention\": false,\n \"periodic\": \"46-08-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99097,\n \"needAttention\": false,\n \"periodic\": \"45-08-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99085,\n \"needAttention\": false,\n \"periodic\": \"33-08-24\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99681,\n \"needAttention\": false,\n \"periodic\": \"131-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99683,\n \"needAttention\": false,\n \"periodic\": \"133-01-25\",\n \"routestatus\": 2,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99399,\n \"needAttention\": false,\n \"periodic\": \"4-12-24\",\n \"routestatus\": 3,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99545,\n \"needAttention\": false,\n \"periodic\": \"110-12-24\",\n \"routestatus\": 3,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99547,\n \"needAttention\": false,\n \"periodic\": \"112-12-24\",\n \"routestatus\": 3,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99108,\n \"needAttention\": false,\n \"periodic\": \"56-08-24\",\n \"routestatus\": 5,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99123,\n \"needAttention\": false,\n \"periodic\": \"12-09-24\",\n \"routestatus\": 5,\n \"tenderparent\": \"11-09-24\"\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99139,\n \"needAttention\": false,\n \"periodic\": \"27-09-24\",\n \"routestatus\": 5,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99265,\n \"needAttention\": false,\n \"periodic\": \"53-10-24\",\n \"routestatus\": 5,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99322,\n \"needAttention\": false,\n \"periodic\": \"16-11-24\",\n \"routestatus\": 5,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99323,\n \"needAttention\": false,\n \"periodic\": \"17-11-24\",\n \"routestatus\": 5,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99337,\n \"needAttention\": false,\n \"periodic\": \"29-11-24\",\n \"routestatus\": 5,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99372,\n \"needAttention\": false,\n \"periodic\": \"63-11-24\",\n \"routestatus\": 5,\n \"tenderparent\": \"62-11-24\"\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99378,\n \"needAttention\": false,\n \"periodic\": \"69-11-24\",\n \"routestatus\": 5,\n \"tenderparent\": \"68-11-24\"\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99395,\n \"needAttention\": false,\n \"periodic\": \"80-11-24\",\n \"routestatus\": 5,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99396,\n \"needAttention\": false,\n \"periodic\": \"81-11-24\",\n \"routestatus\": 5,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99724,\n \"needAttention\": false,\n \"periodic\": \"174-01-25\",\n \"routestatus\": 5,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99303,\n \"needAttention\": false,\n \"periodic\": \"86-10-24\",\n \"routestatus\": 8,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99514,\n \"needAttention\": false,\n \"periodic\": \"90-12-24\",\n \"routestatus\": 8,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99200,\n \"needAttention\": false,\n \"periodic\": \"74-09-24\",\n \"routestatus\": 11,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99202,\n \"needAttention\": false,\n \"periodic\": \"76-09-24\",\n \"routestatus\": 11,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99086,\n \"needAttention\": false,\n \"periodic\": \"34-08-24\",\n \"routestatus\": 10,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99198,\n \"needAttention\": false,\n \"periodic\": \"72-09-24\",\n \"routestatus\": 10,\n \"tenderparent\": null\n },\n {\n \"bookedbyclient\": null,\n \"id\": 99301,\n \"needAttention\": false,\n \"periodic\": \"84-10-24\",\n \"routestatus\": 10,\n \"tenderparent\": null\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Token is required", "originalRequest": [], "status": "Token is required", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get My Active Routes", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getMyRoutes", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getMyRoutes" ], "query": [], "variable": [] }, "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:\n- if you represent a shipper, the method will return routes that the current user had published\n- if you represent a carrier, the method will return routes in which the current user had offered truck \n\nThis method, as opposed to `getAllRoutes` is useful when there are more than manager working in the company.\n\nThe list excludes complete/finished routes.\n\nThe list includes the routes that are:\n- vacant and available for delivery\n- in progress\n- in negotiation phase\n\nFor each route within the list, you get id, route periodic (public route id), status and attention flag.\n\n- If successful, you will receive the list of routes\n- 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\n\n(!) NOTE: routes with `needAttention` set to `true` are the ones in which immediate action is required by the user." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": 120162,\n \"needAttention\": true,\n \"periodic\": \"461-05-20\",\n \"routestatus\": 6\n },\n {\n \"id\": 120331,\n \"needAttention\": true,\n \"periodic\": \"610-05-20\",\n \"routestatus\": 6\n },\n {\n \"id\": 124004,\n \"needAttention\": true,\n \"periodic\": -22493203200,\n \"routestatus\": 6\n },\n {\n \"id\": 124246,\n \"needAttention\": true,\n \"periodic\": -16181856000,\n \"routestatus\": 6\n },\n {\n \"id\": 138702,\n \"needAttention\": true,\n \"periodic\": -23395132800,\n \"routestatus\": 6\n },\n {\n \"id\": 119329,\n \"needAttention\": false,\n \"periodic\": \"549-04-20\",\n \"routestatus\": 3\n },\n {\n \"id\": 119334,\n \"needAttention\": false,\n \"periodic\": \"554-04-20\",\n \"routestatus\": 3\n },\n {\n \"id\": 129435,\n \"needAttention\": false,\n \"periodic\": -14406768000,\n \"routestatus\": 7\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Get my active routes", "originalRequest": [], "status": "Get my active routes", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Complete Routes", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCompleteRoutes", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCompleteRoutes" ], "query": [ { "key": "page", "value": "{{page}}", "description": "Optional, int. Default = 1. Number of the page", "disabled": true }, { "key": "perPage", "value": "{{routesPerPage}}", "description": "Optional, int. Default = 100 (max). Amount of the routes per page", "disabled": true } ], "variable": [] }, "description": "Returns the list of the complete routes of your company.\n\n- if successful you will receive the list of the current company/your completed routes \n- 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" }, "response": [ { "name": "Success (Shipper) / Success (Carrier)", "originalRequest": [], "status": "Success (Shipper) / Success (Carrier)", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"offset\": 0,\n \"page\": 1,\n \"perPage\": 100,\n \"routes\": [\n {\n \"id\": 660420,\n \"periodic\": 68653785600,\n \"routestatus\": 11\n },\n {\n \"id\": 659247,\n \"periodic\": 33846422400,\n \"routestatus\": 11\n },\n {\n \"id\": 659244,\n \"periodic\": 33751728000,\n \"routestatus\": 11\n },\n {\n \"id\": 659241,\n \"periodic\": 33657120000,\n \"routestatus\": 11\n },\n {\n \"id\": 658216,\n \"periodic\": 3267820800,\n \"routestatus\": 11\n },\n {\n \"id\": 657939,\n \"periodic\": -5157993600,\n \"routestatus\": 11\n },\n {\n \"id\": 656070,\n \"periodic\": \"46-07-21\",\n \"routestatus\": 11\n },\n {\n \"id\": 655673,\n \"periodic\": 248336409600,\n \"routestatus\": 11\n },\n {\n \"id\": 655589,\n \"periodic\": 245780352000,\n \"routestatus\": 11\n },\n {\n \"id\": 655251,\n \"periodic\": 235398096000,\n \"routestatus\": 11\n },\n {\n \"id\": 654382,\n \"periodic\": 209868537600,\n \"routestatus\": 11\n },\n {\n \"id\": 653070,\n \"periodic\": 171211276800,\n \"routestatus\": 11\n },\n {\n \"id\": 651707,\n \"periodic\": 131386406400,\n \"routestatus\": 11\n },\n {\n \"id\": 651681,\n \"periodic\": 130692096000,\n \"routestatus\": 11\n },\n {\n \"id\": 650670,\n \"periodic\": 100523635200,\n \"routestatus\": 11\n },\n {\n \"id\": 650666,\n \"periodic\": 100397404800,\n \"routestatus\": 11\n },\n {\n \"id\": 650398,\n \"periodic\": 92224310400,\n \"routestatus\": 11\n },\n {\n \"id\": 650360,\n \"periodic\": 91025078400,\n \"routestatus\": 11\n },\n {\n \"id\": 649127,\n \"periodic\": 53977276800,\n \"routestatus\": 11\n },\n {\n \"id\": 649117,\n \"periodic\": 53661657600,\n \"routestatus\": 11\n },\n {\n \"id\": 648859,\n \"periodic\": 46056384000,\n \"routestatus\": 11\n },\n {\n \"id\": 648776,\n \"periodic\": 43689628800,\n \"routestatus\": 11\n },\n {\n \"id\": 648640,\n \"periodic\": 39650342400,\n \"routestatus\": 11\n },\n {\n \"id\": 648639,\n \"periodic\": 39618806400,\n \"routestatus\": 11\n },\n {\n \"id\": 648596,\n \"periodic\": 38451196800,\n \"routestatus\": 11\n },\n {\n \"id\": 648584,\n \"periodic\": 38072505600,\n \"routestatus\": 11\n },\n {\n \"id\": 648533,\n \"periodic\": 36683971200,\n \"routestatus\": 11\n },\n {\n \"id\": 648096,\n \"periodic\": 24218956800,\n \"routestatus\": 11\n },\n {\n \"id\": 648088,\n \"periodic\": 23966496000,\n \"routestatus\": 11\n },\n {\n \"id\": 647631,\n \"periodic\": 10996560000,\n \"routestatus\": 11\n },\n {\n \"id\": 647598,\n \"periodic\": 9986803200,\n \"routestatus\": 11\n },\n {\n \"id\": 647452,\n \"periodic\": 5600361600,\n \"routestatus\": 11\n },\n {\n \"id\": 647435,\n \"periodic\": 5127062400,\n \"routestatus\": 11\n },\n {\n \"id\": 647420,\n \"periodic\": 4716748800,\n \"routestatus\": 11\n },\n {\n \"id\": 647410,\n \"periodic\": 4401216000,\n \"routestatus\": 11\n },\n {\n \"id\": 647403,\n \"periodic\": 4180291200,\n \"routestatus\": 11\n },\n {\n \"id\": 646984,\n \"periodic\": -8316259200,\n \"routestatus\": 11\n },\n {\n \"id\": 565729,\n \"periodic\": 211299062400,\n \"routestatus\": 11\n },\n {\n \"id\": 565688,\n \"periodic\": 210005222400,\n \"routestatus\": 11\n },\n {\n \"id\": 533793,\n \"periodic\": -15821568000,\n \"routestatus\": 11\n }\n ],\n \"total\": 40\n },\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Filters for Completed Routes", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCompletedFilters", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCompletedFilters" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "perPage", "value": "10", "description": "", "disabled": true } ], "variable": [] }, "description": "Get Filters for Completed Routes" }, "response": [] } ] }, { "name": "Routes & Tenders", "item": [ { "name": "Search Routes or Tenders", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/searchRoutes", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "searchRoutes" ], "query": [], "variable": [] }, "description": "Search Routes or Tenders", "body": { "mode": "formdata", "formdata": [ { "key": "by", "value": "", "description": "", "type": "text" }, { "key": "searchQuery", "value": "", "description": "String. Required", "type": "text" } ] } }, "response": [] }, { "name": "Get Routes or Tenders Summaries", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getBasicDetailsOfRoutes", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getBasicDetailsOfRoutes" ], "query": [ { "key": "routes", "value": "{{routeList}}", "description": "Comma-separated list of periodics.", "disabled": true } ], "variable": [] }, "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.\n\n- if successful you will receive the details of routes that you passed in the route list\n- if unsuccessful you will receive an error explaining the problem in the language you supplied with the header\n\n(!) 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." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"routes\": [\n {\n \"blindtender\": false,\n \"bookedbyme\": false,\n \"bookedsince\": null,\n \"bookedtill\": null,\n \"booktime\": 30,\n \"budget\": 15230,\n \"cartypeRelation\": [],\n \"chargetype\": [\n null\n ],\n \"client\": 1274,\n \"client_relation\": {\n \"company_relation\": {\n \"natcomid\": \"1231231231231\",\n \"title_ru\": \"Super Shipper, LTD\"\n },\n \"hash\": \"3c5e448b11f15293807d9cfdedf21582\"\n },\n \"completemoment\": null,\n \"context\": {\n \"iconTitle\": null,\n \"title\": null\n },\n \"defaultcurrency\": null,\n \"distance\": 47,\n \"ferryproperty\": [\n \"Aggregates 15 pcs\",\n \"temperature\",\n \"belts 5 pcs\"\n ],\n \"id\": 94352,\n \"istender\": false,\n \"kmprice\": 0,\n \"maxquotewithcommission\": null,\n \"mcubeprice\": 0,\n \"minquote\": null,\n \"needAttention\": true,\n \"newMessages\": 0,\n \"operator\": 180,\n \"operator_relation\": {\n \"company\": 844,\n \"company_relation\": {\n \"natcomid\": \"37534111223\",\n \"title_ru\": \"Mega Carrier, LTD\"\n },\n \"hash\": \"da9cc741ae2ca7e4adf596b773a7b187\",\n \"id\": 278\n },\n \"periodic\": \"243-06-16\",\n \"routeparts\": [\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"Aggregates\",\n \"checkpoint_relation\": {\n \"id\": 3941,\n \"town_relation\": {\n \"district\": \"\",\n \"title_ru\": \"Berdiansk\"\n }\n },\n \"complete\": false,\n \"date1\": 1466035200,\n \"date2\": 1466467200,\n \"id\": 111365645,\n \"route\": 94352,\n \"time1\": \"08:30:00\",\n \"time2\": \"14:00:00\",\n \"triggered\": true,\n \"workaction\": 1\n },\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"А\",\n \"checkpoint_relation\": {\n \"id\": 4518,\n \"town_relation\": {\n \"district\": \"Irpin\",\n \"title_ru\": \"Bucha\"\n }\n },\n \"complete\": false,\n \"date1\": 1466467200,\n \"date2\": -62169984000,\n \"id\": 111365646,\n \"route\": 94352,\n \"time1\": \"00:00:00\",\n \"time2\": \"00:00:00\",\n \"triggered\": false,\n \"workaction\": 1\n },\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"\",\n \"checkpoint_relation\": {\n \"id\": 4518,\n \"town_relation\": {\n \"district\": \"Irpin\",\n \"title_ru\": \"Bucha\"\n }\n },\n \"complete\": false,\n \"date1\": 1467244800,\n \"date2\": 1466640000,\n \"id\": 111365647,\n \"route\": 94352,\n \"time1\": \"08:30:00\",\n \"time2\": \"22:00:00\",\n \"triggered\": false,\n \"workaction\": 2\n }\n ],\n \"routeresponse\": 73702,\n \"routeresponse_relation\": [\n {\n \"cancelled\": 0,\n \"car\": 15677,\n \"car_relation\": {\n \"id\": 15677,\n \"make\": 6,\n \"make_relation\": {\n \"id\": 6,\n \"title_ru\": \"Citroen\"\n },\n \"model\": null,\n \"number\": \"123\"\n },\n \"driver\": 14793,\n \"driver2\": null,\n \"driver2_relation\": null,\n \"driver_relation\": {\n \"firstname\": \"123\",\n \"id\": 14793,\n \"lastname\": \"/0\",\n \"maincellphone\": \"123\",\n \"patronymic\": \"\"\n },\n \"id\": 73702,\n \"moment\": 1466096342,\n \"pricequotewithcommission\": null,\n \"route\": 94352,\n \"trailer\": null,\n \"trailer_relation\": null\n }\n ],\n \"routestatus\": 6,\n \"routetender\": {\n \"currentminpricewithcommission\": null,\n \"tenderstatus\": null,\n \"winnerpricewithcommission\": null,\n \"winnerstatus\": null\n },\n \"stepwithcommission\": null,\n \"tenderavailableuntilmoment\": -62169984000,\n \"tenderparent\": \"18-02-26\",\n \"tenderparticipant\": false,\n \"tenderuntil\": {\n \"date\": -62169984000,\n \"time\": \"00:00:00\"\n },\n \"tonnprice\": 0,\n \"unitPrices\": [\n {\n \"title\": \"UAH/tonn\",\n \"value\": null\n },\n {\n \"title\": \"UAH/mcub\",\n \"value\": null\n },\n {\n \"title\": \"UAH/km\",\n \"value\": null\n }\n ]\n },\n {\n \"blindtender\": false,\n \"bookedbyme\": false,\n \"bookedsince\": null,\n \"bookedtill\": null,\n \"booktime\": 30,\n \"budget\": 7500,\n \"cartypeRelation\": [],\n \"chargetype\": [\n null\n ],\n \"client\": 1274,\n \"client_relation\": {\n \"company_relation\": {\n \"title_ru\": \"The client, LTD\"\n }\n },\n \"completemoment\": null,\n \"context\": {\n \"iconTitle\": null,\n \"title\": null\n },\n \"defaultcurrency\": null,\n \"distance\": 566,\n \"ferryproperty\": [\n \"Aggregates 10 pcs\"\n ],\n \"id\": 94362,\n \"istender\": false,\n \"kmprice\": 0,\n \"maxquotewithcommission\": null,\n \"mcubeprice\": 0,\n \"minquote\": null,\n \"needAttention\": true,\n \"newMessages\": 1,\n \"operator\": 180,\n \"operator_relation\": {\n \"company\": 406,\n \"company_relation\": {\n \"title_ru\": \"Carrier 1, LTD\"\n },\n \"id\": 180\n },\n \"periodic\": \"253-06-16\",\n \"routeparts\": [\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"груз 1\",\n \"checkpoint_relation\": {\n \"id\": 6665,\n \"town_relation\": {\n \"district\": \"\",\n \"title_ru\": \"Odesa\"\n }\n },\n \"complete\": false,\n \"date1\": 1466985600,\n \"date2\": 1466467200,\n \"id\": 111365673,\n \"route\": 94362,\n \"time1\": \"09:30:00\",\n \"time2\": \"12:30:00\",\n \"triggered\": true,\n \"workaction\": 1\n },\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"груз 2\",\n \"checkpoint_relation\": {\n \"id\": 4518,\n \"town_relation\": {\n \"district\": \"Irpin\",\n \"title_ru\": \"Bucha\"\n }\n },\n \"complete\": false,\n \"date1\": 1467072000,\n \"date2\": 1466726400,\n \"id\": 111365674,\n \"route\": 94362,\n \"time1\": \"13:00:00\",\n \"time2\": \"19:00:00\",\n \"triggered\": false,\n \"workaction\": 1\n },\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"\",\n \"checkpoint_relation\": {\n \"id\": 5251,\n \"town_relation\": {\n \"district\": \"\",\n \"title_ru\": \"Brovary\"\n }\n },\n \"complete\": false,\n \"date1\": 1467158400,\n \"date2\": 1466640000,\n \"id\": 111365675,\n \"route\": 94362,\n \"time1\": \"00:00:00\",\n \"time2\": \"00:00:00\",\n \"triggered\": false,\n \"workaction\": 2\n },\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"\",\n \"checkpoint_relation\": {\n \"id\": 6665,\n \"town_relation\": {\n \"district\": \"\",\n \"title_ru\": \"Odesa\"\n }\n },\n \"complete\": false,\n \"date1\": 1467244800,\n \"date2\": 1466726400,\n \"id\": 111365676,\n \"route\": 94362,\n \"time1\": \"09:00:00\",\n \"time2\": \"15:00:00\",\n \"triggered\": false,\n \"workaction\": 2\n }\n ],\n \"routeresponse\": 73719,\n \"routeresponse_relation\": [\n {\n \"cancelled\": 0,\n \"car\": 8062,\n \"car_relation\": {\n \"id\": 8062,\n \"make\": 8,\n \"make_relation\": {\n \"id\": 8,\n \"title_ru\": \"DAF\"\n },\n \"model\": null,\n \"number\": \"АА1122ЕЕ\"\n },\n \"driver\": 7953,\n \"driver2\": null,\n \"driver2_relation\": null,\n \"driver_relation\": {\n \"firstname\": \"John\",\n \"id\": 7953,\n \"lastname\": \"Driver\",\n \"maincellphone\": \"38(050)111-22-33\",\n \"patronymic\": \"\"\n },\n \"id\": 73719,\n \"moment\": 1466160341,\n \"pricequotewithcommission\": null,\n \"route\": 94362,\n \"trailer\": 8120,\n \"trailer_relation\": {\n \"id\": 8120,\n \"model\": null,\n \"number\": \"АА2211ХХ\"\n }\n }\n ],\n \"routestatus\": 6,\n \"routetender\": {\n \"currentminpricewithcommission\": null,\n \"tenderstatus\": null,\n \"winnerpricewithcommission\": null,\n \"winnerstatus\": null\n },\n \"stepwithcommission\": null,\n \"tenderavailableuntilmoment\": -62169984000,\n \"tenderparticipant\": false,\n \"tenderuntil\": {\n \"date\": -62169984000,\n \"time\": \"00:00:00\"\n },\n \"tonnprice\": 0,\n \"unitPrices\": [\n {\n \"title\": \"UAH/tonn\",\n \"value\": null\n },\n {\n \"title\": \"UAH/mcub\",\n \"value\": null\n },\n {\n \"title\": \"UAH/km\",\n \"value\": null\n }\n ]\n },\n {\n \"blindtender\": false,\n \"bookedbyme\": false,\n \"bookedsince\": null,\n \"bookedtill\": null,\n \"booktime\": 30,\n \"budget\": 15230,\n \"cartypeRelation\": [],\n \"chargetype\": [\n null\n ],\n \"client\": 1274,\n \"client_relation\": {\n \"company_relation\": {\n \"title_ru\": \"The client, LTD\"\n }\n },\n \"completemoment\": null,\n \"context\": {\n \"iconTitle\": null,\n \"title\": null\n },\n \"defaultcurrency\": null,\n \"distance\": 47,\n \"ferryproperty\": [\n \"Aggregates 15 pcs\",\n \"temperature\",\n \"belts 5 pcs\"\n ],\n \"id\": 94352,\n \"istender\": false,\n \"kmprice\": 0,\n \"maxquotewithcommission\": null,\n \"mcubeprice\": 0,\n \"minquote\": null,\n \"needAttention\": true,\n \"newMessages\": 0,\n \"operator\": 180,\n \"operator_relation\": {\n \"company\": 406,\n \"company_relation\": {\n \"title_ru\": \"Carrier 1, LTD\"\n },\n \"id\": 180\n },\n \"periodic\": \"243-06-16\",\n \"routeparts\": [\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"Aggregates\",\n \"checkpoint_relation\": {\n \"id\": 3941,\n \"town_relation\": {\n \"district\": \"\",\n \"title_ru\": \"Berdiansk\"\n }\n },\n \"complete\": false,\n \"date1\": 1466035200,\n \"date2\": 1466467200,\n \"id\": 111365645,\n \"route\": 94352,\n \"time1\": \"08:30:00\",\n \"time2\": \"14:00:00\",\n \"triggered\": true,\n \"workaction\": 1\n },\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"А\",\n \"checkpoint_relation\": {\n \"id\": 4518,\n \"town_relation\": {\n \"district\": \"Irpin\",\n \"title_ru\": \"Bucha\"\n }\n },\n \"complete\": false,\n \"date1\": 1466467200,\n \"date2\": -62169984000,\n \"id\": 111365646,\n \"route\": 94352,\n \"time1\": \"00:00:00\",\n \"time2\": \"00:00:00\",\n \"triggered\": false,\n \"workaction\": 1\n },\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"\",\n \"checkpoint_relation\": {\n \"id\": 4518,\n \"town_relation\": {\n \"district\": \"Irpin\",\n \"title_ru\": \"Bucha\"\n }\n },\n \"complete\": false,\n \"date1\": 1467244800,\n \"date2\": 1466640000,\n \"id\": 111365647,\n \"route\": 94352,\n \"time1\": \"08:30:00\",\n \"time2\": \"22:00:00\",\n \"triggered\": false,\n \"workaction\": 2\n }\n ],\n \"routeresponse\": 73702,\n \"routeresponse_relation\": [\n {\n \"cancelled\": 0,\n \"car\": 15677,\n \"car_relation\": {\n \"id\": 15677,\n \"make\": 6,\n \"make_relation\": {\n \"id\": 6,\n \"title_ru\": \"Citroen\"\n },\n \"model\": null,\n \"number\": \"123\"\n },\n \"driver\": 14793,\n \"driver2\": null,\n \"driver2_relation\": null,\n \"driver_relation\": {\n \"firstname\": \"123\",\n \"id\": 14793,\n \"lastname\": \"/0\",\n \"maincellphone\": \"123\",\n \"patronymic\": \"\"\n },\n \"id\": 73702,\n \"moment\": 1466096342,\n \"pricequotewithcommission\": null,\n \"route\": 94352,\n \"trailer\": null,\n \"trailer_relation\": null\n }\n ],\n \"routestatus\": 6,\n \"routetender\": {\n \"currentminpricewithcommission\": null,\n \"tenderstatus\": null,\n \"winnerpricewithcommission\": null,\n \"winnerstatus\": null\n },\n \"stepwithcommission\": null,\n \"tenderavailableuntilmoment\": -62169984000,\n \"tenderparticipant\": false,\n \"tenderuntil\": {\n \"date\": -62169984000,\n \"time\": \"00:00:00\"\n },\n \"tonnprice\": 0,\n \"unitPrices\": [\n {\n \"title\": \"UAH/tonn\",\n \"value\": null\n },\n {\n \"title\": \"UAH/mcub\",\n \"value\": null\n },\n {\n \"title\": \"UAH/km\",\n \"value\": null\n }\n ]\n },\n {\n \"blindtender\": false,\n \"bookedbyme\": false,\n \"bookedsince\": null,\n \"bookedtill\": null,\n \"booktime\": 30,\n \"budget\": 45,\n \"cartypeRelation\": [],\n \"chargetype\": [\n null\n ],\n \"client\": 1274,\n \"client_relation\": {\n \"company_relation\": {\n \"title_ru\": \"The client, LTD\"\n }\n },\n \"completemoment\": null,\n \"context\": {\n \"iconTitle\": null,\n \"title\": null\n },\n \"defaultcurrency\": null,\n \"distance\": 493,\n \"id\": 94363,\n \"istender\": false,\n \"kmprice\": 0,\n \"maxquotewithcommission\": null,\n \"mcubeprice\": 0,\n \"minquote\": null,\n \"needAttention\": true,\n \"newMessages\": 0,\n \"operator\": 180,\n \"operator_relation\": {\n \"company\": 406,\n \"company_relation\": {\n \"title_ru\": \"Carrier 1, LTD\"\n },\n \"id\": 180\n },\n \"periodic\": \"254-06-16\",\n \"routeparts\": [\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"d\",\n \"checkpoint_relation\": {\n \"id\": 5251,\n \"town_relation\": {\n \"district\": \"\",\n \"title_ru\": \"Brovary\"\n }\n },\n \"complete\": true,\n \"date1\": 1466208000,\n \"date2\": -62169984000,\n \"id\": 111365677,\n \"route\": 94363,\n \"time1\": \"09:30:00\",\n \"time2\": \"00:00:00\",\n \"triggered\": true,\n \"workaction\": 1\n },\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"\",\n \"checkpoint_relation\": {\n \"id\": 6665,\n \"town_relation\": {\n \"district\": \"\",\n \"title_ru\": \"Odesa\"\n }\n },\n \"complete\": false,\n \"date1\": 1466380800,\n \"date2\": -62169984000,\n \"id\": 111365678,\n \"route\": 94363,\n \"time1\": \"09:30:00\",\n \"time2\": \"00:00:00\",\n \"triggered\": true,\n \"workaction\": 2\n }\n ],\n \"routeresponse\": 80828,\n \"routeresponse_relation\": [\n {\n \"cancelled\": 0,\n \"car\": 9820,\n \"car_relation\": {\n \"id\": 9820,\n \"make\": 11,\n \"make_relation\": {\n \"id\": 11,\n \"title_ru\": \"ERF\"\n },\n \"model\": null,\n \"number\": \"444\"\n },\n \"driver\": 9501,\n \"driver2\": null,\n \"driver2_relation\": null,\n \"driver_relation\": {\n \"firstname\": \"asd\",\n \"id\": 9501,\n \"lastname\": \"asd\",\n \"maincellphone\": \"222\",\n \"patronymic\": \"asd\"\n },\n \"id\": 73720,\n \"moment\": 1466160842,\n \"pricequotewithcommission\": null,\n \"route\": 94363,\n \"trailer\": 9704,\n \"trailer_relation\": {\n \"id\": 9704,\n \"model\": null,\n \"number\": \"666\"\n }\n },\n {\n \"cancelled\": 0,\n \"car\": 15741,\n \"car_relation\": {\n \"id\": 15741,\n \"make\": 8,\n \"make_relation\": {\n \"id\": 8,\n \"title_ru\": \"DAF\"\n },\n \"model\": null,\n \"number\": \"АА1111AА\"\n },\n \"driver\": 14857,\n \"driver2\": null,\n \"driver2_relation\": null,\n \"driver_relation\": {\n \"firstname\": \"Jesse\",\n \"id\": 14857,\n \"lastname\": \"Pinkman\",\n \"maincellphone\": \"3805011111111\",\n \"patronymic\": \"\"\n },\n \"id\": 80828,\n \"moment\": 1580309291,\n \"pricequotewithcommission\": null,\n \"route\": 94363,\n \"trailer\": 9704,\n \"trailer_relation\": {\n \"id\": 9704,\n \"model\": null,\n \"number\": \"666\"\n }\n }\n ],\n \"routestatus\": 9,\n \"routetender\": {\n \"currentminpricewithcommission\": null,\n \"tenderstatus\": null,\n \"winnerpricewithcommission\": null,\n \"winnerstatus\": null\n },\n \"stepwithcommission\": null,\n \"tenderavailableuntilmoment\": -62169984000,\n \"tenderparticipant\": false,\n \"tenderuntil\": {\n \"date\": -62169984000,\n \"time\": \"00:00:00\"\n },\n \"tonnprice\": 0,\n \"unitPrices\": [\n {\n \"title\": \"UAH/tonn\",\n \"value\": null\n },\n {\n \"title\": \"UAH/mcub\",\n \"value\": null\n },\n {\n \"title\": \"UAH/km\",\n \"value\": null\n }\n ]\n },\n {\n \"blindtender\": false,\n \"bookedbyme\": false,\n \"bookedsince\": null,\n \"bookedtill\": null,\n \"booktime\": 30,\n \"budget\": 15230,\n \"cartypeRelation\": [],\n \"chargetype\": [\n null\n ],\n \"client\": 1274,\n \"client_relation\": {\n \"company_relation\": {\n \"title_ru\": \"The client, LTD\"\n }\n },\n \"completemoment\": null,\n \"context\": {\n \"iconTitle\": null,\n \"title\": null\n },\n \"defaultcurrency\": null,\n \"distance\": 47,\n \"ferryproperty\": [\n \"Aggregates 15 pcs\",\n \"temperature\",\n \"belts 5 pcs\"\n ],\n \"id\": 94352,\n \"istender\": false,\n \"kmprice\": 0,\n \"maxquotewithcommission\": null,\n \"mcubeprice\": 0,\n \"minquote\": null,\n \"needAttention\": true,\n \"newMessages\": 0,\n \"operator\": 180,\n \"operator_relation\": {\n \"company\": 406,\n \"company_relation\": {\n \"title_ru\": \"Carrier 1, LTD\"\n },\n \"id\": 180\n },\n \"periodic\": \"243-06-16\",\n \"routeparts\": [\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"Aggregates\",\n \"checkpoint_relation\": {\n \"id\": 3941,\n \"town_relation\": {\n \"district\": \"\",\n \"title_ru\": \"Berdiansk\"\n }\n },\n \"complete\": false,\n \"date1\": 1466035200,\n \"date2\": 1466467200,\n \"id\": 111365645,\n \"route\": 94352,\n \"time1\": \"08:30:00\",\n \"time2\": \"14:00:00\",\n \"triggered\": true,\n \"workaction\": 1\n },\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"А\",\n \"checkpoint_relation\": {\n \"id\": 4518,\n \"town_relation\": {\n \"district\": \"Irpin\",\n \"title_ru\": \"Bucha\"\n }\n },\n \"complete\": false,\n \"date1\": 1466467200,\n \"date2\": -62169984000,\n \"id\": 111365646,\n \"route\": 94352,\n \"time1\": \"00:00:00\",\n \"time2\": \"00:00:00\",\n \"triggered\": false,\n \"workaction\": 1\n },\n {\n \"bordercrossforoperator\": false,\n \"cargo\": \"\",\n \"checkpoint_relation\": {\n \"id\": 4518,\n \"town_relation\": {\n \"district\": \"Irpin\",\n \"title_ru\": \"Bucha\"\n }\n },\n \"complete\": false,\n \"date1\": 1467244800,\n \"date2\": 1466640000,\n \"id\": 111365647,\n \"route\": 94352,\n \"time1\": \"08:30:00\",\n \"time2\": \"22:00:00\",\n \"triggered\": false,\n \"workaction\": 2\n }\n ],\n \"routeresponse\": 73702,\n \"routeresponse_relation\": [\n {\n \"cancelled\": 0,\n \"car\": 15677,\n \"car_relation\": {\n \"id\": 15677,\n \"make\": 6,\n \"make_relation\": {\n \"id\": 6,\n \"title_ru\": \"Citroen\"\n },\n \"model\": null,\n \"number\": \"123\"\n },\n \"driver\": 14793,\n \"driver2\": null,\n \"driver2_relation\": null,\n \"driver_relation\": {\n \"firstname\": \"123\",\n \"id\": 14793,\n \"lastname\": \"/0\",\n \"maincellphone\": \"123\",\n \"patronymic\": \"\"\n },\n \"id\": 73702,\n \"moment\": 1466096342,\n \"pricequotewithcommission\": null,\n \"route\": 94352,\n \"trailer\": null,\n \"trailer_relation\": null\n }\n ],\n \"routestatus\": 6,\n \"routetender\": {\n \"currentminpricewithcommission\": null,\n \"tenderstatus\": null,\n \"winnerpricewithcommission\": null,\n \"winnerstatus\": null\n },\n \"stepwithcommission\": null,\n \"tenderavailableuntilmoment\": -62169984000,\n \"tenderparticipant\": false,\n \"tenderuntil\": {\n \"date\": -62169984000,\n \"time\": \"00:00:00\"\n },\n \"tonnprice\": 0,\n \"unitPrices\": [\n {\n \"title\": \"UAH/tonn\",\n \"value\": null\n },\n {\n \"title\": \"UAH/mcub\",\n \"value\": null\n },\n {\n \"title\": \"UAH/km\",\n \"value\": null\n }\n ]\n }\n ]\n },\n \"status\": \"success\"\n}" }, { "name": "Missing token", "originalRequest": [], "status": "Missing token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is required\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] } ] }, { "name": "Tenders", "item": [ { "name": "Get Not Interested Routes", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getNotInterested", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getNotInterested" ], "query": [ { "key": "tender", "value": "1", "description": "", "disabled": true } ], "variable": [] }, "description": "Returns the list of the complete routes of your company.\n\n- if successful you will receive the list of the current company/your completed routes \n- 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" }, "response": [ { "name": "Invalid token / Invalid token", "originalRequest": [], "status": "Invalid token / Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Tender Groups", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getTenderGroups", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getTenderGroups" ], "query": [], "variable": [] }, "description": "The endpoint shows the groups or categories of tenders available to the user.\n\nThe contents differ depending on the type of user (shipper or carrier).\n\nFor 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.\n\n* If successful, you will receive the groups of tenders available to you\n* 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" }, "response": [ { "name": "Success for shipper / Success for carrier", "originalRequest": [], "status": "Success for shipper / Success for carrier", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"aux\": {\n \"api\": \"required\"\n },\n \"id\": 1,\n \"stati\": [\n 91\n ],\n \"title\": \"Текущие\"\n },\n {\n \"aux\": {\n \"api\": \"required\"\n },\n \"id\": 3,\n \"stati\": [\n 92\n ],\n \"title\": \"Выигранные\"\n },\n {\n \"aux\": {\n \"api\": \"required\"\n },\n \"id\": 4,\n \"stati\": [\n 93\n ],\n \"title\": \"В которых я участвовал\"\n },\n {\n \"aux\": {\n \"api\": \"required\"\n },\n \"id\": 6,\n \"stati\": [\n 0\n ],\n \"title\": \"Архив\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Get tender groups", "originalRequest": [], "status": "Get tender groups", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Токен недействителен\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get All Tenders", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getAllTenders", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getAllTenders" ], "query": [], "variable": [] }, "description": "Get the list of tenders which are active at the moment for current user.\n\nFor shipper, the list excludes complete/finished tenders. For carrier, complete tenders are included.\n\nThe list includes the tenders that are:\n\n- vacant and available for bids\n \n- in active bargain\n \n- bargain complete and implementation in progress\n \n- implemented ones\n \nFor each tender within the list, you get id, route periodic (public route id), status and attention flag.\n\n- If successful, you will receive the list of tenders\n \n- 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\n \n(!) NOTE: tenders with `needAttention` set to `true` are the ones in which immediate action is required by the user." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"contextstatus\": 92,\n \"id\": 129653,\n \"needAttention\": false,\n \"periodic\": -8000640000\n },\n {\n \"contextstatus\": 92,\n \"id\": 129638,\n \"needAttention\": false,\n \"periodic\": -8474025600\n },\n {\n \"contextstatus\": 92,\n \"id\": 128974,\n \"needAttention\": false,\n \"periodic\": -27976233600\n },\n {\n \"contextstatus\": 92,\n \"id\": 128374,\n \"needAttention\": false,\n \"periodic\": \"564-06-21\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 128242,\n \"needAttention\": false,\n \"periodic\": \"449-06-21\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 127456,\n \"needAttention\": false,\n \"periodic\": -14788137600\n },\n {\n \"contextstatus\": 92,\n \"id\": 119352,\n \"needAttention\": false,\n \"periodic\": \"572-04-20\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 99050,\n \"needAttention\": false,\n \"periodic\": \"100-03-19\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 95614,\n \"needAttention\": false,\n \"periodic\": \"28-09-16\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 91042,\n \"needAttention\": false,\n \"periodic\": \"338-09-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 89847,\n \"needAttention\": false,\n \"periodic\": -15259276800\n },\n {\n \"contextstatus\": 92,\n \"id\": 88970,\n \"needAttention\": false,\n \"periodic\": \"624-06-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 85749,\n \"needAttention\": false,\n \"periodic\": -20374156800\n },\n {\n \"contextstatus\": 92,\n \"id\": 84866,\n \"needAttention\": false,\n \"periodic\": \"460-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 84856,\n \"needAttention\": false,\n \"periodic\": \"452-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 84833,\n \"needAttention\": false,\n \"periodic\": \"429-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 84782,\n \"needAttention\": false,\n \"periodic\": \"378-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 84731,\n \"needAttention\": false,\n \"periodic\": \"329-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 81406,\n \"needAttention\": false,\n \"periodic\": \"542-04-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 79160,\n \"needAttention\": false,\n \"periodic\": \"778-03-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 78657,\n \"needAttention\": false,\n \"periodic\": \"301-03-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 74863,\n \"needAttention\": false,\n \"periodic\": -1134864000\n },\n {\n \"contextstatus\": 92,\n \"id\": 70443,\n \"needAttention\": false,\n \"periodic\": -3030998400\n },\n {\n \"contextstatus\": 92,\n \"id\": 68544,\n \"needAttention\": false,\n \"periodic\": 84600028800\n },\n {\n \"contextstatus\": 92,\n \"id\": 67123,\n \"needAttention\": false,\n \"periodic\": 40704336000\n },\n {\n \"contextstatus\": 92,\n \"id\": 58459,\n \"needAttention\": false,\n \"periodic\": 2767651200\n },\n {\n \"contextstatus\": 92,\n \"id\": 54109,\n \"needAttention\": false,\n \"periodic\": -27119577600\n },\n {\n \"contextstatus\": 92,\n \"id\": 52450,\n \"needAttention\": false,\n \"periodic\": 49087814400\n },\n {\n \"contextstatus\": 92,\n \"id\": 46190,\n \"needAttention\": false,\n \"periodic\": 6120614\n },\n {\n \"contextstatus\": 92,\n \"id\": 45130,\n \"needAttention\": false,\n \"periodic\": 25660514\n },\n {\n \"contextstatus\": 92,\n \"id\": 44106,\n \"needAttention\": false,\n \"periodic\": 15570514\n },\n {\n \"contextstatus\": 92,\n \"id\": 43962,\n \"needAttention\": false,\n \"periodic\": 14140514\n },\n {\n \"contextstatus\": 92,\n \"id\": 42428,\n \"needAttention\": false,\n \"periodic\": 7720514\n },\n {\n \"contextstatus\": 92,\n \"id\": 34611,\n \"needAttention\": false,\n \"periodic\": 6180514\n },\n {\n \"contextstatus\": 92,\n \"id\": 25912,\n \"needAttention\": false,\n \"periodic\": 20500414\n },\n {\n \"contextstatus\": 92,\n \"id\": 24057,\n \"needAttention\": false,\n \"periodic\": 3810414\n },\n {\n \"contextstatus\": 92,\n \"id\": 15179,\n \"needAttention\": false,\n \"periodic\": 3411013\n },\n {\n \"contextstatus\": 93,\n \"id\": 127406,\n \"needAttention\": false,\n \"periodic\": -16334352000\n },\n {\n \"contextstatus\": 93,\n \"id\": 95614,\n \"needAttention\": false,\n \"periodic\": \"28-09-16\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 91042,\n \"needAttention\": false,\n \"periodic\": \"338-09-15\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 79334,\n \"needAttention\": false,\n \"periodic\": \"952-03-15\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 74238,\n \"needAttention\": false,\n \"periodic\": -19532534400\n },\n {\n \"contextstatus\": 93,\n \"id\": 73770,\n \"needAttention\": false,\n \"periodic\": \"890-01-15\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 70443,\n \"needAttention\": false,\n \"periodic\": -3030998400\n },\n {\n \"contextstatus\": 93,\n \"id\": 57288,\n \"needAttention\": false,\n \"periodic\": \"899-09-14\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 54109,\n \"needAttention\": false,\n \"periodic\": -27119577600\n },\n {\n \"contextstatus\": 93,\n \"id\": 53656,\n \"needAttention\": false,\n \"periodic\": \"676-08-14\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 49590,\n \"needAttention\": false,\n \"periodic\": \"695-07-14\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 47141,\n \"needAttention\": false,\n \"periodic\": 15580614\n },\n {\n \"contextstatus\": 93,\n \"id\": 76061,\n \"needAttention\": false,\n \"periodic\": \"674-02-15\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 46118,\n \"needAttention\": false,\n \"periodic\": 5400614\n },\n {\n \"contextstatus\": 93,\n \"id\": 24388,\n \"needAttention\": false,\n \"periodic\": 5620414\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Токен недействителен\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Open Tenders", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCurrentTenders", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCurrentTenders" ], "query": [], "variable": [] }, "description": "Get the list of tenders which are active at the moment for current user.\n\nFor shipper, the list excludes complete/finished tenders. For carrier, complete tenders are included.\n\nThe list includes the tenders that are:\n\n- vacant and available for bids\n \n- in active bargain\n \n- bargain complete and implementation in progress\n \nFor each tender within the list, you get id, route periodic (public route id), status and attention flag.\n\n- If successful, you will receive the list of tenders\n \n- 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\n \n(!) NOTE: tenders with `needAttention` set to `true` are the ones in which immediate action is required by the user." }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"contextstatus\": 92,\n \"id\": 129653,\n \"needAttention\": false,\n \"periodic\": -8000640000\n },\n {\n \"contextstatus\": 92,\n \"id\": 129638,\n \"needAttention\": false,\n \"periodic\": -8474025600\n },\n {\n \"contextstatus\": 92,\n \"id\": 128974,\n \"needAttention\": false,\n \"periodic\": -27976233600\n },\n {\n \"contextstatus\": 92,\n \"id\": 128374,\n \"needAttention\": false,\n \"periodic\": \"564-06-21\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 128242,\n \"needAttention\": false,\n \"periodic\": \"449-06-21\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 127456,\n \"needAttention\": false,\n \"periodic\": -14788137600\n },\n {\n \"contextstatus\": 92,\n \"id\": 119352,\n \"needAttention\": false,\n \"periodic\": \"572-04-20\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 99050,\n \"needAttention\": false,\n \"periodic\": \"100-03-19\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 95614,\n \"needAttention\": false,\n \"periodic\": \"28-09-16\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 91042,\n \"needAttention\": false,\n \"periodic\": \"338-09-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 89847,\n \"needAttention\": false,\n \"periodic\": -15259276800\n },\n {\n \"contextstatus\": 92,\n \"id\": 88970,\n \"needAttention\": false,\n \"periodic\": \"624-06-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 85749,\n \"needAttention\": false,\n \"periodic\": -20374156800\n },\n {\n \"contextstatus\": 92,\n \"id\": 84866,\n \"needAttention\": false,\n \"periodic\": \"460-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 84856,\n \"needAttention\": false,\n \"periodic\": \"452-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 84833,\n \"needAttention\": false,\n \"periodic\": \"429-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 84782,\n \"needAttention\": false,\n \"periodic\": \"378-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 84731,\n \"needAttention\": false,\n \"periodic\": \"329-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 81406,\n \"needAttention\": false,\n \"periodic\": \"542-04-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 79160,\n \"needAttention\": false,\n \"periodic\": \"778-03-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 78657,\n \"needAttention\": false,\n \"periodic\": \"301-03-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 74863,\n \"needAttention\": false,\n \"periodic\": -1134864000\n },\n {\n \"contextstatus\": 92,\n \"id\": 70443,\n \"needAttention\": false,\n \"periodic\": -3030998400\n },\n {\n \"contextstatus\": 92,\n \"id\": 68544,\n \"needAttention\": false,\n \"periodic\": 84600028800\n },\n {\n \"contextstatus\": 92,\n \"id\": 67123,\n \"needAttention\": false,\n \"periodic\": 40704336000\n },\n {\n \"contextstatus\": 92,\n \"id\": 58459,\n \"needAttention\": false,\n \"periodic\": 2767651200\n },\n {\n \"contextstatus\": 92,\n \"id\": 54109,\n \"needAttention\": false,\n \"periodic\": -27119577600\n },\n {\n \"contextstatus\": 92,\n \"id\": 52450,\n \"needAttention\": false,\n \"periodic\": 49087814400\n },\n {\n \"contextstatus\": 92,\n \"id\": 46190,\n \"needAttention\": false,\n \"periodic\": 6120614\n },\n {\n \"contextstatus\": 92,\n \"id\": 45130,\n \"needAttention\": false,\n \"periodic\": 25660514\n },\n {\n \"contextstatus\": 92,\n \"id\": 44106,\n \"needAttention\": false,\n \"periodic\": 15570514\n },\n {\n \"contextstatus\": 92,\n \"id\": 43962,\n \"needAttention\": false,\n \"periodic\": 14140514\n },\n {\n \"contextstatus\": 92,\n \"id\": 42428,\n \"needAttention\": false,\n \"periodic\": 7720514\n },\n {\n \"contextstatus\": 92,\n \"id\": 34611,\n \"needAttention\": false,\n \"periodic\": 6180514\n },\n {\n \"contextstatus\": 92,\n \"id\": 25912,\n \"needAttention\": false,\n \"periodic\": 20500414\n },\n {\n \"contextstatus\": 92,\n \"id\": 24057,\n \"needAttention\": false,\n \"periodic\": 3810414\n },\n {\n \"contextstatus\": 92,\n \"id\": 15179,\n \"needAttention\": false,\n \"periodic\": 3411013\n },\n {\n \"contextstatus\": 93,\n \"id\": 127406,\n \"needAttention\": false,\n \"periodic\": -16334352000\n },\n {\n \"contextstatus\": 93,\n \"id\": 95614,\n \"needAttention\": false,\n \"periodic\": \"28-09-16\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 91042,\n \"needAttention\": false,\n \"periodic\": \"338-09-15\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 79334,\n \"needAttention\": false,\n \"periodic\": \"952-03-15\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 74238,\n \"needAttention\": false,\n \"periodic\": -19532534400\n },\n {\n \"contextstatus\": 93,\n \"id\": 73770,\n \"needAttention\": false,\n \"periodic\": \"890-01-15\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 70443,\n \"needAttention\": false,\n \"periodic\": -3030998400\n },\n {\n \"contextstatus\": 93,\n \"id\": 57288,\n \"needAttention\": false,\n \"periodic\": \"899-09-14\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 54109,\n \"needAttention\": false,\n \"periodic\": -27119577600\n },\n {\n \"contextstatus\": 93,\n \"id\": 53656,\n \"needAttention\": false,\n \"periodic\": \"676-08-14\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 49590,\n \"needAttention\": false,\n \"periodic\": \"695-07-14\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 47141,\n \"needAttention\": false,\n \"periodic\": 15580614\n },\n {\n \"contextstatus\": 93,\n \"id\": 76061,\n \"needAttention\": false,\n \"periodic\": \"674-02-15\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 46118,\n \"needAttention\": false,\n \"periodic\": 5400614\n },\n {\n \"contextstatus\": 93,\n \"id\": 24388,\n \"needAttention\": false,\n \"periodic\": 5620414\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Токен недействителен\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get My Active Tenders", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful\n", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getMyTenders", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getMyTenders" ], "query": [], "variable": [] }, "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:\n- if you represent a shipper, the method will return tenders that the current user had published\n- if you represent a carrier, the method will return tenders, in which the current user offered delivery price\n\nThe list excludes complete/finished tenders.\nThe list includes the tenders that are:\n- vacant and available for delivery\n- in progress\n- in negotiation phase\n\nFor each tender within the list, you get id, tender periodic (public tender id), status and attention flag.\n\n- If successful, you will receive the list of tenders\n- 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\n\n(!) NOTE: tenders with `needAttention` set to true are the ones in which immediate action is required by the user." }, "response": [ { "name": "Get my active tenders", "originalRequest": [], "status": "Get my active tenders", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"contextstatus\": 92,\n \"id\": 129653,\n \"needAttention\": false,\n \"periodic\": -8000640000\n },\n {\n \"contextstatus\": 92,\n \"id\": 129638,\n \"needAttention\": false,\n \"periodic\": -8474025600\n },\n {\n \"contextstatus\": 92,\n \"id\": 128974,\n \"needAttention\": false,\n \"periodic\": -27976233600\n },\n {\n \"contextstatus\": 92,\n \"id\": 128374,\n \"needAttention\": false,\n \"periodic\": \"564-06-21\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 128242,\n \"needAttention\": false,\n \"periodic\": \"449-06-21\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 127456,\n \"needAttention\": false,\n \"periodic\": -14788137600\n },\n {\n \"contextstatus\": 92,\n \"id\": 119352,\n \"needAttention\": false,\n \"periodic\": \"572-04-20\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 99050,\n \"needAttention\": false,\n \"periodic\": \"100-03-19\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 95614,\n \"needAttention\": false,\n \"periodic\": \"28-09-16\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 91042,\n \"needAttention\": false,\n \"periodic\": \"338-09-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 89847,\n \"needAttention\": false,\n \"periodic\": -15259276800\n },\n {\n \"contextstatus\": 92,\n \"id\": 88970,\n \"needAttention\": false,\n \"periodic\": \"624-06-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 85749,\n \"needAttention\": false,\n \"periodic\": -20374156800\n },\n {\n \"contextstatus\": 92,\n \"id\": 84866,\n \"needAttention\": false,\n \"periodic\": \"460-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 84856,\n \"needAttention\": false,\n \"periodic\": \"452-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 84833,\n \"needAttention\": false,\n \"periodic\": \"429-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 84782,\n \"needAttention\": false,\n \"periodic\": \"378-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 84731,\n \"needAttention\": false,\n \"periodic\": \"329-05-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 81406,\n \"needAttention\": false,\n \"periodic\": \"542-04-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 79160,\n \"needAttention\": false,\n \"periodic\": \"778-03-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 78657,\n \"needAttention\": false,\n \"periodic\": \"301-03-15\"\n },\n {\n \"contextstatus\": 92,\n \"id\": 74863,\n \"needAttention\": false,\n \"periodic\": -1134864000\n },\n {\n \"contextstatus\": 92,\n \"id\": 70443,\n \"needAttention\": false,\n \"periodic\": -3030998400\n },\n {\n \"contextstatus\": 92,\n \"id\": 68544,\n \"needAttention\": false,\n \"periodic\": 84600028800\n },\n {\n \"contextstatus\": 92,\n \"id\": 67123,\n \"needAttention\": false,\n \"periodic\": 40704336000\n },\n {\n \"contextstatus\": 92,\n \"id\": 58459,\n \"needAttention\": false,\n \"periodic\": 2767651200\n },\n {\n \"contextstatus\": 92,\n \"id\": 54109,\n \"needAttention\": false,\n \"periodic\": -27119577600\n },\n {\n \"contextstatus\": 92,\n \"id\": 52450,\n \"needAttention\": false,\n \"periodic\": 49087814400\n },\n {\n \"contextstatus\": 92,\n \"id\": 46190,\n \"needAttention\": false,\n \"periodic\": 6120614\n },\n {\n \"contextstatus\": 92,\n \"id\": 45130,\n \"needAttention\": false,\n \"periodic\": 25660514\n },\n {\n \"contextstatus\": 92,\n \"id\": 44106,\n \"needAttention\": false,\n \"periodic\": 15570514\n },\n {\n \"contextstatus\": 92,\n \"id\": 43962,\n \"needAttention\": false,\n \"periodic\": 14140514\n },\n {\n \"contextstatus\": 92,\n \"id\": 42428,\n \"needAttention\": false,\n \"periodic\": 7720514\n },\n {\n \"contextstatus\": 92,\n \"id\": 34611,\n \"needAttention\": false,\n \"periodic\": 6180514\n },\n {\n \"contextstatus\": 92,\n \"id\": 25912,\n \"needAttention\": false,\n \"periodic\": 20500414\n },\n {\n \"contextstatus\": 92,\n \"id\": 24057,\n \"needAttention\": false,\n \"periodic\": 3810414\n },\n {\n \"contextstatus\": 92,\n \"id\": 15179,\n \"needAttention\": false,\n \"periodic\": 3411013\n },\n {\n \"contextstatus\": 93,\n \"id\": 127406,\n \"needAttention\": false,\n \"periodic\": -16334352000\n },\n {\n \"contextstatus\": 93,\n \"id\": 95614,\n \"needAttention\": false,\n \"periodic\": \"28-09-16\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 91042,\n \"needAttention\": false,\n \"periodic\": \"338-09-15\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 79334,\n \"needAttention\": false,\n \"periodic\": \"952-03-15\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 74238,\n \"needAttention\": false,\n \"periodic\": -19532534400\n },\n {\n \"contextstatus\": 93,\n \"id\": 73770,\n \"needAttention\": false,\n \"periodic\": \"890-01-15\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 70443,\n \"needAttention\": false,\n \"periodic\": -3030998400\n },\n {\n \"contextstatus\": 93,\n \"id\": 57288,\n \"needAttention\": false,\n \"periodic\": \"899-09-14\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 54109,\n \"needAttention\": false,\n \"periodic\": -27119577600\n },\n {\n \"contextstatus\": 93,\n \"id\": 53656,\n \"needAttention\": false,\n \"periodic\": \"676-08-14\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 49590,\n \"needAttention\": false,\n \"periodic\": \"695-07-14\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 47141,\n \"needAttention\": false,\n \"periodic\": 15580614\n },\n {\n \"contextstatus\": 93,\n \"id\": 76061,\n \"needAttention\": false,\n \"periodic\": \"674-02-15\"\n },\n {\n \"contextstatus\": 93,\n \"id\": 46118,\n \"needAttention\": false,\n \"periodic\": 5400614\n },\n {\n \"contextstatus\": 93,\n \"id\": 24388,\n \"needAttention\": false,\n \"periodic\": 5620414\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Токен недействителен\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Completed Tenders", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCompleteTenders", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCompleteTenders" ], "query": [ { "key": "page", "value": "{{page}}", "description": "Optional, int. Default = 1. Number of the page", "disabled": true }, { "key": "perPage", "value": "{{tendersPerPage}}\n", "description": "Optional, int. Default = 100 (max). Amount of the tenders per page", "disabled": true } ], "variable": [] }, "description": "Returns the list of the complete tenders of your company. Tender is complete when all routes within this tender are complete.\n\n- if successful you will receive the list of the current company/your completed tenders\n- 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" }, "response": [ { "name": "Success (Shipper) / Success (Carrier) / Invalid Token", "originalRequest": [], "status": "Success (Shipper) / Success (Carrier) / Invalid Token", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"offset\": 0,\n \"page\": 1,\n \"perPage\": 5,\n \"routes\": [\n {\n \"id\": 660151,\n \"periodic\": 60732979200,\n \"routestatus\": -1\n },\n {\n \"id\": 658844,\n \"periodic\": 21602332800,\n \"routestatus\": -1\n },\n {\n \"id\": 658810,\n \"periodic\": 20529417600,\n \"routestatus\": -1\n },\n {\n \"id\": 658211,\n \"periodic\": 3110054400,\n \"routestatus\": -1\n },\n {\n \"id\": 657193,\n \"periodic\": -27121651200,\n \"routestatus\": -1\n }\n ],\n \"total\": 25\n },\n \"status\": \"success\"\n}" } ] } ] } ] }, { "name": "Shippers", "item": [ { "name": "Routes", "item": [ { "name": "Create Route", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/createRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "createRoute" ], "query": [], "variable": [] }, "description": "With this endpoint you can add routes/orders into Phleetto from your systems one at a time or many at once.\n\nYou 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)\n\n`post` parameter explanation:\n\n- request must be in JSON\n \n- _routes_ is the root element, that can contain one or more _route_ objects\n \n\n### `route` object explanation:\n\n| param | required | type | explanation | valid example | invalid example |\n| --- | --- | --- | --- | --- | --- |\n| routeparts | yes | array of `routepart` objects | an array of points for the order/route, like loading, unloading, border, customs, etc | (see below) | empty |\n| route_apicode | yes | string (40) | an id of the order/route within your (external) system | DG-1982, 123221 | empty or duplicate |\n| budget | yes | decimal (12,2) | order's price, in national currency if currency param is not provided | 1090.55 | _100,00_, one thousand |\n| draft | | bool | whether to publish the route as draft or not | 1, true | |\n| currency | | string (3) | currency, default to national currency, valid values: USD, EUR | EUR | GBP |\n| nds | | bool | | 1 for value added tax included, 0 for no VAT included | 1 |\n| paymenttype | | int (1) | according to internal mapping: 2 for bank transfer, 3 for cash, see [mapping](https://phleet.to/data-mapping) | 2 | 4 |\n| 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 |\n| 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 |\n| 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 |\n| 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 |\n| 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\"} | |\n| 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\\] |\n| 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.\" | |\n| 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\" |\n\n### `routepart` object explanation:\n\n| param | required | type | applicable workaction | explanation | valid example | invalid example |\n| --- | --- | --- | --- | --- | --- | --- |\n| 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 |\n| apicode | yes | string (10) | 1,2 | id of the point in your (external) system, for simplicity of geography integration | | |\n| category | | int (5) | 1 | internal ID of the category, for order/route grouping, must match the mapping | 192 | non-matching id |\n| cargo | yes | string (255) | 1 | the payload being shipped | гн. швеллер и рельс | |\n| weight | almost | decimal (13,3) | 1 | weight of cargo in tonns, either this or volume must be supplied for workaction 1 | 22.3 | |\n| volume | almost | decimal (13,3) | 1 | volume of cargo in cubic meters, either this or weight must be supplied for workaction 1 | 70 | |\n| length | | decimal (13,3) | 1 | length of cargo in meters | 8 | |\n| height | | decimal (13,3) | 1 | height of cargo in meters | 0.2 | |\n| width | | decimal (13,3) | 1 | width of cargo in meters | 5.5 | |\n| date1 | | string (YYYY-MM-DD) | all | expected date of arrival to this point | 2020-06-20 | 30-12-2020 |\n| time1 | | string (HH:MM:SS) | all | expected time of arrival to this point, in 24 hour format | 18:00:00 | 6 PM |\n| 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 | |\n| company_natcomid | almost | string (30) | 1,2 | the national code of the legal entity, either this or company_name is required | 40003782 | |\n| contact_name | yes | string (255) | 1,2 | name of the person responsible for the work on the point | John Doe | |\n| contact_cellnum | almost | string (40) | 1,2 | phone number of the responsible person, either this or email is required | 38 050 111 22 33 | |\n| 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 |\n| 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 |\n| geo_region | | string (255) | 1,2 | sublocality (administrative_area_level_1), region, state, oblast, or other administrative division | Киевская область | |\n| geo_district | | string (255) | 1,2 | county, district (administrative_area_level_2) or other smaller administrative division | Богуславский район | |\n| geo_city | yes | string (255) | 1,2 | town, village, locality, city or other administrative division | Богуслав | |\n| geo_address | yes | string (200) | 1,2 | street address | ул. Орджоникидзе 14 | наша машина, паспорт номер такойто, область, город |\n| geo_town_id | | int (7) | 4 | internal town ID or border crossing | | |\n| geo_apicode | | string (10) | 3 | your (external) point ID of the customs point | | |\n| 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 |\n| border_operator_select | | int(1) | 4 | set to 1 if the carrier is expected to indicte the point of border crossing | | |\n\nEach route must start with a workaction=1 routepart and end with workaction=2 routepart.", "body": { "mode": "formdata", "formdata": [ { "key": "post", "value": "{\n \"routes\":{\n \"route\":{\n \"cartype\":[\n 1,\n 2,\n 4\n ],\n \"routeparts\":[\n {\n \"apicode\":\"internalcode123\",\n \"contact_name\":\"Marina Niedzialkowska - экспорт менеджер\",\n \"geo_country_iso_num\":616,\n \"geo_region\":\"\",\n \"company_natcomid\":\"\",\n \"weight\":1.47,\n \"date1\":\"2019-11-06\",\n \"contact_email\":\"noemail@email.com\",\n \"time1\":\"00:00:00\",\n \"contact_cellnum\":\"050 1 1 1 1 1 1 \",\n \"company_title\":\"INSTAL PROJEKT Gawlowscy, Scierzynscy Spolka Jawna\",\n \"geo_district\":\"\",\n \"geo_address\":\"ul. some street, 12a\",\n \"workaction\":\"3\",\n \"geo_city\":\"kruszyn\",\n \"category\":0,\n \"cargo\":\"плитка\\/сантехніка\"\n },\n {\n \"contact_name\":\"nocontact\",\n \"geo_country_iso_num\":804,\n \"geo_region\":\"київська\",\n \"company_natcomid\":\"\",\n \"weight\":1.47,\n \"date1\":\"2019-11-14\",\n \"contact_email\":\"noemail@email.com\",\n \"time1\":\"00:00:00\",\n \"contact_cellnum\":\"(044) 123123123 #$%^&*()_\",\n \"company_title\":\"Агросем\",\n \"geo_district\":\"\",\n \"geo_address\":\"вул. hrest, 17-А\",\n \"workaction\":\"2\",\n \"geo_city\":\"Київ\",\n \"cargo\":\"плитка\\/сантехніка\"\n }\n ],\n \"currency\":\"UAH\",\n \"payorcode\":\"\",\n \"chargetype\":[\n 3,\n 2,\n 4\n ],\n \"route_apicode\":\"unique-external-id-11212\",\n \"paymenttype\":2,\n \"budget\":20500.0\n }\n }\n}", "description": "The main body of the request, the payload that contains the route/order details.", "type": "text" }, { "key": "signature", "value": "{{MAC}}", "description": "A MAC must be supplied, which is a SHA256 hash product of the `post` parameter and the MAC key.", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"periodic\": \"436-04-22\",\n \"url\": \"/a/index.php?p=view&id=436-04-22&m=shipping\",\n \"userroutenumber\": \"unique-external-id-11212\"\n }\n ],\n \"status\": \"created\"\n}" }, { "name": "Request by carrier / Invalid MAC supplied / Missing params / Invalid routeparts order", "originalRequest": [], "status": "Request by carrier / Invalid MAC supplied / Missing params / Invalid routeparts order", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"ERROR: Data is corrupt.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Update Budget", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/changeBudget", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "changeBudget" ], "query": [], "variable": [] }, "description": "Update Budget", "body": { "mode": "raw", "raw": "{\n \"budget\": \"123222\",\n \"changebudget\": 1,\n \"nds\": 1,\n \"route\": \"{{periodic}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create Payment Adjustment", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/addAdjustment", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "addAdjustment" ], "query": [], "variable": [] }, "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.\n\nThe 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.\n\n(!) Important: setting #15 ( `premiumindicate`) must be turned on for the endpoint to work.\n\n_If successful_, you will receive the success message, and the route will be updated with the new budget correction.\n\n_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.", "body": { "mode": "raw", "raw": "{\n \"fine\": \"100\",\n \"fineremark\": \"Штраф за запізнення\",\n \"nds\": 1,\n \"route\": \"790-05-26\",\n \"setpremium\": 1,\n \"uplift\": \"500\",\n \"upliftremark\": \"Надбавка за терміновість\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove Payment Adjustment", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/removeAdjustment", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "removeAdjustment" ], "query": [], "variable": [] }, "description": "Remove Payment Adjustment", "body": { "mode": "raw", "raw": "{\n \"del\": \"Z2vzqHucmFjSEGRlQZ9L5fFLZOsAmPOtB30f%2Fv8bIRiD5OCNfqiY%3D\",\n \"route\": \"{{periodic}}\",\n \"setpremium\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deprecated: Create Payment Adjustment", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/addBudgetCorrection", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "addBudgetCorrection" ], "query": [], "variable": [] }, "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.\n\nThe 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.\n\n(!) Important: setting #15 ( `premiumindicate`) must be turned on for the endpoint to work.\n\n_If successful_, you will receive the success message, and the route will be updated with the new budget correction.\n\n_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.", "body": { "mode": "formdata", "formdata": [ { "key": "absoluteSum", "value": "-100", "description": "Sum of the correction in the currency of the route. Must be positive. Decimal. Required.", "type": "text" }, { "key": "remark", "value": "{{correctionReason}}", "description": "Remark for the correction. String. Optional.", "type": "text" }, { "key": "route", "value": "{{routePeriodic}}", "description": "Periodic of the route. Required. String", "type": "text" }, { "key": "type", "value": "fine", "description": "One of \"uplift\" or \"fine\". String. Required.", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"budget\": 20200,\n \"currency\": \"uah\",\n \"route\": \"18-02-25\"\n },\n \"status\": \"success\"\n}" }, { "name": "Bad correction type supplied / Bad sum supplied", "originalRequest": [], "status": "Bad correction type supplied / Bad sum supplied", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Type must be one of \\\"uplift\\\", \\\"fine\\\", but \\\"premium\\\" given\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Approve Carrier Proposal", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/ratifyOperator", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "ratifyOperator" ], "query": [], "variable": [] }, "description": "Allows shipper to confirm or ratify the carrier, that applied for the completion of the specified order.\n\n* If successful, you will receive the success message and the carrier that applied will be assigned to the order\n* If unsuccessful you will receive an error explaining \n the problem in the language you supplied with the header or the language set in the app", "body": { "mode": "formdata", "formdata": [ { "key": "route", "value": "{{singleRoute}}", "description": "Route periodic. String. Required.", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Params not passed / Request by carrier", "originalRequest": [], "status": "Params not passed / Request by carrier", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"No parameters were provided.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Reject Carrier Proposal", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/rejectOperator", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "rejectOperator" ], "query": [], "variable": [] }, "description": "Allows shipper to decline the delivery offer.\n\n* If successful, you will receive the success message, the carrier will be declined, the route will be vacant for offers again\n* If unsuccessful you will receive an error explaining \n the problem in the language you supplied with the header or the language set in the app", "body": { "mode": "formdata", "formdata": [ { "key": "route", "value": "{{routePeriodic}}", "description": "Periodic of the route. Required. String", "type": "text" }, { "key": "routeresponse", "value": "{{responseID}}", "description": "ID of the response. Int. Required.", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Invalid params passed / Params not passed", "originalRequest": [], "status": "Invalid params passed / Params not passed", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"This action is unavailable\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Confirm Loading", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/confirmCharge", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "confirmCharge" ], "query": [], "variable": [] }, "description": "Confirms the loading by the shipper. \n\nIf 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.\n\nIf only the `route` parameter is supplied (without additional parameters) then the endpoint considers the first loading point as default one to confirm.\n\nYou 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.\n\nAdditionally, 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.\n\n(!) NOTE: when forcing confirmation of a particular non-first loading on a complex route, all preceding points will be automatically set as complete.\n\n- 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\n- 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", "body": { "mode": "formdata", "formdata": [ { "key": "force", "value": "{{forceFlag}}", "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": "text" }, { "key": "route", "value": "{{singleRoute}}", "description": "route periodic", "type": "text" }, { "key": "routepart", "value": "{{routepartID}}", "description": "optional (int), but required if force flag is supplied, indicates which exactly point to confirm", "type": "text" } ] } }, "response": [ { "name": "Success (no additional params) / Success (with additional params)", "originalRequest": [], "status": "Success (no additional params) / Success (with additional params)", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Route in such status that loading confirmation is unavailable / Point passed is in such status that confirmation is unavailable", "originalRequest": [], "status": "Route in such status that loading confirmation is unavailable / Point passed is in such status that confirmation is unavailable", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The stop is incorrect.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Confirm Unloading", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/confirmUncharge", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "confirmUncharge" ], "query": [], "variable": [] }, "description": "Confirms the unloading by the shipper.\n\nIf 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.\n\nIf only the `route` parameter is supplied (without additional parameters) then the endpoint considers the first unloading point as default one to confirm.\n\nYou 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.\n\nAdditionally, 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.\n\n(!) NOTE: when forcing confirmation of a particular non-first unloading on a complex route, all preceding points will be automatically set as complete.\n\n* 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\n* 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", "body": { "mode": "formdata", "formdata": [ { "key": "force", "value": "{{forceFlag}}", "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": "text" }, { "key": "route", "value": "{{invalidRoute}}", "description": "route periodic", "type": "text" }, { "key": "routepart", "value": "{{routepartID}}", "description": "optional (int), but required if force flag is supplied, indicates which exactly point to confirm", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Request by carrier / Route not ready for unloading / Invalid route periodic passed", "originalRequest": [], "status": "Request by carrier / Route not ready for unloading / Invalid route periodic passed", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"You don’t have permission to view this route.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Request Stop Changes", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/requestChangeCheckpoints", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "requestChangeCheckpoints" ], "query": [], "variable": [] }, "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.\n\n**Request Body** \nThe request body must be in JSON format and contain the following fields:\n\n- **periodic**: route periodic number, string, required\n- **routepart**: the identifier for the specific part of the route, int, required\n- **newChekpointcontactdata**: the new contact data for the checkpoint, int, required\n \n**Response** \nThe response will indicate the success or failure of the request to change the checkpoints.\n\nEnsure 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.", "body": { "mode": "raw", "raw": "{\n \"newChekpointcontactdata\": 24247,\n \"periodic\": \"3-01-21\",\n \"routepart\": 112264261\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"routechange\": 152650\n}" }, { "name": "Invalid checkpoint contact data", "originalRequest": [], "status": "Invalid checkpoint contact data", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Given chekpointcontactdata is not valid\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Missing token", "originalRequest": [], "status": "Missing token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"token is required\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Force Complete Route", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/finishRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "finishRoute" ], "query": [ { "key": "route", "value": "{{singleRoute}}", "description": "Required, string. Single route periodic", "disabled": true } ], "variable": [] }, "description": "Marks the route complete and all checkpoints within it.\n\n- if successful you will mark complete the route and all checkpoints within it\n- 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 \n\n(!) NOTE: Can be only used by shippers" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Route not ready to be forced as complete / Request from carrier", "originalRequest": [], "status": "Route not ready to be forced as complete / Request from carrier", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The action is not available.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Cancel Route and Reopen for Carrier Pool", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/forceVacantizeRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "forceVacantizeRoute" ], "query": [], "variable": [] }, "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.\n\nThe request body must be in JSON format and contain the following field:\n\n- **periodic:** the periodic of the route to be canceled, string, required\n \nThe response will indicate the success or failure of the request to cancel the route and move it to the vacant list.\n\n- if success you will change route status and route will become available.\n \nThis endpoint is typically used by clients who need to manage route statuses dynamically, allowing them to cancel ongoing routes and reassign them as needed.", "body": { "mode": "raw", "raw": "{\n \"periodic\": \"18-07-21\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": true\n}" }, { "name": "Route In Tender State Error / Invalid route number", "originalRequest": [], "status": "Route In Tender State Error / Invalid route number", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Incorrect route number.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Remove Open Route", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/removeFreeRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "removeFreeRoute" ], "query": [], "variable": [] }, "description": "Remove Open Route", "body": { "mode": "raw", "raw": "{\n \"route\": \"738-04-26\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Reopen Route", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/reviveRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "reviveRoute" ], "query": [], "variable": [] }, "description": "Reopen Route", "body": { "mode": "raw", "raw": "{\n \"route\": \"738-04-26\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create Route Order", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/createOrder", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "createOrder" ], "query": [], "variable": [] }, "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.\n\n- if successful response will confirm the creation of the order and provide details about the order.\n \n**Body:**\n\nThe request body should be in raw JSON format containing the order details.\n\n- **route:** (string) required \n Description: Identifier of the route.\n\n \n- **number:** (string) required \n Description: Order number\n\n \n- **palletbases_plan:** (integer) required \n Description: Planned number of pallet bases.\n\n \n- **palletplaces_plan:** (integer) required \n Description: Planned number of pallet places.\n\n \n- **aux:** (string) optional \n Description: Additional technical data.\n\n \n- **products: (array of objects)** required \n Description: List of products in the order. See below.\n\n \n- **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.\n \nAdditional fields required for eCMR (eTTN):\n\n- **customer_order_number**: String. Optional. Order number of the buyer of the goods.\n \n- **customer_order_date:** Date YYYY-MM-DD. Optional. Order date of the buyer of the goods.\n \n- **customer_gln:** String. Optional. GLN of the buyer of the goods.\n \n- **output_date:** Date YYYY-MM-DD. Optional. Loading date\n \n- **planned_delivery_date.** Date YYYY-MM-DD. Optional. Planned unloading date\n \n- **contract_date:** String. Optional. Contract date.\n \n- **contract_number:** String. Optional. Contract number.\n \n- **deliveryplace_gln:** String. Optional. GLN of the destination point.\n \n- **deliveryplace_zip:** String. Optional. Post code of the destination point.\n \nProducts objects parameters:\n\n- **position:** String. Optional. Periodic position number in order.\n \n- **sku:** String. Required. SKU of the product.\n \n- **title:** String. Required. Description or name of the product.\n \n- **quantity:** Decimal. Optional. Quantity of the item in the order, in whatever units.\n \n- **measure_unit:** String. Optional. Measure unit, in whatever form needed. Example: BX, box.\n \n- **weight:** Decimal. Optional. Weight in metric tonns.\n \n- **volume:** Decimal. Optional. Volumne in cubic meters.\n \n- **unit_price:** Decimal. Optional. Price for a single unit.\n \n- **total_price:** Decimal. Optional. Price for all the units.\n \n- **vat:** Decimal. Optional. VAT of all the units.\n \n- **barcode:** String. Optional. Bar code of the item.\n \n- **customer_code:** String. Optional. Customer product code.\n \n- **class:** String. Optional. Category of goods.", "body": { "mode": "raw", "raw": "{\n \"aux\": \"some technical data\",\n \"checkunique\": true,\n \"number\": \"0987689987\",\n \"palletbases_plan\": 10,\n \"palletplaces_plan\": 20,\n \"products\": [\n {\n \"extra1\": 10.111,\n \"extra2\": 200002.22222,\n \"extra3\": 339999333.33333,\n \"measure_unit\": \"короб\",\n \"position\": 1,\n \"quantity\": 9,\n \"sku\": \"12312223\",\n \"title\": \"smittles\",\n \"total_price\": 2901.55,\n \"unit_price\": 10.66,\n \"vat\": 60,\n \"volume\": 0.4089,\n \"weight\": 0.212\n },\n {\n \"extra1\": 1.111,\n \"extra2\": 2222222.22222,\n \"extra3\": 3333333333.3333,\n \"measure_unit\": \"шт\",\n \"position\": 2,\n \"quantity\": 223,\n \"sku\": \"m112323\",\n \"title\": \"wiskas\",\n \"total_price\": 600,\n \"unit_price\": 19.89,\n \"vat\": 125,\n \"volume\": 8.0289,\n \"weight\": 0.933\n }\n ],\n \"route\": \"2-09-24\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": 1111,\n \"number\": \"0500000000\",\n \"route\": -27106704000\n },\n \"status\": \"success\"\n}" }, { "name": "Bad request / Duplicate order", "originalRequest": [], "status": "Bad request / Duplicate order", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Unsupported operand types\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "No token supplied", "originalRequest": [], "status": "No token supplied", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token is required\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Delete Route Orders", "request": { "method": "DELETE", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/deleteOrders/:singleRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "deleteOrders", ":singleRoute" ], "query": [], "variable": [ { "key": "singleRoute", "value": "", "description": "" } ] }, "description": "Delete Route Orders" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"deleted\": [\n \"order number 2\"\n ]\n },\n \"status\": \"success\"\n}" } ] } ] }, { "name": "Shared Operations", "item": [ { "name": "Get Freight Descriptions", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCargo", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCargo" ], "query": [ { "key": "q", "value": "{{cargoQuery}}", "description": "Required. Freight description search string", "disabled": true } ], "variable": [] }, "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.\n\n- if successful you will receive a list of freight descriptions \n- 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\n\n(!) NOTE: Returns no more than 50 entries. Can be used only by shipper", "body": { "mode": "formdata", "formdata": [] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n \"Aggregates\",\n \"Aggregated materials\"\n ],\n \"status\": \"success\"\n}" }, { "name": "No Query Parameter", "originalRequest": [], "status": "No Query Parameter", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Search query not passed\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Update Visibility", "request": { "method": "PUT", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/route/:singleRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "route", ":singleRoute" ], "query": [], "variable": [ { "key": "singleRoute", "value": "", "description": "" } ] }, "description": "Allows you to update the route/tender, and change the carriers who would be allowed to work on the route.\n\n- if successful you will have your route/tender moved to the bin\n \n- 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\n \n(!)NOTE: Only for shippers\n\n**singleRoute** URL must be a periodic of the route or tender, in form 123-12-12.\n\n**operators** param must contain the array of clientHash strings of the carriers, can be found in GET getPartners", "body": { "mode": "raw", "raw": "{\n \"operators\": [\n \"d08dbfc74eff5853073aa49e174af6e2\",\n \"ec2b30b1d99dadf7ce87a6236c439464\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"operators\": [\n \"d08dbfc74eff5853073aa49e174af6e2\",\n \"ec2b30b1d99dadf7ce87a6236c439464\"\n ],\n \"route\": \"96-04-25\"\n },\n \"status\": \"success\"\n}" }, { "name": "Route is booked error", "originalRequest": [], "status": "Route is booked error", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"The route is reserved for a carrier and cannot be edited.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Delete Route or Tender", "request": { "method": "DELETE", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/route/:singleRoute", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "route", ":singleRoute" ], "query": [], "variable": [ { "key": "singleRoute", "value": "", "description": "" } ] }, "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.\n\n- if successful you will have your route/tender moved to the bin\n \n- 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\n \n(!)NOTE: Only for shippers\n\n**singleRoute** URL must be a periodic of the route or tender, in form 123-12-12.", "body": { "mode": "formdata", "formdata": [] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"deleted\": -22033123200\n },\n \"status\": \"success\"\n}" }, { "name": "Invalid route periodic", "originalRequest": [], "status": "Invalid route periodic", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Route not found.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Update API Code", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/updateApiCode", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "updateApiCode" ], "query": [], "variable": [] }, "description": "Update API Code", "body": { "mode": "raw", "raw": "{\n \"route\": \"{{periodic}}\",\n \"userroutenumber\": \"{{userroutenumber}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Billing Entity", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/updatePayor", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "updatePayor" ], "query": [], "variable": [] }, "description": "Update Billing Entity", "body": { "mode": "raw", "raw": "{\n \"payor\": \"Z2vzqHucmY5JrETMhcv9bcI6oiGM859RLjn3vBB99BbWZNRgycoE%3D\",\n \"route\": \"738-04-26\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Loading Schedule", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/updateLoadingDates", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "updateLoadingDates" ], "query": [], "variable": [] }, "description": "Update Loading Schedule", "body": { "mode": "raw", "raw": "{\n \"date1\": \"18.04.2026\",\n \"factarrivaldate\": \"17.04.2026\",\n \"factarrivaltime\": \"00:00:00\",\n \"route\": \"738-04-26\",\n \"routepart\": 123456,\n \"time1\": \"00:00:01\",\n \"workcompletedate\": \"19.04.2026\",\n \"workcompletetime\": \"00:00:00\",\n \"workstartdate\": \"18.04.2026\",\n \"workstarttime\": \"00:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Cargo Specifications", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/updateLoadingMetrics", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "updateLoadingMetrics" ], "query": [], "variable": [] }, "description": "Update Cargo Specifications", "body": { "mode": "raw", "raw": "{\n \"dalvolume\": \"2\",\n \"height\": \"0\",\n \"length\": \"0\",\n \"palletplaces\": \"2\",\n \"route\": \"790-05-26\",\n \"routepart\": 115697883,\n \"unit\": 12881,\n \"unitquantity\": \"0\",\n \"volume\": \"2\",\n \"weight\": \"128.000\",\n \"width\": \"0\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Stops", "item": [ { "name": "Get Stops", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCheckpoint", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCheckpoint" ], "query": [ { "key": "byCompany", "value": "{{checkpointsByCheckpointCompany}}", "description": "Optional int. Id of the company that owns the loading, unloading or customs checkpoints. Returns the list of checkpoints of passed company.", "disabled": true }, { "key": "byTown", "value": "{{checkpointsByCheckpointTown}}", "description": "Optional int. Id of the town with loading, unloading or customs checkpoints. Returns the list of checkpoints in the passed town. ", "disabled": true }, { "key": "customs", "value": "{{checkpointsCustomsFlag}}", "description": "Optional bool. True: Returns the list of customs checkpoints. False (default): ignores the parameter, returns loading and unloading checkpoints.", "disabled": true } ], "variable": [] }, "description": "Returns the list of loading, unloading or customs checkpoints of the current company, depending on the passed parameters.\n\n- if successful you will receive list of loading, unloading or customs checkpoints, depending on the passed parameters\n\n- 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\n\n(!) NOTE: Only for shippers. At least 1 parameter must be passed." }, "response": [ { "name": "Success (byCompany parameter passed) / Success (byTown parameter passed) / Success (customs parameter passed)", "originalRequest": [], "status": "Success (byCompany parameter passed) / Success (byTown parameter passed) / Success (customs parameter passed)", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"address\": \"1 High Street\",\n \"id\": 44,\n \"latit\": \"50.412020000000000\",\n \"longit\": \"30.572705000000000\",\n \"town\": 9657,\n \"zip\": null\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "No parameters passed", "originalRequest": [], "status": "No parameters passed", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Missing parameters\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Stop Countries", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCountry", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCountry" ], "query": [ { "key": "byCheckpoint", "value": "{{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", "disabled": true }, { "key": "byCompany", "value": "{{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", "disabled": true }, { "key": "byTown", "value": "{{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", "disabled": true } ], "variable": [] }, "description": "Returns the list of countries, depending on the passed parameters.\n\n- if successful you will receive list of countries, depending of the list parameters\n- 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\n\n(!) NOTE: Only for shippers", "body": { "mode": "formdata", "formdata": [] } }, "response": [ { "name": "Success (No parameters passed) / Success (byCheckpoint passed) / Success (byTown passed) / Success (byCompany passed) / Success with all parameters passed", "originalRequest": [], "status": "Success (No parameters passed) / Success (byCheckpoint passed) / Success (byTown passed) / Success (byCompany passed) / Success with all parameters passed", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"isoNum\": 36,\n \"title\": \"Австралия\",\n \"titleLatin\": \"Australia\"\n },\n {\n \"id\": 2,\n \"isoNum\": 40,\n \"title\": \"Австрия\",\n \"titleLatin\": \"Austria\"\n },\n {\n \"id\": 3,\n \"isoNum\": 31,\n \"title\": \"Азербайджан\",\n \"titleLatin\": \"Azerbaijan\"\n },\n {\n \"id\": 4,\n \"isoNum\": 8,\n \"title\": \"Албания\",\n \"titleLatin\": \"Albania\"\n },\n {\n \"id\": 5,\n \"isoNum\": 12,\n \"title\": \"Алжир\",\n \"titleLatin\": \"Algeria\"\n },\n {\n \"id\": 6,\n \"isoNum\": 16,\n \"title\": \"Американское Самоа\",\n \"titleLatin\": \"American Samoa\"\n },\n {\n \"id\": 7,\n \"isoNum\": 660,\n \"title\": \"Ангилья\",\n \"titleLatin\": \"Anguilla\"\n },\n {\n \"id\": 8,\n \"isoNum\": 24,\n \"title\": \"Ангола\",\n \"titleLatin\": \"Angola\"\n },\n {\n \"id\": 9,\n \"isoNum\": 20,\n \"title\": \"Андорра\",\n \"titleLatin\": \"Andorra\"\n },\n {\n \"id\": 10,\n \"isoNum\": 10,\n \"title\": \"Антарктида\",\n \"titleLatin\": \"Antarctica\"\n },\n {\n \"id\": 11,\n \"isoNum\": 28,\n \"title\": \"Антигуа и Барбуда\",\n \"titleLatin\": \"Antigua and Barbuda\"\n },\n {\n \"id\": 12,\n \"isoNum\": 32,\n \"title\": \"Аргентина\",\n \"titleLatin\": \"Argentina\"\n },\n {\n \"id\": 13,\n \"isoNum\": 51,\n \"title\": \"Армения\",\n \"titleLatin\": \"Armenia\"\n },\n {\n \"id\": 14,\n \"isoNum\": 533,\n \"title\": \"Аруба\",\n \"titleLatin\": \"Aruba\"\n },\n {\n \"id\": 15,\n \"isoNum\": 4,\n \"title\": \"Афганистан\",\n \"titleLatin\": \"Afghanistan\"\n },\n {\n \"id\": 16,\n \"isoNum\": 44,\n \"title\": \"Багамы\",\n \"titleLatin\": \"Bahamas, The\"\n },\n {\n \"id\": 17,\n \"isoNum\": 50,\n \"title\": \"Бангладеш\",\n \"titleLatin\": \"Bangladesh\"\n },\n {\n \"id\": 18,\n \"isoNum\": 52,\n \"title\": \"Барбадос\",\n \"titleLatin\": \"Barbados\"\n },\n {\n \"id\": 19,\n \"isoNum\": 48,\n \"title\": \"Бахрейн\",\n \"titleLatin\": \"Bahrain\"\n },\n {\n \"id\": 20,\n \"isoNum\": 112,\n \"title\": \"Беларусь\",\n \"titleLatin\": \"Belarus\"\n },\n {\n \"id\": 21,\n \"isoNum\": 84,\n \"title\": \"Белиз\",\n \"titleLatin\": \"Belize\"\n },\n {\n \"id\": 22,\n \"isoNum\": 56,\n \"title\": \"Бельгия\",\n \"titleLatin\": \"Belgium\"\n },\n {\n \"id\": 23,\n \"isoNum\": 204,\n \"title\": \"Бенин\",\n \"titleLatin\": \"Benin\"\n },\n {\n \"id\": 24,\n \"isoNum\": 60,\n \"title\": \"Бермуды\",\n \"titleLatin\": \"Bermuda\"\n },\n {\n \"id\": 25,\n \"isoNum\": 100,\n \"title\": \"Болгария\",\n \"titleLatin\": \"Bulgaria\"\n },\n {\n \"id\": 26,\n \"isoNum\": 68,\n \"title\": \"Боливия\",\n \"titleLatin\": \"Bolivia\"\n },\n {\n \"id\": 27,\n \"isoNum\": 70,\n \"title\": \"Босния и Герцеговина\",\n \"titleLatin\": \"Bosnia and Herzegovina\"\n },\n {\n \"id\": 28,\n \"isoNum\": 72,\n \"title\": \"Ботсвана\",\n \"titleLatin\": \"Botswana\"\n },\n {\n \"id\": 29,\n \"isoNum\": 76,\n \"title\": \"Бразилия\",\n \"titleLatin\": \"Brazil\"\n },\n {\n \"id\": 30,\n \"isoNum\": 86,\n \"title\": \"Британская территория в Индийском океане\",\n \"titleLatin\": \"British Indian Ocean Territory\"\n },\n {\n \"id\": 31,\n \"isoNum\": 96,\n \"title\": \"Бруней-Даруссалам\",\n \"titleLatin\": \"Brunei\"\n },\n {\n \"id\": 32,\n \"isoNum\": 854,\n \"title\": \"Буркина-Фасо\",\n \"titleLatin\": \"Burkina Faso\"\n },\n {\n \"id\": 33,\n \"isoNum\": 108,\n \"title\": \"Бурунди\",\n \"titleLatin\": \"Burundi\"\n },\n {\n \"id\": 34,\n \"isoNum\": 64,\n \"title\": \"Бутан\",\n \"titleLatin\": \"Bhutan\"\n },\n {\n \"id\": 35,\n \"isoNum\": 548,\n \"title\": \"Вануату\",\n \"titleLatin\": \"Vanuatu\"\n },\n {\n \"id\": 36,\n \"isoNum\": 348,\n \"title\": \"Венгрия\",\n \"titleLatin\": \"Hungary\"\n },\n {\n \"id\": 37,\n \"isoNum\": 862,\n \"title\": \"Венесуэла\",\n \"titleLatin\": \"Venezuela\"\n },\n {\n \"id\": 38,\n \"isoNum\": 92,\n \"title\": \"Виргинские острова, Британские\",\n \"titleLatin\": \"British Virgin Islands\"\n },\n {\n \"id\": 39,\n \"isoNum\": 850,\n \"title\": \"Виргинские острова, США\",\n \"titleLatin\": \"Virgin Islands\"\n },\n {\n \"id\": 40,\n \"isoNum\": 704,\n \"title\": \"Вьетнам\",\n \"titleLatin\": \"Vietnam\"\n },\n {\n \"id\": 41,\n \"isoNum\": 266,\n \"title\": \"Габон\",\n \"titleLatin\": \"Gabon\"\n },\n {\n \"id\": 42,\n \"isoNum\": 332,\n \"title\": \"Гаити\",\n \"titleLatin\": \"Haiti\"\n },\n {\n \"id\": 43,\n \"isoNum\": 328,\n \"title\": \"Гайана\",\n \"titleLatin\": \"Guyana\"\n },\n {\n \"id\": 44,\n \"isoNum\": 270,\n \"title\": \"Гамбия\",\n \"titleLatin\": \"Gambia, The\"\n },\n {\n \"id\": 45,\n \"isoNum\": 288,\n \"title\": \"Гана\",\n \"titleLatin\": \"Ghana\"\n },\n {\n \"id\": 46,\n \"isoNum\": 312,\n \"title\": \"Гваделупа\",\n \"titleLatin\": \"Guadeloupe\"\n },\n {\n \"id\": 47,\n \"isoNum\": 320,\n \"title\": \"Гватемала\",\n \"titleLatin\": \"Guatemala\"\n },\n {\n \"id\": 48,\n \"isoNum\": 324,\n \"title\": \"Гвинея\",\n \"titleLatin\": \"Guinea\"\n },\n {\n \"id\": 49,\n \"isoNum\": 624,\n \"title\": \"Гвинея-Бисау\",\n \"titleLatin\": \"Guinea-Bissau\"\n },\n {\n \"id\": 50,\n \"isoNum\": 276,\n \"title\": \"Германия\",\n \"titleLatin\": \"Germany\"\n },\n {\n \"id\": 51,\n \"isoNum\": 831,\n \"title\": \"Гернси\",\n \"titleLatin\": \"Guernsey\"\n },\n {\n \"id\": 52,\n \"isoNum\": 292,\n \"title\": \"Гибралтар\",\n \"titleLatin\": \"Gibraltar\"\n },\n {\n \"id\": 53,\n \"isoNum\": 340,\n \"title\": \"Гондурас\",\n \"titleLatin\": \"Honduras\"\n },\n {\n \"id\": 54,\n \"isoNum\": 344,\n \"title\": \"Гонконг\",\n \"titleLatin\": \"Hong Kong\"\n },\n {\n \"id\": 55,\n \"isoNum\": 308,\n \"title\": \"Гренада\",\n \"titleLatin\": \"Grenada\"\n },\n {\n \"id\": 56,\n \"isoNum\": 304,\n \"title\": \"Гренландия\",\n \"titleLatin\": \"Greenland\"\n },\n {\n \"id\": 57,\n \"isoNum\": 300,\n \"title\": \"Греция\",\n \"titleLatin\": \"Greece\"\n },\n {\n \"id\": 58,\n \"isoNum\": 268,\n \"title\": \"Грузия\",\n \"titleLatin\": \"Georgia\"\n },\n {\n \"id\": 59,\n \"isoNum\": 316,\n \"title\": \"Гуам\",\n \"titleLatin\": \"Guam\"\n },\n {\n \"id\": 60,\n \"isoNum\": 208,\n \"title\": \"Дания\",\n \"titleLatin\": \"Denmark\"\n },\n {\n \"id\": 61,\n \"isoNum\": 832,\n \"title\": \"Джерси\",\n \"titleLatin\": \"Jersey\"\n },\n {\n \"id\": 62,\n \"isoNum\": 262,\n \"title\": \"Джибути\",\n \"titleLatin\": \"Djibouti\"\n },\n {\n \"id\": 63,\n \"isoNum\": 212,\n \"title\": \"Доминика\",\n \"titleLatin\": \"Dominica\"\n },\n {\n \"id\": 64,\n \"isoNum\": 214,\n \"title\": \"Доминиканская Республика\",\n \"titleLatin\": \"Dominican Republic\"\n },\n {\n \"id\": 65,\n \"isoNum\": 818,\n \"title\": \"Египет\",\n \"titleLatin\": \"Egypt\"\n },\n {\n \"id\": 66,\n \"isoNum\": 894,\n \"title\": \"Замбия\",\n \"titleLatin\": \"Zambia\"\n },\n {\n \"id\": 67,\n \"isoNum\": 732,\n \"title\": \"Западная Сахара\",\n \"titleLatin\": \"Western Sahara\"\n },\n {\n \"id\": 68,\n \"isoNum\": 716,\n \"title\": \"Зимбабве\",\n \"titleLatin\": \"Zimbabwe\"\n },\n {\n \"id\": 69,\n \"isoNum\": 376,\n \"title\": \"Израиль\",\n \"titleLatin\": \"Israel\"\n },\n {\n \"id\": 70,\n \"isoNum\": 356,\n \"title\": \"Индия\",\n \"titleLatin\": \"India\"\n },\n {\n \"id\": 71,\n \"isoNum\": 360,\n \"title\": \"Индонезия\",\n \"titleLatin\": \"Indonesia\"\n },\n {\n \"id\": 72,\n \"isoNum\": 400,\n \"title\": \"Иордания\",\n \"titleLatin\": \"Jordan\"\n },\n {\n \"id\": 73,\n \"isoNum\": 368,\n \"title\": \"Ирак\",\n \"titleLatin\": \"Iraq\"\n },\n {\n \"id\": 74,\n \"isoNum\": 364,\n \"title\": \"Иран, Исламская Республика\",\n \"titleLatin\": \"Iran\"\n },\n {\n \"id\": 75,\n \"isoNum\": 372,\n \"title\": \"Ирландия\",\n \"titleLatin\": \"Ireland\"\n },\n {\n \"id\": 76,\n \"isoNum\": 352,\n \"title\": \"Исландия\",\n \"titleLatin\": \"Iceland\"\n },\n {\n \"id\": 77,\n \"isoNum\": 724,\n \"title\": \"Испания\",\n \"titleLatin\": \"Spain\"\n },\n {\n \"id\": 78,\n \"isoNum\": 380,\n \"title\": \"Италия\",\n \"titleLatin\": \"Italy\"\n },\n {\n \"id\": 79,\n \"isoNum\": 887,\n \"title\": \"Йемен\",\n \"titleLatin\": \"Yemen\"\n },\n {\n \"id\": 80,\n \"isoNum\": 132,\n \"title\": \"Кабо-Верде\",\n \"titleLatin\": \"Cape Verde\"\n },\n {\n \"id\": 81,\n \"isoNum\": 398,\n \"title\": \"Казахстан\",\n \"titleLatin\": \"Kazakhstan\"\n },\n {\n \"id\": 82,\n \"isoNum\": 116,\n \"title\": \"Камбоджа\",\n \"titleLatin\": \"Cambodia\"\n },\n {\n \"id\": 83,\n \"isoNum\": 120,\n \"title\": \"Камерун\",\n \"titleLatin\": \"Cameroon\"\n },\n {\n \"id\": 84,\n \"isoNum\": 124,\n \"title\": \"Канада\",\n \"titleLatin\": \"Canada\"\n },\n {\n \"id\": 85,\n \"isoNum\": 634,\n \"title\": \"Катар\",\n \"titleLatin\": \"Qatar\"\n },\n {\n \"id\": 86,\n \"isoNum\": 404,\n \"title\": \"Кения\",\n \"titleLatin\": \"Kenya\"\n },\n {\n \"id\": 87,\n \"isoNum\": 196,\n \"title\": \"Кипр\",\n \"titleLatin\": \"Cyprus\"\n },\n {\n \"id\": 88,\n \"isoNum\": 417,\n \"title\": \"Киргизия\",\n \"titleLatin\": \"Kyrgyzstan\"\n },\n {\n \"id\": 89,\n \"isoNum\": 296,\n \"title\": \"Кирибати\",\n \"titleLatin\": \"Kiribati\"\n },\n {\n \"id\": 90,\n \"isoNum\": 156,\n \"title\": \"Китай\",\n \"titleLatin\": \"China\"\n },\n {\n \"id\": 91,\n \"isoNum\": 166,\n \"title\": \"Кокосовые (Килинг) острова\",\n \"titleLatin\": \"Cocos (Keeling) Islands\"\n },\n {\n \"id\": 92,\n \"isoNum\": 170,\n \"title\": \"Колумбия\",\n \"titleLatin\": \"Colombia\"\n },\n {\n \"id\": 93,\n \"isoNum\": 174,\n \"title\": \"Коморы\",\n \"titleLatin\": \"Comoros\"\n },\n {\n \"id\": 94,\n \"isoNum\": 178,\n \"title\": \"Конго\",\n \"titleLatin\": \"Congo, Republic of the\"\n },\n {\n \"id\": 95,\n \"isoNum\": 180,\n \"title\": \"Конго, Демократическая Республика\",\n \"titleLatin\": \"Congo, Democratic Republic of the\"\n },\n {\n \"id\": 96,\n \"isoNum\": 688,\n \"title\": \"Косово\",\n \"titleLatin\": \"Kosovo\"\n },\n {\n \"id\": 97,\n \"isoNum\": 188,\n \"title\": \"Коста-Рика\",\n \"titleLatin\": \"Costa Rica\"\n },\n {\n \"id\": 98,\n \"isoNum\": 384,\n \"title\": \"Кот д'Ивуар\",\n \"titleLatin\": \"Cote d'Ivoire\"\n },\n {\n \"id\": 99,\n \"isoNum\": 192,\n \"title\": \"Куба\",\n \"titleLatin\": \"Cuba\"\n },\n {\n \"id\": 100,\n \"isoNum\": 414,\n \"title\": \"Кувейт\",\n \"titleLatin\": \"Kuwait\"\n },\n {\n \"id\": 101,\n \"isoNum\": 418,\n \"title\": \"Лаос\",\n \"titleLatin\": \"Laos\"\n },\n {\n \"id\": 102,\n \"isoNum\": 428,\n \"title\": \"Латвия\",\n \"titleLatin\": \"Latvia\"\n },\n {\n \"id\": 103,\n \"isoNum\": 426,\n \"title\": \"Лесото\",\n \"titleLatin\": \"Lesotho\"\n },\n {\n \"id\": 104,\n \"isoNum\": 422,\n \"title\": \"Ливан\",\n \"titleLatin\": \"Lebanon\"\n },\n {\n \"id\": 105,\n \"isoNum\": 434,\n \"title\": \"Ливийская Арабская Джамахирия\",\n \"titleLatin\": \"Libya\"\n },\n {\n \"id\": 106,\n \"isoNum\": 430,\n \"title\": \"Либерия\",\n \"titleLatin\": \"Liberia\"\n },\n {\n \"id\": 107,\n \"isoNum\": 438,\n \"title\": \"Лихтенштейн\",\n \"titleLatin\": \"Liechtenstein\"\n },\n {\n \"id\": 108,\n \"isoNum\": 440,\n \"title\": \"Литва\",\n \"titleLatin\": \"Lithuania\"\n },\n {\n \"id\": 109,\n \"isoNum\": 442,\n \"title\": \"Люксембург\",\n \"titleLatin\": \"Luxembourg\"\n },\n {\n \"id\": 110,\n \"isoNum\": 480,\n \"title\": \"Маврикий\",\n \"titleLatin\": \"Mauritius\"\n },\n {\n \"id\": 111,\n \"isoNum\": 478,\n \"title\": \"Мавритания\",\n \"titleLatin\": \"Mauritania\"\n },\n {\n \"id\": 112,\n \"isoNum\": 450,\n \"title\": \"Мадагаскар\",\n \"titleLatin\": \"Madagascar\"\n },\n {\n \"id\": 113,\n \"isoNum\": 175,\n \"title\": \"Майотта\",\n \"titleLatin\": \"Mayotte\"\n },\n {\n \"id\": 114,\n \"isoNum\": 446,\n \"title\": \"Макао\",\n \"titleLatin\": \"Macau\"\n },\n {\n \"id\": 115,\n \"isoNum\": 454,\n \"title\": \"Малави\",\n \"titleLatin\": \"Malawi\"\n },\n {\n \"id\": 116,\n \"isoNum\": 458,\n \"title\": \"Малайзия\",\n \"titleLatin\": \"Malaysia\"\n },\n {\n \"id\": 117,\n \"isoNum\": 466,\n \"title\": \"Мали\",\n \"titleLatin\": \"Mali\"\n },\n {\n \"id\": 118,\n \"isoNum\": 581,\n \"title\": \"Малые Тихоокеанские отдаленные острова Соединенных\",\n \"titleLatin\": \"United States Pacific Island Wildlife Refuges\"\n },\n {\n \"id\": 119,\n \"isoNum\": 462,\n \"title\": \"Мальдивы\",\n \"titleLatin\": \"Maldives\"\n },\n {\n \"id\": 120,\n \"isoNum\": 470,\n \"title\": \"Мальта\",\n \"titleLatin\": \"Malta\"\n },\n {\n \"id\": 121,\n \"isoNum\": 504,\n \"title\": \"Марокко\",\n \"titleLatin\": \"Morocco\"\n },\n {\n \"id\": 122,\n \"isoNum\": 474,\n \"title\": \"Мартиника\",\n \"titleLatin\": \"Martinique\"\n },\n {\n \"id\": 123,\n \"isoNum\": 584,\n \"title\": \"Маршалловы острова\",\n \"titleLatin\": \"Marshall Islands\"\n },\n {\n \"id\": 124,\n \"isoNum\": 484,\n \"title\": \"Мексика\",\n \"titleLatin\": \"Mexico\"\n },\n {\n \"id\": 125,\n \"isoNum\": 583,\n \"title\": \"Микронезия, Федеративные Штаты\",\n \"titleLatin\": \"Micronesia, Federated States of\"\n },\n {\n \"id\": 126,\n \"isoNum\": 508,\n \"title\": \"Мозамбик\",\n \"titleLatin\": \"Mozambique\"\n },\n {\n \"id\": 127,\n \"isoNum\": 498,\n \"title\": \"Молдова, Республика\",\n \"titleLatin\": \"Moldova\"\n },\n {\n \"id\": 128,\n \"isoNum\": 492,\n \"title\": \"Монако\",\n \"titleLatin\": \"Monaco\"\n },\n {\n \"id\": 129,\n \"isoNum\": 496,\n \"title\": \"Монголия\",\n \"titleLatin\": \"Mongolia\"\n },\n {\n \"id\": 130,\n \"isoNum\": 500,\n \"title\": \"Монтсеррат\",\n \"titleLatin\": \"Montserrat\"\n },\n {\n \"id\": 131,\n \"isoNum\": 104,\n \"title\": \"Мьянма\",\n \"titleLatin\": \"Burma\"\n },\n {\n \"id\": 132,\n \"isoNum\": 516,\n \"title\": \"Намибия\",\n \"titleLatin\": \"Namibia\"\n },\n {\n \"id\": 133,\n \"isoNum\": 520,\n \"title\": \"Науру\",\n \"titleLatin\": \"Nauru\"\n },\n {\n \"id\": 134,\n \"isoNum\": 524,\n \"title\": \"Непал\",\n \"titleLatin\": \"Nepal\"\n },\n {\n \"id\": 135,\n \"isoNum\": 562,\n \"title\": \"Нигер\",\n \"titleLatin\": \"Niger\"\n },\n {\n \"id\": 136,\n \"isoNum\": 566,\n \"title\": \"Нигерия\",\n \"titleLatin\": \"Nigeria\"\n },\n {\n \"id\": 137,\n \"isoNum\": 530,\n \"title\": \"Нидерландские Антилы\",\n \"titleLatin\": \"Netherlands Antilles\"\n },\n {\n \"id\": 138,\n \"isoNum\": 528,\n \"title\": \"Нидерланды\",\n \"titleLatin\": \"Netherlands\"\n },\n {\n \"id\": 139,\n \"isoNum\": 558,\n \"title\": \"Никарагуа\",\n \"titleLatin\": \"Nicaragua\"\n },\n {\n \"id\": 140,\n \"isoNum\": 570,\n \"title\": \"Ниуэ\",\n \"titleLatin\": \"Niue\"\n },\n {\n \"id\": 141,\n \"isoNum\": 554,\n \"title\": \"Новая Зеландия\",\n \"titleLatin\": \"New Zealand\"\n },\n {\n \"id\": 142,\n \"isoNum\": 540,\n \"title\": \"Новая Каледония\",\n \"titleLatin\": \"New Caledonia\"\n },\n {\n \"id\": 143,\n \"isoNum\": 578,\n \"title\": \"Норвегия\",\n \"titleLatin\": \"Norway\"\n },\n {\n \"id\": 144,\n \"isoNum\": 784,\n \"title\": \"Объединенные Арабские Эмираты\",\n \"titleLatin\": \"United Arab Emirates\"\n },\n {\n \"id\": 145,\n \"isoNum\": 512,\n \"title\": \"Оман\",\n \"titleLatin\": \"Oman\"\n },\n {\n \"id\": 146,\n \"isoNum\": 74,\n \"title\": \"Остров Буве\",\n \"titleLatin\": \"Bouvet Island\"\n },\n {\n \"id\": 147,\n \"isoNum\": 0,\n \"title\": \"Остров Клиппертон\",\n \"titleLatin\": \"Clipperton Island\"\n },\n {\n \"id\": 148,\n \"isoNum\": 833,\n \"title\": \"Остров Мэн\",\n \"titleLatin\": \"Isle of Man\"\n },\n {\n \"id\": 149,\n \"isoNum\": 574,\n \"title\": \"Остров Норфолк\",\n \"titleLatin\": \"Norfolk Island\"\n },\n {\n \"id\": 150,\n \"isoNum\": 162,\n \"title\": \"Остров Рождества\",\n \"titleLatin\": \"Christmas Island\"\n },\n {\n \"id\": 151,\n \"isoNum\": 663,\n \"title\": \"Остров Святого Мартина\",\n \"titleLatin\": \"Saint Martin\"\n },\n {\n \"id\": 152,\n \"isoNum\": 334,\n \"title\": \"Остров Херд и острова Макдональд\",\n \"titleLatin\": \"Heard Island and McDonald Islands\"\n },\n {\n \"id\": 153,\n \"isoNum\": 136,\n \"title\": \"Острова Кайман\",\n \"titleLatin\": \"Cayman Islands\"\n },\n {\n \"id\": 154,\n \"isoNum\": 184,\n \"title\": \"Острова Кука\",\n \"titleLatin\": \"Cook Islands\"\n },\n {\n \"id\": 155,\n \"isoNum\": 796,\n \"title\": \"Острова Теркс и Кайкос\",\n \"titleLatin\": \"Turks and Caicos Islands\"\n },\n {\n \"id\": 156,\n \"isoNum\": 586,\n \"title\": \"Пакистан\",\n \"titleLatin\": \"Pakistan\"\n },\n {\n \"id\": 157,\n \"isoNum\": 585,\n \"title\": \"Палау\",\n \"titleLatin\": \"Palau\"\n },\n {\n \"id\": 158,\n \"isoNum\": 275,\n \"title\": \"Палестинская территория, оккупированная\",\n \"titleLatin\": \"Palestinian Territory, Occupied\"\n },\n {\n \"id\": 159,\n \"isoNum\": 591,\n \"title\": \"Панама\",\n \"titleLatin\": \"Panama\"\n },\n {\n \"id\": 160,\n \"isoNum\": 336,\n \"title\": \"Папский Престол (Государство — город Ватикан)\",\n \"titleLatin\": \"Holy See (Vatican City)\"\n },\n {\n \"id\": 161,\n \"isoNum\": 598,\n \"title\": \"Папуа-Новая Гвинея\",\n \"titleLatin\": \"Papua New Guinea\"\n },\n {\n \"id\": 162,\n \"isoNum\": 600,\n \"title\": \"Парагвай\",\n \"titleLatin\": \"Paraguay\"\n },\n {\n \"id\": 163,\n \"isoNum\": 604,\n \"title\": \"Перу\",\n \"titleLatin\": \"Peru\"\n },\n {\n \"id\": 164,\n \"isoNum\": 612,\n \"title\": \"Питкерн\",\n \"titleLatin\": \"Pitcairn\"\n },\n {\n \"id\": 165,\n \"isoNum\": 616,\n \"title\": \"Польша\",\n \"titleLatin\": \"Poland\"\n },\n {\n \"id\": 166,\n \"isoNum\": 620,\n \"title\": \"Португалия\",\n \"titleLatin\": \"Portugal\"\n },\n {\n \"id\": 167,\n \"isoNum\": 630,\n \"title\": \"Пуэрто-Рико\",\n \"titleLatin\": \"Puerto Rico\"\n },\n {\n \"id\": 168,\n \"isoNum\": 807,\n \"title\": \"Республика Македония\",\n \"titleLatin\": \"Macedonia\"\n },\n {\n \"id\": 169,\n \"isoNum\": 638,\n \"title\": \"Реюньон\",\n \"titleLatin\": \"Reunion\"\n },\n {\n \"id\": 170,\n \"isoNum\": 643,\n \"title\": \"Россия\",\n \"titleLatin\": \"Russia\"\n },\n {\n \"id\": 171,\n \"isoNum\": 646,\n \"title\": \"Руанда\",\n \"titleLatin\": \"Rwanda\"\n },\n {\n \"id\": 172,\n \"isoNum\": 642,\n \"title\": \"Румыния\",\n \"titleLatin\": \"Romania\"\n },\n {\n \"id\": 173,\n \"isoNum\": 882,\n \"title\": \"Самоа\",\n \"titleLatin\": \"Samoa\"\n },\n {\n \"id\": 174,\n \"isoNum\": 674,\n \"title\": \"Сан-Марино\",\n \"titleLatin\": \"San Marino\"\n },\n {\n \"id\": 175,\n \"isoNum\": 678,\n \"title\": \"Сан-Томе и Принсипи\",\n \"titleLatin\": \"Sao Tome and Principe\"\n },\n {\n \"id\": 176,\n \"isoNum\": 682,\n \"title\": \"Саудовская Аравия\",\n \"titleLatin\": \"Saudi Arabia\"\n },\n {\n \"id\": 177,\n \"isoNum\": 748,\n \"title\": \"Свазиленд\",\n \"titleLatin\": \"Swaziland\"\n },\n {\n \"id\": 178,\n \"isoNum\": 654,\n \"title\": \"Святая Елена\",\n \"titleLatin\": \"Saint Helena\"\n },\n {\n \"id\": 179,\n \"isoNum\": 408,\n \"title\": \"Северная Корея\",\n \"titleLatin\": \"Korea, North\"\n },\n {\n \"id\": 180,\n \"isoNum\": 580,\n \"title\": \"Северные Марианские острова\",\n \"titleLatin\": \"Northern Mariana Islands\"\n },\n {\n \"id\": 181,\n \"isoNum\": 652,\n \"title\": \"Сен-Бартельми\",\n \"titleLatin\": \"Saint Barthélemy\"\n },\n {\n \"id\": 182,\n \"isoNum\": 666,\n \"title\": \"Сен-Пьер и Микелон\",\n \"titleLatin\": \"Saint Pierre and Miquelon\"\n },\n {\n \"id\": 183,\n \"isoNum\": 686,\n \"title\": \"Сенегал\",\n \"titleLatin\": \"Senegal\"\n },\n {\n \"id\": 184,\n \"isoNum\": 670,\n \"title\": \"Сент-Винсент и Гренадины\",\n \"titleLatin\": \"Saint Vincent and the Grenadines\"\n },\n {\n \"id\": 185,\n \"isoNum\": 662,\n \"title\": \"Сент-Люсия\",\n \"titleLatin\": \"Saint Lucia\"\n },\n {\n \"id\": 186,\n \"isoNum\": 659,\n \"title\": \"Сент-Китс и Невис\",\n \"titleLatin\": \"Saint Kitts and Nevis\"\n },\n {\n \"id\": 187,\n \"isoNum\": 688,\n \"title\": \"Сербия\",\n \"titleLatin\": \"Serbia\"\n },\n {\n \"id\": 188,\n \"isoNum\": 690,\n \"title\": \"Сейшелы\",\n \"titleLatin\": \"Seychelles\"\n },\n {\n \"id\": 189,\n \"isoNum\": 702,\n \"title\": \"Сингапур\",\n \"titleLatin\": \"Singapore\"\n },\n {\n \"id\": 190,\n \"isoNum\": 760,\n \"title\": \"Сирийская Арабская Республика\",\n \"titleLatin\": \"Syria\"\n },\n {\n \"id\": 191,\n \"isoNum\": 703,\n \"title\": \"Словакия\",\n \"titleLatin\": \"Slovakia\"\n },\n {\n \"id\": 192,\n \"isoNum\": 705,\n \"title\": \"Словения\",\n \"titleLatin\": \"Slovenia\"\n },\n {\n \"id\": 193,\n \"isoNum\": 826,\n \"title\": \"Великобритания\",\n \"titleLatin\": \"United Kingdom\"\n },\n {\n \"id\": 194,\n \"isoNum\": 840,\n \"title\": \"Соединенные Штаты\",\n \"titleLatin\": \"United States\"\n },\n {\n \"id\": 195,\n \"isoNum\": 90,\n \"title\": \"Соломоновы острова\",\n \"titleLatin\": \"Solomon Islands\"\n },\n {\n \"id\": 196,\n \"isoNum\": 706,\n \"title\": \"Сомали\",\n \"titleLatin\": \"Somalia\"\n },\n {\n \"id\": 197,\n \"isoNum\": 736,\n \"title\": \"Судан\",\n \"titleLatin\": \"Sudan\"\n },\n {\n \"id\": 198,\n \"isoNum\": 740,\n \"title\": \"Суринам\",\n \"titleLatin\": \"Suriname\"\n },\n {\n \"id\": 199,\n \"isoNum\": 694,\n \"title\": \"Сьерра-Леоне\",\n \"titleLatin\": \"Sierra Leone\"\n },\n {\n \"id\": 200,\n \"isoNum\": 762,\n \"title\": \"Таджикистан\",\n \"titleLatin\": \"Tajikistan\"\n },\n {\n \"id\": 201,\n \"isoNum\": 764,\n \"title\": \"Таиланд\",\n \"titleLatin\": \"Thailand\"\n },\n {\n \"id\": 202,\n \"isoNum\": 834,\n \"title\": \"Танзания, Объединенная Республика\",\n \"titleLatin\": \"Tanzania\"\n },\n {\n \"id\": 203,\n \"isoNum\": 158,\n \"title\": \"Тайвань (Китай)\",\n \"titleLatin\": \"Taiwan\"\n },\n {\n \"id\": 204,\n \"isoNum\": 626,\n \"title\": \"Тимор-Лесте\",\n \"titleLatin\": \"Timor-Leste\"\n },\n {\n \"id\": 205,\n \"isoNum\": 768,\n \"title\": \"Того\",\n \"titleLatin\": \"Togo\"\n },\n {\n \"id\": 206,\n \"isoNum\": 772,\n \"title\": \"Токелау\",\n \"titleLatin\": \"Tokelau\"\n },\n {\n \"id\": 207,\n \"isoNum\": 776,\n \"title\": \"Тонга\",\n \"titleLatin\": \"Tonga\"\n },\n {\n \"id\": 208,\n \"isoNum\": 780,\n \"title\": \"Тринидад и Тобаго\",\n \"titleLatin\": \"Trinidad and Tobago\"\n },\n {\n \"id\": 209,\n \"isoNum\": 798,\n \"title\": \"Тувалу\",\n \"titleLatin\": \"Tuvalu\"\n },\n {\n \"id\": 210,\n \"isoNum\": 788,\n \"title\": \"Тунис\",\n \"titleLatin\": \"Tunisia\"\n },\n {\n \"id\": 211,\n \"isoNum\": 795,\n \"title\": \"Туркмения\",\n \"titleLatin\": \"Turkmenistan\"\n },\n {\n \"id\": 212,\n \"isoNum\": 792,\n \"title\": \"Турция\",\n \"titleLatin\": \"Turkey\"\n },\n {\n \"id\": 213,\n \"isoNum\": 800,\n \"title\": \"Уганда\",\n \"titleLatin\": \"Uganda\"\n },\n {\n \"id\": 214,\n \"isoNum\": 860,\n \"title\": \"Узбекистан\",\n \"titleLatin\": \"Uzbekistan\"\n },\n {\n \"id\": 215,\n \"isoNum\": 804,\n \"title\": \"Украина\",\n \"titleLatin\": \"Ukraine\"\n },\n {\n \"id\": 216,\n \"isoNum\": 876,\n \"title\": \"Уоллис и Футуна\",\n \"titleLatin\": \"Wallis and Futuna\"\n },\n {\n \"id\": 217,\n \"isoNum\": 858,\n \"title\": \"Уругвай\",\n \"titleLatin\": \"Uruguay\"\n },\n {\n \"id\": 218,\n \"isoNum\": 234,\n \"title\": \"Фарерские острова\",\n \"titleLatin\": \"Faroe Islands\"\n },\n {\n \"id\": 219,\n \"isoNum\": 242,\n \"title\": \"Фиджи\",\n \"titleLatin\": \"Fiji\"\n },\n {\n \"id\": 220,\n \"isoNum\": 608,\n \"title\": \"Филиппины\",\n \"titleLatin\": \"Philippines\"\n },\n {\n \"id\": 221,\n \"isoNum\": 246,\n \"title\": \"Финляндия\",\n \"titleLatin\": \"Finland\"\n },\n {\n \"id\": 222,\n \"isoNum\": 238,\n \"title\": \"Фолклендские острова (Мальвинские)\",\n \"titleLatin\": \"Falkland Islands (Islas Malvinas)\"\n },\n {\n \"id\": 223,\n \"isoNum\": 250,\n \"title\": \"Франция\",\n \"titleLatin\": \"France\"\n },\n {\n \"id\": 224,\n \"isoNum\": 254,\n \"title\": \"Французская Гвиана\",\n \"titleLatin\": \"French Guiana\"\n },\n {\n \"id\": 225,\n \"isoNum\": 258,\n \"title\": \"Французская Полинезия\",\n \"titleLatin\": \"French Polynesia\"\n },\n {\n \"id\": 226,\n \"isoNum\": 260,\n \"title\": \"Французские Южные территории\",\n \"titleLatin\": \"French Southern Lands\"\n },\n {\n \"id\": 227,\n \"isoNum\": 191,\n \"title\": \"Хорватия\",\n \"titleLatin\": \"Croatia\"\n },\n {\n \"id\": 228,\n \"isoNum\": 140,\n \"title\": \"Центрально-Африканская Республика\",\n \"titleLatin\": \"Central African Republic\"\n },\n {\n \"id\": 229,\n \"isoNum\": 148,\n \"title\": \"Чад\",\n \"titleLatin\": \"Chad\"\n },\n {\n \"id\": 230,\n \"isoNum\": 499,\n \"title\": \"Черногория\",\n \"titleLatin\": \"Montenegro\"\n },\n {\n \"id\": 231,\n \"isoNum\": 203,\n \"title\": \"Чешская Республика\",\n \"titleLatin\": \"Czech Republic\"\n },\n {\n \"id\": 232,\n \"isoNum\": 152,\n \"title\": \"Чили\",\n \"titleLatin\": \"Chile\"\n },\n {\n \"id\": 233,\n \"isoNum\": 756,\n \"title\": \"Швейцария\",\n \"titleLatin\": \"Switzerland\"\n },\n {\n \"id\": 234,\n \"isoNum\": 752,\n \"title\": \"Швеция\",\n \"titleLatin\": \"Sweden\"\n },\n {\n \"id\": 235,\n \"isoNum\": 744,\n \"title\": \"Шпицберген и Ян Майен\",\n \"titleLatin\": \"Svalbard and Jan Mayen\"\n },\n {\n \"id\": 236,\n \"isoNum\": 144,\n \"title\": \"Шри-Ланка\",\n \"titleLatin\": \"Sri Lanka\"\n },\n {\n \"id\": 237,\n \"isoNum\": 218,\n \"title\": \"Эквадор\",\n \"titleLatin\": \"Ecuador\"\n },\n {\n \"id\": 238,\n \"isoNum\": 226,\n \"title\": \"Экваториальная Гвинея\",\n \"titleLatin\": \"Equatorial Guinea\"\n },\n {\n \"id\": 239,\n \"isoNum\": 248,\n \"title\": \"Эландские острова\",\n \"titleLatin\": \"Åland Islands\"\n },\n {\n \"id\": 240,\n \"isoNum\": 222,\n \"title\": \"Эль-Сальвадор\",\n \"titleLatin\": \"El Salvador\"\n },\n {\n \"id\": 241,\n \"isoNum\": 232,\n \"title\": \"Эритрея\",\n \"titleLatin\": \"Eritrea\"\n },\n {\n \"id\": 242,\n \"isoNum\": 233,\n \"title\": \"Эстония\",\n \"titleLatin\": \"Estonia\"\n },\n {\n \"id\": 243,\n \"isoNum\": 231,\n \"title\": \"Эфиопия\",\n \"titleLatin\": \"Ethiopia\"\n },\n {\n \"id\": 244,\n \"isoNum\": 710,\n \"title\": \"Южная Африка\",\n \"titleLatin\": \"South Africa\"\n },\n {\n \"id\": 245,\n \"isoNum\": 239,\n \"title\": \"Южная Джорджия и Южные Сандвичевы острова\",\n \"titleLatin\": \"South Georgia and the South Sandwich Islands\"\n },\n {\n \"id\": 246,\n \"isoNum\": 410,\n \"title\": \"Южная Корея\",\n \"titleLatin\": \"Korea, South\"\n },\n {\n \"id\": 247,\n \"isoNum\": 388,\n \"title\": \"Ямайка\",\n \"titleLatin\": \"Jamaica\"\n },\n {\n \"id\": 248,\n \"isoNum\": 392,\n \"title\": \"Япония\",\n \"titleLatin\": \"Japan\"\n },\n {\n \"id\": 249,\n \"isoNum\": 203,\n \"title\": \"\",\n \"titleLatin\": \"Czech Republic\"\n },\n {\n \"id\": 250,\n \"isoNum\": 498,\n \"title\": \"Україна\",\n \"titleLatin\": \"Republic of Moldova\"\n },\n {\n \"id\": 251,\n \"isoNum\": 807,\n \"title\": \"Україна\",\n \"titleLatin\": \"North Macedonia\"\n },\n {\n \"id\": 252,\n \"isoNum\": 0,\n \"title\": \"Україна\",\n \"titleLatin\": \"\"\n },\n {\n \"id\": 253,\n \"isoNum\": 0,\n \"title\": \"Україна\",\n \"titleLatin\": \"\"\n },\n {\n \"id\": 254,\n \"isoNum\": 0,\n \"title\": \"Україна\",\n \"titleLatin\": \"\"\n },\n {\n \"id\": 255,\n \"isoNum\": 0,\n \"title\": \"Іспанія\",\n \"titleLatin\": \"\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Get Stop Companies", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCompanies", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCompanies" ], "query": [ { "key": "byCheckpoint", "value": "true", "description": "Required bool. True: Returns the list of companies who own loading/unloading checkpoint in your account. False: not allowed", "disabled": true }, { "key": "byCountry", "value": "{{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", "disabled": true }, { "key": "byRegion", "value": "{{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", "disabled": true }, { "key": "byTown", "value": "{{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", "disabled": true } ], "variable": [] }, "description": "Returns the list of companies, depending on the passed parameters.\n\n- if successful you will receive list of companies, depending of the passed parameters\n- 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\n\n(!) NOTE: Only for shippers" }, "response": [ { "name": "Success (byCheckpoint passed) / Success (byCountry passed) / Success (byRegion passed) / Success (byTown passed) / Success with all parameters", "originalRequest": [], "status": "Success (byCheckpoint passed) / Success (byCountry passed) / Success (byRegion passed) / Success (byTown passed) / Success with all parameters", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": 60,\n \"natcomid\": \"360587991\",\n \"title\": \"Company\",\n \"titleFull\": \"Company full name\"\n },\n {\n \"id\": 572,\n \"natcomid\": \"1231l2knk 123\",\n \"title\": \"testing, LLC\",\n \"titleFull\": \"testing, limited liability company\"\n },\n {\n \"id\": 781,\n \"natcomid\": \"10029029\",\n \"title\": \"SOME\",\n \"titleFull\": \"SOME full name\"\n },\n {\n \"id\": 3,\n \"natcomid\": \"39028162\",\n \"title\": \"Phleetto, LTD\",\n \"titleFull\": \"Phleetto Limited\"\n },\n {\n \"id\": 828,\n \"natcomid\": \"\",\n \"title\": \"Стартап.уа, LTD\",\n \"titleFull\": \"Стартап.уа, Общество с ограниченной ответственностью\"\n },\n {\n \"id\": 839,\n \"natcomid\": \"\",\n \"title\": \"LTD Траверсы\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 857,\n \"natcomid\": \"2232323\",\n \"title\": \"ДБО, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1815,\n \"natcomid\": \"1258756489\",\n \"title\": \"Зеланд, ЧП\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1855,\n \"natcomid\": \"\",\n \"title\": \"Брендсорс, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1857,\n \"natcomid\": \"\",\n \"title\": \"Лорейн, ДП\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1858,\n \"natcomid\": \"\",\n \"title\": \"Ремкомплект, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1865,\n \"natcomid\": \"\",\n \"title\": \"Отправка, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1941,\n \"natcomid\": \"\",\n \"title\": \"Таможня 1\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1942,\n \"natcomid\": \"\",\n \"title\": \"Floha Logistic\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1943,\n \"natcomid\": \"\",\n \"title\": \"Немецкая таможня\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1945,\n \"natcomid\": \"\",\n \"title\": \"Склад, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1946,\n \"natcomid\": \"\",\n \"title\": \"Пчелкин, СП\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 2207,\n \"natcomid\": \"\",\n \"title\": \"Укринвестрой, ГП\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 2288,\n \"natcomid\": \"\",\n \"title\": \"КремСофтСервис\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 2429,\n \"natcomid\": \"\",\n \"title\": \"RAILWAY-CARRIAGE REPAIR WORKS-99 S.A.\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 2461,\n \"natcomid\": \"\",\n \"title\": \"Свинтус, МЧП\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 2936,\n \"natcomid\": \"\",\n \"title\": \"Sherlock Inc\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 2937,\n \"natcomid\": \"\",\n \"title\": \"Bureau of Investigation\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 3544,\n \"natcomid\": \"rey\",\n \"title\": \"eary\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 3545,\n \"natcomid\": \"rstu\",\n \"title\": \"rstu\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 4041,\n \"natcomid\": \"245145322\",\n \"title\": \"Вентус, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 852,\n \"natcomid\": \"12345678\",\n \"title\": \"Ужгород Импекс Стар, ЧП\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 4454,\n \"natcomid\": \"\",\n \"title\": \"Рубероид, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 4455,\n \"natcomid\": \"\",\n \"title\": \"Дунай, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 4458,\n \"natcomid\": \"\",\n \"title\": \"Рафинад\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1944,\n \"natcomid\": \"\",\n \"title\": \"Киевская таможня\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5365,\n \"natcomid\": \"01010110\",\n \"title\": \"Империал групп Украина, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5372,\n \"natcomid\": \"Компания some ЕГРПОУ\",\n \"title\": \"Компания some\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5377,\n \"natcomid\": \"23232\",\n \"title\": \"23323\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5378,\n \"natcomid\": \"8857678\",\n \"title\": \"Совтес, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 4469,\n \"natcomid\": \"\",\n \"title\": \"Киев\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5379,\n \"natcomid\": \"\",\n \"title\": \"лукоц, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 2688,\n \"natcomid\": \"12\",\n \"title\": \"Марс, ФОП\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 50,\n \"natcomid\": \"1\",\n \"title\": \"Либра Транс, LTD\",\n \"titleFull\": \", Общество с ограниченной ответственностью)\"\n },\n {\n \"id\": 5380,\n \"natcomid\": \"123456789\",\n \"title\": \"Лісова пісня, ЧП\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5381,\n \"natcomid\": \"000000\",\n \"title\": \"Супермены\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5382,\n \"natcomid\": \"000000\",\n \"title\": \"Москалики\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5383,\n \"natcomid\": \"62896254\",\n \"title\": \"Кит\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5384,\n \"natcomid\": \"36372232\",\n \"title\": \"Ресторанчик\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5388,\n \"natcomid\": \"14708458\",\n \"title\": \"Бэби, ЧАО\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5389,\n \"natcomid\": \"00411938\",\n \"title\": \"Монстры, Корп\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5390,\n \"natcomid\": \"38155194\",\n \"title\": \"Главпочтамт\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5392,\n \"natcomid\": \"36913534\",\n \"title\": \"Таможенка, ЧАО\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5423,\n \"natcomid\": \"02174626\",\n \"title\": \"Компания без формы\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5424,\n \"natcomid\": \"\",\n \"title\": \"Зверинец\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5431,\n \"natcomid\": \"\",\n \"title\": \"Оболонь, ПАО\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5436,\n \"natcomid\": \"1234567890\",\n \"title\": \"Rj\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5437,\n \"natcomid\": \"0369258147\",\n \"title\": \"ьи\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5444,\n \"natcomid\": \"\",\n \"title\": \"Днепропетровский таможенный пост, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 3001,\n \"natcomid\": \"\",\n \"title\": \"Z.I.des Hauts Sarts\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 3000,\n \"natcomid\": \"\",\n \"title\": \"Arcelor Mittal Ringmill Zoning Industriel CMI,\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5453,\n \"natcomid\": \"\",\n \"title\": \"Кожушок\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5454,\n \"natcomid\": \"\",\n \"title\": \"а\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5366,\n \"natcomid\": \"\",\n \"title\": \"Компания\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5455,\n \"natcomid\": \"\",\n \"title\": \"Таможенка\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5465,\n \"natcomid\": \"7744556622\",\n \"title\": \"тат\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5466,\n \"natcomid\": \"9966330022\",\n \"title\": \"бма\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5467,\n \"natcomid\": \"0033115588\",\n \"title\": \"Таможня в Маяках\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5468,\n \"natcomid\": \"9955117700\",\n \"title\": \"Тирас (Маяки, Паланка)\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5469,\n \"natcomid\": \"\",\n \"title\": \"Частное лицо, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 17656,\n \"natcomid\": \"\",\n \"title\": \"Цирк, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19335,\n \"natcomid\": \"0369852014\",\n \"title\": \"Company\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19336,\n \"natcomid\": \"3698520147\",\n \"title\": \"Svb tr\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19339,\n \"natcomid\": \"0000001123\",\n \"title\": \"Rk\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19340,\n \"natcomid\": \"0011447788\",\n \"title\": \"Е\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19341,\n \"natcomid\": \"0033669988\",\n \"title\": \"Компанийка в Одессочке\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19342,\n \"natcomid\": \"\",\n \"title\": \"Корпорация, Корп\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19343,\n \"natcomid\": \"\",\n \"title\": \"Ка, Корп\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19344,\n \"natcomid\": \"\",\n \"title\": \", ДП\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19364,\n \"natcomid\": \"\",\n \"title\": \"Жучок, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19381,\n \"natcomid\": \"\",\n \"title\": \"Soumen katu, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19382,\n \"natcomid\": \"\",\n \"title\": \"Ислашка, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19383,\n \"natcomid\": \"\",\n \"title\": \"Мизури!, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19384,\n \"natcomid\": \"\",\n \"title\": \"Oesterreich, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19386,\n \"natcomid\": \"\",\n \"title\": \"Калгари Тауэр, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5430,\n \"natcomid\": \"39469994\",\n \"title\": \"Киев\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 2452,\n \"natcomid\": \"3568803982\",\n \"title\": \"1\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19388,\n \"natcomid\": \"\",\n \"title\": \"..., ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19389,\n \"natcomid\": \"\",\n \"title\": \"Кисса, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19390,\n \"natcomid\": \"\",\n \"title\": \"КОшак, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19391,\n \"natcomid\": \"\",\n \"title\": \"Жванык, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19392,\n \"natcomid\": \"\",\n \"title\": \"Жашка, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19393,\n \"natcomid\": \"\",\n \"title\": \"ячвчц у, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19394,\n \"natcomid\": \"\",\n \"title\": \"счвв, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19395,\n \"natcomid\": \"\",\n \"title\": \"Мняфге, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19396,\n \"natcomid\": \"\",\n \"title\": \"Няшка, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19397,\n \"natcomid\": \"\",\n \"title\": \"Ketu, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19398,\n \"natcomid\": \"\",\n \"title\": \"Домик, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19399,\n \"natcomid\": \"\",\n \"title\": \"Зорька, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19376,\n \"natcomid\": \"\",\n \"title\": \"Тестик, ЧЛ\",\n \"titleFull\": \"Тестик, Частное лицо\"\n },\n {\n \"id\": 19400,\n \"natcomid\": \"\",\n \"title\": \"Общажка, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19401,\n \"natcomid\": \"\",\n \"title\": \"Котик-бегемотик, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19402,\n \"natcomid\": \"\",\n \"title\": \"Бяка, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19373,\n \"natcomid\": \"\",\n \"title\": \"согласно заявке\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 571,\n \"natcomid\": \"899фывоиирфоыв\",\n \"title\": \"тестовая, АО\",\n \"titleFull\": \"тестовая, Частное акционерное общество\"\n },\n {\n \"id\": 19403,\n \"natcomid\": \"\",\n \"title\": \"Нячго, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19404,\n \"natcomid\": \"\",\n \"title\": \"Морько, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19405,\n \"natcomid\": \"876543215\",\n \"title\": \"Котик, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19406,\n \"natcomid\": \"\",\n \"title\": \"авфыа\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19407,\n \"natcomid\": \"\",\n \"title\": \"афвы\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19409,\n \"natcomid\": \"\",\n \"title\": \"ло\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19410,\n \"natcomid\": \"\",\n \"title\": \"Манька, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19411,\n \"natcomid\": \"\",\n \"title\": \"Ванька\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19424,\n \"natcomid\": \"\",\n \"title\": \"Компашкес, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19425,\n \"natcomid\": \"\",\n \"title\": \"Тустаньчик, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19443,\n \"natcomid\": \"\",\n \"title\": \"Ремонтик, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19447,\n \"natcomid\": \"\",\n \"title\": \"Кошка, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19458,\n \"natcomid\": \"\",\n \"title\": \"Котичек, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19459,\n \"natcomid\": \"\",\n \"title\": \"Мимими, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19462,\n \"natcomid\": \"\",\n \"title\": \"Волынянка, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19463,\n \"natcomid\": \"\",\n \"title\": \"Ня, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19464,\n \"natcomid\": \"\",\n \"title\": \"Креведго, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19467,\n \"natcomid\": \"\",\n \"title\": \"Няняня, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19468,\n \"natcomid\": \"\",\n \"title\": \"Саф, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5435,\n \"natcomid\": \"\",\n \"title\": \"Парам, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19470,\n \"natcomid\": \"\",\n \"title\": \"Изба, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19472,\n \"natcomid\": \"\",\n \"title\": \"Офис, ТОВ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19473,\n \"natcomid\": \"\",\n \"title\": \"алкомаркет, ТОВ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19486,\n \"natcomid\": \"\",\n \"title\": \"Равиолька, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19487,\n \"natcomid\": \"\",\n \"title\": \"Кротик, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19489,\n \"natcomid\": \"\",\n \"title\": \"Предприятие Кавычка, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19502,\n \"natcomid\": \"\",\n \"title\": \"Рассейка, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19504,\n \"natcomid\": \"\",\n \"title\": \"ВВЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19505,\n \"natcomid\": \"\",\n \"title\": \"Винницкая птицефабрика\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19506,\n \"natcomid\": \"\",\n \"title\": \"МПФРЛЦекспорт\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19507,\n \"natcomid\": \"\",\n \"title\": \"PFL\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19575,\n \"natcomid\": \"\",\n \"title\": \"Ровно тест\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19591,\n \"natcomid\": \"\",\n \"title\": \"Юнит\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19615,\n \"natcomid\": \"\",\n \"title\": \"Студия Лебедева\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19616,\n \"natcomid\": \"\",\n \"title\": \"тут\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 678720,\n \"natcomid\": \"\",\n \"title\": \"Ровноснаб\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 678787,\n \"natcomid\": \"\",\n \"title\": \"около, тест\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 2974,\n \"natcomid\": \"\",\n \"title\": \"МХП\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 678881,\n \"natcomid\": \"\",\n \"title\": \"СОХ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 678884,\n \"natcomid\": \"\",\n \"title\": \"Sukano AG\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19587,\n \"natcomid\": \"12345\",\n \"title\": \"ТОВ Надя\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 678958,\n \"natcomid\": \"\",\n \"title\": \"123456\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679136,\n \"natcomid\": \"\",\n \"title\": \"Жлоб\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679137,\n \"natcomid\": \"\",\n \"title\": \"Моряк, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 5432,\n \"natcomid\": \"\",\n \"title\": \"Совтес\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679161,\n \"natcomid\": \"\",\n \"title\": \"Раб\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679412,\n \"natcomid\": \"\",\n \"title\": \"Кафе\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19449,\n \"natcomid\": \"\",\n \"title\": \"Школа\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679413,\n \"natcomid\": \"\",\n \"title\": \"Кавярня\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679414,\n \"natcomid\": \"\",\n \"title\": \"Книгарня\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679415,\n \"natcomid\": \"\",\n \"title\": \"Спа-салон\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679872,\n \"natcomid\": \"\",\n \"title\": \"Моряк\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679746,\n \"natcomid\": \"\",\n \"title\": \"Бугай\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 680697,\n \"natcomid\": \"22334455\",\n \"title\": \"Контора, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 680698,\n \"natcomid\": \"\",\n \"title\": \"Совтек\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 405,\n \"natcomid\": \"37534432\",\n \"title\": \"Енотик, ЧЛ\",\n \"titleFull\": \"Енотичек\"\n },\n {\n \"id\": 402,\n \"natcomid\": \"3053508595\",\n \"title\": \"ОТО, ПАО\",\n \"titleFull\": \"ОТО, Публичное акционерное общество\"\n },\n {\n \"id\": 681410,\n \"natcomid\": \"3227002595\",\n \"title\": \"Бугай\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 681434,\n \"natcomid\": \"41444125\",\n \"title\": \"олдіідідід\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 681433,\n \"natcomid\": \"31826484\",\n \"title\": \"татата\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 682023,\n \"natcomid\": \"3294211325\",\n \"title\": \"ТОВ РУШ 32007740\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 17895,\n \"natcomid\": \"36071694\",\n \"title\": \"ТРАНС-АТЛАС\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 2073,\n \"natcomid\": \"35917412\",\n \"title\": \"Транс-Логiстик, ТОВ\",\n \"titleFull\": \"Транс-Логiстик, Товариство з Обмеженою Відповідальностю\"\n },\n {\n \"id\": 682382,\n \"natcomid\": \"397400637\",\n \"title\": \"Моряк\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 682763,\n \"natcomid\": \"434554324\",\n \"title\": \"Моряк\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1482,\n \"natcomid\": \"21496904\",\n \"title\": \"Агротеп, LTD\",\n \"titleFull\": \"Агротеп, Общество с ограниченной ответственностью\"\n },\n {\n \"id\": 682782,\n \"natcomid\": \"3753443244\",\n \"title\": \"Моряк\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 682803,\n \"natcomid\": \"12345546236\",\n \"title\": \"Тестер Кладовщик\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 682832,\n \"natcomid\": \"45реввпр566уу4\",\n \"title\": \"Моряк\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679768,\n \"natcomid\": \"\",\n \"title\": \"INSTAL PROJEKT Gawlowscy, Scierzynscy Spolka Jawna\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 682750,\n \"natcomid\": \"\",\n \"title\": \"Агросем\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 682957,\n \"natcomid\": \"37534432768678\",\n \"title\": \"Тест\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 682968,\n \"natcomid\": \"5е3е34е634е\",\n \"title\": \"Моряк\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 682969,\n \"natcomid\": \"3591741265564\",\n \"title\": \"Бугай\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 682970,\n \"natcomid\": \"34н45гц4гн4\",\n \"title\": \"Жлоб\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 682981,\n \"natcomid\": \"546789876543\",\n \"title\": \"Моряк\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 682982,\n \"natcomid\": \"п7ап47цп73\",\n \"title\": \"мотор\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 678728,\n \"natcomid\": \"\",\n \"title\": \"Агромат\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 683005,\n \"natcomid\": \"\",\n \"title\": \"\\\"Агромат\\\" м. Львів,Дуля І,Покупець,САЛОН АРХІТЕКТУРА БУДІВНИЦТВО ДИЗАЙН ТОВ,Пелешко Л.З. ФОП,Коваль О.,Кончікова Т.М. ФОП\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 683055,\n \"natcomid\": \"\",\n \"title\": \"дом Колотушкина\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 683056,\n \"natcomid\": \"\",\n \"title\": \"дом культуры\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 683261,\n \"natcomid\": \"\",\n \"title\": \"Vinicola CASTELLO DI LOZZOLO dei Fratelli Berteletti s.r.l.\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 683275,\n \"natcomid\": \"5щ4групу\",\n \"title\": \"Моряк\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 829448,\n \"natcomid\": \"iuygbno987tgnko9876tg\",\n \"title\": \"unit mega city \\\"quote\\\"\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 829450,\n \"natcomid\": \"1234567890йцукен\",\n \"title\": \"Бадрак\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 829451,\n \"natcomid\": \"3g753g44j32\",\n \"title\": \"Одна и та же\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 829452,\n \"natcomid\": \"36071694ат\",\n \"title\": \"Одна и та же\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 829453,\n \"natcomid\": \"36474рукр\",\n \"title\": \"Моряк\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 829454,\n \"natcomid\": \"34е3п3\",\n \"title\": \"Моряк\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 19461,\n \"natcomid\": \"\",\n \"title\": \"Мняг!, ЧЛ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 1299,\n \"natcomid\": \"30487219\",\n \"title\": \"АТБ-Маркет, ТОВ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 834776,\n \"natcomid\": null,\n \"title\": \"Noyon Uul Erdene” LLC\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 834777,\n \"natcomid\": \"39195657\",\n \"title\": \"ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ ЄВРО-АЗІАТСЬКА ЛОГІСТИЧНА КОМПАНІЯ\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 834787,\n \"natcomid\": null,\n \"title\": \"Noyon Uul Erdene LLC\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 835254,\n \"natcomid\": null,\n \"title\": \"INSTAL PROJEKT Gawlowscy, Scierzynscy Spolka Jawna\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679004,\n \"natcomid\": \"81926763\",\n \"title\": \"МонтажЛифтТекстильЛизинг, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679002,\n \"natcomid\": \"24026833\",\n \"title\": \"МеталРос, LTD\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679005,\n \"natcomid\": \"70121803\",\n \"title\": \"Восток, Корп\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679003,\n \"natcomid\": \"25272710\",\n \"title\": \"Мотор, ПАО\",\n \"titleFull\": \"\"\n },\n {\n \"id\": 679006,\n \"natcomid\": \"80759553\",\n \"title\": \"ОблПив, ТОВ\",\n \"titleFull\": \"\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "No parameters passed", "originalRequest": [], "status": "No parameters passed", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Parameters missing\",\n \"relogin\": false,\n \"status\": \"error\"\n}" }, { "name": "Invalid token", "originalRequest": [], "status": "Invalid token", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Token invalid\",\n \"relogin\": true,\n \"status\": \"error\"\n}" } ] }, { "name": "Create Stop", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/addCheckpoint", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "addCheckpoint" ], "query": [], "variable": [] }, "description": "Create Stop", "body": { "mode": "raw", "raw": "\"{\\n \\\"town-string\\\": \\\"Запоріжжя\\\",\\n \\\"town\\\": \\\"69061* Запоріжжя, Запорізька область\\\",\\n \\\"company\\\": \\\"Test company\\\",\\n \\\"address\\\": \\\"Бородинская, 221\\\",\\n\\n//optional\\n \\\"longit\\\": \\\"35.0691465\\\",\\n \\\"latit\\\": \\\"47.8892067\\\",\\n \\\"googleplaceid\\\": \\\"ChIJA7uF-j1n3EARSj9NB9lcZ34\\\",\\n \\\"country-code\\\": \\\"UA\\\",\\n \\\"customs\\\": \\\"1\\\",\\n \\\"natcomid\\\": \\\"123444\\\",\\n \\\"apicode\\\": \\\"11234\\\",\\n \\\"cellnum\\\": \\\"+380501234567\\\",\\n \\\"flag\\\": \\\"1\\\"\\n}\"", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Stop", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/updateCheckpoint", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "updateCheckpoint" ], "query": [], "variable": [] }, "description": "Update Stop", "body": { "mode": "raw", "raw": "{\n \"address\": \"ул. Промышленная, 32\",\n \"apicode\": \"584622\",\n \"id\": 36535,\n \"latit\": \"48.471820100000000\",\n \"longit\": \"34.017777500000000\",\n \"radius_km\": \"0.5\",\n \"technote\": \"1111\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Stop Contacts", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "The language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/getCheckpointContactData", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "getCheckpointContactData" ], "query": [ { "key": "checkpoint", "value": "{{checkpoint}}", "description": "Required int. id of the loading, unloading or customs checkpoint", "disabled": true } ], "variable": [] }, "description": "Returns the contact data of the single loading, unloading or customs checkpoint.\n\n- if successful you will receive contact data of the single loading, unloading or customs checkpoint\n- 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\n\n(!) NOTE: Only for Shippers" }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"cellnum\": \"\",\n \"checkpoint\": 44,\n \"contactperson\": \"John Smith\",\n \"email\": \"john.smith@example.com\",\n \"faxnum\": \"02070000002\",\n \"id\": 44,\n \"remark\": \"\",\n \"telnum\": \"02070000001\"\n },\n {\n \"cellnum\": \"447700000000\",\n \"checkpoint\": 44,\n \"contactperson\": \"Alice Johnson\",\n \"email\": \"alice.johnson@example.com\",\n \"faxnum\": \"447700000002\",\n \"id\": 641,\n \"remark\": \"\",\n \"telnum\": \"447700000001\"\n }\n ],\n \"status\": \"success\"\n}" }, { "name": "Request by carrier", "originalRequest": [], "status": "Request by carrier", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Action not available\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Create Stop Contact", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/addCheckpointcontactdata", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "addCheckpointcontactdata" ], "query": [], "variable": [] }, "description": "Create Stop Contact", "body": { "mode": "raw", "raw": "{\n \"cellnum\": \"+380501234567\",\n \"checkpoint\": 36535,\n \"contactperson\": \"Contact person name\",\n \"email\": \"test@example.com\",\n \"faxnum\": \"+380501234567\",\n \"remark\": \"Remark text\",\n \"telnum\": \"+380501234567\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Stop Contact", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/softDeleteCheckpointcontactdata", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "softDeleteCheckpointcontactdata" ], "query": [], "variable": [] }, "description": "Delete Stop Contact", "body": { "mode": "raw", "raw": "{\n \"id\": 197774\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Templates", "item": [ { "name": "Get Templates", "request": { "method": "GET", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/routeTemplates", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "routeTemplates" ], "query": [], "variable": [] }, "description": "Get Templates" }, "response": [] }, { "name": "Сreate Template", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/createRouteTemplates", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "createRouteTemplates" ], "query": [], "variable": [] }, "description": "Сreate Template", "body": { "mode": "raw", "raw": "{\n \"description\": \"новий темплейт опис\",\n \"periodic\": -27105753600,\n \"title\": \"Новий темплейт\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Template", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/updateRouteTemplates", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "updateRouteTemplates" ], "query": [ { "key": "id", "value": "", "description": "", "disabled": true } ], "variable": [] }, "description": "Update Template", "body": { "mode": "raw", "raw": "{\n \"description\": \"Route template updated\",\n \"id\": \"Z2vzqH\",\n \"periodic\": \"49-03-26\",\n \"title\": \"Route template updated\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Template", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/deleteRouteTemplates", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "deleteRouteTemplates" ], "query": [ { "key": "id", "value": "", "description": "", "disabled": true } ], "variable": [] }, "description": "Delete Template", "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Tenders", "item": [ { "name": "Create Tender", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/createTender", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "createTender" ], "query": [], "variable": [] }, "description": "With this endpoint you can add tenders into Phleetto from your systems one at a time or many at once.\n\nYou 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)\n\n`post` parameter explanation:\n\n- request must be in JSON\n \n- _routes_ is the root element, that can contain one or more _route_ objects\n \n\n### `route` object explanation:\n\n| param | required | type | explanation | valid example | invalid example |\n| --- | --- | --- | --- | --- | --- |\n| routeparts | yes | array of `routepart` objects | an array of points for the order/route, like loading, unloading, border, customs, etc | (see below) | empty |\n| tender | yes | bool | indicates tender flag | 1 | |\n| blind_tender | no | bool | indicates whether the tender is blind or not | 1 | blind |\n| tender_terms | no | string | comment about the tender | only for authorized carriers | |\n| total_count | yes | int | total amount of units that need to be delivered within the scope of the tender | 10, 5000 | |\n| 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 |\n| step | no | int | offer step restriction, forces carriers to diminish the price offer by the indicated step | 100, 50 | |\n| max_quote | no | float | the maximum acceptable price, above which offers will not be allowed, expected based on the `pricefor` param | 15000, 31.5 | |\n| 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 |\n| 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 |\n| forallpartners | no | bool | whether to publish the tender for all partners or not1 | 1 | |\n| route_apicode | yes | string (40) | an id of the order/route within your (external) system | DG-1982, 123221 | empty or duplicate |\n| draft | | bool | whether to publish the route as draft or not | 1, true | |\n| currency | | string (3) | currency, default to national currency, valid values: USD, EUR | EUR | GBP |\n| nds | | bool | | 1 for value added tax included, 0 for no VAT included | 1 |\n| paymenttype | | int (1) | according to internal mapping: 2 for bank transfer, 3 for cash, see [mapping](https://phleet.to/data-mapping) | 2 | 4 |\n| 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 |\n| 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 |\n| 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 |\n| 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 |\n| 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\"} | |\n| 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\\] |\n| 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.\" | |\n| 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\" |\n\n### `routepart` object explanation:\n\n| param | required | type | applicable workaction | explanation | valid example | invalid example |\n| --- | --- | --- | --- | --- | --- | --- |\n| 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 |\n| apicode | yes | string (10) | 1,2 | id of the point in your (external) system, for simplicity of geography integration | | |\n| category | | int (5) | 1 | internal ID of the category, for order/route grouping, must match the mapping | 192 | non-matching id |\n| cargo | yes | string (255) | 1 | the payload being shipped | гн. швеллер и рельс | |\n| weight | almost | decimal (13,3) | 1 | weight of cargo in tonns, either this or volume must be supplied for workaction 1 | 22.3 | |\n| volume | almost | decimal (13,3) | 1 | volume of cargo in cubic meters, either this or weight must be supplied for workaction 1 | 70 | |\n| length | | decimal (13,3) | 1 | length of cargo in meters | 8 | |\n| height | | decimal (13,3) | 1 | height of cargo in meters | 0.2 | |\n| width | | decimal(13,3) | 1 | width of cargo in meters | 5.5 | |\n| date1 | | string (YYYY-MM-DD) | all | expected date of arrival to this point | 2020-06-20 | 30-12-2020 |\n| time1 | | string (HH:MM:SS) | all | expected time of arrival to this point, in 24 hour format | 18:00:00 | 6 PM |\n| 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 | |\n| company_natcomid | almost | string (30) | 1,2 | the national code of the legal entity, either this or company_name is required | 40003782 | |\n| contact_name | yes | string (255) | 1,2 | name of the person responsible for the work on the point | John Doe | |\n| contact_cellnum | almost | string (40) | 1,2 | phone number of the responsible person, either this or email is required | 38 050 111 22 33 | |\n| 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 |\n| 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 |\n| geo_region | | string (255) | 1,2 | sublocality (administrative_area_level_1), region, state, oblast, or other administrative division | Киевская область | |\n| geo_district | | string (255) | 1,2 | county, district (administrative_area_level_2) or other smaller administrative division | Богуславский район | |\n| geo_city | yes | string (255) | 1,2 | town, village, locality, city or other administrative division | Богуслав | |\n| geo_address | yes | string (200) | 1,2 | street address | ул. Орджоникидзе 14 | наша машина, паспорт номер такойто, область, город |\n| geo_town_id | | int (7) | 4 | internal town ID or border crossing | | |\n| geo_apicode | | string (10) | 3 | your (external) point ID of the customs point | | |\n| 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 |\n| border_operator_select | | int(1) | 4 | set to 1 if the carrier is expected to indicte the point of border crossing | | |\n\nEach route must start with a workaction=1 routepart and end with workaction=2 routepart.\n\nFor 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\n\n```\n\"ferryproperty\":\n[\n {\n \"TrailerAttributesPhleettoId\":\"10\",\n \"Value\":20\n },\n {\n \"TrailerAttributesPhleettoId\":\"11\",\n \"Value\":5\n },\n]\n\n ```", "body": { "mode": "formdata", "formdata": [ { "key": "post", "value": "{\n \"routes\":{\n \"route\":{\n \"client_hash\":\"lalala\",\n \"tender\":1,\n \"tender_terms\":\"tututu\",\n \"total_count\":2,\n \"forallpartners\":1,\n \"step\":100,\n \"max_quote\":10000,\n \"pricefor\":\"tonn\",\n \"tender_deadline\":\"2022-04-17 13:50:00\",\n \"publish_datetime\":\"2022-17-04 13:52:00\",\n \"pricefor\":\"tonn\",\n \"cartype\":[\n 1,\n 2,\n 4\n ],\n \"userclient_email\":\"\",\n \"routeparts\":[\n {\n \"apicode\":\"internalcode123\",\n \"contact_name\":\"Marina Niedzialkowska - экспорт менеджер\",\n \"geo_country_iso_num\":616,\n \"geo_region\":\"\",\n \"company_natcomid\":\"\",\n \"weight\":1.47,\n \"date1\":\"2022-03-18»,\n \"contact_email\":\"noemail@email.com\",\n \"time1\":\"00:00:00\",\n \"contact_cellnum\":\"050 1 1 1 1 1 1 \",\n \"company_title\":\"INSTAL PROJEKT Gawlowscy, Scierzynscy Spolka Jawna\",\n \"geo_district\":\"\",\n \"geo_address\":\"ul. some street, 12a\",\n \"workaction\":\"1\",\n \"geo_city\":\"kruszyn\",\n \"category\":0,\n \"cargo\":\"плитка\\/сантехніка\"\n },\n {\n \"contact_name\":\"nocontact\",\n \"geo_country_iso_num\":804,\n \"geo_region\":\"київська\",\n \"company_natcomid\":\"\",\n \"weight\":1.47,\n \"date1\":\"2022-03-19\",\n \"contact_email\":\"noemail@email.com\",\n \"time1\":\"00:00:00\",\n \"contact_cellnum\":\"(044) 123123123 #$%^&*()_\",\n \"company_title\":\"Агросем\",\n \"geo_district\":\"\",\n \"geo_address\":\"вул. hrest, 17-А\",\n \"workaction\":\"2\",\n \"geo_city\":\"Київ\",\n \"cargo\":\"плитка\\/сантехніка\"\n }\n ],\n \"currency\":\"UAH\",\n \"payorcode\":\"\",\n \"chargetype\":[\n 3,\n 2,\n 4\n ],\n \"route_apicode\":\"unique-external-id-123\",\n \"paymenttype\":2,\n \"budget\":20500.0\n }\n }\n}18»", "description": "The main body of the request, the payload that contains the route/order details.", "type": "text" }, { "key": "signature", "value": "{{MAC}}", "description": "A MAC must be supplied, which is a SHA256 hash product of the `post` parameter and the MAC key.", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"periodic\": \"651-04-22\",\n \"url\": \"/a/index.php?p=view&id=651-04-22&m=shipping\",\n \"userroutenumber\": \"unique-external-id-123\"\n }\n ],\n \"status\": \"created\"\n}" }, { "name": "Invalid MAC supplied / Loading date is earlier than tender deadline / Publish date in the past / Invalid JSON (note routepart date quote)", "originalRequest": [], "status": "Invalid MAC supplied / Loading date is earlier than tender deadline / Publish date in the past / Invalid JSON (note routepart date quote)", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Json_decode error: Control character error, possibly incorrectly encoded\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Submit Counteroffer", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/oppositeOffer", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "oppositeOffer" ], "query": [], "variable": [] }, "description": "Allows shipper to bargain in tender.\n\nWhen 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.\n\nFor 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.\n\n* If successful, you will receive the success message, the counter offer will be submitted to the carrier that made the supplied bid\n* 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", "body": { "mode": "formdata", "formdata": [ { "key": "loadquote", "value": "{{counterLoadQuote}}", "description": "The new quantity of the counter offer. Int.", "type": "text" }, { "key": "pricequote", "value": "{{counterPriceQuote}}", "description": "The new price of the counter offer. Float.", "type": "text" }, { "key": "route", "value": "{{singleRoute}}", "description": "Periodic of the target tender", "type": "text" }, { "key": "routeresponse", "value": "{{routeResponseId}}", "description": "ID of the carrier bid (can be taken from `GET singleRoute` endpoint, `response` set)", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Incorrect bid ID supplied / Incorrect route periodic supplied / Request by carrier", "originalRequest": [], "status": "Incorrect bid ID supplied / Incorrect route periodic supplied / Request by carrier", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Incorrect bid number.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Select Tender Winner", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/pickTenderWinner", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "pickTenderWinner" ], "query": [], "variable": [] }, "description": "Enables shipper to pick winner in a tender.\n\n- If successful, you will receive the success message, tender winner will be selected\n \n- 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", "body": { "mode": "formdata", "formdata": [ { "key": "quote", "value": "{{tendeQuoteResponseId}}", "description": "ID of the quote response id. Int. Required.", "type": "text" }, { "key": "tenderPeriodic", "value": "{{tenderPeriodic}}", "description": "Periodic of the tender. String. Required.", "type": "text" }, { "key": "winner", "value": "{{tenderWinnerCompanyHash}}", "description": "Company hash of the carrier company. String. Required.", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Not all params supplied", "originalRequest": [], "status": "Not all params supplied", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Missing required parameters.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Relaunch Tender", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/relaunchTender", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "relaunchTender" ], "query": [], "variable": [] }, "description": "Enables shipper to cancel winner pick in a tender and start the bidding over.\n\n- If successful, you will receive the success message, tender winner will be selected\n \n- 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", "body": { "mode": "formdata", "formdata": [ { "key": "tenderPeriodic", "value": "", "description": "Periodic of the tender. String. Required.", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [],\n \"status\": \"success\"\n}" }, { "name": "Not all params supplied", "originalRequest": [], "status": "Not all params supplied", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Missing required parameters.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Publish Route from Tender", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/publishTenderChild", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "publishTenderChild" ], "query": [], "variable": [] }, "description": "Allows shipper to publish a route or a set of similar routes based on a tender.\n\nExample: 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.\n\n* If successful, you will receive the success message with periodic numbers of the created routes that are published for the tender winner\n* 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", "body": { "mode": "formdata", "formdata": [ { "key": "quantity", "value": "{{routeQuantity}}", "description": "Quantity of routes to be published. Int", "type": "text" }, { "key": "tenderPeriodic", "value": "{{badTenderPeriodic}}", "description": "Tender periodic, for which to publish routes", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n \"174-04-22\",\n \"175-04-22\"\n ],\n \"status\": \"created\"\n}" }, { "name": "Incorrect tender supplied", "originalRequest": [], "status": "Incorrect tender supplied", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Action forbidden\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] }, { "name": "Create Second-Stage Tender", "request": { "method": "POST", "header": [ { "key": "language", "value": "{{language}}", "description": "the language in which you would like to receive feedback, if the authentication attempts are unsuccessful", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{token}}", "description": "JWT access token received from the authentication endpoint.", "type": "text", "disabled": false } ], "url": { "raw": "{{baseUrl}}/a/v2/rest/public/createStep2Tender", "host": [ "{{baseUrl}}" ], "path": [ "a", "v2", "rest", "public", "createStep2Tender" ], "query": [], "variable": [] }, "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.", "body": { "mode": "urlencoded", "urlencoded": [ { "key": "deadline", "value": "{{tenderDeadline}}", "description": "", "type": "text" }, { "key": "step1tender", "value": "{{step1tenderPeriodic}}", "description": "", "type": "text" }, { "key": "userclient_email", "value": "{{responsibleUserEmail}}", "description": "", "type": "text" } ] } }, "response": [ { "name": "Success", "originalRequest": [], "status": "Success", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": [\n \"111-04-23\"\n ],\n \"status\": \"success\"\n}" }, { "name": "Invalid deadline supplied / Invalid step1 tender supplied / Create Second Step of tenders", "originalRequest": [], "status": "Invalid deadline supplied / Invalid step1 tender supplied / Create Second Step of tenders", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"We couldn’t find a user with that email address.\",\n \"relogin\": false,\n \"status\": \"error\"\n}" } ] } ] } ] } ] } ], "variable": [ { "key": "baseUrl", "value": "https://test.phleetto.co.uk", "type": "string", "description": "Test server" }, { "key": "language", "value": "en", "type": "string" }, { "key": "token", "value": "", "type": "string" }, { "key": "staticToken", "value": "", "type": "string" }, { "key": "MAC", "value": "", "type": "string" } ] }