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

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.

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
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldTypeNotes
accountA valid account number, up to 6 digits in length.* Optional
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
 
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
 
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.
num_unitsAn integer 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
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_descriptionA string of text, containing no newlines or other control characters.
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
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_price_totalA 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_price_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
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
 
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
 
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.
num_unitsAn integer 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
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_descriptionA string of text, containing no newlines or other control characters.
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
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_price_totalA 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_price_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
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
 
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
 
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.
num_unitsAn integer 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
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_descriptionA string of text, containing no newlines or other control characters.
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
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_price_totalA 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_price_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
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
 
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
 
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.
num_unitsAn integer 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
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_descriptionA string of text, containing no newlines or other control characters.
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
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_price_totalA 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_price_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

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.

If the basket is pending, valid, and fully claimed with an owner and account, calling purchase will perform any final actions (e.g. tax assessments) and return the basket with a 'ready' status. This is to allow the basket purchaser to review any changes that occured as a result of the final actions. If there were no changes, the basket will instead complete the purchase with an order.

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
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
 
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
 
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.
num_unitsAn integer 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
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_descriptionA string of text, containing no newlines or other control characters.
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
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_price_totalA 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_price_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