Overview
Error Handling

Methods

API Documentation (API Version bleed)

Product/

DESCRIPTION

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

detailList

URL:

https://api.liquidweb.com/bleed/Product/detailList

Description:

Returns a datastructure with information about a products pricing and options. The options can be a tree structure of arbitrary depth.

Parameters:

ParameterTypeNotes
aliasAn array of a string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max.
codeAn array of a valid product code, at least 3 chars long, including at least one letter.* Required if:
  • alias is not given
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

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
 
activeA boolean value (0 or 1).* Optional
aliasA string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max.* Optional
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.
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
defaultSubdomainA single word, consisting of only letters, digits, and underscores.* Optional
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.
discountableA boolean value (0 or 1).* Optional
display_in_catalogA boolean value (0 or 1).* Optional
entereddateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
featuresAn array of a string permitting tabs, carriage returns and newlines
global_discountableA boolean value (0 or 1).* Optional
idA non-negative integer value (i.e. 0 and up).* Optional
option_value_featuresAn associative array of arbitrary keys and values.* Optional
optionsAn array of associative arrays containing * Optional
 
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
parent_product_idA non-negative integer value (i.e. 0 and up).* Optional
pov_tagsAn array of a string of text, containing no newlines or other control characters.* Optional
price_time_unit_idA non-negative integer value (i.e. 0 and up).* Optional
pricesAn associative array of arbitrary keys and values.* Optional
related_productAn associative array of arbitrary keys and values.* Optional
related_product_idA positive integer value (i.e. 1 and up).* Optional
seriesAn array of a string of text, containing no newlines or other control characters.
sub_titleA string.* Optional
subdomainA single word, consisting of only letters, digits, and underscores.* 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

details

URL:

https://api.liquidweb.com/bleed/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.
alsowithA single word, consisting of only letters, digits, and underscores.
available_onlyA boolean value (0 or 1).
codeA valid product code, at least 3 chars long, including at least one letter.* Required if:
  • alias is not given
include_pov_tagsA boolean value (0 or 1).

Returns:

FieldTypeNotes
aliasA string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max.* Optional
ancestorCodeA valid product code, at least 3 chars long, including at least one letter.
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.
credit_eligibleA boolean value (0 or 1).* Optional
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.
discountableA boolean value (0 or 1).* Optional
featuresAn array of a string permitting tabs, carriage returns and newlines
global_discountableA boolean value (0 or 1).* Optional
option_value_featuresAn associative array of arbitrary keys and values.* Optional
optionsAn array of associative arrays containing * Optional
 
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
pov_tagsAn array of a string of text, containing no newlines or other control characters.* Optional
pricesAn associative array of arbitrary keys and values.* Optional
purchaseQuantityLimitA positive integer value (i.e. 1 and up).* 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
subdomainA single word, consisting of only letters, digits, and underscores.* 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

flatDetails

URL:

https://api.liquidweb.com/bleed/Product/flatDetails

Description:

Returns all the necessary product data in a flat structure. If called by a user associated to an account, 'extra_data' will be included to provide account specific data.

By default, data returned will be reduced, in that keys/value pairs of which the value is null or empty (e.g. {} or []), the key/value pair is deleted from the returned data.

Optional parameter 'price_time_unit_override' will re-calculate prices to the specified override price time unit unless the price time unit is 'nontemporal' or 'deferred' or 'one-time'.

Parameters:

ParameterTypeNotes
price_time_unit_overrideOne of: 'hour', 'month', 'quarter', 'semiannual', 'year'
product_codeA valid product code, at least 3 chars long, including at least one letter.* Required
reduce_dataA boolean value (0 or 1).* Optional
  • Defaults to: 1

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
capabilitiesAn array of arbitrary values.* Optional
categoriesAn array of arbitrary values.
credit_eligibleA boolean value (0 or 1).
descriptionA string.
discountableA boolean value (0 or 1).
flat_optionsAn array of associative arrays containing * Optional
 
descriptionA string of text, containing no newlines or other control characters.
display_orderAn integer value.* Optional
groupA string of text, containing no newlines or other control characters.
group_display_orderA string of text, containing no newlines or other control characters.
keyA product option name.
linkA string permitting tabs, carriage returns and newlines* Optional
parent_keyA product option name.* Optional
parent_ptok_idA valid id number (a positive integer).* Optional
parent_ptov_idA valid id number (a positive integer).* Optional
parent_valueA product option value.* Optional
ptok_idA valid id number (a positive integer).
ptov_product_codeA valid product code, at least 3 chars long, including at least one letter.
publicA boolean value (0 or 1).
requiredA boolean value (0 or 1).
valuesAn array of associative arrays containing
 
activeA boolean value (0 or 1).
commentsA string permitting tabs, carriage returns and newlines* Optional
descriptionA string of text, containing no newlines or other control characters.
discountableA boolean value (0 or 1).
display_orderAn integer value.* Optional
num_unitsAn integer value.* Optional
num_units_lockedA boolean value (0 or 1).* Optional
num_units_maxA non-negative integer value (i.e. 0 and up).* Optional
num_units_minA non-negative integer value (i.e. 0 and up).* Optional
num_units_num_setAn array of arbitrary values.* Optional
num_units_typeA single word, consisting of only letters, digits, and underscores.* Optional
price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
ptov_aclsAn associative array containing the fields:* Optional
 
