Overview
Error Handling

Methods

API Documentation (API Version bleed)

Basket/

DESCRIPTION

The Basket API is used to purchase Liquid Web products and services. A basket is comprised of items and item configs. Items represent products and item configs represent the product options.

Current Available Alsowiths:

	* totals
	* items
	* configs
	* alerts
	* productInfo**

A desired output with all item(s) and config(s) including the basket, item(s), and config(s) totals would have the following alsowith:

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

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

** 'productInfo' is a supported nested alsowith off of the 'items' alsowith. E.g.

	{... "alsowith":["items", ["items", "productInfo"] ]" ...}

addCoupon

URL:

https://api.liquidweb.com/bleed/Basket/addCoupon

Description:

Parameters:

ParameterTypeNotes
coupon_codeA 6 to 36 character coupon code* Required
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

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

assertMetadata

URL:

https://api.liquidweb.com/bleed/Basket/assertMetadata

Description:

Update basket metadata without affecting existing metadata.

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
metadataAn associative array of arbitrary keys and values.* Required
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldType
metadataAn associative array of arbitrary keys and values.

Possible Errors:

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

claim

URL:

https://api.liquidweb.com/bleed/Basket/claim

Description:

Claim a basket to the authenticated to this API user as the owner. If the user is associated to a Liquid Web account, the basket will also be claimed to that account. Any not already purchased basket associated with the same owner will be merged.

Users that claimed a basket before having a Liquid Web account will need to recall this method to claim the basket to the user's Liquid Web account.

Parameters:

ParameterTypeNotes
alsowithAn array of
mergeA boolean value (0 or 1).* Optional
  • Defaults to: 1
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldTypeNotes
accountA valid account number, up to 6 digits in length.* 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.
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
itemsAn 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.
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
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
num_unitsAn integer value.* 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
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
num_unitsAn integer value.* 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
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
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
num_unitsAn integer value.* 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
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.
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
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
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_termEither: 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).
metadataAn associative array of arbitrary keys and values.* Optional
nameA string of text, containing no newlines or other control characters.* Optional
ownerA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Optional
share_codeA string of text, containing no newlines or other control characters.
statusA single word, consisting of only letters, digits, and underscores.
totalsAn associative array containing the fields:* Optional
 
items_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
items_prepay_discount_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_prepay_once_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_prepay_ongoing_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_price_totalA monetary value, such as -$.05, 0.05, or -5.00
items_setup_fee_totalA monetary value, such as -$.05, 0.05, or -5.00
items_subtotalA monetary value, such as -$.05, 0.05, or -5.00
items_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
total_basket_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/clone

Description:

Clone an existing basket.

Parameters:

ParameterTypeNotes
alsowithAn array of
share_codeA string of text, containing no newlines or other control characters.* Required

Returns:

FieldTypeNotes
accountA valid account number, up to 6 digits in length.* 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.
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
itemsAn 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.
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
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
num_unitsAn integer value.* 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
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
num_unitsAn integer value.* 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
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
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
num_unitsAn integer value.* 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
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.
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
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
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_termEither: 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).
metadataAn associative array of arbitrary keys and values.* Optional
nameA string of text, containing no newlines or other control characters.* Optional
ownerA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Optional
share_codeA string of text, containing no newlines or other control characters.
statusA single word, consisting of only letters, digits, and underscores.
totalsAn associative array containing the fields:* Optional
 
items_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
items_prepay_discount_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_prepay_once_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_prepay_ongoing_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_price_totalA monetary value, such as -$.05, 0.05, or -5.00
items_setup_fee_totalA monetary value, such as -$.05, 0.05, or -5.00
items_subtotalA monetary value, such as -$.05, 0.05, or -5.00
items_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
total_basket_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

create

URL:

https://api.liquidweb.com/bleed/Basket/create

Description:

Create a new basket.

Parameters:

ParameterType
accountA valid account number, up to 6 digits in length.
alsowithAn array of
itemsAn array of associative arrays containing
 
configsAn array of associative arrays containing
 
keyA product option name.* Required
num_unitsAn integer value.
parent_keyA product option name.
parent_valueA product option value.
valueA product option value.* Required
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
metadataAn associative array of arbitrary keys and values.
nameA string of text, containing no newlines or other control characters.
ownerA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Returns:

FieldTypeNotes
accountA valid account number, up to 6 digits in length.* 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.
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
itemsAn 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.
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
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
num_unitsAn integer value.* 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
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
num_unitsAn integer value.* 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
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
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
num_unitsAn integer value.* 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
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.
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
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
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_termEither: 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).
metadataAn associative array of arbitrary keys and values.* Optional
nameA string of text, containing no newlines or other control characters.* Optional
ownerA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Optional
share_codeA string of text, containing no newlines or other control characters.
statusA single word, consisting of only letters, digits, and underscores.
totalsAn associative array containing the fields:* Optional
 
