Publish, Route, Assign, and complete work orders.
Once a work order is created, you must move it through its lifecycle using specific API actions.
Every work order response includes a status object. Expand a status below to see its corresponding id.
The display for Assigned sub-status varies with the provider's progress (Confirmed, On My Way, Checked In, Assigned: At Risk, etc.), but its id is always 3.
| Display | What it means |
|---|---|
| Assigned | Work Order has been assigned to a provider, who hasn't confirmed yet. |
| Start Time Set | The assigned provider has confirmed the Work Order. |
| Confirmed | Work Order schedule has been confirmed by the Provider. |
| On My Way | Provider is en route to the work location. |
| Checked In | Provider has checked in to the Work Order. |
| Checked Out | Provider has checked out from the Work Order. |
| On Hold | Work Order has been placed on hold. |
| Assigned: At Risk | Provider failed to set the start time for the Work Order. |
| Assigned: Delayed | Work Order is delayed beyond scheduled time. |
| Assigned: Cancelled | The Work Order has been cancelled. |
A work order starts in Draft state. It is invisible to anyone but you. Publishing changes the state to Published, making it visible to any provider in the Field Nation marketplace. To send it to specific providers instead, see Route vs. Assign below — that moves it to Routed.
POST /workorders/{id}/publish
You can also unpublish a work order to return it to Draft state using DELETE /workorders/{id}/publish.
You have two primary ways to fill a work order:
Use Route when you need to find talent or get competitive offers. Use Assign when you have a dedicated W-2 employee or a preferred contractor you've already spoken with.
Routing sends the work order to specific providers or groups, inviting them to request the work.
POST /workorders/{id}/route
{
"technician": { "id": 12345 }
}To route to many providers at once (e.g., a Talent Pool), use the mass-route endpoint.
POST /workorders/{id}/mass-route
{
"talent_pool_id": 9921
}Automatically routes the work order based on pre-defined rules.
POST /workorders/auto_dispatch
When routing, you can apply Selection Rules to filter providers.
{
"selection_rule": {
"rules": [
{ "name": "rating", "operator": ">=", "value": 4.5 }
]
}
}See Assignments for detailed assignment management.
POST /workorders/{id}/assignee
If satisfied with the work, approve to release payment.
POST /workorders/{id}/approve
If unsatisfied, mark it incomplete to send it back.
DELETE /workorders/{id}/complete
Required Params:
reason: Text descriptionreason_id: The ID of the incomplete reason| Action | Endpoint | Method |
|---|---|---|
| Publish | /workorders/{id}/publish | POST |
| Unpublish | /workorders/{id}/publish | DELETE |
| Route to provider | /workorders/{id}/route | POST |
| Mass route | /workorders/{id}/mass-route | POST |
| Auto dispatch | /workorders/auto_dispatch | POST |
| Assign | /workorders/{id}/assignee | POST |
| Approve | /workorders/{id}/approve | POST |
| Mark incomplete | /workorders/{id}/complete | DELETE |
Last updated on