Skip to content

Jobs and Steps

Steps within a job define the workflow of the job.

We require at least one step, and suggest two or three so that you can measure the duration of a job.

Completing the first step starts the job, and completing all steps completes the job. Steps must be completed in order, so that no steps are skipped.

Steps may optionally include an address. If you sending an address with a job, ensure that you send a display name as well as the lat and long of the location, the format is as follows:

<step>
    <name>Pickup goods</name>
    <location>
        <formatted_address>1 Main St, Anytown, USA</formatted_address>
        <lat type="decimal">-36.879621</lat>
        <lng type="decimal">174.751282</lng>
    </location>
</step>

The job can also be started and progressed through its steps by setting a completed_at datetime for each of its steps.

To update an existing step with a step completion time, you can either include the step ID or the step name and the completion time in a PUT, like so:

<job>
    <steps type="array">
        <step>
            <id>65130723</id>
            <completed_at>2020-01-25T14:02:00%2013:00</completed_at>
        </step>
    </steps>
</job>