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
          },
          "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.

BarcodeintegerOptional

Barcode Associated with variant

Barcodeslist of stringsOptional

Barcodes Associated with variant

CategoryIdslist of integersOptional

List of Category Ids associated with product

ChannelIdslist of integersOptional

Looks for Products variants by their channel IDs

HasDigitalVariantsbooleanOptional

Looks for Products with/without digital variants

HasVariantsbooleanOptional

Looks for Products with/without variants

InventoryIdlist of integersOptional

Looks for variants by its associated inventory id

IsInventorySyncEnabledobjectOptional

Looks for Products variants by their IsInventorySyncEnabled is true

LastUpdatedTimestampdatetimeOptional

Looks for Products that have been updated since the given date

LegacyIdslist of integersOptional

Looks for Products with by Legacy Product Id(s)

NamestringOptional

Looks for Products/Variants by name

OnHandintegerOptional

Looks for Products with inventory

PlatformIdslist of stringsOptional

Looks for Products variants by their external Platform IDs

ProductIdlist of integersOptional

Looks for Products with an assigned Id

ProductTypeintegerOptional

Looks for Products by type

ReviewsPendinglist of stringsOptional

Looks for Products by ReviewsPending

SalesChannellist of stringsOptional

Looks for Products variants assigned to a platform/sales channel

SellerSKUstringOptional

Looks for Products that match the provided Seller query

SKUstringOptional

Looks for Products that match the provided Sku query

TaxonomyIdslist of integersOptional

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

VariantIdlist of integersOptional

Looks for products that contain a variant with the given ID

VariantStatusstringOptional

Looks for Products with variants that contain provided status

PageSizeintegerOptional

1-250

SortBystringOptional

Id, Name, Category, TotalOnHandQty

SortOrderstringOptional

ASC,DESC

Response

Success

firststring

itemslist of objects

laststring

nextstring

prevstring

Errors

400

Bad Request Error

404

Not Found Error

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