Get Product Variants | ShipBob Developer API

[
  {
    "additional_hazmat_attributes": {
      "charge_state_percentage": 0.1,
      "container_type": "string",
      "lithium_battery_packaging": "string",
      "lithium_battery_type": "string",
      "magnet": true,
      "net_volume": 0.1,
      "net_weight": 0.1,
      "container_metal": true
    },
    "associated_bundles": [
      {
        "product_id": 0,
        "product_name": "string",
        "quantity": 0,
        "variant_id": 0,
        "variant_sku": "string"
      }
    ],
    "barcodes": [
      {
        "sticker_url": "string",
        "value": "string"
      }
    ],
    "bundle_definition": [
      {
        "product_id": 0,
        "quantity": 0,
        "variant_id": 0,
        "variant_name": "string",
        "variant_sku": "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"
      }
    ],
    "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
    }
  }
]

Retrieves all variants for a specific product.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Path parameters

productIdlongRequired

The product id

Response

Success

additional_hazmat_attributesobjectOptional

Additional hazardous materials attributes for lithium batteries and dangerous goods

associated_bundleslist of objects or nullOptional

List of bundle products that include this variant as a component

barcodeslist of objects or nullOptional

List of barcodes associated with this variant (UPC, EAN, etc.)

bundle_definitionlist of objects or nullOptional

If this variant is a bundle, defines which variants and quantities make up the bundle

channel_metadatalist of objects or nullOptional

Platform-specific metadata for sales channels (e.g., Amazon ASIN, Shopify product IDs)

created_ondatetimeOptional

Timestamp when the variant was created

customsobjectOptional

Customs and international shipping information (tariff codes, country of origin, declared value)

dimensionobjectOptional

Physical dimensions of the variant (length, width, height)

fulfillment_settingsobjectOptional

Fulfillment-specific settings (Prop 65, dangerous goods, serial scanning, case pick)

gtinstring or nullOptional

Global Trade Item Number - standardized product identifier

idlongOptional

Unique identifier for the variant

inventoryobjectOptional

Current inventory information including on-hand quantity. This is not the source of truth for inventory levels. Use the latest Inventory API for current inventory levels.

is_digitalbooleanOptional

Flag indicating whether this is a digital product (no physical fulfillment)

is_image_uploadedbooleanOptional

Flag indicating whether a product image has been uploaded for this variant

lot_informationobjectOptional

Lot tracking settings including whether lot tracking is enabled and minimum shelf life requirements

merge_childrenlist of objects or nullOptional

List of variants that have been merged into this variant

namestring or nullOptional

Variant name or descriptor

packaging_material_typeobjectOptional

Type of packaging material used for this variant (ID and name)

packaging_requirementobjectOptional

Special packaging requirements for this variant (ID and name)

return_preferencesobjectOptional

Customer return handling preferences including primary and backup actions

reviews_pendinglist of strings or nullOptional

List of pending review types for this variant (e.g., compliance checks, quality reviews)

skustring or nullOptional

Stock Keeping Unit - unique identifier for the variant used in inventory management

statusstring or nullOptional

Current status of the variant (e.g., ‘Active’, ‘Inactive’)

upcstring or nullOptional

Universal Product Code - 12-digit barcode identifier

updated_ondatetime or nullOptional

Timestamp when the variant was last updated

weightobjectOptional

Weight of the variant including unit of measure

Errors

400

Bad Request Error

404

Not Found Error