Update Existing Product

This API is offering to update existing products.

PUT {{Base_url}}/rest/V1/products/{SKU}

This API response allows for updating various product details in the Magento system. By sending a PUT request to the {{Base_url}}/rest/V1/products/{SKU} endpoint, you can modify several key attributes of the product. These include the product's price, availability, and stock quantity, as well as its visibility, status, and weight. The response also includes the ability to update custom attributes such as the product description, short description, meta information (meta title, meta description, and keywords), and images (such as the main image, small image, and thumbnail). Furthermore, stock management settings such as minimum and maximum sale quantities, backorders, and stock notifications can be updated. You can also update product options, media gallery entries, and relationships with other products (such as upsells or related products). Overall, this API facilitates detailed and flexible product updates, enabling changes to both core product properties and additional attributes, ensuring your product data remains current in the Magento system.

Body

Request Body

{
  "product": {
    "price": 120,
    "status": 1,
    "extension_attributes": {
      "stock_item": {
           "qty": 100
      }
    },
    "custom_attributes": [
      {
        "attribute_code": "description",
        "value": "Updated product description"
      }
    ]
  }
}

The request updates specific attributes of a product identified by its SKU ({SKU}). The following changes are made:

1. Price: Updated to 120.

2. Status: Set to 1 (enabled).

3. Stock Quantity: Updated to 100 using extension_attributes.

4. Description: Updated to "Updated product description" using custom_attributes.

Curl

curl --location --request PUT '{{Base_url}}/rest/V1/products/your-product-sku' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJraWQiOiIxIiwiYWxnIjoiSFMyNTYifQ.eyJ1aWQiOjU1LCJ1dHlwaWQiOjIsImlhdCI6MTczNjIzNzMxMCwiZXhwIjoxNzM2MjQwOTEwfQ.u5Wm_JuwMMkPgZcS2SfaXQzOEUMS1VcBRz2nX-S_IFw' \
--header 'Cookie: PHPSESSID=6t4unirh1unu87ef0stp2sv3kv; private_content_version=5ab80b7def0c212f723edead3c971a19' \
--data '{
  "product": {
    "price": 120,
    "status": 1,
    "extension_attributes": {
      "stock_item": {
           "qty": 100
      }
    },
    "custom_attributes": [
      {
        "attribute_code": "description",
        "value": "Updated product description"
      }
    ]
  }
}
'

Responses

Success Response 200

