Edit / Update Order
Update an existing order after creation. Supports pickup readiness, OTP relay, society gate events, and order/product detail updates.
| Attribute | Value |
|---|---|
| Method / Path | POST /api/v3/clients/order_update/ |
| Staging URL | https://dale.staging.shadowfax.in/api/v3/clients/order_update/ |
| Headers | Same as Create Order |
Update overrides existing order parameters. awb_number is mandatory; all other fields are optional and only the fields present in the request are updated.
Important: If product_details is supplied, the complete product list must be sent — it replaces the existing list. When product composition changes, weight / product_value / total_amount must be updated accordingly.
Restriction: Once the shipment has been picked up by the rider and is out for delivery, edit order is no longer permitted. Such requests are rejected with an HTTP 400 error.
Payload Variant A — Pickup Readiness
Code
Payload Variant B — OTP Details
Used to relay gate-entry, delivery, and return-verification OTPs collected on the client's side.
Code
Payload Variant C — Society Gate Passed Event
Code
Payload Variant D — Order Details / Product Update
Code
Field Reference
| Field | Type | Required | Description |
|---|---|---|---|
awb_number | string | Yes | Shadowfax-generated tracking number for the shipment |
is_ready_for_pickup | boolean | No | Marks the order ready for rider pickup at store |
pickup_rack_details | array | No | Bag/rack mapping for in-store staging; blocked once is_ready_for_pickup is true |
otp_detail.society_gate_entry | object | No | Gate OTP for gated communities (MyGate/NoBroker style vendors) |
otp_detail.delivery_otp | object | No | Customer delivery confirmation OTP |
otp_detail.return_verification_otp | object | No | OTP to verify return-to-store item receipt |
order_details.eta_details | object | No | Revised ETA/SLA timing; only editable pre-pickup |
product_details | array | No | Full replacement list of order line items |
return_received_products | array | No | Line items confirmed received back at store/warehouse |
Field Update Eligibility Window
| Field(s) | Allowed Order Status |
|---|---|
eta_details, pickup_rack_details, is_ready_for_pickup | Only while order is in a pre-pickup state (New / Assigned) |
society_gate_entry, delivery_otp | Only while order is in New / Assigned / Out-for-delivery state |
return_verification_otp | Only while order is in a return-in-progress state (RTS / In-return-process) |
product_details | Only while order is in a pre-pickup state |
return_received_products | Only once, while order is in a return-in-progress state |
Response
Code