Skip to content

First Delivery API

Select theme

Start here
Guides
API reference
- Platform API
  - Territories
    Create Territory
    Get Territories
    Get Territory
  - Cohorts
    Get Cohorts
  - Runners
    Create Runner
  - Merchants
    Create Merchant
    Update Merchant
    Get Merchants
    Get Merchant
  - Orders
    Get Provider Quotes
    Create Order
    Get Orders
    Get Order
    Update Order
    Update Fulfillment Status
    Get Fulfillment Status
    Cancel Order
  - Strategies
    Create Dispatch Strategy
    Replace Strategy Schedule
    Get Dispatch Strategies
    (BETA) Get Strategy Schedule
    (BETA) Remove Strategy Schedule
    Append To Strategy Schedule
  - Exports
    Create Order Export
    Get Order Export
    Download Order Export
    Orders (Legacy)
  - Refunds
    Create DSP Refund Request
    Get DSP Refunds
    Update DSP Refund
    Get DSP Refund By DSP ID
  - Shifts
    List Shifts
    Get Shift
    Create Shift
    Update Shift
    Cancel Shift
    Check In To Shift
    Check Out Of Shift
- Webhooks
- Driver App API
  - Auth & Login
    Send Verification Code
    Login (Phone + PIN)
  - User & Profile
    Get Current User
    Update Profile
    Get Availability
    Update Availability
    Repair / Resync Run
  - Devices
    Register Device
  - Geolocation
    Post Location Ping
  - Orders
    Place Order (Finalize Pickup Items)
    Self-Assign Order
    Unassign Order (Set Pending_dispatch)
    Get Order Contents
    Acknowledge Order
    Arrive At Pickup
    Arrive At Dropoff
    Mark Picked Up
    Mark Order Not Ready
    Drop Off Order
    Submit Proof Of Delivery
    Upload Receipt Image
    Get My Orders (V3)
    Get Previous Orders (V3)
    New Request
  - Runs & Plans
    Get Current Run
  - Shifts & Blocks
    Claim Shift
    Drop Shift
    Check In To Shift
    Get Upcoming Shifts
    Get Free Shifts (Categorized)
    Get Previous Shifts
  - Messages
    Get Legacy Messages
    Mark Legacy Messages Seen
    Send Legacy Message
    Get Group Messages
    Mark Group Messages Read
    Send Group Message
    Get Message Groups
  - Territory & Operator Config
    Get My Territory
    Get Territory By Id
    Get Operator Config
  - Payouts
    Get Stripe Balance
    Get Stripe Connect Client Id
    Get Stripe Dashboard URL
    Get Daily Summaries
  - Offers
    Get Offers For Runner
  - Retreat Points
    Get Retreat Points
  - Realtime (Socket.IO) — Reference Only
    Emit: Authenticate
    Listen: Connect
    Listen: Connect_error
    Listen: Authenticate-Callback
    Listen: {UserId}:Plan
    Listen: {UserId}:Orders
    Listen: {UserId}:Shift
    Listen: {UserId}:User
    Listen: Group-Message-Change
    Listen: Messages
Changelog

Select theme

On this page

Overview
Endpoints

On this page

Overview
Endpoints

Runs & Plans

The driver’s current batched run/plan of stops, as produced by dispatch’s batching engine.

Endpoints

Section titled “Endpoints”

GET Get current run