Jump to Content
⇠ Back to Dev Hub
Support Center ›
API Status ›
Engineering Blog ›
Home
API Reference
Changelog
v2.7
⇠ Back to Dev Hub
Support Center ›
API Status ›
Engineering Blog ›
API Reference
v2.7
API Reference
Recipient Overrides
All
Pages
Start typing to search…
JUMP TO
QUICKSTART
Quickstart Guide
GUIDES
Introduction
Authentication
Testing your API key
Throttling
Data Types and Response Formats
Errors
An invalid request
Entities
Metadata
Supported Entities
Limitations
The metadata object
Working with metadata
Querying metadata
Status
Deep Linking
Testing
API Wrappers
Scoped API Key
No-code Integration Platforms
Proof of Delivery Retrieval
API REFERENCE
Organizations
Get details
Get delegatee details
Administrators
Create administrator
List administrators
Update administrator
Delete administrator
Workers
Create worker
List workers
List Worker's Assigned Tasks
Get workers by location
Get single worker
Update worker
Delete worker
Get worker's schedule
Set worker's schedule
Worker's Route Delivery Manifest
Hubs
Create Hub
Update Hub
List hubs
Teams
Create team
Update team
List teams
Get single team
Delete team
Team Auto-Dispatch
Driver Time Estimate
List Unassigned Tasks in a Team
Destinations
Create destination
Get single destination
Destination Address Warnings
Recipients
Create recipient
Update recipient
Find recipient
Get single recipient
Tasks
Create task
Create tasks in batch
Create tasks in batch - async
Batch Job Status
Task Custom Fields - Create and Update
Task Custom Fields - Search
Type
State
Automatic Assignment
Manual Assignment
Completion Requirements
Dependencies
Recipient Overrides
List tasks
Get single task
Get single task by shortId
Update task
Complete task
Clone task
Delete task
Automatically assign list of tasks
Containers
Get container
Insert tasks at index (or append)
Update tasks
Webhooks
Quick Start
Webhook Validation
Webhook Authentication
Retry
Testing
Create webhook
Update webhook
List webhooks
Delete webhook
Webhook Payload Examples
Asynchronous Batch Job Webhook
Barcode Scanning
Creating a new task with requested barcodes
Barcode Requirement Scenarios
Updating an existing task with barcodes
Capturing
Orders
Create Order
Get Orders
Update Order
Cancel Order
Clone Orders
Reject Order
Quote Order
Route Plans
Create Route Plan
Update Route Plan
Add Tasks to Route Plan
GET Route plan
GET RoutePlan by ID
Delete RoutePlan
Route Optimization
Initialize Standard Route Optimization
Initialize Auto-Dispatch Route Optimization
Initialize Vehicle Based Route Optimization
Start Route Optimization
Get Optimization Status
Abort Optimization
Apply Optimization Results
Powered by
Recipient Overrides
Ask AI
