Shadowfax Hyperlocal Dedicated Store API
APIs for integrating Shadowfax hyperlocal order delivery with pre-registered stores (Dedicated Store / store-based model). Stores are created upfront at Shadowfax and mapped to a unique store_code used in API calls. If pickup locations are not fixed, use the Marketplace API instead.
Authentication
Hyperlocal Dedicated Store supports Token Authentication only — OAuth2 is not available. Staging and production API keys are shared by the Shadowfax team via automated email rather than the Partner Portal. See Authentication for details.
Code
Order Status
| Status | Description |
|---|---|
ACCEPTED | Order accepted by Shadowfax for delivery |
ALLOTED | Order allotted to a rider (pull API spelling) |
ARRIVED | Rider arrived at pickup location |
DISPATCHED | Order collected and dispatched |
ARRIVED_CUSTOMER_DOORSTEP | Rider arrived at drop location |
DELIVERED | Order delivered to customer |
CANCELLED | Order cancelled |
CANCELLED_BY_CUSTOMER | Order cancelled by customer |
RETURNED_TO_SELLER | SKUs or COD returned to seller |
UNDELIVERED | Milk Run model — used instead of CANCELLED_BY_CUSTOMER |
Callbacks may use ALLOTTED (double T) and additional statuses like UNASSIGNED.
Callbacks
Configure a webhook URL with Shadowfax to receive order status and rider location updates. See the Callbacks guide for payload formats.
Tags
Security Schemes
ApiTokenAuth
Client API token. Format:
Token <api_token>apiKey