<!-- Generated by scripts/generate_endpoint_docs.py — do not edit by hand. -->
# `api.jobs.form.shipments`

> `GET /job/{jobDisplayId}/form/shipments` — ACPortal

**Python**

```python
api.jobs.form.shipments(job_display_id: int) -> list[FormsShipmentPlan]
```

**CLI**

```bash
ab jobs form shipments <job_display_id>
```

List shipment plans for *job_display_id* (``GET /job/{jobDisplayId}/form/shipments``).

Returns ``List[FormsShipmentPlan]`` rather than PDF bytes -- use the
``job_shipment_id`` of a plan to drive the BOL routes below.

## Response

Returns a list of `List[FormsShipmentPlan]`.

| Field | Type | Required | Description |
|---|---|---|---|
| `shipmentPlanId` | `Optional[str]` | no | Plan identifier |
| `providerOptionIndex` | `Optional[int]` | no | Provider index |
| `carrierName` | `Optional[str]` | no | Carrier |
| `serviceType` | `Optional[str]` | no | Service level |
| `jobShipmentID` | `Optional[str]` | no | Shipment UUID |
| `jobID` | `Optional[str]` | no | Job UUID |
| `fromAddressId` | `Optional[int]` | no | Origin address ID |
| `toAddressId` | `Optional[int]` | no | Destination address ID |
| `providerID` | `Optional[str]` | no | Provider UUID |
| `sequenceNo` | `Optional[int]` | no | Sequence number |
| `fromLocationCompanyName` | `Optional[str]` | no | Origin company name |
| `toLocationCompanyName` | `Optional[str]` | no | Destination company name |
| `transportType` | `Optional[str]` | no | Transport type (PickUp, Delivery, House) |
| `providerCompanyName` | `Optional[str]` | no | Provider company name |
| `optionIndex` | `Optional[int]` | no | Option index |

---

[← Back to api.jobs](../jobs.md)