Update a single product with Json Merge Patch functionality

curl -X PATCH https://api.shipbob.com/2.0/product/productId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "category_id": 0,
  "name": "string",
  "sub_category_id": 0,
  "type_id": 0,
  "variants": [
    {
      "barcode": "string",
      "barcode_sticker_url": "string",
      "bundle_definition": [
        {
          "quantity": 0,
          "variant_id": 0
        }
      ],
      "channel_metadata": [
        {
          "asin": "string",
          "fnsku": "string",
          "fulfillment_channel": "string",
          "channel_id": 0,
          "currency": "string",
          "id": 0,
          "is_inventory_sync_enabled": true,
          "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",
      "id": 0,
      "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
    }
  ]
}'

{
  "category": {
    "id": 0,
    "name": "string"
  },
  "created_on": "2019-08-24T14:15:22Z",
  "id": 0,
  "name": "string",
  "sub_category": {
    "id": 0,
    "name": "string"
  },
  "type": "string",
  "updated_on": "2019-08-24T14:15:22Z",
  "user_id": 0,
  "variants": [
    {
      "associated_bundles": [
        {
          "product_id": 0,
          "product_name": "string",
          "quantity": 0,
          "variant_id": 0,
          "variant_sku": "string"
        }
      ],
      "barcode": "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,
        "length": 0.1,
        "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,
      "lot_information": {
        "is_lot": true,
        "minimum_shelf_life_days": 0
      },
      "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"
        }
      },
      "sku": "string",
      "status": "string",
      "upc": "string",
      "updated_on": "2019-08-24T14:15:22Z",
      "weight": {
        "unit": "string",
        "weight": 0.1
      }
    }
  ]
}

Updates a single product. This endpoint supports Json Merge Patch functionality, which allows partial updates to be made to the product. The endpoint will only update the fields that are provided in the request. For updating variants, you mnust include the ID of the variant that you would like to update.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Path parameters

productIdstringRequiredformat: "int64"

The product identifier

Request

This endpoint expects an object.

category_idinteger or nullOptional

namestring or nullOptional

sub_category_idinteger or nullOptional

type_idintegerOptional

variantslist of objects or nullOptional

Response

Success

categoryobject or null

created_ondatetime or null

idlong or null

namestring or null

sub_categoryobject or null

typestring or null

updated_ondatetime or null

user_idlong or null

variantslist of objects or null