Skip to main content
POST
/
2025-07
/
product
/
{productId}
/
variants
Adds new product variants to a product
curl --request POST \
  --url https://api.shipbob.com/2025-07/product/{productId}/variants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "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
    },
    "barcodes": [
      {
        "sticker_url": "string",
        "value": "string"
      }
    ],
    "bundle_definition": [
      {
        "quantity": 0,
        "variant_id": 0
      }
    ],
    "channel_metadata": [
      {
        "asin": "string",
        "channel_id": 0,
        "currency": "string",
        "fnsku": "string",
        "fulfillment_channel": "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"
      }
    ],
    "customs": {
      "country_code_of_origin": "string",
      "description": "string",
      "hs_tariff_code": "string",
      "is321_eligible": true,
      "value": 0
    },
    "dimension": {
      "height": 0.1,
      "length": 0.1,
      "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",
    "is_digital": true,
    "lot_information": {
      "is_lot": true,
      "minimum_shelf_life_days": 0
    },
    "name": "string",
    "packaging_material_type_id": 0,
    "packaging_requirement_id": 0,
    "return_preferences": {
      "backup_action_id": 0,
      "instructions": "string",
      "primary_action_id": 0,
      "return_to_sender_backup_action_id": 0,
      "return_to_sender_primary_action_id": 0
    },
    "sku": "string",
    "status_id": 0,
    "upc": "string",
    "weight": 0.1
  }
]
'
{
  "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": [
    {
      "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"
        }
      ],
      "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: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
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Path Parameters

productId
string<int64>
required

Body

application/json

The product variants to add to product

additional_hazmat_attributes
object
bundle_definition
object[] | null
channel_metadata
object[] | null

Amazon Sales Channel Information with custom Amazon Fields

  • Option 1
  • Option 2
  • Option 3
  • Option 4
customs
object
dimension
object
fulfillment_settings
object
gtin
string | null
is_digital
boolean
lot_information
object
name
string | null
packaging_material_type_id
integer<int32> | null
packaging_requirement_id
integer<int32> | null
return_preferences
object
sku
string | null
status_id
integer<int32>
upc
string | null
weight
number<double>
barcodes
object[] | null
Example:
[
{
"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
},
"barcodes": [
{
"sticker_url": "string",
"value": "string"
}
],
"bundle_definition": [{ "quantity": 0, "variant_id": 0 }],
"channel_metadata": [
{
"asin": "string",
"channel_id": 0,
"currency": "string",
"fnsku": "string",
"fulfillment_channel": "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"
}
],
"customs": {
"country_code_of_origin": "string",
"description": "string",
"hs_tariff_code": "string",
"is321_eligible": true,
"value": 0
},
"dimension": {
"height": 0.1,
"length": 0.1,
"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",
"is_digital": true,
"lot_information": {
"is_lot": true,
"minimum_shelf_life_days": 0
},
"name": "string",
"packaging_material_type_id": 0,
"packaging_requirement_id": 0,
"return_preferences": {
"backup_action_id": 0,
"instructions": "string",
"primary_action_id": 0,
"return_to_sender_backup_action_id": 0,
"return_to_sender_primary_action_id": 0
},
"sku": "string",
"status_id": 0,
"upc": "string",
"weight": 0.1
}
]

Response

201 - application/json

Created

created_on
string<date-time>
id
integer<int64>
name
string | null
taxonomy
object
type
string | null
updated_on
string<date-time> | null
user_id
integer<int64>
variants
object[] | null
  • Option 1
  • Option 2