Shadowfax Hyperlocal Dedicated Store API

Orders

Server

Place, edit, track, cancel, and manage store-based delivery orders.

Place a store order

POST

https://hlbackend.staging.shadowfax.in

/api/v2/stores/orders/

Authorization (header)

Place a delivery order from a pre-registered store. Returns a track_url for live order tracking.

Pickup OTP validation:

COID validation — last four digits of client_order_id
Custom OTP — pass pickup_otp in the misc object

Place a store order › Request Body

PlaceStoreOrderRequest

store_code

string · required

StoreOrderDetails · required

CustomerDetails · required

ProductDetail[] · required

pickup_contact_number

string

OrderMisc

Place a store order › Responses

Order placed successfully

StoreOrderSuccessResponse

message

string

data

object

POST/api/v2/stores/orders/

curl --request POST \
  --url https://hlbackend.staging.shadowfax.in/api/v2/stores/orders/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "store_code": "store_code",
  "pickup_contact_number": "pickup_contact_number",
  "order_details": {
    "client_order_id": "client_order_id",
    "order_value": 0,
    "paid": true,
    "scheduled_time": "scheduled_time",
    "store_manager_number": "store_manager_number",
    "delivery_geofence_radius": 0,
    "rain_flag": true,
    "delivery_instruction": {
      "drop_instruction_text": "drop_instruction_text",
      "take_drop_off_picture": true,
      "drop_off_picture_mandatory": true
    }
  },
  "customer_details": {
    "name": "name",
    "address_line_1": "address_line_1",
    "address_line_2": "address_line_2",
    "city": "city",
    "contact_number": "contact_number",
    "masked_customer_contact_number": "masked_customer_contact_number",
    "latitude": 0,
    "longitude": 0
  },
  "product_details": [
    {
      "id": 0,
      "name": "name",
      "price": 0,
      "quantity": 0,
      "weight": 0
    }
  ],
  "misc": {
    "type": "slotted",
    "pickup_otp": "pickup_otp",
    "return_otp": "return_otp",
    "delivery_otp": "delivery_otp",
    "promised_delivery_time": "2024-08-25T15:00:00Z",
    "weight": 0
  }
}
'

shell

Example Request Body

{
  "store_code": "store_code",
  "pickup_contact_number": "pickup_contact_number",
  "order_details": {
    "client_order_id": "client_order_id",
    "order_value": 0,
    "paid": true,
    "scheduled_time": "scheduled_time",
    "store_manager_number": "store_manager_number",
    "delivery_geofence_radius": 0,
    "rain_flag": true,
    "delivery_instruction": {
      "drop_instruction_text": "drop_instruction_text",
      "take_drop_off_picture": true,
      "drop_off_picture_mandatory": true
    }
  },
  "customer_details": {
    "name": "name",
    "address_line_1": "address_line_1",
    "address_line_2": "address_line_2",
    "city": "city",
    "contact_number": "contact_number",
    "masked_customer_contact_number": "masked_customer_contact_number",
    "latitude": 0,
    "longitude": 0
  },
  "product_details": [
    {
      "id": 0,
      "name": "name",
      "price": 0,
      "quantity": 0,
      "weight": 0
    }
  ],
  "misc": {
    "type": "slotted",
    "pickup_otp": "pickup_otp",
    "return_otp": "return_otp",
    "delivery_otp": "delivery_otp",
    "promised_delivery_time": "2024-08-25T15:00:00Z",
    "weight": 0
  }
}

json

Example Responses

{
  "message": "message",
  "data": {}
}

json

application/json

Edit a store order

PUT

https://hlbackend.staging.shadowfax.in

/api/v1/stores/edit-order/

Authorization (header)

Edit payment mode, order items, and total amount. Order is identified by sfx_order_id in the request body. Editable until the rider picks up the order.

Edit a store order › Request Body

EditStoreOrderRequest

store_code

string · required

sfx_order_id

integer · required

COID

string

amount

number

paid

boolean

rain_flag

boolean

ProductDetail[]

Edit a store order › Responses

Order updated

EditStoreOrderResponse

store_code

string

status

string

sfx_order_id

integer

track_url

string

order_details

object

CustomerDetails

object[]

PUT/api/v1/stores/edit-order/

curl --request PUT \
  --url https://hlbackend.staging.shadowfax.in/api/v1/stores/edit-order/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "store_code": "STORE_CODE",
  "sfx_order_id": 9228119,
  "COID": "150340000010725",
  "amount": 420,
  "rain_flag": false,
  "paid": false,
  "product_details": [
    {
      "id": 12095247,
      "weight": 0.5,
      "quantity": 1,
      "name": "Rajma Jamu",
      "price": 130
    }
  ]
}
'

shell

Example Request Body

{
  "store_code": "STORE_CODE",
  "sfx_order_id": 9228119,
  "COID": "150340000010725",
  "amount": 420,
  "rain_flag": false,
  "paid": false,
  "product_details": [
    {
      "id": 12095247,
      "weight": 0.5,
      "quantity": 1,
      "name": "Rajma Jamu",
      "price": 130
    }
  ]
}

json

application/json

Example Responses

