Update specific channel metadata record from a variant by channel metadata ID

curl -X PUT https://api.shipbob.com/2025-07/variant/variantId/channel-metadata/channelMetadataId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "asin": "string",
  "fnsku": "string",
  "fulfillment_channel": "string",
  "channel_id": 0,
  "currency": "string",
  "id": 0,
  "is_inventory_sync_enabled": true,
  "legacy_product_id": 0,
  "platform_identifier": "string",
  "platform_inventory_item_id": "string",
  "price": 0.1,
  "seller_sku": "string",
  "platform": "string"
}'

{
  "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: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
  }
}

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Path parameters

variantIdstringRequiredformat: "int64"

The ID of the variant to update the metadata from

channelMetadataIdstringRequiredformat: "int64"

The ID of the channel metadata record to update

Request

This endpoint expects an object.

Products.AmazonChannelMetadataRequestModelobjectRequired

Amazon Sales Channel Information with custom Amazon Fields

Products.BaseChannelMetadataRequestModelobjectRequired

Standard Channel Metadata Record to store SellerSKU for a Sales Channel

Products.BigCommerceChannelMetadataRequestModelobjectRequired

BigCommerce Sales Channel Information with custom Amazon Fields

Products.ShopifyChannelMetadataRequestModelobjectRequired

Shopify Sales Channel Information

Response

Success

additional_hazmat_attributesobjectOptional

associated_bundleslist of objects or nullOptional

barcodeslist of objects or nullOptional

bundle_definitionlist of objects or nullOptional

channel_metadatalist of objects or nullOptional

created_ondatetimeOptional

customsobjectOptional

dimensionobjectOptional

fulfillment_settingsobjectOptional

gtinstring or nullOptional

idlongOptional

inventoryobjectOptional

is_digitalbooleanOptional

is_image_uploadedbooleanOptional

lot_informationobjectOptional

merge_childrenlist of objects or nullOptional

namestring or nullOptional

packaging_material_typeobjectOptional

packaging_requirementobjectOptional

return_preferencesobjectOptional

reviews_pendinglist of strings or nullOptional

skustring or nullOptional

statusstring or nullOptional

upcstring or nullOptional

updated_ondatetime or nullOptional

weightobjectOptional

Errors

400

Bad Request Error

404

Not Found Error