Skip to content
/
Update Inbound Delivery

Update Inbound Delivery

Request

Update an Existing Inbound Delivery

Description

This endpoint allows you to update an existing inbound delivery with courier details, gate pass information, and/or schedule a PENDING inbound.

Use Cases

  • Adding courier/gate pass details (plate number, courier name, contact) to an inbound - Attaching documents such as emirates ID, vehicle registration, or gate passes - Scheduling a PENDING inbound by providing slot times and attendees
Security
OAuth2
Path
idstringrequired
Bodyapplication/json
attendeesArray of strings(List of attendees who will be present for the delivery )

Optional: Required when slot times are provided for scheduling

courier_contactstring(Contact number of the courier or driver )

Optional: For coordination during delivery

courier_namestring(Name of the courier or driver making the delivery )

Optional: For gate pass and identification purposes

documentsArray of objects(List of documents to attach to the inbound delivery )

Optional: Supporting documents like emirates_id, vehicle_registration, gate_pass, etc.

plate_numberstring(Vehicle plate number of the courier/delivery truck )

Optional: For gate pass and security purposes

slot_end_atstring, (date-time)(End time of the delivery slot )

Optional: When provided with slot_start_at, schedules a PENDING inbound to BOOKED

slot_start_atstring, (date-time)(Start time of the delivery slot )

Optional: When provided with slot_end_at, schedules a PENDING inbound to BOOKED

curl -i -X PATCH \
  'https://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/inbounds/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "attendees": [
      "string"
    ],
    "courier_contact": "string",
    "courier_name": "string",
    "documents": [
      {
        "content_base64": "string",
        "document_type": "string",
        "file_name": "string",
        "file_size": 0,
        "file_url": "string",
        "mime_type": "string"
      }
    ],
    "plate_number": "string",
    "slot_end_at": "2019-08-24T14:15:22Z",
    "slot_start_at": "2019-08-24T14:15:22Z"
  }'

Responses

Success response

Bodyapplication/json
asn_idstring(ASN (Advance Shipment Notice) ID )
inbound_idstring(Unique identifier for the inbound booking )required
statusstring(InboundStatus represents the status of an inbound booking )required
Response
{
  "asn_id": "string",
  "inbound_id": "string",
  "status": "string"
}