Understanding the Cigo Tracker API: An Essential Guide

A Job is a general term used in Cigo Tracker to describe a destination, such as a Customer, where your Operator(s) may do a delivery, a service call, an installation, or various Job Actions (see explanation on 'Job Action' below).

When a job is created via the API, its initial status value is staging. If you log in to Cigo, you can find this Job by opening the sidebar menu and navigating the Import Tool page. Once you've landed on the Import Tool page, you'll find your created API records under the 'Review records from API Integration' tab.

Dispatcher will typically use the Import Tool to validate and review upcoming Jobs prior to dispatching them to vehicles. At a glance, they can validate if the address of each Job will be properly geo-coded and if the address string is valid.

However, if this step is not needed for your integration, you can skip the Import Tool when the Job is created via the API by setting skip_staging to true (for details, refer to the POST Create a new Job).

Managing job processes effectively is vital to ensure smooth operations within any logistics or delivery company. Cigo Tracker offers a comprehensive system to monitor and manage the status of jobs, catering to the nuanced needs of such businesses. The job statuses in Cigo Tracker reflect the lifecycle of a job from creation to completion, portraying transparency and control at each step.

A Job can be assigned any number of Actions. These Actions serve as a to-do list for the Operator arriving on site (i.e. a customer’s location). Actions have types (i.e. delivery, installation, service, etc.) and other attributes, such as handle time (the amount of time the action is estimated to take).

Job Action statuses range from:

When you create a new Job, an existing Customer profile is either linked or created. Customer profiles are created or updated based on a Job's first name, last name, phone number, and address fields.

When you first create a Job, you can assign a Customer Reference ID. When you create new Jobs assigned to the same Customer Reference ID, it'll keep all of them associated with the same Customer.

No, you cannot. Within the web interface, there are a few things you can update on an existing Customer profile, but this is not currently available via the API.

In order to prevent duplicate orders from being entered into Cigo Tracker, we prevent orders with the same core information from being re-entered. For example, if you have an order with the same first name, last name, address, and delivery date, we detect it as a duplicate job and prevent its creation.

This default behaviour may not be suitable for your business if you can receive multiple orders per day from the same customer. In that case, setting a unique reference_id during the Job creation process will allow you to work around this restriction. If you have a unique Order ID from an external system (e.g. Shopify), you can use that in your reference_id field, and Cigo Tracker will ignore the duplicate check.

If you did not specify skip_staging: true in your POST call to create a Job, it'll be created in the staging status.

You'll only be able to find this Job by logging into the Cigo Tracker web portal, opening the sidebar menu and navigating the Import Tool page. Once you've landed on the Import Tool page, you'll find your created Job records under the 'Review records from API Integration' tab.

Pickups and Drop-offs are automatically generated by Cigo Tracker. Every Pickup and Drop-off is directly correlated to a Job Action via its stop_location_id.

For instance, if a Job has an Action of type 'pickup' with a valid stop_location_id, once an Itinerary is created by your Dispatcher, a Pickup will automatically be created to indicate that it must be done prior to the related Job.

An Itinerary is a detailed list of ordered Route Stops, including its initial start and final return location, estimated time of departure, as well as the assigned Operator(s) and Vehicle.

A Stop, or Route Stop, is simply a geographical location on an Itinerary and it can either a Job, a Pickup, or a Drop-off.

An Operator is an individual assigned to an Itinerary. For instance, if your company handles the delivery of goods, you may already internally refer to your Operators as Drivers, as opposed to Technicians in other industries. Operators interact with Cigo Tracker via our mobile application.

A Dispatcher is a web platform user who is able to create Itineraries, Jobs, and Actions and has direct access to the Staging Area (inside of Cigo Tracker, the Staging Area is referred to as the "Import Tool").

For clarification, the majority of API time and date-time values are presented in GMT (UTC+00:00), unless mentioned otherwise.

Check out this diagram illustrating key concepts, offering a visual representation of how the resources and relationships between the explained concepts are interconnected.