Hyperlocal
Onboarding
Follow these steps to complete your Dedicated Store integration. Stores must be registered with Shadowfax before you can place orders — you'll receive a store_code for each outlet.
1. Staging Setup
Shadowfax shares staging credentials, a Postman collection, and this documentation via automated email.
Using staging credentials:
- Run a serviceability check for your store.
- Place an order in the staging environment.
- Retrieve order details via Get Order Details.
2. Callback Testing (Optional)
To test callback setup and order flow in staging:
- Share your staging callback URL with the Shadowfax team.
- Use the Sandbox Testing APIs to simulate status transitions.
- Verify your webhook handler receives and processes callbacks correctly.
3. Production Credentials
Once staging testing is complete, Shadowfax shares production credentials for live orders.
4. Production Callback Configuration
Set up your production callback URL and share the details with the Shadowfax team:
- Callback URL for order status updates
- Callback URL for rider location updates (if separate)
- Custom headers (if any)
- HTTP method preference (
POSTorPUT)
5. Go Live
After successful production testing, the integration is complete.
Checklist
| Step | Staging | Production |
|---|---|---|
| Store codes registered | ✓ | ✓ |
| Credentials received | ✓ | ✓ |
| Serviceability tested | ✓ | ✓ |
| Order placement tested | ✓ | ✓ |
| Callback URL configured | ✓ | ✓ |
| Callback handler idempotent | ✓ | ✓ |
| End-to-end flow verified | ✓ | ✓ |
See Quickstart to begin staging integration.
Last modified on