items_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
items_prepay_discount_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_prepay_once_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_prepay_ongoing_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_price_totalA monetary value, such as -$.05, 0.05, or -5.00
items_setup_fee_totalA monetary value, such as -$.05, 0.05, or -5.00
items_subtotalA monetary value, such as -$.05, 0.05, or -5.00
items_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
total_basket_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/details

Description:

Given a basket UUID, return details of the basket.

Parameters:

ParameterType
alsowithAn array of
uuidA valid UUID (Universally Unique IDentifier).

Returns:

FieldTypeNotes
accountA valid account number, up to 6 digits in length.* 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.
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
itemsAn 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.
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
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
num_unitsAn integer value.* 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
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
num_unitsAn integer value.* 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
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
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
num_unitsAn integer value.* 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
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.
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
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
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_termEither: 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).
metadataAn associative array of arbitrary keys and values.* Optional
nameA string of text, containing no newlines or other control characters.* Optional
ownerA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Optional
share_codeA string of text, containing no newlines or other control characters.
statusA single word, consisting of only letters, digits, and underscores.
totalsAn associative array containing the fields:* Optional
 
items_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
items_prepay_discount_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_prepay_once_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_prepay_ongoing_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_price_totalA monetary value, such as -$.05, 0.05, or -5.00
items_setup_fee_totalA monetary value, such as -$.05, 0.05, or -5.00
items_subtotalA monetary value, such as -$.05, 0.05, or -5.00
items_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
total_basket_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

list

URL:

https://api.liquidweb.com/bleed/Basket/list

Description:

Lists all baskets belonging to your user (owner of basket).

Parameters:

ParameterTypeNotes
alsowithAn array of
order_byAn associative array containing the fields:
 
fieldOne of: 'id', 'name', 'uuid'* Required
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25
statusAn array of One of: 'empty', 'pending', 'purchased', 'ready'

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
accountA valid account number, up to 6 digits in length.* 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.
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
itemsAn 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.
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
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
num_unitsAn integer value.* 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
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
num_unitsAn integer value.* 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
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
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
num_unitsAn integer value.* 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
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.
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
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
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_termEither: 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).
metadataAn associative array of arbitrary keys and values.* Optional
nameA string of text, containing no newlines or other control characters.* Optional
ownerA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Optional
share_codeA string of text, containing no newlines or other control characters.
statusA single word, consisting of only letters, digits, and underscores.
totalsAn associative array containing the fields:* Optional
 
items_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
items_prepay_discount_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_prepay_once_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_prepay_ongoing_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_price_totalA monetary value, such as -$.05, 0.05, or -5.00
items_setup_fee_totalA monetary value, such as -$.05, 0.05, or -5.00
items_subtotalA monetary value, such as -$.05, 0.05, or -5.00
items_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
total_basket_costA monetary value, such as -$.05, 0.05, or -5.00
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

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

purchase

URL:

https://api.liquidweb.com/bleed/Basket/purchase

Description:

Purchase a basket. Basket must be valid and have a 'ready' status to complete the purchase with an order.

Obtain a 'ready' status by applying taxes to the basket (see applyTaxes method).

Parameters:

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

Returns:

FieldTypeNotes
accountA valid account number, up to 6 digits in length.* 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.
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
itemsAn 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.
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
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
num_unitsAn integer value.* 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
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
num_unitsAn integer value.* 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
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
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
num_unitsAn integer value.* 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
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.
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
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
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_termEither: 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).
metadataAn associative array of arbitrary keys and values.* Optional
nameA string of text, containing no newlines or other control characters.* Optional
ownerA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Optional
share_codeA string of text, containing no newlines or other control characters.
statusA single word, consisting of only letters, digits, and underscores.
totalsAn associative array containing the fields:* Optional
 
items_discount_totalA monetary value, such as -$.05, 0.05, or -5.00
items_prepay_discount_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_prepay_once_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_prepay_ongoing_totalEither: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only.
items_price_totalA monetary value, such as -$.05, 0.05, or -5.00
items_setup_fee_totalA monetary value, such as -$.05, 0.05, or -5.00
items_subtotalA monetary value, such as -$.05, 0.05, or -5.00
items_tax_totalA monetary value, such as -$.05, 0.05, or -5.00
total_basket_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

removeCoupon

URL:

https://api.liquidweb.com/bleed/Basket/removeCoupon

Description:

Parameters:

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

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

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