Schemas

ForwardOrderRequest

Request body for placing a forward delivery order.

CustomerDetails · required

Customer delivery address and contact information.

FwdOrderInfo · required

Order-level details. payment_mode and cod_amount are not required for order_type: d2d.

PickupAddress · required

Pickup address (seller, origin, or warehouse).

Required unconditionally: pincode, address_line_1
name/contact are additionally required when order_type is marketplace

ReturnAddress · required

Where a failed delivery is returned.

return_type: "seller" — returns to the seller/pickup address
return_type: "origin" — returns to your warehouse

For order_type: d2d, return_type is always forced to origin, and its pincode must match pickup_details.pincode.

FwdSkuItem[] · minItems: 1 · required

List of SKUs in the order. At least one required.

order_type

string · enum

Selects how the order is fulfilled. Defaults to marketplace if omitted. hyperlocal is restricted to onboarded clients only — see the Order Types guide for how required fields shift per type.

Enum values:

marketplace

warehouse

d2d

hyperlocal

Default: marketplace

CustomerDetails

Customer delivery address and contact information.

name

string · maxLength: 100 · required

Customer full name.

contact

string · minLength: 10 · maxLength: 14 · pattern: ^[0-9+]+$ · required

Customer phone number. 10-14 digits, may include + prefix.

address_line_1

string · required

Delivery address line 1.

city

string · maxLength: 50 · required

Delivery city.

pincode

integer · pattern: ^[1-9][0-9]{5}$ · required

6-digit Indian pincode. Must start with 1-9.

address2

string

Delivery address line 2 (optional).

alternate_contact

string · maxLength: 13

Alternate phone number.

latitude

string · maxLength: 40

longitude

string · maxLength: 40

location_accuracy

string · enum

Location accuracy indicator: L (low), H (high), G (GPS).

Enum values:

location_type

string · enum

Address type.

Enum values:

commercial

residential

state

string · maxLength: 40

Delivery state.

FwdOrderInfo

Order-level details. `payment_mode` and `cod_amount` are not required for `order_type: d2d`.

client_order_id

string · maxLength: 100 · required

Your unique order ID. Used for idempotency.

product_value

number · min: 0 · required

Total product value in INR. E-way bill required if >= 50,000.

payment_mode

string · enum · required

Payment mode.

Enum values:

prepaid

cod

cod_amount

number · min: 0 · required

Cash on delivery amount. Must be 0 for prepaid orders.

awb_number

string · maxLength: 25 · pattern: ^[a-zA-Z0-9]+$

Your own AWB number (optional). Alphanumeric only, max 25 chars.

actual_weight

number

Actual weight in kg.

volumetric_weight

number

Volumetric weight in kg.

promised_delivery_date

string

Promised delivery date. Format: yyyy-MM-dd hh:mm:ss.

total_amount

number · min: 0

Total order amount.

eway_bill

string · maxLength: 12

12-digit e-way bill number. Required when product value >= ₹50,000.

order_service

string · enum

Shipping service level.

Enum values:

Regular

shopify_order_id

string · maxLength: 100

Shopify order ID (if applicable).

woocommerce_order_id

string · maxLength: 100

WooCommerce order ID (if applicable).

fulfillment_order_id

string · maxLength: 100

Fulfillment order ID (if applicable).

order_identifier

string · enum

Order priority identifier.

Enum values:

premium

express

regular

economy

object

Optional rider-facing delivery instructions.

PickupAddress

Pickup address (seller, origin, or warehouse). - Required unconditionally: `pincode`, `address_line_1` - `name`/`contact` are additionally required when `order_type` is `marketplace`

pickup_type

string · enum · required

Pickup location type.

Enum values:

seller

origin

warehouse

address_line_1

string · required

Pickup address.

city

string · maxLength: 50 · required

Pickup city.

pincode

integer · pattern: ^[1-9][0-9]{5}$ · required

6-digit Indian pincode.

name

string · maxLength: 100

Contact name. Required for order_type: marketplace.

contact

string · minLength: 10 · maxLength: 14 · pattern: ^[0-9+]+$

