# List shipments (paginated, filterable)

Returns a paginated list of shipments for the authenticated caller's organization. Supports filtering by status (multi-valued), gate (by UUID or external id), free-text, and three independent date ranges (created, activated, closed). Null-date semantics: when any bound is supplied on activateDate or closeDate, shipments whose corresponding date field is null are excluded.

Endpoint: GET /integration/rest/api/v1/shipment
Version: v0
Security: X-AUTH-KEY

## Query parameters:

  - `statuses` (array)
    Filter by shipment status (multi-valued).
    Enum: "PLANNED", "TO_DO", "IN_PROGRESS", "COMPLETED", "CANCELLED"

  - `gate` (string)
    Filter by gate identifier (accepts external id or uuid).

  - `activateDateAfter` (integer)
    Activated-date range lower bound (epoch millis, inclusive). Shipments with null activateDate are excluded when any bound is supplied.

  - `activateDateBefore` (integer)
    Activated-date range upper bound (epoch millis, inclusive).

  - `closeDateAfter` (integer)
    Closed-date range lower bound (epoch millis, inclusive). Shipments with null closeDate are excluded when any bound is supplied.

  - `closeDateBefore` (integer)
    Closed-date range upper bound (epoch millis, inclusive).

  - `q` (string)

  - `createDateAfter` (integer)

  - `createDateBefore` (integer)

  - `pageNumber` (integer)
    Page number (1-based)

  - `pageSize` (integer)
    Page size

  - `sort.sortBy` (string)
    Sorting field

  - `sort.direction` (string)
    Sorting direction
    Enum: "ASC", "DESC"

## Response 200 fields (*/*):

  - `content` (array)

  - `content.createDate` (string)

  - `content.updateDate` (string)

  - `content.deepLink` (string)
    Deep link URL to open this entity in Ops.App.

  - `content.externalIdentifier` (string)
    Caller-assigned external identifier, unique per organization within the Shipment namespace.

  - `content.status` (string)
    Lifecycle status of the shipment.
    Enum: "PLANNED", "TO_DO", "IN_PROGRESS", "COMPLETED", "CANCELLED"

  - `content.gate` (object)
    Gate currently assigned to the shipment, if any.

  - `content.gate.name` (string)
    Human-readable gate name.

  - `content.gate.externalIdentifier` (string)
    External unique identifier of the gate.

  - `content.gate.status` (string)
    Current operational status of the gate.
    Enum: "AVAILABLE", "LOADING", "OUT_OF_SERVICE"

  - `content.gate.gateType` (string)
    Gate type. SINGLE_MANIFEST allows one active manifest at a time; MULTI_MANIFEST allows several manifests active simultaneously.
    Enum: "SINGLE_MANIFEST", "MULTI_MANIFEST"

  - `content.manifests` (array)
    Manifests currently attached to the shipment.

  - `content.manifests.uuid` (string)
    Internal manifest identifier (uuid).

  - `content.manifests.externalIdentifier` (string)
    Caller-assigned manifest external identifier, if any.

  - `content.manifests.manifestStatus` (string)
    Current manifest status.
    Enum: "PLANNED", "TO_DO", "IN_PROGRESS", "COMPLETED", "CANCELLED"

  - `content.tracksCount` (integer)
    Planning view: total tracks (assets) currently included across this shipment's manifests, regardless of loading state. For Total/Loaded execution counts use totalAssetsCount and loadedAssetsCount.

  - `content.totalAssetsCount` (integer)
    Total assets attached to the shipment, excluding invalid loadings (WRONGLY_LOADED, UNKNOWN_LOADING) and records belonging to cancelled manifests.

  - `content.loadedAssetsCount` (integer)
    Successfully loaded assets, excluding invalid loadings and records belonging to cancelled manifests.

  - `content.notes` (string)
    Optional free-text notes.

  - `content.activateDate` (string)
    Timestamp when the shipment transitioned to IN_PROGRESS, null if not yet activated.

  - `content.closeDate` (string)
    Timestamp when the shipment transitioned to a terminal status (COMPLETED or CANCELLED), null if still active.

  - `content.deleted` (boolean)
    Soft-delete flag. Deleted shipments are excluded from list and get endpoints.

  - `content.customFields` (array)
    Custom field values set on this shipment. Omitted when the organization's dispatch strategy is not SHIPMENT.

  - `content.customFields.fieldKey` (string, required)
    Unique key (name) of the custom field. This must match the configured field name.

  - `content.customFields.fieldValue` (string)
    Value of the custom field as a string. For numeric fields, send the number as a string.

  - `pageRequest` (object)

  - `pageRequest.pageNumber` (integer)

  - `pageRequest.pageSize` (integer)

  - `pageRequest.sort` (object)

  - `pageRequest.sort.sortBy` (string)

  - `pageRequest.sort.direction` (string)
    Enum: "ASC", "DESC"

  - `totalElements` (integer)

## Response 400 fields (*/*):

  - `code` (string)
    Error code

  - `message` (string)
    Error message

  - `timeStamp` (integer)
    Timestamp

  - `correlationId` (string)
    Correlation id

## Response 403 fields (*/*):

  - `code` (string)
    Error code

  - `message` (string)
    Error message

  - `timeStamp` (integer)
    Timestamp

  - `correlationId` (string)
    Correlation id

## Response 500 fields (*/*):

  - `code` (string)
    Error code

  - `message` (string)
    Error message

  - `timeStamp` (integer)
    Timestamp

  - `correlationId` (string)
    Correlation id