Onfleet API

  • Onfleet
  • Support
  • API Status
  • Engineering Blog

    The Onfleet Developer Hub

    Welcome to the Onfleet developer hub. You'll find comprehensive guides and documentation to help you start working with Onfleet API as quickly as possible, as well as support if you get stuck. Let's jump right in!

    v2.7
    • v2.7stable
    HomeGuidesRecipesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs
      HomeAPI Reference
    discard
    Only admins can see thisEnable it for everyone

    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

    API REFERENCE

    • Organizations
      • Get details
      • Get delegatee details
    • Administrators
      • Create administrator
      • List administrators
      • Update administrator
      • Delete administrator
    • Workers
      • Create worker
      • List workers
      • Get workers by location
      • Get single worker
      • Update worker
      • Delete worker
      • Get worker's schedule
      • Set worker's schedule
    • Hubs
      • List hubs
    • Teams
      • Create team
      • Update team
      • List teams
      • Get single team
      • Delete team
      • Team Auto-Dispatch
    • Destinations
      • Create destination
      • Get single destination
    • Recipients
      • Create recipient
      • Update recipient
      • Find recipient
      • Get single recipient
    • Tasks
      • Create task
      • Create tasks in batch
      • 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
      • Additional options
    • Webhooks
      • Quick Start
      • Webhook Validation
      • Webhook Authentication
      • Retry
      • Testing
      • Create webhook
      • List webhooks
      • Delete webhook
      • Webhook Payload Examples
    • Barcode Scanning
      • Requesting
      • Barcode Requirement Scenarios
      • Creating a new task with requested barcodes
      • Updating an existing task with requested barcodes
      • Capturing
    Powered by

    Getting started

    The Onfleet API is a RESTful web service for developers and integrations to programmatically interact with Onfleet’s data and real-time delivery management and analytics functionality.

    API Wrappers

    Learn all about Onfleet Wrappers that you can use to get started on your projects. We have official Onfleet wrappers in python and javascript that you can use as well as some resources for unofficial wrappers.

    Onfleet Developer

    Onfleet open source repository for developers. Contribute to onfleet/developer development by creating an account on GitHub.

    Jumpstart your deliveries

    Get in touch with our sales team or start your 14-day free trial

    Start free trial Contact sales
    Onfleet

    Copyright © 2014-2021 Onfleet, Inc. All rights reserved.

    Product

    • Features
    • Partners
    • Solutions
    • API
    • Pricing
    • Sign Up
    • Log In

    Company

    • Customers
    • About
    • Press
    • Careers
    • Contact

    Support

    • Support
    • Status
    • Terms
    • Privacy Policy
    • CCPA Notice

    Connect

    • Blog
    • Twitter
    • Facebook
    • LinkedIn
    • Instagram