List inventory items | ShipBob Developer API

curl https://api.shipbob.com/1.0/inventory \
     -H "Authorization: Bearer <token>"

[
  {
    "dimensions": {
      "depth": 0.1,
      "length": 0.1,
      "weight": 0.1,
      "width": 0.1
    },
    "fulfillable_quantity_by_fulfillment_center": [
      {
        "awaiting_quantity": 0,
        "committed_quantity": 0,
        "fulfillable_quantity": 0,
        "id": 0,
        "internal_transfer_quantity": 0,
        "name": "Cicero",
        "onhand_quantity": 0
      }
    ],
    "fulfillable_quantity_by_lot": [
      {
        "awaiting_quantity": 0,
        "committed_quantity": 0,
        "expiration_date": "2019-08-24T14:15:22Z",
        "fulfillable_quantity": 0,
        "fulfillable_quantity_by_fulfillment_center": [
          {
            "awaiting_quantity": 0,
            "committed_quantity": 0,
            "fulfillable_quantity": 0,
            "id": 0,
            "internal_transfer_quantity": 0,
            "name": "Cicero",
            "onhand_quantity": 0
          }
        ],
        "internal_transfer_quantity": 0,
        "lot_number": "1234",
        "onhand_quantity": 0
      }
    ],
    "id": 0,
    "is_active": true,
    "is_case_pick": true,
    "is_digital": true,
    "is_lot": true,
    "name": "Medium Blue T-Shirt",
    "packaging_attribute": "None",
    "total_awaiting_quantity": 0,
    "total_backordered_quantity": 0,
    "total_committed_quantity": 0,
    "total_exception_quantity": 0,
    "total_fulfillable_quantity": 0,
    "total_internal_transfer_quantity": 0,
    "total_onhand_quantity": 0,
    "total_sellable_quantity": 0
  }
]

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Query parameters

PageintegerOptional0-2147483647

Page of inventory items to get

LimitintegerOptional1-250

Amount of inventory items per page to request

IsActivebooleanOptional

Whether the inventory should be active or not

IsDigitalbooleanOptional

Whether the inventory is digital or not

IDsstringOptional

Comma separated inventory ids to filter by

SortstringOptional

Sort will default to ascending order for each field. To sort in descending order please pass a ”-” in front of the field name. For example, Sort=-onHand,name will sort by onHand descending

SearchstringOptional

Search is available for 2 fields, Inventory ID and Name -

Expected behavior for search by Inventory ID is exact match
Expected behavior for search by Inventory Name is partial match, i.e. does not have to be start of word, but must be consecutive characters. This is not case sensitive.

Search is available for 2 fields, Inventory ID and Name - 1. Expected behavior for search by Inventory ID is exact match 2. Expected behavior for search by Inventory Name is partial match, i.e. does not have to be start of word, but must be consecutive characters. This is not case sensitive.

LocationTypestringOptional

LocationType is valid for hub, spoke, or lts. LocationType will default to all locations.

Response

Success

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error