For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
      • GETGet Order
      • GETGet Shipment Logs
      • POSTMark Tracking Uploaded
      • GETGet All Shipments for Order
      • GETGet Order Store Data
      • POSTEstimate Fulfillment Cost For Order
      • GETGet Orders
      • POSTCreate Order
      • POSTCancel Shipment
      • POSTCancel Shipment by Order ID and Shipment ID
      • GETGet Shipping Methods
      • POSTCancel Order
      • GETGet Shipment Logs by Order ID and Shipment ID
      • GETGet Shipment Status Timeline by Order ID and Shipment ID
      • GETGet Shipment Timeline
      • GETGet Shipment
      • POSTBatch Cancel Shipments
      • GETGet Shipment by Order ID and Shipment ID
      • PUTBulk Update Shipping Service
      • POSTUpdate Shipment Line Items
      • PUTUpdate Shipment Address
      • GETGet Shipment Line Items
      • GETGet Completely Cancelled Orders
      • POSTEstimate Delivery Date
LogoLogo
API ReferenceOrders

Get Shipment Line Items

||View as Markdown|
GET
https://sandbox-api.shipbob.com/2026-01/shipment/:shipmentId:getLineItems
GET
/2026-01/shipment/:shipmentId:getLineItems
$curl https://sandbox-api.shipbob.com/2026-01/shipment/1:getLineItems \
> -H "Authorization: Bearer <token>"
1[
2 {
3 "committed_quantity": 5,
4 "inventory_id": 789012,
5 "is_hazmat": false,
6 "is_lot": true,
7 "lot": {
8 "lot_date": "2024-06-01T00:00:00+00:00",
9 "lot_number": "LOT-2024-001",
10 "selection_method": "Specific"
11 },
12 "product_variant": {
13 "id": 456,
14 "name": "Vitamin D Supplement",
15 "sku": "VIT-D-60CT"
16 },
17 "quantity": 5
18 },
19 {
20 "committed_quantity": 3,
21 "inventory_id": 789012,
22 "is_hazmat": false,
23 "is_lot": true,
24 "lot": {
25 "lot_date": "2024-09-15T00:00:00+00:00",
26 "lot_number": "LOT-2024-002",
27 "selection_method": "Specific"
28 },
29 "product_variant": {
30 "id": 456,
31 "name": "Vitamin D Supplement",
32 "sku": "VIT-D-60CT"
33 },
34 "quantity": 3
35 },
36 {
37 "committed_quantity": 2,
38 "inventory_id": 345678,
39 "is_hazmat": false,
40 "is_lot": false,
41 "lot": {
42 "selection_method": "Specific"
43 },
44 "product_variant": {
45 "id": 789,
46 "name": "Bluetooth Speaker",
47 "sku": "BT-SPKR-BLK"
48 },
49 "quantity": 2
50 }
51]
Retrieves the current line items for a specific shipment, including product variant details, lot information, committed quantities, and serial numbers. Use this endpoint to get the current state before calling updateLineItems, which requires the full item list.
Was this page helpful?
Previous

Update Shipment Address

Next

Get Completely Cancelled Orders

Built with

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

shipmentIdintegerRequired
Unique identifier of the shipment

Response

OK
committed_quantityinteger
Quantity of the inventory item committed for fulfillment
inventory_idinteger
Unique identifier of the inventory item
is_hazmatboolean
Indicates whether the inventory item is classified as hazardous material
is_lotboolean

Indicates whether the inventory item is lot-tracked

lotobject

Lot information for the inventory item, if lot-tracked

product_variantobject
Product variant details associated with this line item
quantityinteger
Total quantity of the inventory item in the shipment
serial_numberslist of strings
List of serial numbers assigned to this line item

Errors

404
Not Found Error