# List the lines of a shipment ```http GET https://secure.yoprint.com/v2/api/store/{team_slug}/v2/shipment/{unique_key}/item ``` - API version: v2 - Operation ID: `v2_public_shipment_item_index` - Section: Shipping › [Shipment line items](https://developer.yoprint.com/reference/shipment-line-items.md) - Web page: https://developer.yoprint.com/reference/shipment-line-items/v2-shipment-item-index/ - Authentication: `Authorization: Bearer YOUR_API_KEY` Returns every line of a shipment: shipped order lines and shipping cost lines. Not paged; sort by `position`. | `product.type` | What it is | | --- | --- | | `order_item` | Ships a quantity of a line of the same order (any kind of product line, or a fee). | | `shipment_cost` | A shipping cost line (Shipping Cost in the web app), with its own price, optionally tied to a package or an estimate. | ## 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`. - `unique_key` (string, required): The shipment's `id` (a hash id), as its answers show it. Its unique key (`shp_...`) also works, but API answers don't include it. 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/item' \ -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: - `_meta` (object, optional): Read-only details of the line. - `auto_invoice_managed` (boolean, optional) - `billable_fee_total` (decimal pair, optional): Shipping cost lines only: what is billed (after override, markup or margin); `pricing.product_cost.total` is the cost. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 1250, "dp": 2 }` is 12.50). Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md. - `external_ids` (array of objects, optional): Links to external systems; usually empty. - `external_type` (string | null, optional) - `from_legacy` (boolean, optional) - `id` (string, optional): The shipment line. - `is_external` (boolean, optional) - `lock_version` (integer, optional): Returned but not checked on shipment lines. - `position` (integer, optional) - `pricing` (object, optional): For `system`, `_meta.unit_price` is the order line's unit price and `_meta.subtotal` is that price × this shipment line's quantity (`_meta.total` is always 0); for `shipment_cost`, `product_cost` has `override` (always true for lines saved through the API), `total` (the cost), `pricing_mode` and `pricing_mode_total` (decimal pairs at 6 decimal places). - `type` (string, optional): One of: `"system"`, `"shipment_cost"`. - `product` (object, optional) - `_meta` (object, optional): Read-only details; for `order_item`, `parent` describes the order line. - `properties` (object, optional): For `order_item`, `id` is the order line; for `shipment_cost`, `name`, `description`, `shipment_package_id`, `shipment_estimate_id`. - `type` (string, optional): One of: `"order_item"`, `"shipment_cost"`. - `quantity` (object, optional) - `type` (string, optional): Always `"unit"`. - `total` (decimal pair, optional): The quantity. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 1250, "dp": 2 }` is 12.50). Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md. - `shipment_id` (string, optional): The shipment. - `type` (string, optional): Same as `product.type`. - `weight` (object, optional): The order line's weight (`_meta.total`, `_meta.unit`). - `status` (integer, required) - `success` (boolean, required) Example response: ```json { "data": [ { "auto_invoice_managed": false, "external_ids": [], "external_type": null, "from_legacy": false, "id": "u8mEG7LHUtS55s", "is_external": false, "lock_version": 1730000000000000, "position": 100, "pricing": { "_meta": { "subtotal": { "dp": 0, "value": 300 }, "total": { "dp": 0, "value": 0 }, "unit_price": { "dp": 6, "value": 12500000 } }, "type": "system" }, "product": { "_meta": { "parent": { "product_name": "Gildan 5000 T-shirt" } }, "properties": { "id": "ZJTJ2uF5dMiArL" }, "type": "order_item" }, "quantity": { "total": { "dp": 0, "value": 24 }, "type": "unit" }, "shipment_id": "MQyJUnd3oty75h", "type": "order_item", "weight": { "type": "use_system" } } ], "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 shipment isn't your team's. Fix: Check the id. ## Related - [Add a line to a shipment](https://developer.yoprint.com/reference/shipment-line-items/v2-shipment-item-create.md): `POST /v2/api/store/{team_slug}/v2/shipment/{unique_key}/item` - [Add, change and remove shipment lines at once](https://developer.yoprint.com/reference/shipment-line-items/v2-shipment-item-bulk.md): `POST /v2/api/store/{team_slug}/v2/shipment/{unique_key}/item/bulk`