Get Product | ShipBob Developer API

curl https://api.shipbob.com/2026-01/product/productId \
     -H "Authorization: Bearer <token>"

{
  "created_on": "2019-08-24T14:15:22Z",
  "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:22Z",
  "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:22Z",
      "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:22Z",
          "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:22Z",
      "weight": {
        "unit": "string",
        "weight": 0.1
      }
    }
  ]
}

Retrieves a product with all its variants and details.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

Path parameters

productIdstringRequiredformat: "int64"

Response

Success

created_ondatetime or null

Timestamp when the product was created

idlong or null

Unique identifier for the product

namestring or null

Product name

taxonomyobject or null

Product categorization information including category hierarchy

typestring or null

Product type (e.g., ‘Regular’ or ‘Bundle’)

updated_ondatetime or null

Timestamp when the product was last updated

user_idlong or null

ID of the user who owns this product

variantslist of objects or null

List of variants belonging to this product. Each variant represents a specific SKU.

Authentication

Path parameters

Response

Errors