Contact phone. Required for order_type: marketplace.

latitude

string · maxLength: 40

longitude

string · maxLength: 40

pickup_slot

string

Requested pickup slot key (e.g. slot_1, slot_2) from your account's configured slots. Only honored for order_type: marketplace — ignored for other order types.

pickup_date

string · date

Requested pickup date, YYYY-MM-DD. Only honored for order_type: marketplace — ignored for other order types. Combined with pickup_slot to schedule the pickup window; dates in the past are treated as today.

ReturnAddress

Return address for the order's return leg, sent as `return_details` on the order request.

return_type

string · enum · required

seller — returns a failed delivery to the seller/pickup address
origin — returns it to your warehouse

Genuinely selectable on Marketplace orders; Warehouse and D2D always treat this as origin regardless of what's sent.

Enum values:

seller

origin

address_line_1

string · required

Return address.

pincode

integer · pattern: ^[1-9][0-9]{5}$ · required

6-digit Indian pincode. For order_type: d2d, must match pickup_details.pincode.

name

string · maxLength: 100

Contact name. Required when return_type is seller.

contact

string · minLength: 10 · maxLength: 14 · pattern: ^[0-9+]+$

Contact phone. Required when return_type is seller.

city

string · maxLength: 50

email

string · email · maxLength: 100

latitude

string · maxLength: 40

longitude

string · maxLength: 40

FwdSkuItem

SKU item in a forward order.

sku_name

string · required

Product name.

sku_id

string · maxLength: 100 · required

Your SKU identifier.

price

number · required

Unit price in INR.

category

string · maxLength: 200

Product category.

hsn_code

string · maxLength: 100

HSN (Harmonized System of Nomenclature) code for GST.

invoice_no

string · maxLength: 50

Invoice number.

brand

string · maxLength: 200

SellerDetails

Seller information for GST compliance.

TaxDetails

Tax breakdown for the SKU.

FwdAdditionalDetails

Additional SKU metadata.

SellerDetails

Seller information for GST compliance.

seller_name

string · maxLength: 100

seller_address

string

seller_state

string · maxLength: 50

gstin_number

string · maxLength: 50

GSTIN number. Required when product value >= ₹50,000.

TaxDetails

Tax breakdown for the SKU.

cgst_amount

number

Default: 0

sgst_amount

number

Default: 0

igst_amount

number

Default: 0

total_tax_value

number

Default: 0

FwdAdditionalDetails

Additional SKU metadata.

requires_extra_care

boolean

type_extra_care

string

product_id

string

product_weight

string

quantity

number

Required, numeric, for every SKU on a d2d order.

mode

string · enum

D2D transport mode.

Enum values:

rail

air

surface

slot_type

string · enum

D2D delivery slot type.

Enum values:

slotted

all_day

ForwardOrderSuccessResponse

Successful order creation response.

message

string

OrderDetails

Created order details.

errors

null

OrderDetails

Order details as returned in creation and tracking responses.

id

integer

Internal order ID.

client_name

string

client_order_id

string

awb_number

string

Shadowfax AWB number assigned to this order.

product_value

number

cod_amount

number

payment_mode

string

order_date

string · date

promised_delivery_date

string · date-time

status

string · enum

Current order status. See the Order Lifecycle guide for the states that matter for day-to-day integration — this is the full set of values you may see, including less common ones:

