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)
Order Statuses
Section titled “Order Statuses”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 |
Endpoints
Section titled “Endpoints”- POST Create Territory
- GET Get Territories
- GET Get Territory
- GET Get Cohorts
- POST Create Runner
- POST Create Merchant
- PATCH Update Merchant
- GET Get Merchants
- GET Get Merchant
- POST Get Provider Quotes
- POST Create Order
- GET Get Orders
- GET Get Order
- PATCH Update Order
- POST Update Fulfillment Status
- GET Get Fulfillment Status
- POST Cancel Order
- POST Create Dispatch Strategy
- POST Replace Strategy Schedule
- GET Get Dispatch Strategies
- GET (BETA) Get Strategy Schedule
- DELETE (BETA) Remove Strategy Schedule
- PATCH Append To Strategy Schedule
- POST Create Order Export
- GET Get Order Export
- GET Download Order Export
- POST Orders (Legacy)
- POST Create DSP Refund Request
- GET Get DSP Refunds
- PATCH Update DSP Refund
- GET Get DSP Refund by DSP ID
- GET List Shifts
- GET Get Shift
- POST Create Shift
- PATCH Update Shift
- DELETE Cancel Shift
- POST Check In to Shift
- POST Check Out of Shift

