Updates a fulfilment order. Top-level fields you omit keep their current values, with one exception: billing_address must be sent on every request, as a complete address, and becomes the order's billing address. A request without it currently fails with a server error.
An address or products list you send replaces the current one whole, so send complete addresses and the full product list.
To cancel the order, send status cancelled. The status can only change while the order is pending, problematic or wms_on_hold, so an order cannot be cancelled once picking has started.
An order can be updated while it is pending, problematic, wms_on_hold or picking_started. In any later status the update is rejected.
pre_paid when you have already taken payment, paid_on_delivery when the courier collects it.
Replaces the order's products. Each line may override catalogue values for this order. Omit it to keep the current products.
The delivery service of an order.
Send cancelled to cancel the order. The status can only change while the order is pending, problematic or wms_on_hold, and only to cancelled, pending, problematic or wms_on_hold. Any other value or transition is rejected. Omit it to leave the status unchanged.
- Productionhttps://platform-api.quiqup.com/api/fulfilment/orders/{id}
- Staginghttps://platform-api.staging.quiqup.com/api/fulfilment/orders/{id}
curl -i -X PATCH \
'https://platform-api.quiqup.com/api/fulfilment/orders/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"billing_address": {
"address1": "Villa 12, Street 4",
"address2": "Al Wasl",
"city": "Dubai",
"country_code": "AE",
"email": "sara.ahmed@example.com",
"first_name": "Sara",
"last_name": "Ahmed",
"phone": "+971500000001",
"state": "Dubai"
},
"status": "cancelled"
}'Success response
Special delivery requirements, for example customer_identification_photo.
The order id, a number sent as a string. It is the id you pass to GET and PATCH, and order.* webhooks carry the same number as payload.id.
pre_paid when you have already taken payment, paid_on_delivery when the courier collects it.
The delivery service: partner_next_day, partner_same_day, partner_4hr, partner_export, partner_store or partner_return. A return order reports partner_return.
Status of an order. pending (created, and waiting for or in the warehouse), problematic (a stock or warehouse problem that needs attention), wms_on_hold (held in the warehouse system) and picking_started occur only on fulfilment orders. From ready_for_collection the order follows the shared order lifecycle.
Why the order is in its current status, for example the warehouse error behind problematic.
{ "billing_address": { "address1": "string", "address2": "string", "city": "string", "coordinate": { … }, "country": "string", "country_code": "string", "created_at": "2019-08-24T14:15:22Z", "email": "string", "first_name": "string", "ksa_national_address": "string", "last_name": "string", "name": "string", "notes": "string", "phone": "string", "postcode": "string", "state": "string", "updated_at": "2019-08-24T14:15:22Z" }, "carrier": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "delivery_options": [ "customer_identification_photo" ], "errors": [ { … } ], "id": "string", "incoterm": "string", "initial_order_id": "string", "is_return": true, "notes": "string", "origin_address": { "address1": "string", "address2": "string", "city": "string", "coordinate": { … }, "country": "string", "country_code": "string", "created_at": "2019-08-24T14:15:22Z", "email": "string", "first_name": "string", "ksa_national_address": "string", "last_name": "string", "name": "string", "notes": "string", "phone": "string", "postcode": "string", "state": "string", "updated_at": "2019-08-24T14:15:22Z" }, "parcels": [ { … } ], "partner_order_id": "string", "payment_amount": 0, "payment_mode": "pre_paid", "picking_order_created": true, "products": [ { … } ], "references": [ { … } ], "service_kind": "string", "shipping_address": { "address1": "string", "address2": "string", "city": "string", "coordinate": { … }, "country": "string", "country_code": "string", "created_at": "2019-08-24T14:15:22Z", "email": "string", "first_name": "string", "ksa_national_address": "string", "last_name": "string", "name": "string", "notes": "string", "phone": "string", "postcode": "string", "state": "string", "updated_at": "2019-08-24T14:15:22Z" }, "status": "pending", "status_reason": "string", "tracking_url": "string", "tracking_url_advance": "string", "updated_at": "2019-08-24T14:15:22Z", "uuid": "string" }