Value	Meaning
`new`	Order received, pending processing
`assigned_for_pickup`	Rider assigned to collect the item (Warehouse/D2D)
`assigned_for_seller_pickup`	Rider assigned to collect the item (Marketplace)
`ofp`	Rider en route to collect the item
`picked`	Item collected
`qc_failed`	Item failed quality check at pickup
`received_from_client_warehouse`	Warehouse-model item confirmed picked from your warehouse
`seller_initiated_delay`	Seller asked to reschedule pickup
`seller_not_contactable`	Seller unreachable for pickup
`pickup_not_attempted`	Pickup attempt could not be made
`pickup_on_hold`	Pickup paused pending resolution
`recd_at_rev_hub`	Item received at the pickup-side hub
`recd_at_fwd_hub`	Item received at a delivery-side hub
`recd_at_fwd_dc`	Item received at a destination DC
`assigned_for_delivery`	Rider assigned for last-mile delivery
`ofd`	Rider en route to customer
`delivered`	Item delivered
`partially_delivered`	Some but not all items delivered (hyperlocal orders)
`cid`	Customer asked for another delivery date
`nc`	Customer unreachable
`na`	Delivery attempt not made
`on_hold`	Delivery paused pending resolution
`ewb_on_hold`	Paused pending a valid e-way bill
`pincode_updated`	Delivery pincode was corrected mid-transit
`reopen_ndr`	A failed delivery attempt was reopened for retry
`cancelled_by_customer`	Order cancelled
`rts`	Return to seller initiated (Marketplace)
`rts_in_process`	Return to seller in transit
`rts_d`	Return to seller completed
`rts_nd`	Return to seller attempt failed
`rto`	Return to origin/warehouse initiated (Warehouse/D2D)
`rto_d`	Return to origin completed
`rto_nd`	Return to origin attempt failed
`lost`	Item lost in transit
`pending_inscan`	Item expected but not yet scanned in at a facility

Enum values:

new

assigned_for_pickup

assigned_for_seller_pickup

ofp

picked

qc_failed

received_from_client_warehouse

seller_initiated_delay

status_display

string

AddressDisplay

Address in API responses.

AddressDisplay

Address in API responses.

object[]

eway_bill_number

string

sort_code

string

Hub sort code for routing. Present on order creation.

invoice_date

string

Present on tracking responses.

AddressDisplay

Address in API responses.

name

string

contact

string

address_line_1

string

address_line_2

string

city

string

state

string

pincode

integer

alternate_contact

string

sms_contact

string

latitude

string

longitude

string

ForwardTrackingResponse

Tracking response with order details and event timeline.

message

string

OrderDetails

Order details. status reflects the latest status, overwritten from the most recent tracking event.

object[]

Timeline of tracking events, chronological order.

CancelOrderRequest

Request to cancel a forward order.

request_id

string · required

AWB number or client_order_id of the order to cancel.

cancel_remarks

string

Optional reason for cancellation.

CancelOrderResponse

Cancel order response.

responseMsg

string

responseCode

integer

OrderUpdateRequest

Request to update forward order details. All fields except awb_number are optional — send only what you want to change.

awb_number

string · required

AWB number of the order to update.

object

Customer delivery details to update.

object

Pickup details to update.

object

Return address details to update.

object

Order-level details to update.

object

Trigger a status change (RTO, RTS, or reopen NDR).

ServiceabilityResult

Serviceability information for a single pincode.

code

integer

6-digit pincode.

services

string[]

Available service tiers for this pincode.

AuthErrorResponse

Authentication error response.

status

string

errorCode

string

message

string

ForwardOrderErrorResponse

Error response for forward order operations.

message

string

errors

Validation errors or error message.

ForwardOrderRequest

Request body for placing a forward delivery order.

CustomerDetails · required

Customer delivery address and contact information.

FwdOrderInfo · required

Order-level details. payment_mode and cod_amount are not required for order_type: d2d.

PickupAddress · required

Pickup address (seller, origin, or warehouse).

Required unconditionally: pincode, address_line_1
name/contact are additionally required when order_type is marketplace

ReturnAddress · required

Where a failed delivery is returned.

return_type: "seller" — returns to the seller/pickup address
return_type: "origin" — returns to your warehouse

For order_type: d2d, return_type is always forced to origin, and its pincode must match pickup_details.pincode.

FwdSkuItem[] · minItems: 1 · required

List of SKUs in the order. At least one required.

order_type

string · enum

Selects how the order is fulfilled. Defaults to marketplace if omitted. hyperlocal is restricted to onboarded clients only — see the Order Types guide for how required fields shift per type.

Enum values:

marketplace

warehouse

d2d

hyperlocal

Default: marketplace

CustomerDetails

Customer delivery address and contact information.

name

string · maxLength: 100 · required

Customer full name.

contact

