ProductOptionsFind Endpoint

Overview

Sometimes you just need to find a product option to do something unique with it.  This endpoint allows you to find a 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.

ProductOptionsFind

This REST API endpoint allows you to find a product option in your store. 

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

GET

Parameters

Parameter Description
bvin This is the unique ID of the product option that you wish to find

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 an ID of the product option to find
var optionId = "CF2A6DCF-AD2A-4ACF-A78B-0F0909E9C40D";

// call the API to find the product option
ApiResponse<OptionDTO> response = proxy.ProductOptionsFind(optionId);
// 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 ID of the product option to look for
    var optionId = "DC2D6134-0DBE-422A-BEAE-096273787FD3";

    // call the API to find the specified product option
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + optionId + "?key=" + apiKey,
        type: 'GET',
        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":"Color",
      "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.0000000000,
            "WeightAdjustment":0.0000000000,
            "IsLabel":false,
            "SortOrder":1,
            "IsDefault":false
         },
         {
            "Bvin":"408dc399-ecdf-4dd0-816d-9ecd69fd8af7",
            "StoreId":1,
            "OptionBvin":"dc2d6134-0dbe-422a-beae-096273787fd3",
            "Name":"White",
            "PriceAdjustment":0.0000000000,
            "WeightAdjustment":0.0000000000,
            "IsLabel":false,
            "SortOrder":2,
            "IsDefault":false
         },
         {
            "Bvin":"ea17b0e3-4885-4e12-a44f-d7ce38f72f94",
            "StoreId":1,
            "OptionBvin":"dc2d6134-0dbe-422a-beae-096273787fd3",
            "Name":"Blue",
            "PriceAdjustment":0.0000000000,
            "WeightAdjustment":0.0000000000,
            "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.