Get Order

Request

Get a Fulfilment Order by ID

📌 Description

This endpoint retrieves the details of an existing fulfilment order using its unique ID.

🔹 Use Cases

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.

Security

OAuth2

Path

idstringrequired

curl -i -X GET \
  'https://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

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"
}