string · minLength: 10 · maxLength: 14 · pattern: ^[0-9+]+$ · required

Customer phone number. 10-14 digits, may include + prefix.

address_line_1

string · required

Delivery address line 1.

city

string · maxLength: 50 · required

Delivery city.

pincode

integer · pattern: ^[1-9][0-9]{5}$ · required

6-digit Indian pincode. Must start with 1-9.

address2

string

Delivery address line 2 (optional).

alternate_contact

string · maxLength: 13

Alternate phone number.

latitude

string · maxLength: 40

longitude

string · maxLength: 40

location_accuracy

string · enum

Location accuracy indicator: L (low), H (high), G (GPS).

Enum values:

location_type

string · enum

Address type.

Enum values:

commercial

residential

state

string · maxLength: 40

Delivery state.

FwdOrderInfo

Order-level details. `payment_mode` and `cod_amount` are not required for `order_type: d2d`.

client_order_id

string · maxLength: 100 · required

Your unique order ID. Used for idempotency.

product_value

number · min: 0 · required

Total product value in INR. E-way bill required if >= 50,000.

payment_mode

string · enum · required

Payment mode.

Enum values:

prepaid

cod

cod_amount

number · min: 0 · required

Cash on delivery amount. Must be 0 for prepaid orders.

awb_number

string · maxLength: 25 · pattern: ^[a-zA-Z0-9]+$

Your own AWB number (optional). Alphanumeric only, max 25 chars.

actual_weight

number

Actual weight in kg.

volumetric_weight

number

Volumetric weight in kg.

promised_delivery_date

string

Promised delivery date. Format: yyyy-MM-dd hh:mm:ss.

total_amount

number · min: 0

Total order amount.

eway_bill

string · maxLength: 12

12-digit e-way bill number. Required when product value >= ₹50,000.

order_service

string · enum

Shipping service level.

Enum values:

Regular

shopify_order_id

string · maxLength: 100

Shopify order ID (if applicable).

woocommerce_order_id

string · maxLength: 100

WooCommerce order ID (if applicable).

fulfillment_order_id

string · maxLength: 100

Fulfillment order ID (if applicable).

order_identifier

string · enum

Order priority identifier.

Enum values:

premium

express

regular

economy

object

Optional rider-facing delivery instructions.

PickupAddress

Pickup address (seller, origin, or warehouse). - Required unconditionally: `pincode`, `address_line_1` - `name`/`contact` are additionally required when `order_type` is `marketplace`

pickup_type

string · enum · required

Pickup location type.

Enum values:

seller

origin

warehouse

address_line_1

string · required

Pickup address.

city

string · maxLength: 50 · required

Pickup city.

pincode

integer · pattern: ^[1-9][0-9]{5}$ · required

6-digit Indian pincode.

name

string · maxLength: 100

Contact name. Required for order_type: marketplace.

contact

string · minLength: 10 · maxLength: 14 · pattern: ^[0-9+]+$

Contact phone. Required for order_type: marketplace.

latitude

string · maxLength: 40

longitude

string · maxLength: 40

pickup_slot

string

Requested pickup slot key (e.g. slot_1, slot_2) from your account's configured slots. Only honored for order_type: marketplace — ignored for other order types.

pickup_date

string · date

ReturnAddress

Return address for the order's return leg, sent as `return_details` on the order request.

return_type

string · enum · required

seller — returns a failed delivery to the seller/pickup address
origin — returns it to your warehouse

Genuinely selectable on Marketplace orders; Warehouse and D2D always treat this as origin regardless of what's sent.

Enum values:

seller

origin

address_line_1

string · required

Return address.

pincode

integer · pattern: ^[1-9][0-9]{5}$ · required

6-digit Indian pincode. For order_type: d2d, must match pickup_details.pincode.

name

string · maxLength: 100

Contact name. Required when return_type is seller.

contact

string · minLength: 10 · maxLength: 14 · pattern: ^[0-9+]+$

Contact phone. Required when return_type is seller.

city

string · maxLength: 50

email

string · email · maxLength: 100

latitude

string · maxLength: 40

longitude

string · maxLength: 40

