ProductOptionsUpdate Endpoint

Overview

It wouldn't be unusual to need to update an existing product option.  This endpoint allows you to update any specific product option in your store.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript
  • Visual Studio 2012 or newer

Getting Started

You should already have a project open and ready to accept code to allow you to use this REST API endpoint.  You should also have one or more product options created so that you can successfully find one to update.

ProductOptionsUpdate

This REST API endpoint allows you to update a product option in your store. This requires that you also have a product option to update, which would mean that you should also call the ProductOptionsFind endpoint to get an existing product option.

Example URL

This is what the REST endpoint will look like if you are calling it using JavaScript.  See our REST API URL documentation for more information.

http://example.com/DesktopModules/Hotcakes/API/rest/v1/productoptions/[BVIN]

BVIN is the product option ID as described in the parameters below.

HTTP Method

POST

Parameters

Parameter Description
bvin This is the unique ID of the product option that you wish to update
data You will need to pass an updated JSON version of the OptionDTO object in your post request

Returns

If successful, this endpoint will return a populated OptionDTO object in JSON format.  Otherwise, you should have one or more errors returned.  

Example Code

The following code will allow you to successfully call this endpoint, provided that you have enabled it.

Project References

  • Hotcakes.CommerceDTO

Import Namespaces

  • Hotcakes.CommerceDTO.v1
  • Hotcakes.CommerceDTO.v1.Catalog
  • Hotcakes.CommerceDTO.v1.Client

 

string url = "http://example.com";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// specify the option ID to look for and update
var optionId = "7fd9da28-3eee-4892-b33a-93b7b99df451";

// call the API to find the product option
var option = proxy.ProductOptionsFind(optionId).Content;

// update one or more properties of the option
option.Name = "Common Colors";

// call the API to update the product option
ApiResponse<OptionDTO> response = proxy.ProductOptionsUpdate(option);
// your domain name
var url = "http://example.com"; 
// the path where the API is
var apiPath = "/DesktopModules/Hotcakes/API/rest/v1/";  
// endpoint as shown in the documentation
var endPoint = "productoptions";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the option ID to look for and update
    var optionId = "DC2D6134-0DBE-422A-BEAE-096273787FD3";

    // call the API to find the product option
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + optionId + "?key=" + apiKey,
        type: 'GET',
        success: function (data) {
            // update the product option in another method
            UpdateProductOption(data.Content);
        },
        error: function (jqXHR, textStatus) {
            // do something
        }
    });

});

function UpdateProductOption(option) {
            
    // update one or more properties of the option
    option.Name = "Common Colors";

    // call the API to update the product option
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + option.Bvin + "?key=" + apiKey,
        data: JSON.stringify(option),
        type: 'POST',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
            // do something else
        }
    });

}
{
   "Errors":[

   ],
   "Content":{
      "Bvin":"dc2d6134-0dbe-422a-beae-096273787fd3",
      "StoreId":1,
      "OptionType":100,
      "Name":"Common Colors",
      "NameIsHidden":false,
      "IsVariant":false,
      "IsShared":false,
      "Settings":[
         {
            "Key":"ERPID",
            "Value":"1234567890"
         }
      ],
      "TextSettings":[

      ],
      "Items":[
         {
            "Bvin":"92061e92-8680-47c0-a956-8c0e3152c852",
            "StoreId":1,
            "OptionBvin":"dc2d6134-0dbe-422a-beae-096273787fd3",
            "Name":"Red",
            "PriceAdjustment":0,
            "WeightAdjustment":0,
            "IsLabel":false,
            "SortOrder":1,
            "IsDefault":false
         },
         {
            "Bvin":"408dc399-ecdf-4dd0-816d-9ecd69fd8af7",
            "StoreId":1,
            "OptionBvin":"dc2d6134-0dbe-422a-beae-096273787fd3",
            "Name":"White",
            "PriceAdjustment":0,
            "WeightAdjustment":0,
            "IsLabel":false,
            "SortOrder":2,
            "IsDefault":false
         },
         {
            "Bvin":"ea17b0e3-4885-4e12-a44f-d7ce38f72f94",
            "StoreId":1,
            "OptionBvin":"dc2d6134-0dbe-422a-beae-096273787fd3",
            "Name":"Blue",
            "PriceAdjustment":0,
            "WeightAdjustment":0,
            "IsLabel":false,
            "SortOrder":3,
            "IsDefault":false
         }
      ]
   }
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.