## Retrieves a paginated list of delivery orders.

`deliveries.list_deliveries(DeliveryListDeliveriesParams**kwargs)  -> DeliveryListDeliveriesResponse`

**get** `/api/v2/public/orders/deliveries`

Retrieves a paginated list of delivery orders.

### Parameters

- `delivery_date: Optional[str]`

  Filter by delivery date.

- `group_code: Optional[str]`

  Filter by group code.

- `is_submitted: Optional[bool]`

  Filter by submission status.

- `last_modified_date: Optional[str]`

  Filter by last modified date.

- `order_number: Optional[str]`

  Filter by order number.

- `page_size: Optional[str]`

- `page_start: Optional[str]`

- `secondary_order_number: Optional[str]`

  Filter by secondary order number.

- `status: Optional[str]`

  Filter by order status.

- `store_number: Optional[str]`

  Filter by store number.

- `supplier_code: Optional[str]`

  Filter by supplier code.

- `supplier_name: Optional[str]`

  Filter by supplier name.

### Returns

- `class DeliveryListDeliveriesResponse: …`

  Generic paginated response wrapper.

  - `page_size: int`

    Maximum number of items returned per page.

  - `page_start: int`

    Current page number (1-based).

  - `total_count: int`

    Total number of records matching the query across all pages.

  - `list: Optional[List[List]]`

    Collection of items for the current page.

    - `datetime_created: datetime`

    - `datetime_expected: datetime`

    - `import_id: int`

    - `is_downloaded: bool`

    - `updated_on: datetime`

    - `external_reference_number: Optional[str]`

    - `no_of_containers: Optional[int]`

    - `order_lines: Optional[List[ListOrderLine]]`

      - `line_number: int`

      - `quantity: float`

      - `received_quantity: float`

      - `target_stock_pool: int`

      - `barcode: Optional[str]`

      - `base_unit: Optional[str]`

      - `category_code: Optional[str]`

      - `container_barcode: Optional[str]`

      - `customer_order_number: Optional[str]`

      - `customer_order_shipment_number: Optional[str]`

      - `customer_order_shipment_number_line_number: Optional[int]`

      - `description: Optional[str]`

      - `group_code: Optional[str]`

      - `product_number: Optional[str]`

      - `purchase_unit_barcode: Optional[str]`

      - `purchase_unit_product_number: Optional[str]`

      - `purchase_unit_quantity: Optional[float]`

      - `rounded_quantity: Optional[float]`

      - `secondary_order_number: Optional[str]`

    - `order_number: Optional[str]`

    - `order_type: Optional[str]`

    - `status: Optional[str]`

    - `store_gln: Optional[str]`

    - `store_number: Optional[str]`

    - `store_origin: Optional[str]`

    - `supplier_code: Optional[str]`

    - `supplier_name: Optional[str]`

    - `tracing_url: Optional[str]`

  - `list_body: Optional[Dict[str, Optional[object]]]`

    Additional body-level metadata for the list.

  - `list_filters: Optional[Dict[str, Optional[List[str]]]]`

    Active filter criteria applied to the result set, keyed by field name.

  - `next_page: Optional[int]`

    Next page number, or null when on the last page.

  - `previous_page: Optional[int]`

    Previous page number, or null when on the first page.

  - `project_last_modified_date: Optional[str]`

    Last modified date/time of the project.

  - `scroll_id: Optional[str]`

    Opaque scroll identifier for deep-pagination scenarios.

  - `server_time: Optional[str]`

    Server UTC date/time when the response was generated.

  - `sort_column: Optional[str]`

    Column name the results are sorted by.

  - `sort_order: Optional[str]`

    Sort direction (asc or desc).

  - `task_last_modified_date: Optional[str]`

    Last modified date/time of the task.

### Example

```python
import os
from colleqtive_sdk import Colleqtive

client = Colleqtive(
    bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"),  # This is the default and can be omitted
)
response = client.deliveries.list_deliveries()
print(response.scroll_id)
```

#### Response

```json
{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "import_id": 0,
      "is_downloaded": true,
      "updated_on": "2019-12-27T18:11:19.117Z",
      "external_reference_number": "external_reference_number",
      "no_of_containers": 0,
      "order_lines": [
        {
          "line_number": 0,
          "quantity": 0,
          "received_quantity": 0,
          "target_stock_pool": 0,
          "barcode": "barcode",
          "base_unit": "base_unit",
          "category_code": "category_code",
          "container_barcode": "container_barcode",
          "customer_order_number": "customer_order_number",
          "customer_order_shipment_number": "customer_order_shipment_number",
          "customer_order_shipment_number_line_number": 0,
          "description": "description",
          "group_code": "group_code",
          "product_number": "product_number",
          "purchase_unit_barcode": "purchase_unit_barcode",
          "purchase_unit_product_number": "purchase_unit_product_number",
          "purchase_unit_quantity": 0,
          "rounded_quantity": 0,
          "secondary_order_number": "secondary_order_number"
        }
      ],
      "order_number": "order_number",
      "order_type": "order_type",
      "status": "status",
      "store_gln": "store_gln",
      "store_number": "store_number",
      "store_origin": "store_origin",
      "supplier_code": "supplier_code",
      "supplier_name": "supplier_name",
      "tracing_url": "tracing_url"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}
```