Copy page

Hyperlocal

Quickstart

Get a store-based delivery order live on staging in under 10 minutes. Stores must be pre-registered with Shadowfax — you'll receive a unique store_code for each outlet.

If pickup locations are not fixed, use the Marketplace integration instead.

Authentication

Shadowfax uses Token Authentication. Staging and production API keys are shared by the Shadowfax team via automated email.

Code
Authorization: Token your_api_token

Environments

Environment	Base URL	Purpose
Staging	https://hlbackend.staging.shadowfax.in	Integration testing, development
Production	https://api.shadowfax.in	Live operations

All examples below use the staging base URL.

1. Check Serviceability

Verify that Shadowfax can serve the order from your store. Drop coordinates are optional — if omitted, delivery cost is not calculated.

Code
curl -X PUT https://hlbackend.staging.shadowfax.in/api/v2/store_serviceability/ \
  -H "Authorization: Token your_api_token" \
  -H "Content-Type: application/json" \
  -d '{
    "store_code": "STORE_CODE",
    "paid": "false",
    "order_value": 250,
    "drop_latitude": 17.257465,
    "drop_longitude": 78.085492
  }'

See Serviceability for field details.

2. Place an Order

Code
curl -X POST https://hlbackend.staging.shadowfax.in/api/v2/stores/orders/ \
  -H "Authorization: Token your_api_token" \
  -H "Content-Type: application/json" \
  -d '{
    "store_code": "STORE_CODE",
    "pickup_contact_number": "9711076015",
    "order_details": {
      "order_value": "380.00",
      "paid": false,
      "client_order_id": "TEST-001"
    },
    "customer_details": {
      "name": "Customer name",
      "address_line_1": "106 charms solitaire, ahinsa khand-2",
      "city": "Ghaziabad",
      "contact_number": "9986321214",
      "latitude": 12.387487873,
      "longitude": 77.78787878
    },
    "product_details": [
      {
        "id": 12095247,
        "name": "Rajma Jammu",
        "price": 130,
        "quantity": 1,
        "weight": 0.5
      }
    ]
  }'

Save the sfx_order_id from the response.

3. Get Order Status

Code
curl https://hlbackend.staging.shadowfax.in/api/v2/orders/{sfx_order_id}/status/ \
  -H "Authorization: Token your_api_token"

4. Set Up Callbacks

Share your callback URL with the Shadowfax team for production. In staging, use the Sandbox Testing APIs to simulate status transitions.

See Callbacks for payload formats.

Next Steps

• Order Lifecycle — understand order states
• Onboarding — staging to production checklist
• API Reference — full endpoint documentation