Skip to content
Last-mile
/
/
Cancel orders

Cancel orders

Request

This endpoint cancels orders that are pending or ready_for_collection. Once a courier is on the way to collect, from out_for_collection onwards, it refuses; cancel those in Quiqdash.

Call this endpoint with PUT, you can pass an array of order IDs.

Security
bearerToken or oauthToken
Bodyapplication/json
order_idsArray of any
curl -i -X PUT \
  https://api.staging.quiqup.com/orders/batch/set_cancelled \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_ids": [
      null
    ]
  }'

Responses

The orders that were cancelled.

Bodyapplication/json
Array [
allowed_payment_typesArray of strings
billing_identifierany
brand_namestring
collection_timeobject
created_atstring
delivery_attemptsinteger
delivery_failure_reasonany
destinationobject
display_items_infoboolean
idinteger
item_quantity_countinteger
itemsArray of objects
kindstring
missionany
originobject
partner_order_idstring
payment_amountstring
payment_modestring
region_namestring
required_documentsArray of objects
scheduled_forany
service_kindstring
sku_infoany
statestring
state_updated_atstring
submitted_atstring
tracking_urlstring
userobject
uuidstring
]
Response
[
  {
    "allowed_payment_types": [ … ],
    "brand_name": "Example Brand",
    "collection_time": {},
    "created_at": "2022-11-25T17:57:46.000+04:00",
    "delivery_attempts": 0,
    "destination": { … },
    "display_items_info": false,
    "id": 10000002,
    "item_quantity_count": 1,
    "items": [ … ],
    "kind": "partner_same_day",
    "origin": { … },
    "partner_order_id": "PARTNER-ORDER-ID",
    "payment_amount": "10.0",
    "payment_mode": "paid_on_delivery",
    "region_name": "Dubai",
    "required_documents": [],
    "service_kind": "partner_same_day",
    "state": "cancelled",
    "state_updated_at": "2022-12-08T17:45:14.000+04:00",
    "submitted_at": "2022-11-25T17:57:46.000+04:00",
    "tracking_url": "https://track-parcel.staging.quiqup.com/00000000-0000-4000-8000-000000000002",
    "user": { … },
    "uuid": "00000000-0000-4000-8000-000000000002"
  }
]