FwdSkuItem

SKU item in a forward order.

sku_name

string · required

Product name.

sku_id

string · maxLength: 100 · required

Your SKU identifier.

price

number · required

Unit price in INR.

category

string · maxLength: 200

Product category.

hsn_code

string · maxLength: 100

HSN (Harmonized System of Nomenclature) code for GST.

invoice_no

string · maxLength: 50

Invoice number.

brand

string · maxLength: 200

SellerDetails

Seller information for GST compliance.

TaxDetails

Tax breakdown for the SKU.

FwdAdditionalDetails

Additional SKU metadata.

FwdAdditionalDetails

Additional SKU metadata.

requires_extra_care

boolean

type_extra_care

string

product_id

string

product_weight

string

quantity

number

Required, numeric, for every SKU on a d2d order.

mode

string · enum

D2D transport mode.

Enum values:

rail

air

surface

slot_type

string · enum

D2D delivery slot type.

Enum values:

slotted

all_day

OrderDetails

Order details as returned in creation and tracking responses.

id

integer

Internal order ID.

client_name

string

client_order_id

string

awb_number

string

Shadowfax AWB number assigned to this order.

product_value

number

cod_amount

number

payment_mode

string

order_date

string · date

promised_delivery_date

string · date-time

status

string · enum

Current order status. See the Order Lifecycle guide for the states that matter for day-to-day integration — this is the full set of values you may see, including less common ones:

Value	Meaning
`new`	Order received, pending processing
`assigned_for_pickup`	Rider assigned to collect the item (Warehouse/D2D)
`assigned_for_seller_pickup`	Rider assigned to collect the item (Marketplace)
`ofp`	Rider en route to collect the item
`picked`	Item collected
`qc_failed`	Item failed quality check at pickup
`received_from_client_warehouse`	Warehouse-model item confirmed picked from your warehouse
`seller_initiated_delay`	Seller asked to reschedule pickup
`seller_not_contactable`	Seller unreachable for pickup
`pickup_not_attempted`	Pickup attempt could not be made
`pickup_on_hold`	Pickup paused pending resolution
`recd_at_rev_hub`	Item received at the pickup-side hub
`recd_at_fwd_hub`	Item received at a delivery-side hub
`recd_at_fwd_dc`	Item received at a destination DC
`assigned_for_delivery`	Rider assigned for last-mile delivery
`ofd`	Rider en route to customer
`delivered`	Item delivered
`partially_delivered`	Some but not all items delivered (hyperlocal orders)
`cid`	Customer asked for another delivery date
`nc`	Customer unreachable
`na`	Delivery attempt not made
`on_hold`	Delivery paused pending resolution
`ewb_on_hold`	Paused pending a valid e-way bill
`pincode_updated`	Delivery pincode was corrected mid-transit
`reopen_ndr`	A failed delivery attempt was reopened for retry
`cancelled_by_customer`	Order cancelled
`rts`	Return to seller initiated (Marketplace)
`rts_in_process`	Return to seller in transit
`rts_d`	Return to seller completed
`rts_nd`	Return to seller attempt failed
`rto`	Return to origin/warehouse initiated (Warehouse/D2D)
`rto_d`	Return to origin completed
`rto_nd`	Return to origin attempt failed
`lost`	Item lost in transit
`pending_inscan`	Item expected but not yet scanned in at a facility

Enum values:

new

assigned_for_pickup

assigned_for_seller_pickup

ofp

picked

qc_failed

received_from_client_warehouse

seller_initiated_delay

status_display

string

AddressDisplay

Address in API responses.

AddressDisplay

Address in API responses.

object[]

eway_bill_number

string

sort_code

string

Hub sort code for routing. Present on order creation.

invoice_date

string

Present on tracking responses.

OrderUpdateRequest

Request to update forward order details. All fields except awb_number are optional — send only what you want to change.

awb_number

string · required

AWB number of the order to update.

object

Customer delivery details to update.

object

Pickup details to update.

object

Return address details to update.

object

Order-level details to update.

object

Trigger a status change (RTO, RTS, or reopen NDR).