> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.shipbob.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.shipbob.com/_mcp/server.

# Get Product Variants

GET https://api.shipbob.com/2026-01/product/{productId}/variants

Retrieves all variants for a specific product.

Reference: https://developer.shipbob.com/2026-01/api/products/get-product-variants

## Authentication

- `Authorization` header (bearer token, required) — Authentication using Personal Access Token (PAT) token
- `Authorization` header (bearer token, required) — OAuth2 authentication using JWT tokens

## Servers

- `https://api.shipbob.com` (https://api.shipbob.com, default)
- `https://sandbox-api.shipbob.com` (https://sandbox-api.shipbob.com)

## Request

### Path parameters

- `productId` (long, required) — The product id

## Response

### 200

Success

- `list of object`
  - `additional_hazmat_attributes` (object, optional) — Additional hazardous materials attributes for lithium batteries and dangerous goods
    - `charge_state_percentage` (double, optional, nullable)
    - `container_type` (string, optional, nullable)
    - `lithium_battery_packaging` (string, optional, nullable)
    - `lithium_battery_type` (string, optional, nullable)
    - `magnet` (boolean, optional, nullable)
    - `net_volume` (double, optional, nullable)
    - `net_weight` (double, optional, nullable)
    - `container_metal` (boolean, optional, nullable, deprecated)
  - `associated_bundles` (list of object, optional, nullable) — List of bundle products that include this variant as a component
    - `product_id` (long, optional)
    - `product_name` (string, optional, nullable)
    - `quantity` (integer, optional)
    - `variant_id` (long, optional)
    - `variant_sku` (string, optional, nullable)
  - `barcodes` (list of object, optional, nullable) — List of barcodes associated with this variant (UPC, EAN, etc.)
    - `sticker_url` (string, optional, nullable) — URL to download or view a printable barcode sticker
    - `value` (string, optional, nullable) — The barcode value (e.g., UPC, EAN, GTIN, or other barcode format)
  - `bundle_definition` (list of object, optional, nullable) — If this variant is a bundle, defines which variants and quantities make up the bundle
    - `product_id` (long, optional)
    - `quantity` (integer, optional)
    - `variant_id` (long, optional)
    - `variant_name` (string, optional, nullable)
    - `variant_sku` (string, optional, nullable)
  - `channel_metadata` (list of object or object or object or object, optional, nullable) — Platform-specific metadata for sales channels (e.g., Amazon ASIN, Shopify product IDs)
    - Products.ChannelMetadataViewModel
      - `channel_id` (long, optional)
      - `channel_name` (string, optional, nullable)
      - `currency` (string, optional, nullable)
      - `id` (long, optional)
      - `is_inventory_sync_enabled` (boolean, optional)
      - `legacy_product_id` (long, optional, nullable)
      - `platform` (string, optional, nullable)
      - `platform_identifier` (string, optional, nullable)
      - `platform_inventory_item_id` (string, optional, nullable)
      - `price` (double, optional)
      - `seller_sku` (string, optional, nullable)
    - Products.AmazonChannelMetadataViewModel
      - `asin` (string, optional, nullable)
      - `channel_id` (long, optional)
      - `channel_name` (string, optional, nullable)
      - `currency` (string, optional, nullable)
      - `fnsku` (string, optional, nullable)
      - `fulfillment_channel` (string, optional, nullable)
      - `id` (long, optional)
      - `is_inventory_sync_enabled` (boolean, optional)
      - `legacy_product_id` (long, optional, nullable)
      - `platform` (string, optional, nullable)
      - `platform_identifier` (string, optional, nullable)
      - `platform_inventory_item_id` (string, optional, nullable)
      - `price` (double, optional)
      - `seller_sku` (string, optional, nullable)
    - Products.BigCommerceChannelMetadataViewModel
      - `channel_id` (long, optional)
      - `channel_name` (string, optional, nullable)
      - `currency` (string, optional, nullable)
      - `id` (long, optional)
      - `is_inventory_sync_enabled` (boolean, optional)
      - `legacy_product_id` (long, optional, nullable)
      - `platform` (string, optional, nullable)
      - `platform_identifier` (string, optional, nullable)
      - `platform_inventory_item_id` (string, optional, nullable)
      - `platform_product_id` (long, optional, nullable)
      - `platform_variant_id` (long, optional, nullable)
      - `price` (double, optional)
      - `seller_sku` (string, optional, nullable)
    - Products.ShopifyChannelMetadataViewModel
      - `channel_id` (long, optional)
      - `channel_name` (string, optional, nullable)
      - `currency` (string, optional, nullable)
      - `id` (long, optional)
      - `is_inventory_sync_enabled` (boolean, optional)
      - `legacy_product_id` (long, optional, nullable)
      - `platform` (string, optional, nullable)
      - `platform_identifier` (string, optional, nullable)
      - `platform_inventory_item_id` (string, optional, nullable)
      - `price` (double, optional)
      - `seller_sku` (string, optional, nullable)
  - `created_on` (datetime, optional) — Timestamp when the variant was created
  - `customs` (object, optional) — Customs and international shipping information (tariff codes, country of origin, declared value)
    - `country_code_of_origin` (string, optional, nullable) — ISO 3166-1 alpha-2 country code where the product was manufactured (e.g., 'US', 'CN', 'MX')
    - `currency` (string, optional, nullable) — ISO 4217 currency code for the declared value (e.g., 'USD', 'EUR', 'GBP')
    - `description` (string, optional, nullable) — Product description for customs documentation
    - `hs_tariff_code` (string, optional, nullable) — Harmonized System tariff code used for international customs classification (6-10 digits)
    - `is321_eligible` (boolean, optional) — Flag indicating eligibility for Section 321 de minimis exemption (imports under $800 to US)
    - `value` (integer, optional, nullable) — Declared customs value of the product for international shipping
  - `dimension` (object, optional) — Physical dimensions of the variant (length, width, height)
    - `height` (double, optional) — Height of the product
    - `is_locked` (boolean, optional) — Flag indicating whether dimensions are locked and cannot be automatically recalculated by the system
    - `length` (double, optional) — Length of the product
    - `source` (string, optional, nullable) — Source of the dimension data (e.g., 'User', 'System', 'Warehouse')
    - `unit` (string, optional, nullable) — Unit of measurement for dimensions (e.g., 'in', 'cm')
    - `width` (double, optional) — Width of the product
  - `fulfillment_settings` (object, optional) — Fulfillment-specific settings (Prop 65, dangerous goods, serial scanning, case pick)
    - `dangerous_goods` (boolean, optional) — Flag indicating whether the product is classified as dangerous goods (hazmat) requiring special handling
    - `is_bpm_parcel` (boolean, optional) — Flag indicating whether this product qualifies for Business Parcel Manager (BPM) parcel shipping
    - `is_case_pick` (boolean, optional) — Flag indicating whether this product should be picked by the case rather than individual units
    - `msds_url` (string, optional, nullable) — URL to the Material Safety Data Sheet (MSDS) for hazardous materials
    - `requires_prop65` (boolean, optional) — Flag indicating California Proposition 65 warning label requirement for products containing chemicals known to cause cancer or reproductive harm
    - `serial_scan` (object, optional) — Serial number scanning configuration for tracking individual units
      - `exact_character_length` (integer, optional, nullable)
      - `is_enabled` (boolean, optional)
      - `prefix` (string, optional, nullable)
      - `suffix` (string, optional, nullable)
  - `gtin` (string, optional, nullable) — Global Trade Item Number - standardized product identifier
  - `id` (long, optional) — Unique identifier for the variant
  - `inventory` (object, optional) — Current inventory information including on-hand quantity
    - `inventory_id` (integer, optional, nullable)
    - `on_hand_qty` (integer, optional)
  - `is_digital` (boolean, optional) — Flag indicating whether this is a digital product (no physical fulfillment)
  - `is_image_uploaded` (boolean, optional) — Flag indicating whether a product image has been uploaded for this variant
  - `lot_information` (object, optional) — Lot tracking settings including whether lot tracking is enabled and minimum shelf life requirements
    - `is_lot` (boolean, optional)
    - `minimum_shelf_life_days` (integer, optional, nullable)
  - `merge_children` (list of object, optional, nullable) — List of variants that have been merged into this variant
    - `channel_ids` (list of long, optional, nullable)
    - `completed_at` (datetime, optional)
    - `inventory_id` (long, optional, nullable)
    - `variant_id` (long, optional)
    - `variant_name` (string, optional, nullable)
  - `name` (string, optional, nullable) — Variant name or descriptor
  - `packaging_material_type` (object, optional) — Type of packaging material used for this variant (ID and name)
    - `id` (long, optional)
    - `name` (string, optional, nullable)
  - `packaging_requirement` (object, optional) — Special packaging requirements for this variant (ID and name)
    - `id` (long, optional)
    - `name` (string, optional, nullable)
  - `return_preferences` (object, optional) — Customer return handling preferences including primary and backup actions
    - `backup_action` (object, optional) — Backup action to take if primary action cannot be completed
      - `id` (long, optional)
      - `name` (string, optional, nullable)
    - `instructions` (string, optional, nullable) — Special instructions for handling returned items
    - `primary_action` (object, optional) — Primary action to take when product is returned by customer (e.g., 'Restock', 'Dispose', 'Return to Sender')
      - `id` (long, optional)
      - `name` (string, optional, nullable)
    - `return_to_sender_backup_action` (object, optional) — Backup action for undeliverable packages if primary action cannot be completed
      - `id` (long, optional)
      - `name` (string, optional, nullable)
    - `return_to_sender_primary_action` (object, optional) — Primary action for undeliverable packages that are returned to sender
      - `id` (long, optional)
      - `name` (string, optional, nullable)
  - `reviews_pending` (list of string, optional, nullable) — List of pending review types for this variant (e.g., compliance checks, quality reviews)
  - `sku` (string, optional, nullable) — Stock Keeping Unit - unique identifier for the variant used in inventory management
  - `status` (string, optional, nullable) — Current status of the variant (e.g., 'Active', 'Inactive')
  - `upc` (string, optional, nullable) — Universal Product Code - 12-digit barcode identifier
  - `updated_on` (datetime, optional, nullable) — Timestamp when the variant was last updated
  - `weight` (object, optional) — Weight of the variant including unit of measure
    - `unit` (string, optional, nullable) — Unit of measurement for weight (e.g., 'lb', 'oz', 'kg', 'g')
    - `weight` (double, optional) — Weight value of the product

## Errors

### 400 Bad Request Error

Bad Request

- `map from string to list of string`

### 404 Not Found Error

Not Found

- `object or object`
  - Products.ProblemDetails
    - `detail` (string, optional, nullable)
    - `instance` (string, optional, nullable)
    - `status` (integer, optional, nullable)
    - `title` (string, optional, nullable)
    - `type` (string, optional, nullable)
  - Products.HttpValidationProblemDetails
    - `detail` (string, optional, nullable)
    - `errors` (map from string to list of string, optional, nullable)
    - `instance` (string, optional, nullable)
    - `status` (integer, optional, nullable)
    - `title` (string, optional, nullable)
    - `type` (string, optional, nullable)

## Examples

**Response**

```json
[
  {
    "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
    },
    "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
    }
  }
]
```

**SDK Code**

```python default
import requests

url = "https://api.shipbob.com/2026-01/product/1/variants"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript default
const url = 'https://api.shipbob.com/2026-01/product/1/variants';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go default
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shipbob.com/2026-01/product/1/variants"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby default
require 'uri'
require 'net/http'

url = URI("https://api.shipbob.com/2026-01/product/1/variants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java default
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.shipbob.com/2026-01/product/1/variants")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php default
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.shipbob.com/2026-01/product/1/variants', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp default
using RestSharp;

var client = new RestClient("https://api.shipbob.com/2026-01/product/1/variants");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift default
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.shipbob.com/2026-01/product/1/variants")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```