Place, edit, track, cancel, and manage hyperlocal delivery orders.
Place an order
Place a hyperlocal delivery order. Returns delivery cost and a track_url for live order tracking.
Place an order › Request Body
client_codeMerchant code shared by Shadowfax.
has_tiptip_amountPlace an order › Responses
Order placed successfully
messageEdit an order
Edit order_items and order_details only. Other fields must match the original order. Editable until the rider picks up the order.
path Parameters
sfx_order_idEdit an order › Request Body
client_codeEdit an order › Responses
Order updated successfully
messageGet order details
Cancel an order
Cancel a delivery order with a reason and the user initiating cancellation.
path Parameters
sfx_order_idCancel an order › Request Body
reasonuserCancel an order › Responses
Order cancelled
messageDispatch ready indicator
Notify Shadowfax when the shipment is ready for pickup so the rider can collect it.
path Parameters
coidClient order ID (COID)
Dispatch ready indicator › Request Body
shipment_ready_timestampUTC timestamp when shipment was ready.
Dispatch ready indicator › Responses
Dispatch ready acknowledged
messageMDND cancellation
Mark Delivered Not Delivered (MDND) — highlight orders marked delivered but not physically delivered. Always returns 200 even without request body parameters.
path Parameters
coidClient order ID (COID)
MDND cancellation › Request Body
mdi_claimedCustomer collected refund from client.
order_ratingremarksMDND cancellation › Responses
MDND claim recorded
message