Get Products | ShipBob Developer API

{
  "first": "string",
  "items": [
    {
      "created_on": "2019-08-24T14:15:22+00:00",
      "id": 0,
      "name": "string",
      "taxonomy": {
        "id": 0,
        "name": "string",
        "parent_id": 0,
        "parent_name": "string",
        "path": "string"
      },
      "type": "string",
      "updated_on": "2019-08-24T14:15:22+00:00",
      "user_id": 0,
      "variants": [
        {
          "barcodes": [
            {
              "sticker_url": "string",
              "value": "string"
            }
          ],
          "channel_metadata": [
            {
              "channel_id": 0,
              "channel_name": "string",
              "currency": "string",
              "id": 0,
              "is_inventory_sync_enabled": true,
              "legacy_product_id": 0,
              "platform": "string",
              "platform_identifier": "string",
              "platform_inventory_item_id": "string",
              "price": 0.1,
              "seller_sku": "string"
            }
          ],
          "additional_hazmat_attributes": {
            "charge_state_percentage": 0.1,
            "container_metal": true,
            "container_type": "string",
            "lithium_battery_packaging": "string",
            "lithium_battery_type": "string",
            "magnet": true,
            "net_volume": 0.1,
            "net_weight": 0.1
          },
          "associated_bundles": [
            {
              "product_id": 0,
              "product_name": "string",
              "quantity": 0,
              "variant_id": 0,
              "variant_sku": "string"
            }
          ],
          "bundle_definition": [
            {
              "product_id": 0,
              "quantity": 0,
              "variant_id": 0,
              "variant_name": "string",
              "variant_sku": "string"
            }
          ],
          "created_on": "2019-08-24T14:15:22+00:00",
          "customs": {
            "country_code_of_origin": "string",
            "currency": "string",
            "description": "string",
            "hs_tariff_code": "string",
            "is321_eligible": true,
            "value": 0.1
          },
          "dimension": {
            "height": 0.1,
            "is_locked": true,
            "length": 0.1,
            "source": "string",
            "unit": "string",
            "width": 0.1
          },
          "fulfillment_settings": {
            "dangerous_goods": true,
            "is_bpm_parcel": true,
            "is_case_pick": true,
            "msds_url": "string",
            "requires_prop65": true,
            "serial_scan": {
              "exact_character_length": 0,
              "is_enabled": true,
              "prefix": "string",
              "suffix": "string"
            }
          },
          "gtin": "string",
          "id": 0,
          "inventory": {
            "inventory_id": 0,
            "on_hand_qty": 0
          },
          "is_digital": true,
          "is_image_uploaded": true,
          "lot_information": {
            "is_lot": true,
            "minimum_shelf_life_days": 0
          },
          "merge_children": [
            {
              "channel_ids": [
                0
              ],
              "completed_at": "2019-08-24T14:15:22+00:00",
              "inventory_id": 0,
              "variant_id": 0,
              "variant_name": "string"
            }
          ],
          "name": "string",
          "packaging_material_type": {
            "id": 0,
            "name": "string"
          },
          "packaging_requirement": {
            "id": 0,
            "name": "string"
          },
          "return_preferences": {
            "backup_action": {
              "id": 0,
              "name": "string"
            },
            "instructions": "string",
            "primary_action": {
              "id": 0,
              "name": "string"
            },
            "return_to_sender_backup_action": {
              "id": 0,
              "name": "string"
            },
            "return_to_sender_primary_action": {
              "id": 0,
              "name": "string"
            }
          },
          "reviews_pending": [
            "string"
          ],
          "sku": "string",
          "status": "string",
          "upc": "string",
          "updated_on": "2019-08-24T14:15:22+00:00",
          "weight": {
            "unit": "string",
            "weight": 0.1
          }
        }
      ]
    }
  ],
  "last": "string",
  "next": "string",
  "prev": "string"
}

Retrieves a paginated list of products. Supports filtering by search term, barcode, SKU, status, and other criteria.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Query parameters

SearchstringOptional

Search Products by name, sku, inventory id or product Id.

BarcodeanyOptional

Barcode Associated with variant

BarcodesanyOptional

Barcodes Associated with variant

CategoryIdsanyOptional

List of Category Ids associated with product

ChannelIdsanyOptional

Looks for Products variants by their channel IDs

HasDigitalVariantsanyOptional

Looks for Products with/without digital variants

HasVariantsanyOptional

Looks for Products with/without variants

InventoryIdanyOptional

Looks for variants by its associated inventory id

IsInventorySyncEnabledstringOptional

Looks for Products variants by their IsInventorySyncEnabled is true

LastUpdatedTimestampanyOptional

Looks for Products that have been updated since the given date

LegacyIdsanyOptional

Looks for Products with by Legacy Product Id(s)

NameanyOptional

Looks for Products/Variants by name

OnHandanyOptional

Looks for Products with inventory

PlatformIdsanyOptional

Looks for Products variants by their external Platform IDs

ProductIdanyOptional

Looks for Products with an assigned Id

ProductTypeanyOptional

Looks for Products by type

ReviewsPendinganyOptional

Looks for Products by ReviewsPending

SalesChannelanyOptional

Looks for Products variants assigned to a platform/sales channel

SellerSKUanyOptional

Looks for Products that match the provided Seller query

SKUanyOptional

Looks for Products that match the provided Sku query

TaxonomyIdsanyOptional

Looks for Products variants by their taxonomy id or any descendants of the taxonomies sent separated by comma

VariantIdanyOptional

Looks for products that contain a variant with the given ID

VariantStatusanyOptional

Looks for Products with variants that contain provided status

PageSizeanyOptional

1-250

SortBystringOptional

Id, Name, Category, TotalOnHandQty

SortOrderstringOptional

ASC,DESC

Response

Success

firststring or null

itemslist of objects or null

laststring or null

nextstring or null

prevstring or null

Errors

400

Bad Request Error

404

Not Found Error

$	curl -G https://sandbox-api.shipbob.com/2026-07/product \
>	-H "Authorization: Bearer <token>" \
>	-d Search=string \
>	-d SortBy=string \
>	-d SortOrder=string