--- metadata: - name: generator content: Diplodoc Platform v5.19.6 alternate: - https://docs.routeq.com/doc/en/delivery/functions/shared.md title: RouteQ — functions — order sharing between companies --- > **Documentation Index:** Fetch the complete configuration index at https://docs.routeq.com/doc/en/llms.txt # Order sharing between companies The sharing function lets you grant observer companies permission to view orders. For example, if you delegate orders to different transport companies, you can upload data for them to Track & Trace. They'll only be able to see the orders that you give them access to in their workspace. To access orders, observers must have an account in [RouteQ](https://routeq.com/). An observer company doesn't have access to the dashboard of the head of the company that granted it access, but it does have access to their own company head's dashboard where all available orders will be displayed. If the recipient needs to track a specific order, use the [Client widget](https://docs.routeq.com/doc/en/delivery/functions/client-widget.md). ## Use cases of sharing {#example} 1. A large transportation company grants access to other companies for them to deliver orders. A contractor company can view routes with orders that they've been granted access to. 1. A transportation company that delivers orders grants access to a client company so that they can track delivery information. You can't change orders and add a courier. Couries must be added to the company that granted access. After gaining access, an observer company can view order and route information in [Routing Workspace](#check-ui) and via the [API](#check-api). ## Identifiers {#ids} To enable access, one of the following IDs is required: - `company_id`: The observer company's ID in RouteQ. - Alias: The observer company's external number that can be additionally created for easier identification: - If you can't store the contractor's `company_id` in the internal database. - Not to add the contractor's `company_id`. To do this, [map](https://yandex.ru/routing/doc/en/delivery/redoc/index.html#operation/addsOrEditsContractorNumber) the `contractor_company_id` and external `number`. {% cut "Limitations" %} - Aliases can be any sequence of letters and numbers. - Aliases can't contain commas because commas are used as delimiters. - Aliases are case-sensitive. {% endcut %} ## Enabling access {#open-access} Possible ways: - When planning in [Excel](#excel). - When planning via the [API](#api). - Via [Routing Workspace](#ui). When observers are added via Excel or the API, access is granted to individual orders. If this is done through Routing Workspace, access is granted to all orders in the selected route. ### Excel {#excel} {% list tabs %} - Using `company_id` 1. In the route file, open the **Orders** sheet and add the column `shared_with_company_ids`. 1. In the `shared_with_company_ids` column, specify the `company_id` [*](*id_компании) for orders that observers should have access to. 1. In Routing Workspace, [upload the file](https://docs.routeq.com/doc/en/delivery/load-data.md) to Track & Trace. In the route import window, the observers' IDs are shown on the **Orders** tab in the **Tracking companies (id)** field. If necessary, you can change the data directly in the interface. - Using an alias {% note warning %} Before using this method, [map](https://yandex.ru/routing/doc/en/delivery/redoc/index.html#operation/addsOrEditsContractorNumber) the `contractor_company_id` and the `number` alias. {% endnote %} 1. In the route file, open the **Orders** sheet and add the column `shared_with_company_numbers`. 1. In the `shared_with_company_numbers` column, specify the alias of the observer company for the orders that it should have access to. 1. {% include [excel-load-file](../_includes/load-file-75184670a564.md) %} In the route import window, the observer IDs are shown on the **Orders** tab in the **Tracking companies (numbers)** field. If necessary, you can change the data directly in the interface. {% endlist %} These two methods are not mutually exclusive and can be combined: you can add some observers using the `company_id`, and others using the alias. | id | shared_with_company_ids | shared_with_company_numbers | |---------|-------------------------|-----------------------------| | Order 1 | 1, 2, 3, 4 | | | Order 2 | 5, 6, 7, 8 | Winter Rose, East77 | | Order 3 | | Indigo, 555 | ### API {#api} {% list tabs %} - Using `company_id` Specify the `company_id` [*](*id_компании) in the `shared_with_company_ids` field. The field is used in the request body when performing the following operations: - [Adding an order](https://yandex.ru/routing/doc/en/delivery/redoc/index.html#operation/addsAnOrder). - [Editing an order](https://yandex.ru/routing/doc/en/delivery/redoc/index.html#operation/editsOrder). - [Editing multiple orders](https://yandex.ru/routing/doc/en/delivery/redoc/index.html#operation/editsMultipleOrders). - Using an alias 1. Link the `contractor_company_id` and its `number` alias. [Learn more](https://yandex.ru/routing/doc/en/delivery/redoc/index.html#operation/addsOrEditsContractorNumber). 1. Specify the `number` alias in the `shared_with_company_numbers` field. {% include [api-shared-orders-methods](../_includes/shared-orders-methods-6b414c35c2a7.md) %} {% include [excel-several](../_includes/several-ee422c2dd796.md) %} {% endlist %} ### Routing Workspace interface {#ui} Contact support if you need to: - Create an account for a company that you want to make an observer. - Enable adding observers to routes. - [Link](https://yandex.ru/routing/doc/en/delivery/redoc/index.html#operation/addsOrEditsContractorNumber) the `contractor_company_id` and the `number` alias. You can map the company ID and the alias manually if the observer already has an account in the service and you know their ID. To add observers to a route: 1. [Upload routes](https://docs.routeq.com/doc/en/delivery/load-data.md) to Track & Trace. 1. Select a route that you want to share. 1. Click the icon 0. 1. In the drop-down list, select the companies and click **Apply**. Observers will get access to all orders of the selected route. ![](../_images/observers.png) ## Viewing observers {#check} In Routing Workspace, you can view order observer details: - In the [courier performance report](https://docs.routeq.com/doc/en/delivery/interface/quality-report.md): in the fields **Observer 1**, **Observer 2**, and so on. - In the [order card](https://docs.routeq.com/doc/en/delivery/interface/orders.md) in the **Observers** field. - On the route page, in the **Observers** column. ## Gaining access {#access} By default, orders that another company grants access to are only visible to the observer company's administrators. To make these orders available to managers, a user with the administrator role must grant them [access permissions](https://docs.routeq.com/doc/en/delivery/interface/managers.md) in Routing Workspace. {% cut "Instructions" %} Go to **Settings** → **Managers** and enable the option next to the appropriate company or select **Access to all companies**. ![](../_images/shared-access.png) {% endcut %} ## Viewing order and route information {#check-access} ### API {#check-api} {% note info %} In the `company_id` field, specify the ID of the company that granted access. {% endnote %} The observer company can get route and order information via the API: - [Get multiple routes](https://yandex.ru/routing/doc/en/delivery/redoc/index.html#operation/getsMultipleRoutes). The response will display the IDs of available routes. - [Get multiple orders](https://yandex.ru/routing/doc/en/delivery/redoc/index.html#operation/getsMultipleOrders). Specify the route ID in `route_id`. The response will display information on orders in this route. - [Get delivery quality information](https://yandex.ru/routing/doc/en/delivery/redoc/index.html#operation/getsDeliveryQualityInformation). The response will display a delivery quality report. - [Get photos](https://yandex.ru/routing/doc/en/delivery/redoc/index.html#operation/getsPhotos). The response will display a list of photos that the courier attached. - [Get route information](https://yandex.ru/routing/doc/en/delivery/redoc/index.html#operation/getsRouteInfo). The response will display information about the routes and their orders, including the estimated time of arrival. This information is also available in Routing Workspace. ### Routing Workspace interface {#check-ui} To see the routes and orders that you have access to, in Routing Workspace, select one of the companies from the drop-down list in the upper-left corner. {% cut "View routes and orders" %} ![](../_images/logistics-workplace-interface.png =790x){style="border: solid 1px #cccccc; max-width: 800px;"} {% endcut %} The information on available routes and orders matches the company that granted access, but can't be changed. {% include [warehouse-feedback](../_includes/feedback-7b71896f9bc3.md) %} [*id_компании]: Observer company ID in RouteQ