PUT api/magento/catalog/products/{sku}/update

Updates a product

Request Information

URI Parameters

Name	Description	Type	Additional information
sku	sku	string	Required

Body Parameters

Product update request

SuiteBridge.Models.Magento.ProductUpdateRequest

Name	Description	Type	Additional information
productData	product data	SuiteBridge.MagentoWebService.catalogProductCreateEntity	None.

Request Formats

application/json, text/json

Sample:

{
  "productData": {
    "categories": [
      "sample string 1",
      "sample string 2"
    ],
    "websites": [
      "sample string 1",
      "sample string 2"
    ],
    "name": "sample string 1",
    "description": "sample string 2",
    "short_description": "sample string 3",
    "weight": "sample string 4",
    "status": "sample string 5",
    "url_key": "sample string 6",
    "url_path": "sample string 7",
    "visibility": "sample string 8",
    "category_ids": [
      "sample string 1",
      "sample string 2"
    ],
    "website_ids": [
      "sample string 1",
      "sample string 2"
    ],
    "has_options": "sample string 9",
    "gift_message_available": "sample string 10",
    "price": "sample string 11",
    "special_price": "sample string 12",
    "special_from_date": "sample string 13",
    "special_to_date": "sample string 14",
    "tax_class_id": "sample string 15",
    "tier_price": [
      {
        "customer_group_id": "sample string 1",
        "website": "sample string 2",
        "qty": 3,
        "qtySpecified": true,
        "price": 5.1,
        "priceSpecified": true
      },
      {
        "customer_group_id": "sample string 1",
        "website": "sample string 2",
        "qty": 3,
        "qtySpecified": true,
        "price": 5.1,
        "priceSpecified": true
      }
    ],
    "meta_title": "sample string 16",
    "meta_keyword": "sample string 17",
    "meta_description": "sample string 18",
    "custom_design": "sample string 19",
    "custom_layout_update": "sample string 20",
    "options_container": "sample string 21",
    "additional_attributes": [
      {
        "key": "sample string 1",
        "value": "sample string 2"
      },
      {
        "key": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "stock_data": {
      "qty": "sample string 1",
      "is_in_stock": 2,
      "is_in_stockSpecified": true,
      "manage_stock": 4,
      "manage_stockSpecified": true,
      "use_config_manage_stock": 6,
      "use_config_manage_stockSpecified": true,
      "min_qty": 8,
      "min_qtySpecified": true,
      "use_config_min_qty": 10,
      "use_config_min_qtySpecified": true,
      "min_sale_qty": 12,
      "min_sale_qtySpecified": true,
      "use_config_min_sale_qty": 14,
      "use_config_min_sale_qtySpecified": true,
      "max_sale_qty": 16,
      "max_sale_qtySpecified": true,
      "use_config_max_sale_qty": 18,
      "use_config_max_sale_qtySpecified": true,
      "is_qty_decimal": 20,
      "is_qty_decimalSpecified": true,
      "backorders": 22,
      "backordersSpecified": true,
      "use_config_backorders": 24,
      "use_config_backordersSpecified": true,
      "notify_stock_qty": 26,
      "notify_stock_qtySpecified": true,
      "use_config_notify_stock_qty": 28,
      "use_config_notify_stock_qtySpecified": true
    },
    "associated_skus": [
      "sample string 1",
      "sample string 2"
    ],
    "configurable_attributes": [
      "sample string 1",
      "sample string 2"
    ],
    "price_changes": [
      {
        "key": "sample string 1",
        "value": [
          {
            "key": "sample string 1",
            "value": "sample string 2"
          },
          {
            "key": "sample string 1",
            "value": "sample string 2"
          }
        ]
      },
      {
        "key": "sample string 1",
        "value": [
          {
            "key": "sample string 1",
            "value": "sample string 2"
          },
          {
            "key": "sample string 1",
            "value": "sample string 2"
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ProductUpdateRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <productData>
    <categories>
      <complexObjectArray>sample string 1</complexObjectArray>
      <complexObjectArray>sample string 2</complexObjectArray>
    </categories>
    <websites>
      <complexObjectArray>sample string 1</complexObjectArray>
      <complexObjectArray>sample string 2</complexObjectArray>
    </websites>
    <name>sample string 1</name>
    <description>sample string 2</description>
    <short_description>sample string 3</short_description>
    <weight>sample string 4</weight>
    <status>sample string 5</status>
    <url_key>sample string 6</url_key>
    <url_path>sample string 7</url_path>
    <visibility>sample string 8</visibility>
    <category_ids>
      <complexObjectArray>sample string 1</complexObjectArray>
      <complexObjectArray>sample string 2</complexObjectArray>
    </category_ids>
    <website_ids>
      <complexObjectArray>sample string 1</complexObjectArray>
      <complexObjectArray>sample string 2</complexObjectArray>
    </website_ids>
    <has_options>sample string 9</has_options>
    <gift_message_available>sample string 10</gift_message_available>
    <price>sample string 11</price>
    <special_price>sample string 12</special_price>
    <special_from_date>sample string 13</special_from_date>
    <special_to_date>sample string 14</special_to_date>
    <tax_class_id>sample string 15</tax_class_id>
    <tier_price>
      <complexObjectArray>
        <customer_group_id>sample string 1</customer_group_id>
        <website>sample string 2</website>
        <qty>3</qty>
        <price>5.1</price>
      </complexObjectArray>
      <complexObjectArray>
        <customer_group_id>sample string 1</customer_group_id>
        <website>sample string 2</website>
        <qty>3</qty>
        <price>5.1</price>
      </complexObjectArray>
    </tier_price>
    <meta_title>sample string 16</meta_title>
    <meta_keyword>sample string 17</meta_keyword>
    <meta_description>sample string 18</meta_description>
    <custom_design>sample string 19</custom_design>
    <custom_layout_update>sample string 20</custom_layout_update>
    <options_container>sample string 21</options_container>
    <additional_attributes>
      <complexObjectArray>
        <key>sample string 1</key>
        <value>sample string 2</value>
      </complexObjectArray>
      <complexObjectArray>
        <key>sample string 1</key>
        <value>sample string 2</value>
      </complexObjectArray>
    </additional_attributes>
    <stock_data>
      <qty>sample string 1</qty>
      <is_in_stock>2</is_in_stock>
      <manage_stock>4</manage_stock>
      <use_config_manage_stock>6</use_config_manage_stock>
      <min_qty>8</min_qty>
      <use_config_min_qty>10</use_config_min_qty>
      <min_sale_qty>12</min_sale_qty>
      <use_config_min_sale_qty>14</use_config_min_sale_qty>
      <max_sale_qty>16</max_sale_qty>
      <use_config_max_sale_qty>18</use_config_max_sale_qty>
      <is_qty_decimal>20</is_qty_decimal>
      <backorders>22</backorders>
      <use_config_backorders>24</use_config_backorders>
      <notify_stock_qty>26</notify_stock_qty>
      <use_config_notify_stock_qty>28</use_config_notify_stock_qty>
    </stock_data>
    <associated_skus>
      <complexObjectArray>sample string 1</complexObjectArray>
      <complexObjectArray>sample string 2</complexObjectArray>
    </associated_skus>
    <configurable_attributes>
      <complexObjectArray>sample string 1</complexObjectArray>
      <complexObjectArray>sample string 2</complexObjectArray>
    </configurable_attributes>
    <price_changes>
      <complexObjectArray>
        <key>sample string 1</key>
        <value>
          <complexObjectArray>
            <key>sample string 1</key>
            <value>sample string 2</value>
          </complexObjectArray>
          <complexObjectArray>
            <key>sample string 1</key>
            <value>sample string 2</value>
          </complexObjectArray>
        </value>
      </complexObjectArray>
      <complexObjectArray>
        <key>sample string 1</key>
        <value>
          <complexObjectArray>
            <key>sample string 1</key>
            <value>sample string 2</value>
          </complexObjectArray>
          <complexObjectArray>
            <key>sample string 1</key>
            <value>sample string 2</value>
          </complexObjectArray>
        </value>
      </complexObjectArray>
    </price_changes>
  </productData>
</ProductUpdateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

status 200 OK on successful update

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.