URL:

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

Parameter	Type	Notes
alias	A string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max.
alsowith	A single word, consisting of only letters, digits, and underscores.
available_only	A boolean value (0 or 1).
code	A valid product code, at least 3 chars long, including at least one letter.	* Required if: alias is not given
include_pov_tags	A boolean value (0 or 1).

Returns:

Field	Type	Notes
alias	A string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max.	* Optional
ancestorCode	A valid product code, at least 3 chars long, including at least one letter.
capabilities	An associative array of arbitrary keys and values.
categories	An array of a string permitting tabs, carriage returns and newlines
code	A valid product code, at least 3 chars long, including at least one letter.
credit_eligible	A boolean value (0 or 1).	* Optional
cycle	A single word, consisting of only letters, digits, hyphens, and underscores.
default_price	A positive floating-point value representing a price, containing 2 to 5 decimals.
description	A string of text, containing no newlines or other control characters.
discountable	A boolean value (0 or 1).	* Optional
features	An array of a string permitting tabs, carriage returns and newlines
global_discountable	A boolean value (0 or 1).	* Optional
option_value_features	An associative array of arbitrary keys and values.	* Optional
options	An array of associative arrays containing	* Optional
	automated A boolean value (0 or 1). * Optional display_order A non-negative integer value (i.e. 0 and up). display_text A string permitting tabs, carriage returns and newlines key A product option name. option_key_id A non-negative integer value (i.e. 0 and up). public A boolean value (0 or 1). required A boolean value (0 or 1). values An array of an associative array of arbitrary keys and values.
parent_product	An associative array of arbitrary keys and values.	* Optional
pov_tags	An array of a string of text, containing no newlines or other control characters.	* Optional
prices	An associative array of arbitrary keys and values.	* Optional
purchaseQuantityLimit	A positive integer value (i.e. 1 and up).	* Optional
related_product	An associative array of arbitrary keys and values.	* Optional
series	An array of a string of text, containing no newlines or other control characters.
sub_title	A string.	* Optional
subdomain	A single word, consisting of only letters, digits, and underscores.	* Optional
tax_code	A single word, consisting of only letters and digits.	* Optional
title	A string.	* Optional

Possible Errors:

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

URL:

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

Description:

Converts path elements to a product code and alias.

Parameters:

Parameter	Type	Notes
plan	A single word, consisting of only letters and digits.	* Required
plan_type	A single word, consisting of only letters and digits.	* Required
series	A single word, consisting of only letters and digits.	* Required

Returns:

Field	Type
alias	A string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max.
code	A 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

URL:

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

Parameter	Type	Notes
alsowith	A single word, consisting of only letters, digits, and underscores.
cart_category	Either: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits.
cart_plan	Either: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits.
cart_series	Either: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits.
category	A single word, consisting of only letters and digits.
page_num	A positive integer value (i.e. 1 and up).	* Optional Defaults to: 1
page_size	A positive integer value (i.e. 1 and up).	* Optional Defaults to: 25
series	A single word, consisting of only letters and digits.

Returns:

Field	Type
item_count	A non-negative integer value (i.e. 0 and up).
item_total	A non-negative integer value (i.e. 0 and up).
items	An array of associative arrays containing
	alias A string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max. * Optional code A valid product code, at least 3 chars long, including at least one letter. credit_eligible A boolean value (0 or 1). * Optional cycle A single word, consisting of only letters, digits, hyphens, and underscores. default_price A positive floating-point value representing a price, containing 2 to 5 decimals. description A string of text, containing no newlines or other control characters. discountable A boolean value (0 or 1). * Optional global_discountable A boolean value (0 or 1). * Optional sub_title A string. * Optional subdomain A single word, consisting of only letters, digits, and underscores. * Optional tax_code A single word, consisting of only letters and digits. * Optional title A string. * Optional
page_num	A positive integer value (i.e. 1 and up).
page_size	A positive integer value (i.e. 1 and up).
page_total	A positive integer value (i.e. 1 and up).

Possible Errors:

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

URL:

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

Parameter	Type	Notes
active	A boolean value (0 or 1).	* Optional Defaults to: 1
alsowith	A single word, consisting of only letters, digits, and underscores.
cart_category	Either: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits.
cart_plan	Either: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits.
cart_series	Either: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits.
category	A single word, consisting of only letters and digits.
featured	A boolean value (0 or 1).
key	A product option name.
page_num	A positive integer value (i.e. 1 and up).	* Optional Defaults to: 1
page_size	A positive integer value (i.e. 1 and up).	* Optional Defaults to: 25
product_code	Either: 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.
series	A single word, consisting of only letters and digits.

Returns:

Field	Type
item_count	A non-negative integer value (i.e. 0 and up).
item_total	A non-negative integer value (i.e. 0 and up).
items	An array of associative arrays containing
	alias A string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max. * Optional code A valid product code, at least 3 chars long, including at least one letter. default_price An associative array containing the fields:   hour A positive floating-point value representing a price, containing 2 to 5 decimals. * Optional month A positive floating-point value representing a price, containing 2 to 5 decimals. one-time A positive floating-point value representing a price, containing 2 to 5 decimals. * Optional quarter A positive floating-point value representing a price, containing 2 to 5 decimals. * Optional semiannual A positive floating-point value representing a price, containing 2 to 5 decimals. * Optional year A positive floating-point value representing a price, containing 2 to 5 decimals. * Optional description A string of text, containing no newlines or other control characters. features An array of a string permitting tabs, carriage returns and newlines key A product option name. * Optional prices An associative array of arbitrary keys and values. * Optional starting_price An associative array containing the fields:   hour A positive floating-point value representing a price, containing 2 to 5 decimals. * Optional month A positive floating-point value representing a price, containing 2 to 5 decimals. one-time A positive floating-point value representing a price, containing 2 to 5 decimals. * Optional quarter A positive floating-point value representing a price, containing 2 to 5 decimals. * Optional semiannual A positive floating-point value representing a price, containing 2 to 5 decimals. * Optional year A positive floating-point value representing a price, containing 2 to 5 decimals. * Optional sub_title A string. * Optional title A string. * Optional value A string permitting tabs, carriage returns and newlines * Optional
page_num	A positive integer value (i.e. 1 and up).
page_size	A positive integer value (i.e. 1 and up).
page_total	A positive integer value (i.e. 1 and up).

Possible Errors:

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

URL:

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

Parameter	Type	Notes
code	A valid product code, at least 3 chars long, including at least one letter.	* Required
features	An associative array of arbitrary keys and values.	* Required
region	A positive integer value (i.e. 1 and up).	* Required

Returns:

Field	Type	Notes
approved	A boolean value (0 or 1).
balance	A monetary value, such as -$.05, 0.05, or -5.00	* Optional
cc_charge	A monetary value, such as -$.05, 0.05, or -5.00	* Optional
hour	A monetary value, such as -$.05, 0.05, or -5.00	* Optional
initial	A monetary value, such as -$.05, 0.05, or -5.00
month	A monetary value, such as -$.05, 0.05, or -5.00	* Optional
next_bill	A valid date in YYYY-MM-DD format.

Possible Errors:

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

URL:

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

Description:

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

Parameters:

Parameter	Type	Notes
alsowith	A single word, consisting of only letters, digits, and underscores.
code	Either: 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:

Field	Type
items	An array of associative arrays containing
	price An associative array containing the fields:   hour A positive floating-point value representing a price, containing 2 to 5 decimals. month A positive floating-point value representing a price, containing 2 to 5 decimals. product A 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