{
    "id": 14535,
    "sku": "your-product-sku",
    "name": "Your Product Name",
    "attribute_set_id": 4,
    "price": 120,
    "status": 1,
    "visibility": 4,
    "type_id": "simple",
    "created_at": "2024-12-12 11:03:46",
    "updated_at": "2025-01-07 08:14:34",
    "weight": 1,
    "extension_attributes": {
        "website_ids": [
            1
        ],
        "stock_item": {
            "item_id": 432223,
            "product_id": 14535,
            "stock_id": 1,
            "qty": 100,
            "is_in_stock": true,
            "is_qty_decimal": false,
            "show_default_notification_message": false,
            "use_config_min_qty": true,
            "min_qty": 0,
            "use_config_min_sale_qty": 1,
            "min_sale_qty": 1,
            "use_config_max_sale_qty": true,
            "max_sale_qty": 100,
            "use_config_backorders": true,
            "backorders": 0,
            "use_config_notify_stock_qty": true,
            "notify_stock_qty": 1,
            "use_config_qty_increments": true,
            "qty_increments": 0,
            "use_config_enable_qty_inc": true,
            "enable_qty_increments": false,
            "use_config_manage_stock": true,
            "manage_stock": true,
            "low_stock_date": null,
            "is_decimal_divided": false,
            "stock_status_changed_auto": 0
        }
    },
    "product_links": [],
    "options": [],
    "media_gallery_entries": [
        {
            "id": 212271,
            "media_type": "image",
            "label": "Image Label",
            "position": 0,
            "disabled": false,
            "types": [],
            "file": "/r/b/rbj1_4_2.jpeg"
        },
        {
            "id": 212270,
            "media_type": "image",
            "label": "Image Label",
            "position": 0,
            "disabled": false,
            "types": [],
            "file": "/r/b/rbj1_4_1.jpeg"
        },
        {
            "id": 212268,
            "media_type": "image",
            "label": "Image Label",
            "position": 0,
            "disabled": false,
            "types": [],
            "file": "/r/b/rbj1_3_2.jpeg"
        },
        {
            "id": 212269,
            "media_type": "image",
            "label": "Image Label",
            "position": 0,
            "disabled": false,
            "types": [
                "image",
                "small_image",
                "thumbnail"
            ],
            "file": "/r/b/rbj1_4.jpeg"
        },
        {
            "id": 212267,
            "media_type": "image",
            "label": "Image Label",
            "position": 0,
            "disabled": false,
            "types": [],
            "file": "/r/b/rbj1_3_1.jpeg"
        }
    ],
    "tier_prices": [],
    "custom_attributes": [
        {
            "attribute_code": "short_description",
            "value": "<p>html <b>short description here</b></p>"
        },
        {
            "attribute_code": "image",
            "value": "/r/b/rbj1_4.jpeg"
        },
        {
            "attribute_code": "url_key",
            "value": "your-product-name"
        },
        {
            "attribute_code": "description",
            "value": "Updated product description"
        },
        {
            "attribute_code": "meta_title",
            "value": "Product Meta Title"
        },     
        {
            "attribute_code": "small_image",
            "value": "/r/b/rbj1_4.jpeg"
        },
        {
            "attribute_code": "options_container",
            "value": "container2"
        },
        {
            "attribute_code": "meta_keyword",
            "value": "product, keywords, magento"
        },
        {
            "attribute_code": "thumbnail",
            "value": "/r/b/rbj1_4.jpeg"
        },
        {
            "attribute_code": "meta_description",
            "value": "Meta description for the product."
        },
        {
            "attribute_code": "swatch_image",
            "value": "no_selection"
        },
        {
            "attribute_code": "purchase_price_cap",
            "value": "0.000000"
        },
        {
            "attribute_code": "msrp_display_actual_price_type",
            "value": "0"
        },
        {
            "attribute_code": "is_sclp",
            "value": "0"
        },
        {
            "attribute_code": "required_options",
            "value": "0"
        },
        {
            "attribute_code": "has_options",
            "value": "0"
        },
        {
            "attribute_code": "image_label",
            "value": "Image Label"
        },
        {
            "attribute_code": "small_image_label",
            "value": "Image Label"
        },
        {
            "attribute_code": "thumbnail_label",
            "value": "Image Label"
        },
        {
            "attribute_code": "popular_product",
            "value": "0"
        },
        {
            "attribute_code": "tax_class_id",
            "value": "2"
        },
        {
            "attribute_code": "category_ids",
            "value": []
        },
        {
            "attribute_code": "sw_featured",
            "value": "0"
        }
    ]
}

1. id:

   • Description: Unique identifier for the product in the system.

   • Example: 14535

   • Explanation: This is a system-generated unique ID assigned to each product when it is created.

2. sku:

   • Description: Stock Keeping Unit, a unique identifier for a product.

   • Example: "your-product-sku"

   • Explanation: This is a unique code used to identify and track the product in the inventory system.

3. name:

   • Description: The name of the product.

   • Example: "Your Product Name"

   • Explanation: This is the display name of the product that customers will see on the front end.

4. attribute_set_id:

   • Description: Refers to the attribute set that is used to categorize the product.

   • Example: 4

   • Explanation: An integer representing the attribute set that is applied to the product. The attribute set defines the available attributes for the product.

5. price:

   • Description: The price of the product.

   • Example: 120

   • Explanation: This is the selling price of the product. It reflects the monetary value at which the product will be sold.

6. status:

   • Description: The current status of the product.

   • Example: 1

   • Explanation: The value 1 indicates that the product is enabled and available for sale, while 0 would disable the product.

7. visibility:

   • Description: Determines how the product is displayed in the store.

   • Example: 4

   • Explanation: The visibility attribute controls whether the product is visible in search results or categories on the store frontend. A value of 4 means "Catalog, Search" (visible both in search results and category pages).

8. type_id:

   • Description: Defines the type of product.

   • Example: "simple"

   • Explanation: This specifies the product type, which in this case is a "simple" product (not configurable or grouped).

9. created_at:

   • Description: The timestamp when the product was created.

   • Example: "2024-12-12 11:03:46"

   • Explanation: This is the date and time when the product was initially created in the system.

10. updated_at:

• Description: The timestamp when the product was last updated.

• Example: "2025-01-07 08:14:34"

• Explanation: This field tracks the most recent update to the product's details.

1. weight:

• Description: The weight of the product.

• Example: 1

• Explanation: This refers to the weight of the product in kilograms, used for shipping calculations.

1. extension_attributes:

