Get Shipment Line Items | ShipBob Developer API

[
  {
    "committed_quantity": 5,
    "inventory_id": 789012,
    "is_hazmat": false,
    "is_lot": true,
    "lot": {
      "lot_date": "2024-06-01T00:00:00+00:00",
      "lot_number": "LOT-2024-001",
      "selection_method": "Specific"
    },
    "product_variant": {
      "id": 456,
      "name": "Vitamin D Supplement",
      "sku": "VIT-D-60CT"
    },
    "quantity": 5,
    "serial_numbers": null
  },
  {
    "committed_quantity": 3,
    "inventory_id": 789012,
    "is_hazmat": false,
    "is_lot": true,
    "lot": {
      "lot_date": "2024-09-15T00:00:00+00:00",
      "lot_number": "LOT-2024-002",
      "selection_method": "Specific"
    },
    "product_variant": {
      "id": 456,
      "name": "Vitamin D Supplement",
      "sku": "VIT-D-60CT"
    },
    "quantity": 3,
    "serial_numbers": null
  },
  {
    "committed_quantity": 2,
    "inventory_id": 345678,
    "is_hazmat": false,
    "is_lot": false,
    "lot": {
      "lot_date": null,
      "lot_number": null,
      "selection_method": "Specific"
    },
    "product_variant": {
      "id": 789,
      "name": "Bluetooth Speaker",
      "sku": "BT-SPKR-BLK"
    },
    "quantity": 2,
    "serial_numbers": null
  }
]

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.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Path parameters

shipmentIdintegerRequired

Unique identifier of the shipment

Response

committed_quantityintegerOptional

Quantity of the inventory item committed for fulfillment

inventory_idintegerOptional

Unique identifier of the inventory item

is_hazmatboolean or nullOptional

Indicates whether the inventory item is classified as hazardous material

is_lotboolean or nullOptional

Indicates whether the inventory item is lot-tracked

lotobjectOptional

Lot information for the inventory item, if lot-tracked

product_variantobjectOptional

Product variant details associated with this line item

quantityintegerOptional

Total quantity of the inventory item in the shipment

serial_numberslist of strings or nullOptional

List of serial numbers assigned to this line item

Errors

404

Not Found Error