Overview
Error Handling

Methods

API Documentation (API Version bleed)

Basket/Item/

DESCRIPTION

Current Available Alsowiths:

    * totals
    * configs
    * alerts**
    * productInfo
    * quote (chained off configs alsowith, e.g. "alsowith":["configs", ["configs", "quote"])
    * options (chained off configs alsowith, e.g. "alsowith":["configs", ["configs", "options"])

A desired output with all configs including both item and config totals would have the following alsowith:

    {... "alsowith":["totals", "configs", ["configs", "totals"]" ...}

An output field indicating optional, is returned when the alsowith, it's key, is passed in.

** 'alerts' is a supported nested alsowith off of the 'configs' alsowith. E.g.

    {... "alsowith":["configs", ["configs", "alerts"] ]" ...}

add

URL:

https://api.liquidweb.com/bleed/Basket/Item/add

Description:

Add an item to a basket.

For PrivateParent items, additional properties are required:

  • parent

    The subaccount unique id of the Private Parent this child will be created on.

  • memory

    The amount of memory to assign to this child.

  • diskspace

    The amount of disk space to assign to this child.

  • vcpu

    The number of vcpu's to assign to this child.

Parameters:

ParameterTypeNotes
alsowithAn array of
basketA valid UUID (Universally Unique IDentifier).* Required
configsAn array of associative arrays containing
 
keyA product option name.
num_unitsAn integer value.
parent_keyA product option name.
parent_valueA product option value.
ptokA positive integer value (i.e. 1 and up).
ptovA positive integer value (i.e. 1 and up).
valueA product option value.
product_codeA valid product code, at least 3 chars long, including at least one letter.* Required
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).* Required

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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

addForClone

URL:

https://api.liquidweb.com/bleed/Basket/Item/addForClone

Description:

Adds an item to the basket that is a clone of the options of an existing subaccount, falling back to default product options if the existing subaccount's product options are no longer valid for new subaccounts.

Parameters:

ParameterTypeNotes
alsowithAn array of
basketA valid UUID (Universally Unique IDentifier).* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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

addForParent

URL:

https://api.liquidweb.com/bleed/Basket/Item/addForParent

Description:

Add an item to the basket that is associated to a PrivateParent

Parameters:

ParameterTypeNotes
alsowithAn array of
basketA valid UUID (Universally Unique IDentifier).* Required
diskspaceA positive integer value (i.e. 1 and up).* Required
memoryA positive integer value (i.e. 1 and up).* Required
parentA six-character identifier, containing only capital letters and digits.* Required
product_codeA valid product code, at least 3 chars long, including at least one letter.* Required
vcpuA positive integer value (i.e. 1 and up).* Required

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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

addForRestore

URL:

https://api.liquidweb.com/bleed/Basket/Item/addForRestore

Description:

Adds an item to the basket that is a provisioned product, noting the product with the needed backup/image information to restore from.

Parameters:

ParameterTypeNotes
alsowithAn array of
basketA valid UUID (Universally Unique IDentifier).* Required
product_codeOne of: 'SS.VM', 'SS.VM.WIN', 'SS.VPS', 'SS.VPS.WIN'* Required
regionA valid id number (a positive integer).* Required
restore_idA string of text, containing no newlines or other control characters.* Required
restore_typeOne of: 'backup', 'image'* Required

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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

addForScenario

URL:

https://api.liquidweb.com/bleed/Basket/Item/addForScenario

Description:

Creates a new item on the basket and applies the scenario to it.

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
basketA valid UUID (Universally Unique IDentifier).* Required
scenarioA single word, consisting of only letters, digits, and underscores.* Required
scenario_argsAn associative array of arbitrary keys and values.

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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

alerts

URL:

https://api.liquidweb.com/bleed/Basket/Item/alerts

Description:

Returns alerts for a basket item. Optionally return alerts for its configs.

Parameters:

ParameterTypeNotes
config_alertsA boolean value (0 or 1).
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldTypeNotes
alertsAn array of arbitrary values.
config_alertsAn array of arbitrary values.* Optional

Possible Errors:

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

assertProperties

URL:

https://api.liquidweb.com/bleed/Basket/Item/assertProperties

Description:

Update basket item properties without affecting existing properties.

Note: Array contents are not merged. For example:

    * existing: { 'key' : [1,2] }

    * assert: { 'key' : [3,4] }

    * result: { 'key' : [3,4] } not { key : [1,2,3,4] }

Parameters:

ParameterTypeNotes
nonceA valid UUID (Universally Unique IDentifier).
propertiesAn associative array of arbitrary keys and values.* Required
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldType
propertiesAn associative array of arbitrary keys and values.

Possible Errors:

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

bulkModify

URL:

https://api.liquidweb.com/bleed/Basket/Item/bulkModify

Description:

Modify existing items in bulk.

Parameters:

ParameterTypeNotes
alsowithAn array of
itemsAn array of associative arrays containing * Required
 
configsAn array of associative arrays containing
 
keyA product option name.
num_unitsAn integer value.
parent_keyA product option name.
parent_valueA product option value.
ptokA positive integer value (i.e. 1 and up).
ptovA positive integer value (i.e. 1 and up).
valueA product option value.
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldType
itemsAn array of associative arrays containing
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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

clone

URL:

https://api.liquidweb.com/bleed/Basket/Item/clone

Description:

Duplicates the specified item one or more times, depending on quantity provided (defaults to 1)

Parameters:

ParameterTypeNotes
alsowithAn array of
quantityA positive integer value (i.e. 1 and up).
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldType
itemsAn array of associative arrays containing
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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

details

URL:

https://api.liquidweb.com/bleed/Basket/Item/details

Description:

Return details of a basket item.

Parameters:

ParameterTypeNotes
alsowithAn array of
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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

extraOptions

URL:

https://api.liquidweb.com/bleed/Basket/Item/extraOptions

Description:

Return any extra options available for the basket item that can be created as a basket item config

Parameters:

ParameterTypeNotes
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldType
optionsAn array of associative arrays containing
 
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.
key_group_display_orderA string of text, containing no newlines or other control characters.
valueA product option value.

Possible Errors:

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

modify

URL:

https://api.liquidweb.com/bleed/Basket/Item/modify

Description:

Modify an existing item.

Parameters:

ParameterTypeNotes
alsowithAn array of
configsAn array of associative arrays containing
 
keyA product option name.
num_unitsAn integer value.
parent_keyA product option name.
parent_valueA product option value.
ptokA positive integer value (i.e. 1 and up).
ptovA positive integer value (i.e. 1 and up).
valueA product option value.
nonceA valid UUID (Universally Unique IDentifier).
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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

remove

URL:

https://api.liquidweb.com/bleed/Basket/Item/remove

Description:

Remove an item from a basket.

Parameters:

ParameterTypeNotes
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldType
deletedA boolean value (0 or 1).

Possible Errors:

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

reset

URL:

https://api.liquidweb.com/bleed/Basket/Item/reset

Description:

Deletes all configs belonging for the basket item and creates new configs from default public product options.

Parameters:

ParameterTypeNotes
alsowithAn array of
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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

swap

URL:

https://api.liquidweb.com/bleed/Basket/Item/swap

Description:

Replaces the current basket item specified by UUID with a new basket item. The new item is either of a different, but similar product type (ie, SS.VPS => SS.VM) or the same product, but in a different region, which requires a recalculation of pricing.

Return the details of the new basket item.

Parameters:

ParameterTypeNotes
alsowithAn array of
product_codeA valid product code, at least 3 chars long, including at least one letter.* Required if:
  • region is not given
regionA positive integer value (i.e. 1 and up).* Required if:
  • product_code is not given
uuidA valid UUID (Universally Unique IDentifier).* Required
zoneA valid id number (a positive integer).

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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

updateForParent

URL:

https://api.liquidweb.com/bleed/Basket/Item/updateForParent

Description:

Update an item within the basket that is associated to a PrivateParent. Allows for changing the PrivateParent the item is associated with along with the various other resource allocations.

Parameters:

ParameterTypeNotes
alsowithAn array of
basket_itemA valid UUID (Universally Unique IDentifier).* Required
diskspaceA positive integer value (i.e. 1 and up).* Required if:
  • memory is not given
  • parent_uniq_id is not given
  • vcpu is not given
memoryA positive integer value (i.e. 1 and up).* Required if:
  • diskspace is not given
  • parent_uniq_id is not given
  • vcpu is not given
parentA six-character identifier, containing only capital letters and digits.* Required if:
  • diskspace is not given
  • memory is not given
  • vcpu is not given
vcpuA positive integer value (i.e. 1 and up).* Required if:
  • diskspace is not given
  • memory is not given
  • parent_uniq_id is not given

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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

updateForRestore

URL:

https://api.liquidweb.com/bleed/Basket/Item/updateForRestore

Description:

Updates an item on the basket that is a provisioned product, noting the product with the needed backup/image information to restore from.

Parameters:

ParameterTypeNotes
alsowithAn array of
basket_itemA valid UUID (Universally Unique IDentifier).* Required
restore_idA string of text, containing no newlines or other control characters.* Required
restore_typeOne of: 'backup', 'image'* Required

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
availableBackupsAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
sizeA positive floating-point value requiring a leading whole number.
templateA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
uniq_idA six-character identifier, containing only capital letters and digits.
availableImagesAn array of associative arrays containing * Optional
 
accntA valid account number, up to 6 digits in length.
hv_typeA single word, consisting of only letters and digits.
idA positive integer value (i.e. 1 and up).
nameA string permitting tabs, carriage returns and newlines (Maximum length: 80)
sizeA positive floating-point value requiring a leading whole number.
source_hostnameA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
source_uniq_idA six-character identifier, containing only capital letters and digits.* Optional
templateA string.
template_descriptionA string.
time_takenA valid date and time in YYYY-MM-DD HH:MM:SS format.
base_priceA monetary value, such as -$.05, 0.05, or -5.00
basket_uuidA valid UUID (Universally Unique IDentifier).
configsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* 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
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.
maxDiscountA non-negative integer value (i.e. 0 and up).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
productInfoAn associative array containing the fields:* Optional
 
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.* Optional
credit_eligibleA boolean value (0 or 1).* Optional
cycleA single word, consisting of only letters, digits, hyphens, and underscores.
discountableA boolean value (0 or 1).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_descriptionA string of text, containing no newlines or other control characters.
product_display_groupA string consisting of only letters, digits, hyphens, spaces, and underscores.* Optional
series_descriptionA string of text, containing no newlines or other control characters.* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
sub_titleA string.* Optional
tax_codeA single word, consisting of only letters and digits.* Optional
titleA string.* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
propertiesAn associative array of arbitrary keys and values.
regionA positive integer value (i.e. 1 and up).
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
timeUnitTotalsAn associative array containing the fields:* Optional
 
configs_discount_totalAn associative array of arbitrary keys and values.
configs_price_totalAn associative array of arbitrary keys and values.
configs_subtotalAn associative array of arbitrary keys and values.
configs_tax_totalAn associative array of arbitrary keys and values.
configs_total_costAn associative array of arbitrary keys and values.
item_discount_totalAn associative array of arbitrary keys and values.
item_price_totalAn associative array of arbitrary keys and values.
item_subtotalAn associative array of arbitrary keys and values.
item_tax_totalAn associative array of arbitrary keys and values.
item_total_costAn associative array of arbitrary keys and values.
subtotal_base_costAn associative array of arbitrary keys and values.
total_base_costAn associative array of arbitrary keys and values.
totalsAn associative array containing the fields:* Optional
 
configs_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_price_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_subtotalA monetary value, such as -$.05, 0.05, or -5.00
configs_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
configs_total_costA monetary value, such as -$.05, 0.05, or -5.00
item_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
item_prepay_auto_renewEither: a boolean value (0 or 1).; or perl undef only.
item_prepay_discountEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_onceEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_ongoingEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
item_prepay_term_maxEither: a non-negative integer value (i.e. 0 and up).; or perl undef only.
item_price_totalA monetary value, such as -$.05, 0.05, or -5.00
item_setup_feeA monetary value, such as -$.05, 0.05, or -5.00
item_subtotalA monetary value, such as -$.05, 0.05, or -5.00
item_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
item_total_costA monetary value, such as -$.05, 0.05, or -5.00
subtotal_base_costA monetary value, such as -$.05, 0.05, or -5.00
total_base_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

Possible Errors:

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