Quickstart

Get a quick-commerce delivery order live on staging in a few minutes. You'll need your client credentials and store unique_code mapping from your Shadowfax integration POC.

Environments

All examples below use the staging base URL.

1. Generate a Token

Quick Commerce uses OAuth2 client-credentials — see Authentication for the full token request and response. Save the access_token from the response; tokens expire after 3600 seconds and must be refreshed before expiry.

2. Create an Order

All fields inside eta_details are optional.

Code
curl --location 'https://dale.staging.shadowfax.in/api/v3/clients/orders/' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <ACCESS_TOKEN>' \
  --data-raw '{
    "order_details": {
      "client_order_id": "ORD-2026-000123",
      "customer_order_id": "0123456",
      "actual_weight": 100,
      "product_value": 5555,
      "payment_mode": "Prepaid",
      "cod_amount": "0",
      "total_amount": 5555,
      "order_service": "regular",
      "eta_details": {
        "pickup_ready_time": 1694568000,
        "serviceability_id": "ABCD1234"
      }
    },
    "customer_details": {
      "name": "Jane Doe",
      "contact": "9999999999",
      "address_line_1": "Flat 38, Example Apartments, Sector 9",
      "city": "New Delhi",
      "state": "Delhi",
      "pincode": 110001,
      "latitude": "11.0000",
      "longitude": "77.0000"
    },
    "pickup_details": {
      "name": "Example Dark Store",
      "contact": "9999999999",
      "address_line_1": "8th Main, 5th Cross",
      "city": "Bengaluru",
      "state": "Karnataka",
      "pincode": 560007,
      "latitude": "12.0000",
      "longitude": "78.0000",
      "unique_code": "STORE_0001"
    }
  }'

Save the awb_number from the response — it identifies the shipment in all subsequent calls. See Create Order for the full payload including return, product, and seller details.

3. Mark Ready for Pickup

Code
curl --location 'https://dale.staging.shadowfax.in/api/v3/clients/order_update/' \
  --header 'Authorization: Bearer <ACCESS_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "awb_number": "<AWB_NUMBER>",
    "is_ready_for_pickup": true
  }'

4. Set Up Webhooks

Two separate pushes are delivered to your registered webhook URL while an order is active: order-status changes (created, out for delivery, arrived, etc.) and rider GPS location. Share your webhook URL and expected auth headers with your Shadowfax integration POC.

See Order Status Callbacks and Live Order Location for the payload schemas.

Next Steps

• Create Order — full payload and eta_details field reference
• Edit / Update Order — OTPs, pickup racks, product updates
• Cancel Order — cancellation window and payload
• API Reference — interactive endpoint documentation