Skip to content

Create Order

Request

Create a Fulfilment Order

📌 Description

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.

Available Service Kinds:

  • 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.

🔹 Use Cases

  • 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).
Security
OAuth2
Bodyapplication/json
billing_addressobject(types.AddressRequest)
billing_identifierstring(BillingIdentifier is a custom identifier for billing purposes )

Optional: Used for internal billing reference

carrierstring(Carrier specifies the delivery carrier for the order )

Optional: Used to specify which carrier should handle the delivery

currencystring(Currency is the 3-letter ISO currency code for the order (e.g., AED) )required
delivery_optionsArray of strings(DeliveryOptions specifies special delivery instructions )

Optional: Array of special delivery requirements

Items Value:"customer_identification_photo"
incotermstring(Incoterm specifies the international commercial terms for the order )

Optional: Used for international shipments to define delivery terms

initial_order_idstring(InitialOrderID references the original order for return deliveries )

Optional: When provided for return orders, the original order will be validated

is_returnboolean(IsReturn indicates if this is a return order )

Optional: Set to true for return deliveries

mark_as_ready_for_collectionboolean(MarkAsReadyForCollection indicates if the order should be automatically marked as ready for collection )

Optional: Only applicable for return orders (is_return=true). When set to true, the order will be created with "ready_for_collection" status instead of "pending"

notesstring(Notes contains any additional delivery instructions )

Optional: Maximum 255 characters

origin_addressobject(types.AddressRequest)required
partner_order_idstring(PartnerOrderID is your unique reference for the order )required

Required: Must be unique across all orders

payment_amountnumber(PaymentAmount is the total amount to be collected from the customer )required
payment_modestring(types.PaymentMode)required
Enum:"pre_paid""paid_on_delivery"
productsArray of objects(Products is an array of products to be delivered )
referencesArray of objects(References lets you attach your own external identifiers (label/value pairs) to the )

order, e.g. a marketplace order id. Set is_unique=true on a reference to prevent another order on your account from reusing the same label+value. Optional.

registration_numbersArray of objects(RegistrationNumbers contains customs/VAT registration numbers (e.g., Mirsal 2 VAT code) )

Optional: Used for customs clearance in international shipments

service_kindstring(ServiceKind represents the type of delivery service )required
Enum:"partner_next_day""partner_same_day""partner_4hr""partner_export""partner_store""partner_return"
shipping_addressobject(types.AddressRequest)required
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",
      "notes": "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,
    "mark_as_ready_for_collection": 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",
      "notes": "string",
      "phone": "string",
      "postcode": "string",
      "state": "string"
    },
    "partner_order_id": "string",
    "payment_amount": 0,
    "payment_mode": "pre_paid",
    "products": [
      {
        "barcode": "string",
        "dangerous_goods": true,
        "quantity": 0,
        "sku": "string"
      }
    ],
    "references": [
      {
        "is_unique": true,
        "label": "string",
        "value": "string"
      }
    ],
    "registration_numbers": [
      {
        "issuer_country_code": "string",
        "type_code": "string",
        "value": "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",
      "notes": "string",
      "phone": "string",
      "postcode": "string",
      "state": "string"
    }
  }'

Responses

Success response

Bodyapplication/json
billing_addressobject(types.CreateFulfilmentOrderAddressResponse)
carrierstring(Delivery carrier for the order )
created_atstring, (date-time)(Timestamp when the order was created )
currencystring(3-letter ISO currency code (e.g., AED, SAR) )
delivery_optionsArray of strings(Special delivery requirements )

Possible values: leave_at_door, customer_identification_photo

Items Value:"customer_identification_photo"
errorsArray of objects(Array of error messages if any issues occurred )
idstring(Unique identifier for the fulfilment order )
incotermstring(International commercial terms for the order )
initial_order_idstring(Reference to the original order ID for returns )
is_returnboolean(Indicates if this is a return order )
notesstring(Additional delivery instructions or comments )
origin_addressobject(types.CreateFulfilmentOrderAddressResponse)
parcelsArray of objects(List of parcels associated with the order )
partner_order_idstring(Your unique reference for the order )
payment_amountnumber(Total amount to be collected from the customer )
payment_modestring(types.PaymentMode)
Enum:"pre_paid""paid_on_delivery"
picking_order_createdboolean(Indicates if a picking order has been created )
productsArray of objects(List of products included in the order )
referencesArray of objects(External identifiers attached to the order at creation (label/value pairs). )

Echoes back whatever was sent in the create request's `references`.

service_kindstring(Type of delivery service requested )

Possible values: partner_next_day, partner_same_day, partner_4hr, partner_export, partner_store

shipping_addressobject(types.CreateFulfilmentOrderAddressResponse)
statusstring(OrderStatus represents the possible states of an order )
Enum:"pending""ready_for_collection""picking_started""out_for_collection""out_for_return""at_depot""received_at_depot""in_transit""out_for_delivery""collection_failed"
status_reasonstring(Reason for the current status (e.g., why an order was cancelled) )
tracking_urlstring(URL for basic order tracking )
tracking_url_advancestring(URL for advanced order tracking with more details )
updated_atstring, (date-time)(Timestamp when the order was last updated )
uuidstring(UUID of the fulfilment order )
Response
{
  "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"
}