Skip to content

Platform API

The First Platform API provides full access for you to externally manage your delivery operation

  • Creating markets (territories)
  • Creating runners and merchants
  • Sending orders for internal delivery or to the preferred provider in our DSP network (Doordash, UberEats, etc)

When creating, getting, updating orders - statuses are defined as following:

status description
pending_assign Order is waiting to be dispatched to a runner. Can’t be updated to this. Returned on POST /orders.
pending_merchant Order is waiting for merchant to accept. Can’t be updated to this. Returned on POST /orders.
scheduled Order is scheduled for future. Can’t be updated to this. Returned on POST /orders.
runner_assigned Runner has been assigned - payload required. You can send this multiple times if a new runner is assigned in the course of delivery. Any completed statuses by the previous runner will be rolled back on reassign.
en_route_pickup Runner on way to pickup.
arrived_pickup Runner arrived at pickup
picked_up Runner picked up order
en_route_dropoff Runner on way to dropoff
arrived_dropoff Runner arrived at drop off
completed Order is completed
cancelled Can’t be updated to this. USE POST /cancel to cancel orders