The quick rundown
You can create Teams within your OpenTrack account to mimic the structure of your organization, or to create an isolated test environment.
Teams only see containers that are assigned to them. They also have other limited permissions described below.
Containers can be assigned to teams when they're tracked, or any time after.
To get started, reach out to us and we'll walk you through the setup process.
Why create teams?
Your organization may contain multiple independent sub-units, whether different branch offices or teams that focus on different pieces of your business.
β If it is important that these different units cannot see each others' containers, then Teams in OpenTrack is for you.
π« If the units need to see each others' containers, then Teams in OpenTrack is not the right solution.
β If you want an isolated test environment where you control which containers go in without double-paying for tracking the same containers, then Teams is the way to go.
How to create a Team
Just ask us and we'll create the Team for you. We'll walk you through the process end-to-end to make sure your organization is set up correctly.
When you create a Team in OpenTrack:
You can invite users to it (optional). Users in the team can only see containers assigned to that team. More on team member permissions below.
You can assign containers to it. Containers can be assigned to the team in multiple ways. More on container assignment below.
Team member permissions: What can Team users do?
You can invite Team users with one of two roles:
Team Manager
Team Read-Only Agent
Here's a breakdown of what each role can see and do:
User role | Permissions |
Team Manager | β
Can track containers |
Team Read-Only Agent | π« Cannot track containers β
Can create and save Explore reports |
How to assign containers to a Team
Teams can only see the containers assigned to them. However, once a container is assigned to the team, it is visible by your main account as well as by the team.
So how do you assign containers to a Team?
Containers can be assigned to a Team in all of the following ways:
Team Managers can track containers themselves manually or via bulk CSV upload.
A global user can assign containers to a team using the branchOffice code via bulk CSV upload.
Each Team has its own API key. Containers tracked using this API key are assigned to the Team.
Each Team has its own API tracking code. If you track a container using the parent Account's API key and pass in the Team tracking code, then the container will be assigned to the team.
OpenTrack Customer Success can assign containers on request. If you're not sure how to assign containers to a Team, just ask us and we can help.
Assigning containers to teams via bulk CSV upload
Make sure that your OpenTrack rep has confirmed that your teams are each set up with a unique branchOffice code.
Then to assign a container to a team, you just have to put the team's code under the branchOffice column in your bulk CSV upload. Like this:
Master Bill | Container | SCAC | ... | branchOffice |
MBLU123456 | CNTR123456 | MEDU | ... | unique_code_123 |
Don't forget that you can download the bulk CSV upload template any time from the Start Tracking page.
Assigning containers to teams via API
There are two main ways to assign containers to teams via API:
Make a POST request using the team's API key
Use your main API key, but include the team's tracking code
1) Make a POST request using the team's API key
This looks exactly the same as any other POST request you'd make to our API. See our API reference for more.
To find the team's API key, go to Settings > Developers and look for the team in the API Keys section.
2) Use your main API key, but include the team's tracking code
The team's unique tracking code goes into the "assigneeId"
property within the "referenceNumbers"
object in the body of your request.
For example, if you're using our /containers
endpoint, your request body would look like this:
{
"masterBillNumber": "MBOL12345678",
"scacCode": "MAEU",
"referenceNumbers": {
"assigneeId": "teamCode"
},
}
When OpenTrack receives this request, it will assign this container and all other containers on the MBL to the team.
Where do you get the unique team code? This is editable by OpenTrack Customer Success, so either let us know what you want it to be or ask us to provide one.
As always, don't hesitate to contact us with any questions.