List Product Options

This method retrieves all available product options for a specific store product. Options are unique to each product, so this request must be used for each individual product.

Each option has a name and ID. Each option also has values that have their own names and IDs. Example:

Option Name: Shirt Size

Option Values: Small, Medium, Large, XL

REST

Request

https://api.neoncrm.com/neonws/services/api/store/listProductOptions?userSessionId=[session_id]&productId=78

Response

{
   "ListProductOptionsResponse":
   {
       "operationResult": "SUCCESS",
       "responseMessage": "3 records found.",
       "responseDateTime": "2014-09-11T09:51:40.847-05:00",
       "productOptions":
       {
           "option":
           [
               {
                   "optionId": 18,
                   "name": "Size",
                   "optionValues":
                   {
                       "optionValue":
                       [
                           {
                               "optionValueId": 44,
                               "name": "S"
                           },
                           {
                               "optionValueId": 45,
                               "name": "M"
                           },
                           {
                               "optionValueId": 46,
                               "name": "L"
                           },
                           {
                               "optionValueId": 47,
                               "name": "XL"
                           },
                           {
                               "optionValueId": 76,
                               "name": "XXL",
                               "priceAdjustment": 5
                           }
                       ]
                   }
               },
               {
                   "optionId": 32,
                   "name": "",
                   "optionValues":
                   {
                       "optionValue":
                       [
                           {
                               "optionValueId": 82,
                               "name": "red"
                           },
                           {
                               "optionValueId": 83,
                               "name": "blue"
                           },
                           {
                               "optionValueId": 84,
                               "name": "purple"
                           },
                           {
                               "optionValueId": 85,
                               "name": "yellow"
                           }
                       ]
                   }
               },
               {
                   "optionId": 34,
                   "name": "10% off",
                   "optionValues":
                   {
                       "optionValue":
                       [
                           {
                               "optionValueId": 90,
                               "name": "10% off",
                               "priceAdjustment": -50
                           }
                       ]
                   }
               }
           ]
       }
   }
}

Request Parameters

Name	Required	Description
productId	Yes	The ID of the product for which you would like to retrieve options.

Response Parameters

Name	Required	Description
productOptions.option.optionId	Yes	Product Option ID
productOptions.option.name	Yes	Name of the new product option
productOptions.optionValues.optionValue.optionValueId	Yes	An option value’s ID
productOptions.optionValues.optionValue.name	Yes	An option value’s name
productOptions.optionValues.optionValue.priceAdjustment		This parameter should be repeated for each option value. Value can be either a positive or negative integer (-5, 2, 100)

Error Codes

Code	Text	Description
12202	Product id is invalid.	This product does not exist. Ensure that the product ID is correct.