Overview
Error Handling

Methods

API Documentation (API Version bleed)

Basket/Item/

DESCRIPTION

Current Available Alsowiths:

	* totals
	* configs

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.

add

URL:

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

Description:

Add an item to a basket.

Parameters:

ParameterTypeNotes
alsowithAn array of
basketA valid UUID (Universally Unique IDentifier).* Required
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

Returns:

FieldTypeNotes
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).

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.* Required
num_unitsAn integer value.
parent_keyA product option name.
parent_valueA product option value.
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.
regionA positive integer value (i.e. 1 and up).
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldType
itemsAn array of associative arrays containing
 
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).

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
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).

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.* Required
num_unitsAn integer value.
parent_keyA product option name.
parent_valueA product option value.
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.
regionA positive integer value (i.e. 1 and up).
uuidA valid UUID (Universally Unique IDentifier).* Required

Returns:

FieldTypeNotes
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).

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