Move Variants Between Products | ShipBob Developer API

curl -X POST https://sandbox-api.shipbob.com/2026-01/product/productId:moveVariants \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "category_id": 0,
  "name": "string",
  "product_id": 0,
  "sub_category_id": 0,
  "taxonomy_id": 0,
  "variants": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

{
  "category": {
    "id": 0,
    "name": "string"
  },
  "created_on": "2019-08-24T14:15:22+00:00",
  "id": 0,
  "name": "string",
  "sub_category": {
    "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": [
    {
      "barcode": "string",
      "barcode_sticker_url": "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
      }
    }
  ]
}

Moves variants from their current product to the target product specified in the path. Provide an array of variant IDs to move.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Path parameters

productIdstringRequiredformat: "int64"

Request

Migration definition

category_idinteger or nullOptional

namestring or nullOptional

product_idlongOptional

sub_category_idinteger or nullOptional

taxonomy_idinteger or nullOptional

variantslist of objects or nullOptional

Response

Created

categoryobjectOptional

created_ondatetimeOptional

idlongOptional

namestring or nullOptional

sub_categoryobjectOptional

taxonomyobjectOptional

typestring or nullOptional

updated_ondatetime or nullOptional

user_idlongOptional

variantslist of objects or nullOptional

Errors

400

Bad Request Error

404

Not Found Error