Overview
Error Handling

Methods

API Documentation (API Version v1)

Product/

DESCRIPTION

This section contains some basic methods for getting lists of products, and details, prices of products.

details

URL:

https://api.stormondemand.com/v1/Product/details

Description:

Returns information about a product's pricing and options.

The product code for a specific server or service on an account can be found with the Server/Details method, under the 'type' field, and a list of valid product codes can be obtained via the Product/List method.

Parameters:

ParameterTypeNotes
aliasA string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max.
codeA valid product code, at least 3 chars long, including at least one letter.* Required if:
  • alias is not given

Returns:

FieldTypeNotes
aliasA string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max.* Optional
capabilitiesAn associative array of arbitrary keys and values.
categoriesAn array of a string permitting tabs, carriage returns and newlines
codeA valid product code, at least 3 chars long, including at least one letter.
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
default_priceA positive floating-point value representing a price, containing 2 to 5 decimals.
descriptionA string of text, containing no newlines or other control characters.
featuresAn array of a string permitting tabs, carriage returns and newlines
option_value_featuresAn associative array of arbitrary keys and values.* Optional
optionsAn array of associative arrays containing
 
automatedA boolean value (0 or 1).* Optional
display_orderA non-negative integer value (i.e. 0 and up).
display_textA string permitting tabs, carriage returns and newlines
keyA product option name.
option_key_idA non-negative integer value (i.e. 0 and up).
publicA boolean value (0 or 1).
requiredA boolean value (0 or 1).
valuesAn array of an associative array of arbitrary keys and values.
parent_productAn associative array of arbitrary keys and values.* Optional
pricesAn associative array of arbitrary keys and values.* Optional
related_productAn associative array of arbitrary keys and values.* Optional
seriesAn array of a string of text, containing no newlines or other control characters.
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

getProductCodeFromPath

URL:

https://api.stormondemand.com/v1/Product/getProductCodeFromPath

Description:

Converts path elements to a product code and alias.

Parameters:

ParameterTypeNotes
planA single word, consisting of only letters and digits.* Required
plan_typeA single word, consisting of only letters and digits.* Required
seriesA single word, consisting of only letters and digits.* Required

Returns:

FieldType
aliasA string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max.
codeA valid product code, at least 3 chars long, including at least one letter.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

list

URL:

https://api.stormondemand.com/v1/Product/list

Description:

Returns production information for all products, or products in a series or category depending on the arguments passed. Only returns products available to the account.

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
cart_categoryEither: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits.
cart_planEither: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits.
cart_seriesEither: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits.
categoryA single word, consisting of only letters and digits.
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25
seriesA single word, consisting of only letters and digits.

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
aliasA string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max.* Optional
codeA valid product code, at least 3 chars long, including at least one letter.
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
default_priceA positive floating-point value representing a price, containing 2 to 5 decimals.
descriptionA string of text, containing no newlines or other control characters.
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

marketingList

URL:

https://api.stormondemand.com/v1/Product/marketingList

Description:

Return required 'marketing' information for products.

Inputs includes everything that list accepts, plus key which is the option_key for certain products.

Parameters:

ParameterTypeNotes
activeA boolean value (0 or 1).* Optional
  • Defaults to: 1
alsowithA single word, consisting of only letters, digits, and underscores.
cart_categoryEither: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits.
cart_planEither: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits.
cart_seriesEither: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits.
categoryA single word, consisting of only letters and digits.
featuredA boolean value (0 or 1).
keyA product option name.
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25
product_codeEither: a valid product code, at least 3 chars long, including at least one letter.; or An array of a valid product code, at least 3 chars long, including at least one letter.
seriesA single word, consisting of only letters and digits.

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
aliasA string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max.* Optional
codeA valid product code, at least 3 chars long, including at least one letter.
default_priceAn associative array containing the values:
 
hourA positive floating-point value representing a price, containing 2 to 5 decimals.* Optional
monthA positive floating-point value representing a price, containing 2 to 5 decimals.
one-timeA positive floating-point value representing a price, containing 2 to 5 decimals.* Optional
quarterA positive floating-point value representing a price, containing 2 to 5 decimals.* Optional
semiannualA positive floating-point value representing a price, containing 2 to 5 decimals.* Optional
yearA positive floating-point value representing a price, containing 2 to 5 decimals.* Optional
descriptionA string of text, containing no newlines or other control characters.
featuresAn array of a string permitting tabs, carriage returns and newlines
keyA product option name.* Optional
pricesAn associative array of arbitrary keys and values.* Optional
starting_priceAn associative array containing the values:
 
hourA positive floating-point value representing a price, containing 2 to 5 decimals.* Optional
monthA positive floating-point value representing a price, containing 2 to 5 decimals.
one-timeA positive floating-point value representing a price, containing 2 to 5 decimals.* Optional
quarterA positive floating-point value representing a price, containing 2 to 5 decimals.* Optional
semiannualA positive floating-point value representing a price, containing 2 to 5 decimals.* Optional
yearA positive floating-point value representing a price, containing 2 to 5 decimals.* Optional
sub_titleA string.* Optional
titleA string.* Optional
valueA string permitting tabs, carriage returns and newlines* Optional
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

price

URL:

https://api.stormondemand.com/v1/Product/price

Description:

Get a total price for a product, including other useful information that will affect the order.

The 'balance' is the amount of money on the account that will be used prior to attempting to charge your credit card for the server creation.

The 'initial' amount is the amount you need to prepay for the server for now until your next billing date.

The 'cc_chage' amount is the amount that will be charged to your credit card, if your account is set to the credit card payment method.

'approved' is a boolean. If true then this purchase would be allowed by the system.

Parameters:

ParameterTypeNotes
codeA valid product code, at least 3 chars long, including at least one letter.* Required
featuresAn associative array of arbitrary keys and values.* Required
regionA positive integer value (i.e. 1 and up).* Required

Returns:

FieldTypeNotes
approvedA boolean value (0 or 1).
balanceA monetary value, such as -$.05, 0.05, or -5.00* Optional
cc_chargeA monetary value, such as -$.05, 0.05, or -5.00* Optional
hourA monetary value, such as -$.05, 0.05, or -5.00* Optional
initialA monetary value, such as -$.05, 0.05, or -5.00
monthA monetary value, such as -$.05, 0.05, or -5.00* Optional
next_billA valid date in YYYY-MM-DD format.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

startingPrice

URL:

https://api.stormondemand.com/v1/Product/startingPrice

Description:

Returns the minimal price for a product, picking the cheapest feature for each slot.

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
codeEither: a valid product code, at least 3 chars long, including at least one letter.; or An array of a valid product code, at least 3 chars long, including at least one letter.* Required

Returns:

FieldType
itemsAn array of associative arrays containing
 
priceAn associative array containing the values:
 
hourA positive floating-point value representing a price, containing 2 to 5 decimals.
monthA positive floating-point value representing a price, containing 2 to 5 decimals.
productA valid product code, at least 3 chars long, including at least one letter.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types