• Description: Additional data related to the product that doesn't fit into the standard attributes.

• Sub-attributes:

  • website_ids: Lists the websites where the product is available.

    • Example: [1]

    • Explanation: The product is available on the website with ID 1.

  • stock_item: Information about the stock availability.

    • Sub-attributes:

      • qty: The quantity of the product available in stock.

        • Example: 100

        • Explanation: The available stock for the product.

      • is_in_stock: Whether the product is in stock.

        • Example: true

        • Explanation: A boolean indicating if the product is currently in stock.

      • is_qty_decimal: Whether the stock can be fractional.

        • Example: false

        • Explanation: Indicates whether the stock level can be in decimal values (false means it must be a whole number).

      • backorders: Whether backorders are allowed for this product.

        • Example: 0

        • Explanation: A value of 0 means that backorders are not allowed.

      • manage_stock: Whether stock management is enabled for the product.

        • Example: true

        • Explanation: This indicates whether stock is managed and updated automatically by the system.

1. product_links:

• Description: Links related to the product, such as related products or upsells.

• Example: []

• Explanation: This is an empty array, meaning there are no links to other products defined.

1. options:

• Description: Product options, such as size or color.

• Example: []

• Explanation: This is an empty array, indicating the product has no configurable options (like size or color variants).

1. media_gallery_entries:

• Description: A list of images and media files related to the product.

• Sub-attributes:

  • media_type: The type of media (image, video, etc.).

    • Example: "image"

  • label: A label or description for the image.

    • Example: "Image Label"

  • position: The position/order of the image in the media gallery.

    • Example: 0

  • file: The path to the image or media file.

    • Example: "/r/b/rbj1_4_2.jpeg"

    • Explanation: This is the location of the image file in the system.

1. tier_prices:

• Description: Discounted prices for bulk purchases.

• Example: []

• Explanation: This is an empty array, meaning there are no tier prices (bulk discount pricing) for this product.

1. custom_attributes:

• Description: Custom attributes that define specific product details.

• Sub-attributes:

  • description: The product's full description.

    • Example: "<p>html <b>description here</b></p>"

    • Explanation: The HTML description of the product shown on the product page.

  • meta_title: The meta title for SEO.

    • Example: "Product Meta Title"

    • Explanation: This title is used for search engine optimization and appears in the HTML title tag.

  • meta_keyword: Keywords for SEO.

    • Example: "product, keywords, magento"

    • Explanation: Keywords related to the product, used for SEO purposes.

  • meta_description: The meta description for SEO.

    • Example: "Meta description for the product."

    • Explanation: This description appears in the meta tag of the product page for SEO purposes.

  • image: The primary image of the product.

    • Example: "/r/b/rbj1_4.jpeg"

    • Explanation: This is the image shown as the main product image.

  • short_description: A brief description of the product.

    • Example: "<p>html <b>short description here</b></p>"

    • Explanation: A short version of the product's description that typically appears above the full description.

  • small_image: The image used as a smaller product image (e.g., in search results or product lists).

    • Example: "/r/b/rbj1_4.jpeg"

  • thumbnail: The image used as a thumbnail.

    • Example: "/r/b/rbj1_4.jpeg"

  • options_container: Specifies the display container for options.

    • Example: "container2"

    • Explanation: Defines the container used for options like size or color.

  • swatch_image: The image used for the swatch (e.g., color options).

    • Example: "no_selection"

    • Explanation: The swatch image for the product, indicating no specific selection.

  • purchase_price_cap: The maximum price for purchasing the product.

    • Example: "0.000000"

    • Explanation: Typically used for products that may have a price cap, like discounted or promotional items.

  • msrp_display_actual_price_type: Indicates how the MSRP (Manufacturer's Suggested Retail Price) is displayed.

    • Example: "0"

    • Explanation: The value 0 indicates that the actual price will be shown without the MSRP.

  • tax_class_id: The tax class assigned to the product.

    • Example: "2"

    • Explanation: This represents the product's tax classification (e.g., taxable goods, zero-tax, etc.).

  • category_ids: The IDs of categories that the product belongs to.

    • Example: []

    • Explanation: An empty array, meaning the product does not belong to any specific categories.

  • popular_product: Indicates if the product is marked as popular.

    • Example: "0"

    • Explanation: A value of 0 indicates the product is not marked as popular.

Null SKU 404

{
    "message": "Request does not match any route."
}

Token Not Passed 401

{
    "message": "The consumer isn't authorized to access %resources."
}