# List the packages of a shipment

```http
GET https://secure.yoprint.com/v2/api/store/{team_slug}/v2/shipment/{hash_id}/packages
```

- API version: v2
- Operation ID: `v2_public_shipment_package_index`
- Section: Shipping › [Shipment packages](https://developer.yoprint.com/reference/shipment-packages.md)
- Web page: https://developer.yoprint.com/reference/shipment-packages/v2-shipment-package-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Returns every package of a shipment: Shippo labels, labels recorded from elsewhere, and single labels. Each has its carrier, service, tracking number, size, weight, `charges` (in thousandths: 12.40 is 12400; on a multi-parcel label every package repeats the full amount, so read the master's), `status` and, for Shippo, the label file. Not paged.

The path takes the shipment's hash id; unique keys don't work here. A value that isn't a hash id gives 404, but a hash id that isn't one of your shipments answers 200 with an empty list.

## Permission

Any member of the team.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The shipment's hash id (`id`). Hash ids only: a unique key or a document number gives 404. Example `MQyJUnd3oty75h`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v2/api/store/your-team/v2/shipment/MQyJUnd3oty75h/packages' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `charges` (integer | number | string | null, optional): The label cost. For a multi-parcel label every package repeats the rate's full amount: read the master's value and don't add packages up. Null for external labels. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).
    - `created_at` (string (date-time), optional)
    - `from_address` (any, optional): The address record behind `from_address_id`, or null when it is not set.
    - `from_address_id` (string | null, optional): Older packages only: the ship-from address record; null otherwise.
    - `goshippo` (object, optional): Shippo labels only: the Shippo details (shipment, rate, carrier, addresses, parcels).
      - `address_from` (any, optional): The ship-from address sent to Shippo.
      - `address_return` (any, optional): The return address sent to Shippo.
      - `address_to` (any, optional): The ship-to address sent to Shippo.
      - `carrier_id` (string | null, optional): The Shippo carrier account.
      - `parcel_id` (string | null, optional): The Shippo parcel.
      - `parcels` (any, optional): The parcels of the Shippo shipment.
      - `provider` (string | null, optional)
      - `provider_image_200` (string | null, optional)
      - `provider_image_75` (string | null, optional)
      - `provider_tracking_number` (string | null, optional)
      - `rate_id` (string | null, optional): The Shippo rate bought.
      - `shipment_data` (any, optional): The Shippo shipment the rate came from.
      - `shipment_id` (string | null, optional): The Shippo shipment.
    - `height` (number | string | null, optional): Parcel size and weight as stored, in `length_unit` and `weight_unit`. Null for external labels.
    - `id` (string, optional): The package.
    - `is_master` (boolean, optional): The first package of a label (the others have `parent_id`).
    - `length` (number | string | null, optional)
    - `length_unit` (string | null, optional): Shippo labels only, upper case.
    - `order_external_ids` (array of objects, optional): The order's links to external systems.
    - `order_external_type` (string | null, optional): `shopify` when the order came from Shopify.
    - `order_id` (string, optional): The order.
    - `order_object_type` (string | null, optional)
    - `order_quote` (boolean, optional)
    - `order_scoped_id` (string | null, optional)
    - `parent_id` (string | null, optional): The master package, for the other parcels of a multi-parcel label.
    - `pdf` (array of objects, optional): Not on external labels: the label file. `label` and `description` are fixed texts that always say 4 x 6, whatever your label size setting.
      - Each item:
        - `description` (string, optional)
        - `label` (string, optional)
        - `url` (string, optional): For a Shippo label, Shippo's signed link to the label file: don't publish it.
    - `provider_name` (string | null, optional): The carrier.
    - `provider_saturday_delivery` (boolean, optional): Shippo labels only (absent on external labels); always false today.
    - `provider_service_code` (string | null, optional): For external labels, `ups`, `fedex` or `other`. For Shippo labels it may be null: read the service from `provider_service_name`.
    - `provider_service_name` (string | null, optional)
    - `provider_shipment_id` (string | null, optional): The Shippo transaction id (Shippo labels).
    - `provider_tracking_number` (string | null, optional)
    - `shipment_external_type` (string | null, optional): `shopify` when the shipment is linked to Shopify.
    - `shipment_has_third_party_fulfilled_items` (boolean, optional)
    - `shipment_id` (string, optional): The shipment.
    - `shipment_scoped_id` (string, optional)
    - `shipment_shopify_sync` (any, optional): Shopify sync state of the shipment.
    - `status` (string, optional): One of: `"pending"`, `"ready-to-ship"`, `"shipped"`, `"delivered"`.
    - `to_address` (any, optional): The address record behind `to_address_id`, or null when it is not set.
    - `to_address_id` (string | null, optional): Older packages only: the ship-to address record; null otherwise.
    - `type` (string, optional): `goshippo` a label bought through Shippo; `external_label` a label recorded from elsewhere. One of: `"goshippo"`, `"external_label"`, `"single_label"`.
    - `weight` (number | string | null, optional)
    - `weight_unit` (string | null, optional): Shippo labels only, upper case.
    - `width` (number | string | null, optional)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": [
    {
      "charges": 12400,
      "created_at": "2026-11-03T15:00:00+00:00",
      "goshippo": {
        "parcels": [
          {
            "distance_unit": "in",
            "height": "4",
            "length": "12",
            "mass_unit": "lb",
            "weight": "2",
            "width": "10"
          }
        ],
        "provider": "USPS",
        "rate_id": "rate_0001"
      },
      "height": "4",
      "id": "o6foWpSAayc79D",
      "is_master": true,
      "length": "12",
      "length_unit": "IN",
      "order_id": "sFbALVSYD55eXe",
      "order_object_type": "sales_order",
      "order_quote": false,
      "order_scoped_id": "SO1001",
      "parent_id": null,
      "pdf": [
        {
          "description": "Postage label individually to be printed 4\" x 6\" label",
          "label": "Postage Label (4 in x 6 in label)",
          "url": "https://example.com/labels/o6foWpSAayc79D.pdf"
        }
      ],
      "provider_name": "USPS",
      "provider_saturday_delivery": false,
      "provider_service_code": null,
      "provider_service_name": "Ground Advantage",
      "provider_shipment_id": "transaction_0001",
      "provider_tracking_number": "9400100000000000000000",
      "shipment_has_third_party_fulfilled_items": false,
      "shipment_id": "MQyJUnd3oty75h",
      "shipment_scoped_id": "SHIP-12",
      "status": "pending",
      "type": "goshippo",
      "weight": "2",
      "weight_unit": "LB",
      "width": "10"
    }
  ],
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: The value isn't a hash id (a unique key or a document number, for example). A hash id that isn't one of your shipments answers 200 with `[]` instead. Fix: Use the shipment's `id`, and treat an empty list as "check the id".

## Notes

- A Shippo label's `pdf` URL is Shippo's signed link to the file: don't publish it.

## Related

- [Get a package](https://developer.yoprint.com/reference/shipment-packages/v2-shipment-package-show.md): `GET /v2/api/store/{team_slug}/v2/shipment_package/{hash_id}`
- [Buy a shipping label (charges your Shippo account)](https://developer.yoprint.com/reference/shipping-labels/v2-shipment-label-create-goshippo.md): `POST /v2/api/store/{team_slug}/v2/shipment/{hash_id}/label/goshippo`
- [Download labels as one PDF](https://developer.yoprint.com/reference/shipping-labels/v2-shipment-label-compile-goshippo.md): `POST /v2/api/store/{team_slug}/v2/shipment_package/labels/compile`