Skip to content

Book Inbound Delivery

Request

Book an Inbound Delivery

📌 Description

This endpoint allows you to book an inbound delivery to a warehouse. The system handles the complete lifecycle of inbound deliveries from booking to goods receipt.

🔹 Use Cases

  • Scheduling warehouse deliveries for inventory restocking - Booking collection slots for pickup from suppliers - Managing inbound logistics with proper documentation - Tracking delivery status through the fulfillment system

📋 Required Information

  • Time Slot: Start and end times for the delivery window - Attendees: List of people who will be present for the delivery - Items: List of products being delivered with quantities

Note: The warehouse is automatically determined from your account's facility configuration.

📄 Optional Information

  • Pickup Details: If collection is required from a supplier - Documents: Supporting files like invoices or manifests - Custom Labels: Human-readable slot identifiers
Security
OAuth2
Bodyapplication/json
attendeesArray of strings(List of attendees who will be present for the delivery )

Optional: Required when slot times are provided. At least one attendee must be specified.

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 related to the delivery )

Optional: Supporting documents like invoices, manifests, etc.

itemsArray of objects(List of items being delivered )required

Required: At least one item must be specified

partner_inbound_idstring(Client-provided reference ID for the inbound delivery. )

Strongly recommended for unscheduled (PENDING) inbounds — without it, each retry or double-submit creates a separate inbound with its own ASN sequence. For scheduled inbounds, duplicates are prevented by the slot time combination.

pickup_addressobject(PickupAddress represents the pickup location for collection )
pickup_contactobject(PickupContact represents the contact person for pickup )
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, must be after slot_start_at. Required when slot_start_at is provided.

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

Optional: When provided, must be a valid future timestamp. If omitted, the inbound is created as PENDING.

typestring(Type of inbound: "inbound" (default), "client_return", or "facility_return" )

Optional: Defaults to "inbound" if not specified

curl -i -X POST \
  https://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/inbound/book \
  -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"
      }
    ],
    "items": [
      {
        "batch_number": "string",
        "expiry_date": "2019-08-24T14:15:22Z",
        "manufacturing_date": "2019-08-24T14:15:22Z",
        "original_order_ids": [
          "string"
        ],
        "quantity": 0,
        "sku": "string",
        "unit_price": 0,
        "uom": "string",
        "uom_units": 0
      }
    ],
    "partner_inbound_id": "string",
    "pickup_address": {
      "address1": "string",
      "address2": "string",
      "city": "string",
      "coordinate": {
        "latitude": 0,
        "longitude": 0
      },
      "country": "string",
      "country_code": "string",
      "landmark": "string",
      "name": "string",
      "postcode": "string",
      "state": "string"
    },
    "pickup_contact": {
      "company": "string",
      "email": "string",
      "instructions": "string",
      "name": "string",
      "phone": "string"
    },
    "plate_number": "string",
    "slot_end_at": "2019-08-24T14:15:22Z",
    "slot_start_at": "2019-08-24T14:15:22Z",
    "type": "string"
  }'

Responses

Success response

Bodyapplication/json
already_existedboolean(Indicates if an inbound with the same unique fields (client_id, warehouse_code, time slots) already existed )

Optional: True when returning an existing inbound instead of creating a new one

asn_idstring(ASN (Advance Shipment Notice) ID )

Optional: Generated ASN ID for warehouse systems

inbound_idstring(Unique identifier for the inbound booking )required

Generated by the system

statusstring(InboundStatus represents the status of an inbound booking )required
Response
{
  "already_existed": true,
  "asn_id": "string",
  "inbound_id": "string",
  "status": "string"
}