Pickup Orders
A pickup order instructs Shadowfax to send a rider to a customer's address to collect a return item.
Placing a Pickup Order
Submit a POST request with the customer's address, item details, and return type. The request body has four sections: customer_details, return_details, order_details, and sku_details.
See Place Pickup Order in the API Reference for the full request schema and field descriptions.
Check Serviceability before placing an order to confirm the pincode is covered.
Cancellation
Orders can be cancelled before the rider picks up the item. Once the item is picked, cancellation is not possible — the item enters the return pipeline.
Pass the order in request_id, which accepts either the AWB or your own client_order_id, along with cancel_remarks, which is stored against the order. A refusal comes back as 400 with the reason in responseMsg.
Idempotency
If you submit the same client_order_id twice, the API returns the existing order instead of creating a duplicate. This makes retries safe.
Note that this protection expires 30 minutes after the order is placed, unless a longer window has been configured for your account. Submitting the same client_order_id after that window creates a second, genuine order with its own AWB — so a delayed retry, or a replayed message from your own queue, can double-book a pickup. If you need to re-send beyond 30 minutes, check the order's status first.
See Place Pickup Order in the API Reference.