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.

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.

Use cases of sharing

  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.

  2. 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 and via the API.

Identifiers

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 the contractor_company_id and external number.

    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.

Enabling access

Possible ways:

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

  1. In the route file, open the Orders sheet and add the column shared_with_company_ids.

  2. In the shared_with_company_ids column, specify the company_id * for orders that observers should have access to.

  3. In Routing Workspace, upload the file 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.

Warning

Before using this method, map the contractor_company_id and the number alias.

  1. In the route file, open the Orders sheet and add the column shared_with_company_numbers.

  2. In the shared_with_company_numbers column, specify the alias of the observer company for the orders that it should have access to.

  3. In Routing Workspace, upload the file to Track & Trace.

    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.

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

Specify the company_id * in the shared_with_company_ids field.

The field is used in the request body when performing the following operations:

  1. Link the contractor_company_id and its number alias. Learn more.

  2. Specify the number alias in the shared_with_company_numbers field.

    The field is used in the request body when performing the following operations:

In this case, you can combine the methods. Some observers can be specified using company_id, and others, using the synonym.

Routing Workspace interface

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 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 to Track & Trace.
  2. Select a route that you want to share.
  3. Click the icon .
  4. In the drop-down list, select the companies and click Apply.

Observers will get access to all orders of the selected route.

Viewing observers

In Routing Workspace, you can view order observer details:

Gaining 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 in Routing Workspace.

Instructions

Go to Settings → Managers and enable the option next to the appropriate company or select Access to all companies.

Viewing order and route information

API

Note

In the company_id field, specify the ID of the company that granted access.

The observer company can get route and order information via the API:

This information is also available in Routing Workspace.

Routing Workspace interface

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.

View routes and orders

The information on available routes and orders matches the company that granted access, but can't be changed.

Contact support

Observer company ID in RouteQ

Previous
Client widget
Next
Courier push notifications