This is the API documentation for the Fulfilment API.
Fulfilment API (1.0.0)
Request
This endpoint allows you to create a fulfilment order. The service_kind field determines the picking & packing SLA based on your account's cut-off times and automatically selects the appropriate delivery service with the carrier.
- partner_next_day → Next-day delivery (standard service), available in UAE & KSA.
- partner_same_day → Same-day delivery, currently only available in the UAE.
- partner_4hr → 4-hour deliveries, only available in Dubai.
- partner_export → International shipments, carrier allocation is rule-based.
Additionally, return orders can be created by setting is_return to true.
- Creating a new customer order for fulfilment.
- Processing a return order by setting
is_return: true. - Handling multi-item orders with various delivery options.
- Managing payment-on-delivery orders (
payment_mode: paid_on_delivery).
Optional: Used for internal billing reference
Optional: Used to specify which carrier should handle the delivery
Optional: Array of special delivery requirements
Optional: Used for international shipments to define delivery terms
Required only for return orders, references the original order
Optional: Set to true for return deliveries
Required: Must be unique across all orders
- Mock serverhttps://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/orders
- Productionhttps://platform-api.quiqup.com/api/fulfilment/orders
- Staginghttps://platform-api.staging.quiqup.com/api/fulfilment/orders
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/orders \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"coordinate": {
"latitude": 0,
"longitude": 0
},
"country": "string",
"country_code": "string",
"email": "string",
"first_name": "string",
"ksa_national_address": "string",
"last_name": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"state": "string"
},
"billing_identifier": "string",
"carrier": "string",
"currency": "string",
"delivery_options": [
"customer_identification_photo"
],
"incoterm": "string",
"initial_order_id": "string",
"is_return": true,
"notes": "string",
"origin_address": {
"address1": "string",
"address2": "string",
"city": "string",
"coordinate": {
"latitude": 0,
"longitude": 0
},
"country": "string",
"country_code": "string",
"email": "string",
"first_name": "string",
"ksa_national_address": "string",
"last_name": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"state": "string"
},
"partner_order_id": "string",
"payment_amount": 0,
"payment_mode": "pre_paid",
"products": [
{
"quantity": 0,
"sku": "string"
}
],
"service_kind": "partner_next_day",
"shipping_address": {
"address1": "string",
"address2": "string",
"city": "string",
"coordinate": {
"latitude": 0,
"longitude": 0
},
"country": "string",
"country_code": "string",
"email": "string",
"first_name": "string",
"ksa_national_address": "string",
"last_name": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"state": "string"
}
}'Success response
Possible values: leave_at_door, customer_identification_photo
Possible values: partner_next_day, partner_same_day, partner_4hr, partner_export, partner_store
{ "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", "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", "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": [ { … } ], "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", "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" }
Request
This endpoint retrieves the details of an existing fulfilment order using its unique ID.
- Checking the status of a previously created fulfilment order.
- Retrieving tracking details to share with customers.
- Confirming order information before dispatch or customer communication.
- Verifying payment and service type for an order.
- Mock serverhttps://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/orders/{id}
- Productionhttps://platform-api.quiqup.com/api/fulfilment/orders/{id}
- Staginghttps://platform-api.staging.quiqup.com/api/fulfilment/orders/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/orders/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Success response
Possible values: leave_at_door, customer_identification_photo
Possible values: partner_next_day, partner_same_day, partner_4hr, partner_export, partner_store
{ "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", "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", "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": [ { … } ], "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", "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" }
Request
This endpoint allows you to update an existing fulfilment order. Depending on the current order status, some fields may not be modifiable.
For example:
- If the order is already out for delivery, the shipping address cannot be changed.
- If the order has been picked and packed, modifications to products are no longer possible.
- Orders that are cancelled or completed cannot be updated.
- Updating the shipping address before the order is dispatched.
- Modifying payment details before dispatched.
- Adjusting product quantities before fulfilment begins.
- Cancelling an order if it has not yet been picked and packed.
Optional: Used to specify which carrier should handle the delivery
Optional: Used for international shipments to define delivery terms
For updates, products can include additional fields to override catalog values
Optional: If not provided, uses the value from the product catalog
Optional: If not provided, uses the value from the product catalog
Optional: If not provided, uses the value from the product catalog
Required: Must be at least 1 Minimum value: 1
Optional: If not provided, uses the price from the product catalog
Required: Must be a valid SKU from your product catalog Maximum length: 100 characters
Optional: If not provided, uses the value from the product catalog
- Mock serverhttps://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/orders/{id}
- Productionhttps://platform-api.quiqup.com/api/fulfilment/orders/{id}
- Staginghttps://platform-api.staging.quiqup.com/api/fulfilment/orders/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/orders/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"coordinate": {
"latitude": 0,
"longitude": 0
},
"country": "string",
"country_code": "string",
"email": "string",
"first_name": "string",
"ksa_national_address": "string",
"last_name": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"state": "string"
},
"carrier": "string",
"incoterm": "string",
"origin_address": {
"address1": "string",
"address2": "string",
"city": "string",
"coordinate": {
"latitude": 0,
"longitude": 0
},
"country": "string",
"country_code": "string",
"email": "string",
"first_name": "string",
"ksa_national_address": "string",
"last_name": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"state": "string"
},
"payment_amount": 0,
"payment_mode": "pre_paid",
"products": [
{
"country_of_origin": "string",
"dimensions": {
"height": 0,
"length": 0,
"unit": "string",
"width": 0
},
"hs_code": "string",
"quantity": 0,
"selling_price": 0,
"sku": "string",
"weight": 0,
"weight_unit": "string"
}
],
"service_kind": "partner_next_day",
"shipping_address": {
"address1": "string",
"address2": "string",
"city": "string",
"coordinate": {
"latitude": 0,
"longitude": 0
},
"country": "string",
"country_code": "string",
"email": "string",
"first_name": "string",
"ksa_national_address": "string",
"last_name": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"state": "string"
},
"status": "string"
}'Success response
Possible values: leave_at_door, customer_identification_photo
Possible values: partner_next_day, partner_same_day, partner_4hr, partner_export, partner_store
{ "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", "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", "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": [ { … } ], "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", "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" }