GET
/
product
curl --request GET \
  --url https://api.shipbob.com/1.0/product \
  --header 'Authorization: Bearer <token>'
[
  {
    "barcode": "123456789012",
    "bundle_root_information": {
      "id": 0,
      "name": "string"
    },
    "channel": {
      "id": 0,
      "name": "House of Slippers"
    },
    "created_date": "2019-08-24T14:15:22Z",
    "fulfillable_inventory_items": [
      {
        "id": 0,
        "name": "Medium Blue T-Shirt",
        "quantity": 0
      }
    ],
    "fulfillable_quantity_by_fulfillment_center": [
      {
        "committed_quantity": 0,
        "fulfillable_quantity": 0,
        "id": 0,
        "name": "Cicero",
        "onhand_quantity": 0
      }
    ],
    "gtin": "012345678905",
    "id": 0,
    "name": "Medium Blue T-Shirt",
    "reference_id": "TShirtBlueM",
    "sku": "TShirtBlueM",
    "total_committed_quantity": 0,
    "total_fulfillable_quantity": 0,
    "total_onhand_quantity": 0,
    "unit_price": 20.32,
    "upc": "012345678912"
  }
]

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Headers

​
shipbob_channel_id
string

Channel Id for Operation

Query Parameters

​
ReferenceIds
string

Comma separated list of reference ids to filter by

​
Page
number

Page of products to get - Valid Range is 0 to integer max with a default of 1

Required range: 0 <= x <= 2147483647
​
Limit
number

Amount of products per page to request - Valid Range is 1 to 250 with a default of 50

Required range: 1 <= x <= 250
​
IDs
string

Comma separated list of product ids to filter by

​
Search
string

Search is available for 2 fields of the inventory record related to the product: 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.
​
ActiveStatus
string

Status filter for products:

  • Any: Include both active and inactive
  • Active: Filter products that are Active
  • Inactive: Filter products that are Inactive",
​
BundleStatus
string

Bundle filter for products:

  • Any: Don't filter and consider products that are bundles or not bundles
  • Bundle: Filter by products that are bundles
  • NotBundle: Filter by products that are not bundles"

Response

200
application/json
Success

The response is of type object[].