No example specified for this content type

application/json

Get order details

GET

https://hlbackend.staging.shadowfax.in

/api/v2/orders/{sfx_order_id}/status/

Authorization (header)

Get order details and current status for a store-based order.

Get order details › path Parameters

sfx_order_id

integer · required

Get order details › Responses

Order details

StoreOrderStatusResponse

message

string

data

object

Cancel an order

PUT

https://hlbackend.staging.shadowfax.in

/api/v2/orders/{sfx_order_id}/cancel/

Authorization (header)

Cancel a delivery order with a reason and the user initiating cancellation.

Cancel an order › path Parameters

sfx_order_id

integer · required

Cancel an order › Request Body

CancelOrderRequest

reason

string · maxLength: 128 · required

user

string · enum · required

Enum values:

Customer

Seller

Rider

Cancel an order › Responses

Order cancelled

StoreCancelResponse

message

string

data

object

Dispatch ready indicator

PUT

https://hlbackend.staging.shadowfax.in

/api/v2/orders/{coid}/dispatch-ready/

Authorization (header)

Notify Shadowfax when the shipment is ready for pickup.

Dispatch ready indicator › path Parameters

coid

string · required

Client order ID (COID)

Dispatch ready indicator › Request Body

DispatchReadyRequest

shipment_ready_timestamp

string · date-time · required

Dispatch ready indicator › Responses

Dispatch ready acknowledged

MessageResponse

message

string

Stop re-attempt

POST

https://hlbackend.staging.shadowfax.in

/api/v2/orders/stop-reattempt/

Authorization (header)

Cancel a next-day re-attempt for an order. If triggered before the rescheduled time, the reattempt flag is disabled. If triggered after, the order status is updated to Cancelled.

Stop re-attempt › Request Body

StopReattemptRequest

order_id

integer · required

Shadowfax order ID (sfx_order_id).

Stop re-attempt › Responses

Re-attempt cancelled

MessageResponse

message

string

Serviceability Sandbox

Place a store order

POST

https://hlbackend.staging.shadowfax.in

/api/v2/stores/orders/

Authorization (header)

Place a delivery order from a pre-registered store. Returns a track_url for live order tracking.

Pickup OTP validation:

COID validation — last four digits of client_order_id
Custom OTP — pass pickup_otp in the misc object

Place a store order › Request Body

PlaceStoreOrderRequest

store_code

string · required

StoreOrderDetails · required

CustomerDetails · required

ProductDetail[] · required

pickup_contact_number

string

OrderMisc

Place a store order › Responses

Order placed successfully

StoreOrderSuccessResponse

message

string

data

object

Edit a store order

PUT

https://hlbackend.staging.shadowfax.in

/api/v1/stores/edit-order/

Authorization (header)

Edit payment mode, order items, and total amount. Order is identified by sfx_order_id in the request body. Editable until the rider picks up the order.

Edit a store order › Request Body

EditStoreOrderRequest

store_code

string · required

sfx_order_id

integer · required

COID

string

amount

number

paid

boolean

rain_flag

boolean

ProductDetail[]

Edit a store order › Responses

Order updated

EditStoreOrderResponse

store_code

string

status

string

sfx_order_id

integer

track_url

string

order_details

object

CustomerDetails

object[]

Get order details

GET

https://hlbackend.staging.shadowfax.in

/api/v2/orders/{sfx_order_id}/status/

Authorization (header)

Get order details and current status for a store-based order.

Get order details › path Parameters

sfx_order_id

integer · required

Get order details › Responses

Order details

StoreOrderStatusResponse

message

string

data

object

Cancel an order

PUT

https://hlbackend.staging.shadowfax.in

/api/v2/orders/{sfx_order_id}/cancel/

Authorization (header)

Cancel a delivery order with a reason and the user initiating cancellation.

Cancel an order › path Parameters

sfx_order_id

integer · required

Cancel an order › Request Body

CancelOrderRequest

reason

string · maxLength: 128 · required

user

string · enum · required

Enum values:

Customer

Seller

Rider

Cancel an order › Responses

Order cancelled

StoreCancelResponse

message

string

data

object

Dispatch ready indicator

PUT

https://hlbackend.staging.shadowfax.in

/api/v2/orders/{coid}/dispatch-ready/

Authorization (header)

Notify Shadowfax when the shipment is ready for pickup.

Dispatch ready indicator › path Parameters

coid

string · required

Client order ID (COID)

Dispatch ready indicator › Request Body

DispatchReadyRequest

shipment_ready_timestamp

string · date-time · required

Dispatch ready indicator › Responses

Dispatch ready acknowledged

MessageResponse

message

string

Stop re-attempt

POST

https://hlbackend.staging.shadowfax.in

/api/v2/orders/stop-reattempt/

Authorization (header)

Cancel a next-day re-attempt for an order. If triggered before the rescheduled time, the reattempt flag is disabled. If triggered after, the order status is updated to Cancelled.

Stop re-attempt › Request Body

StopReattemptRequest

order_id

integer · required

Shadowfax order ID (sfx_order_id).

Stop re-attempt › Responses

Re-attempt cancelled

MessageResponse

message

string