Shadowfax Hyperlocal Dedicated Store API

Schemas

StoreServiceabilityRequest

store_code

string · required

Unique store code shared by Shadowfax.

paid

string · enum · required

Enum values:

true

false

order_value

number · required

COID

string

Client order ID for mapping.

stage_of_check

string · enum

Enum values:

pre_order

post_order

drop_latitude

number

Optional. If omitted, delivery cost is not calculated.

drop_longitude

number

is_nearest_rider_details_required

boolean

Return rider ETA in response.

rain_flag

boolean

StoreServiceabilityResponse

available_rider_count

number

Nearby riders who can pick up within 10 minutes.

busy_rider_count

number

delivery_cost

number

pickup_rain_mode_flag

boolean

drop_rain_mode_flag

boolean

rain_surge_amount

number

reason

string

StoreOrderDetails

client_order_id

string · required

order_value

number | string · required

paid

boolean | string · required

scheduled_time

string

IST 24-hour format. For slotted orders, start of slot time.

store_manager_number

string · maxLength: 13

delivery_geofence_radius

number

Geofence radius in meters.

rain_flag

boolean

object

CustomerDetails

address_line_1

string · required

city

string · required

contact_number

string · required

name

string

address_line_2

string

masked_customer_contact_number

string

latitude

number

longitude

number

ProductDetail

id

integer | string · required

name

string · required

price

number · required

quantity

number

weight

number

OrderMisc

type

string · enum

Default: express.

Enum values:

slotted

express

pickup_otp

string

return_otp

string

delivery_otp

string

promised_delivery_time

string · date-time

weight

number

Overall order weight in kg.

PlaceStoreOrderRequest

store_code

string · required

StoreOrderDetails · required

CustomerDetails · required

ProductDetail[] · required

pickup_contact_number

string

OrderMisc

EditStoreOrderRequest

store_code

string · required

sfx_order_id

integer · required

COID

string

amount

number

paid

boolean

rain_flag

boolean

ProductDetail[]

StoreOrderSuccessResponse

message

string

data

object

EditStoreOrderResponse

store_code

string

status

string

sfx_order_id

integer

track_url

string

order_details

object

CustomerDetails

object[]

StoreOrderStatusResponse

message

string

data

object

CancelOrderRequest

reason

string · maxLength: 128 · required

user

string · enum · required

Enum values:

Customer

Seller

Rider

StoreCancelResponse

message

string

data

object

DispatchReadyRequest

shipment_ready_timestamp

string · date-time · required

StopReattemptRequest

order_id

integer · required

Shadowfax order ID (sfx_order_id).

AllotRiderRequest

rider_id

integer · required

only_allot

integer

Pass 1 to trigger acceptance callback.

RiderArrivalRequest

time_arrival

string · required

CollectOrderRequest

status

string · enum · required

Enum values:

COLLECTED

pickup_lat

number · required

pickup_lng

number · required

CollectOrderResponse

message

string

virtual_contact_number

string | null

DoorstepArrivalRequest

time_arrival

string · required

arrival_lat

number · required

arrival_lng

number · required

arrival_accuracy

number · required

DeliverOrderRequest

status

string · enum · required

Enum values:

DELIVERED

delivery_latitude

number · required

delivery_longitude

number · required

is_partial_delivery

boolean · required

CustomerReturnRequest

return_reason

string · required

CustomerReturnSandboxResponse

status

boolean

message

string

rts_order_id

integer

SellerReturnRequest

rts_order_id

integer · required

UpdateRiderLocationRequest

update_latitude

number · required

update_longitude

number · required

SandboxStatusResponse

status

boolean

message

string

MessageResponse

message

string

DetailErrorResponse

detail

string

OrderErrorResponse

status

integer

message

string

error

string

StoreServiceabilityRequest

store_code

string · required

Unique store code shared by Shadowfax.

paid

string · enum · required

Enum values:

true

false

order_value

number · required

COID

string

Client order ID for mapping.

stage_of_check

string · enum

Enum values:

pre_order

post_order

drop_latitude

number

Optional. If omitted, delivery cost is not calculated.

drop_longitude

number

is_nearest_rider_details_required

boolean

Return rider ETA in response.

rain_flag

boolean

StoreOrderDetails

client_order_id

string · required

order_value

number | string · required

paid

boolean | string · required

scheduled_time

string

IST 24-hour format. For slotted orders, start of slot time.

store_manager_number

string · maxLength: 13

delivery_geofence_radius

number

Geofence radius in meters.

rain_flag

boolean

object