forbidsAn array of arbitrary values.* Optional
is_forbidden_byAn array of arbitrary values.* Optional
is_required_byAn array of arbitrary values.* Optional
requiresAn array of arbitrary values.* Optional
ptov_idA valid id number (a positive integer).
publicA boolean value (0 or 1).
region_id_defaultsAn associative array of arbitrary keys and values.
region_id_pricesAn associative array of arbitrary keys and values.* Optional
tagsAn array of arbitrary values.* Optional
valueA product option value.
marketplace_activeA boolean value (0 or 1).
marketplace_descriptionA string potentially containing and/or ending with newline characters.
marketplace_display_orderA non-negative integer value (i.e. 0 and up).
marketplace_publicA boolean value (0 or 1).
parent_product_idA positive integer value (i.e. 1 and up).* Optional
prepay_settingsAn associative array of arbitrary keys and values.* Optional
price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
primary_categoryA string permitting tabs, carriage returns and newlines* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_idA valid id number (a positive integer).
publicA boolean value (0 or 1).
region_id_pricesAn associative array of arbitrary keys and values.
related_product_idA positive integer value (i.e. 1 and up).* Optional
series_descriptionA string permitting tabs, carriage returns and newlines* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
series_entry_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
subdomainA single word, consisting of only letters, digits, and underscores.* Optional
tagsAn array of arbitrary values.* Optional
titleA string.* Optional

Possible Errors:

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

flatPublicDefaultOptions

URL:

https://api.liquidweb.com/bleed/Product/flatPublicDefaultOptions

Description:

Returns all the necessary product data for a default configuration in a flat structure.

By default, data returned will be reduced, in that keys/value pairs of which the value is null or empty (e.g. {} or []), the key/value pair is deleted from the returned data. Optional parameter to disable this may be passed in.

Parameters:

ParameterTypeNotes
product_codeA valid product code, at least 3 chars long, including at least one letter.* Required
reduce_dataA boolean value (0 or 1).* Optional
  • Defaults to: 1
region_idA valid id number (a positive integer).* Required

Returns:

FieldType
flat_optionsAn array of associative arrays containing
 
descriptionA string of text, containing no newlines or other control characters.
display_orderAn integer value.* Optional
groupA string of text, containing no newlines or other control characters.
group_display_orderA string of text, containing no newlines or other control characters.
keyA product option name.
linkA string permitting tabs, carriage returns and newlines* Optional
parent_keyA product option name.* Optional
parent_ptok_idA valid id number (a positive integer).* Optional
parent_ptov_idA valid id number (a positive integer).* Optional
parent_valueA product option value.* Optional
ptok_idA valid id number (a positive integer).
ptov_product_codeA valid product code, at least 3 chars long, including at least one letter.
publicA boolean value (0 or 1).
requiredA boolean value (0 or 1).
valuesAn array of associative arrays containing
 
activeA boolean value (0 or 1).
commentsA string permitting tabs, carriage returns and newlines* Optional
descriptionA string of text, containing no newlines or other control characters.
discountableA boolean value (0 or 1).
display_orderAn integer value.* Optional
num_unitsAn integer value.* Optional
num_units_lockedA boolean value (0 or 1).* Optional
num_units_maxA non-negative integer value (i.e. 0 and up).* Optional
num_units_minA non-negative integer value (i.e. 0 and up).* Optional
num_units_num_setAn array of arbitrary values.* Optional
num_units_typeA single word, consisting of only letters, digits, and underscores.* Optional
price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
ptov_aclsAn associative array containing the fields:* Optional
 
forbidsAn array of arbitrary values.* Optional
is_forbidden_byAn array of arbitrary values.* Optional
is_required_byAn array of arbitrary values.* Optional
requiresAn array of arbitrary values.* Optional
ptov_idA valid id number (a positive integer).
publicA boolean value (0 or 1).
region_id_defaultsAn associative array of arbitrary keys and values.
region_id_pricesAn associative array of arbitrary keys and values.* Optional
tagsAn array of arbitrary values.* Optional
valueA product option value.

Possible Errors:

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

getProductCodeFromPath

URL:

https://api.liquidweb.com/bleed/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.liquidweb.com/bleed/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.
credit_eligibleA boolean value (0 or 1).* Optional
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.
discountableA boolean value (0 or 1).* Optional
global_discountableA boolean value (0 or 1).* Optional
sub_titleA string.* Optional
subdomainA single word, consisting of only letters, digits, and underscores.* 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.liquidweb.com/bleed/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 fields:
 
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 fields:
 
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.liquidweb.com/bleed/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

primaryCategoryMapping

URL:

https://api.liquidweb.com/bleed/Product/primaryCategoryMapping

Description:

Return a hash mapping of all product codes and the primary categories associated with them

Parameters:

No Values Defined

Returns:

FieldType
One or more keys matching: a valid product code, at least 3 chars long, including at least one letter.A single word, consisting of only letters and digits.

Possible Errors:

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

startingPrice

URL:

https://api.liquidweb.com/bleed/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 fields:
 
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

zonesWithAvailability

URL:

https://api.liquidweb.com/bleed/Product/zonesWithAvailability

Description:

Returns zone availability and the region the zone belongs to for Provisioned products.

Parameters:

ParameterTypeNotes
product_codeA valid product code, at least 3 chars long, including at least one letter.* Required
region_idA valid id number (a positive integer).

Returns:

FieldType
availableAn array of arbitrary values.

Possible Errors:

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