Authentication
Path parameter
Editability rules
Request body
Send the same fields asPOST /orders. All fields are re-validated on update, so include the complete desired state rather than only the changed fields.
string
required
Customer’s full name.
string
required
Customer’s primary phone number.
string
Secondary / alternative phone number.
string
required
Customer’s street address.
string
Building number.
string
Apartment number.
string
required
Destination governorate. Accepted values:
Cairo, Giza, or Qalyubia.string
required
Exact zone string from
GET /delivery-zones (e.g. "Nasr City - ElHay 06 (Nasr City)").string
required
Type of shipment:
Deliver, Return, or Exchange.boolean
Set to
true if the delivery address is a workplace rather than a residence.boolean
When
true, the customer may inspect contents before accepting delivery.string
Updated notes for the courier.
string
Your platform’s internal order reference.
string
Merchant pickup address ID override.
Deliver-specific fields
string
Updated product description. Required for
Deliver orders.number
Updated item count. Required for
Deliver orders (positive integer).boolean
Express delivery flag. Cannot be changed for orders older than 6 hours.
boolean
Cash on delivery flag.
number
COD amount in EGP when
COD is true.Return-specific fields
string
Description of the product(s) being returned. Required for
Return orders.number
Number of items being returned. Required for
Return orders.string
The
orderNumber of the completed Deliver order this return is raised against. Required for Return orders.string
Reason for the return. Required for
Return orders.string
Additional notes about the return for the courier.
boolean
Set to
true when only some items from the original order are being returned.number
Number of items being returned. Required when
isPartialReturn is true.number
Total number of items in the original deliver order. Optional — used for reference.
Exchange-specific fields
string
Description of the product the customer currently holds (being collected). Required for
Exchange orders.number
Number of items being collected from the customer. Required for
Exchange orders.string
Description of the replacement product being delivered. Required for
Exchange orders.number
Number of replacement items being delivered. Required for
Exchange orders.boolean
Set to
true when a cash difference needs to be collected or refunded during the exchange.number
Cash difference amount in EGP when
CashDifference is true.Request
Response
200 — Order updated
The response returns the updated order object with the newly recomputedorderFees.
