Schemas

OAuthTokenRequest

client_id

string · required

client_secret

string · required

grant_type

string · enum · required

Enum values:

client_credentials

OAuthTokenResponse

access_token

string

expires_in

integer

token_type

string

OAuthErrorResponse

error

string

ServiceabilityRequest

pickup_latitude

string · required

Pickup latitude (converted to float).

pickup_longitude

string · required

Pickup longitude (converted to float).

drop_latitude

string · required

Drop latitude (converted to float).

drop_longitude

string · required

Drop longitude (converted to float).

paid

string · enum · required

false for COD, true for prepaid.

Enum values:

true

false

order_value

number · required

Order value.

COID

string

Client order ID for mapping.

stage_of_check

string · enum

pre_order or post_order.

Enum values:

pre_order

post_order

rain_flag

boolean

Pass true if rain-impacted.

client_surge

number

Extra surge incentive for the rider.

ServiceabilityResponse

serviceable

boolean

delivery_cost

number

Estimated delivery cost including GST.

pickup_eta

number

Pickup ETA in minutes.

drop_eta

number

Drop ETA in minutes.

pickup_rain_mode_flag

boolean

drop_rain_mode_flag

boolean

rain_surge_amount

number

reason

string

Reason when not serviceable.

serviceability

boolean

DeliveryInstruction

drop_instruction_text

string

take_drop_off_picture

boolean

drop_off_picture_mandatory

boolean

client_surge

number

OrderDetails

order_value

number · required

paid

string · enum · required

Enum values:

true

false

client_order_id

string · required

scheduled_time

string

IST 24-hour format, e.g. 2026-03-12 16:00:00

pickup_otp

string

Pickup validation OTP.

return_otp

string

4-digit return confirmation OTP.

rain_flag

boolean

DeliveryInstruction

client_surge

number

allow_undelivered

boolean

Allow rider to mark undelivered and initiate RTS.

rts_required

boolean

Order eligible for Return to Source.

lm_distance

number

Distance between pickup and drop in km.

preparation_time

integer

pickup_eta

number

drop_eta

number

allot_time

string | null

arrival_time

string | null

dispatch_time

string | null

delivery_time

string | null

vehicle_number

string | null

order_date

string

LocationDetails

city

string · required

name

string · required

address

string · maxLength: 255 · required

latitude

number · required

longitude

number · required

contact_number

string

10-digit contact number.

masked_customer_contact_number

string

delivery_geofence_radius

integer

Geofence radius in meters.

delivery_otp

string

4-digit delivery OTP.

OrderItem

id

string · required

name

string · required

price

number · required

quantity

number · required

weight

number | null

category

string | null

unit_price

number

return_condition

string

RiderDetails

rider_name

string

rider_phone

string

rider_location

object | null

PlaceOrderRequest

client_code

string · required

Merchant code shared by Shadowfax.

OrderDetails · required

LocationDetails · required

OrderItem[] · required

has_tip

boolean

tip_amount

number

EditOrderRequest

client_code

string · required

OrderDetails · required

LocationDetails · required

OrderItem[] · required

OrderData

client_code

string

status

string

sfx_order_id

integer

OrderDetails

LocationDetails

OrderItem[]

RiderDetails

track_url

string

drop_image_url

string

delivery_cost

number

OrderSuccessResponse

message

string

OrderData

CancelOrderRequest

reason

string · maxLength: 128 · required

user

string · enum · required

Enum values:

Customer

Seller

Rider

DispatchReadyRequest

shipment_ready_timestamp

string · date-time · required

UTC timestamp when shipment was ready.

MDNDRequest

mdi_claimed

boolean

Customer collected refund from client.

Default: false

order_rating

number

remarks

string

AllotRiderRequest

rider_id

integer · required

only_allot

integer

0 for acceptance callback, 1 for allot callback.

RiderArrivalRequest

time_arrival

string · required

Format: YYYY-MM-DD HH:MM:SS

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

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

ServiceabilityRequest

pickup_latitude

string · required

Pickup latitude (converted to float).

pickup_longitude

string · required

Pickup longitude (converted to float).

drop_latitude

string · required

Drop latitude (converted to float).

drop_longitude

string · required

Drop longitude (converted to float).

paid

string · enum · required

false for COD, true for prepaid.

Enum values:

true

false

order_value

number · required

Order value.

COID

string

Client order ID for mapping.

stage_of_check

string · enum

pre_order or post_order.

Enum values:

pre_order

post_order

rain_flag

boolean

Pass true if rain-impacted.

client_surge

number

Extra surge incentive for the rider.

ServiceabilityResponse

serviceable

boolean

delivery_cost

number

Estimated delivery cost including GST.

pickup_eta

number

Pickup ETA in minutes.

drop_eta

number

Drop ETA in minutes.

pickup_rain_mode_flag

boolean

drop_rain_mode_flag

boolean

rain_surge_amount

number

reason

string

Reason when not serviceable.

serviceability

boolean

OrderDetails

order_value

number · required

paid

string · enum · required

Enum values:

true

false

client_order_id

string · required

scheduled_time

string

IST 24-hour format, e.g. 2026-03-12 16:00:00

pickup_otp

string

Pickup validation OTP.

return_otp

string

4-digit return confirmation OTP.

rain_flag

boolean

DeliveryInstruction

client_surge

number

allow_undelivered

boolean

Allow rider to mark undelivered and initiate RTS.

rts_required

boolean

Order eligible for Return to Source.

lm_distance

number

Distance between pickup and drop in km.

preparation_time

integer

pickup_eta

number

drop_eta

number

allot_time

string | null

arrival_time

string | null

dispatch_time

string | null

delivery_time

string | null

vehicle_number

string | null

order_date

string

LocationDetails

city

string · required

name

string · required

address

string · maxLength: 255 · required

latitude

number · required

longitude

number · required

contact_number

string

10-digit contact number.

masked_customer_contact_number

string

delivery_geofence_radius

integer

Geofence radius in meters.

delivery_otp

string

4-digit delivery OTP.