# List Inbound Deliveries

## List All Inbound Deliveries

### 📌 Description

This endpoint retrieves all inbound deliveries for the authenticated user. You can view delivery history and track multiple deliveries across different time slots.

### 🔹 Use Cases

- Viewing delivery history for inventory management - Tracking multiple deliveries across different time slots - Monitoring delivery status for planning purposes - Auditing inbound logistics for reporting

Endpoint: GET /api/fulfilment/inbounds
Version: 1.0.0
Security: OAuth2

## Query parameters:

  - `limit` (integer)
    Maximum number of items to return per page (1-100)

  - `page` (integer)
    Page number to return (starts at 1)

  - `sort` (string)
    Field to sort results by

  - `sort_desc` (boolean)
    Sort in descending order if true

  - `state` (string)
    Filter by inbound status

  - `ids` (array)
    Filter by inbound IDs

  - `asn_id` (string)
    Filter by WMS ASN ID

## Response 200 fields (application/json):

  - `inbounds` (array, required)

  - `inbounds.asn_id` (string)

  - `inbounds.attendees` (array)

  - `inbounds.created_at` (string, required)

  - `inbounds.documents` (array)

  - `inbounds.documents.document_type` (string, required)
    Required: Type of document being uploaded

  - `inbounds.documents.file_name` (string, required)
    Required: Original filename

  - `inbounds.documents.file_size` (integer)
    Optional: File size for validation

  - `inbounds.documents.file_url` (string, required)
    Required: Accessible URL to the document

  - `inbounds.documents.mime_type` (string)
    Optional: MIME type for proper handling

  - `inbounds.error_message` (string)

  - `inbounds.id` (string, required)

  - `inbounds.items` (array)

  - `inbounds.items.batch_number` (string)

  - `inbounds.items.expiry_date` (string)

  - `inbounds.items.manufacturing_date` (string)

  - `inbounds.items.quantity` (integer, required)

  - `inbounds.items.quarantine_quantity` (integer)

  - `inbounds.items.received_qty` (integer)

  - `inbounds.items.sku` (string, required)

  - `inbounds.items.unit_price` (string)

  - `inbounds.items.unusable_quantity` (integer)

  - `inbounds.items.uom` (string)

  - `inbounds.items.uom_units` (integer)

  - `inbounds.items.updated_at` (string)

  - `inbounds.items.usable_quantity` (integer)

  - `inbounds.pickup_address` (object)

  - `inbounds.pickup_address.address1` (string, required)
    Required: Full street address

  - `inbounds.pickup_address.address2` (string)
    Optional: Building, floor, suite, etc.

  - `inbounds.pickup_address.city` (string, required)
    Required: City where pickup is located

  - `inbounds.pickup_address.coordinate` (object)
    Optional: Latitude and longitude

  - `inbounds.pickup_address.coordinate.latitude` (number, required)

  - `inbounds.pickup_address.coordinate.longitude` (number, required)

  - `inbounds.pickup_address.country` (string, required)
    Required: Full country name

  - `inbounds.pickup_address.country_code` (string, required)
    Required: Two-letter country code

  - `inbounds.pickup_address.landmark` (string)
    Optional: Nearby landmark for easier identification

  - `inbounds.pickup_address.name` (string, required)
    Required: Business name or location identifier

  - `inbounds.pickup_address.postcode` (string)
    Optional: ZIP or postal code

  - `inbounds.pickup_address.state` (string)
    Optional: State or province name

  - `inbounds.pickup_contact` (object)

  - `inbounds.pickup_contact.company` (string)
    Optional: Company the contact person works for

  - `inbounds.pickup_contact.email` (string)
    Optional: Email for additional communication

  - `inbounds.pickup_contact.instructions` (string)
    Optional: Any special instructions for the pickup

  - `inbounds.pickup_contact.name` (string, required)
    Required: Name of the person to contact

  - `inbounds.pickup_contact.phone` (string, required)
    Required: Must be in E.164 format

  - `inbounds.pickup_window` (string)

  - `inbounds.requires_collection` (boolean)

  - `inbounds.slot_end_at` (string)

  - `inbounds.slot_start_at` (string)

  - `inbounds.status` (string, required)

  - `inbounds.warehouse_code` (string, required)

  - `pagination` (object, required)

  - `pagination.next` (object)

  - `pagination.next.limit` (integer, required)

  - `pagination.next.page` (integer, required)

  - `pagination.next.sort` (string, required)

  - `pagination.next.sort_desc` (boolean, required)

  - `pagination.next_url` (string)

  - `pagination.prev` (object)

  - `pagination.prev_url` (string)

  - `pagination.total` (integer, required)

## Response default fields (application/json):

  - `code` (string)
    Error code
    Example: "not_found"

  - `details` (object)
    Error details

  - `message` (string)
    Error message