> ## Documentation Index
> Fetch the complete documentation index at: https://traddal.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# List consignments

> Retrieve a paginated list of consignments.

Requires the `consignments:read` scope.

<ParamField query="limit" type="integer" default="25">
  Number of consignments to return per page.
</ParamField>

<ParamField query="offset" type="integer" default="0">
  Number of consignments to skip.
</ParamField>

<ParamField query="q" type="string">
  Free-text search across references, parties, and barcodes.
</ParamField>

<ParamField query="status" type="string">
  Filter by consignment status.
</ParamField>

<ResponseField name="consignments" type="array">
  The page of consignments, newest first.
</ResponseField>

<ResponseField name="total" type="integer">
  Total consignments matching the filter.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://{partner}.mytraddal.com/admin/api/v1/consignments?limit=2" \
    -H 'Authorization: Bearer {access_token}'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "consignments": [
      {
        "id": "cons_01J9ZK...",
        "shipment_ref": "SHIP-1001",
        "status": "created",
        "receiver": { "city": "New York", "country_code": "US" },
        "created_at": "2026-07-19T09:12:00Z"
      }
    ],
    "total": 118
  }
  ```
</ResponseExample>