Overview
Error Handling

Methods

API Documentation (API Version bleed)

Basket/Item/Config/

DESCRIPTION

Current Available Alsowiths:

	* totals
	* quote
	* options
	* alerts

A desired output with totals and options would have the following alsowith:

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

An output field indicating optional (other than parent_key/parent_value), is returned when the alsowith, it's key, is passed in.

alerts

URL:

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

Description:

Return alerts

Parameters:

ParameterTypeNotes
basket_itemA valid UUID (Universally Unique IDentifier).* Required
keyA product option name.* Required
parent_keyA product option name.
parent_valueA product option value.
valueA product option value.* Required

Returns:

FieldType
alertsAn array of arbitrary values.

Possible Errors:

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

delete

URL:

https://api.liquidweb.com/bleed/Basket/Item/Config/delete

Description:

Parameters:

ParameterTypeNotes
basket_itemA valid UUID (Universally Unique IDentifier).* Required
keyA product option name.* Required
parent_keyA product option name.
parent_valueA product option value.
valueA product option value.* Required

Returns:

FieldType
deletedA boolean value (0 or 1).

Possible Errors:

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

lookup

URL:

https://api.liquidweb.com/bleed/Basket/Item/Config/lookup

Description:

Look up and return the details of a basket item config.

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'alerts', 'discountable', 'options', 'quote', 'totals'
basket_itemA valid UUID (Universally Unique IDentifier).* Required
keyA product option name.* Required
parent_keyA product option name.
parent_valueA product option value.
valueA product option value.* Required

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* Optional
num_units_lockedA boolean value (0 or 1).* Optional
num_units_maxA non-negative integer value (i.e. 0 and up).* Optional
num_units_minA non-negative integer value (i.e. 0 and up).* Optional
num_units_num_setAn array of arbitrary values.* Optional
num_units_typeA single word, consisting of only letters, digits, and underscores.* Optional
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* Optional
num_units_lockedA boolean value (0 or 1).* Optional
num_units_maxA non-negative integer value (i.e. 0 and up).* Optional
num_units_minA non-negative integer value (i.e. 0 and up).* Optional
num_units_num_setAn array of arbitrary values.* Optional
num_units_typeA single word, consisting of only letters, digits, and underscores.* Optional
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* Optional
num_units_lockedA boolean value (0 or 1).* Optional
num_units_maxA non-negative integer value (i.e. 0 and up).* Optional
num_units_minA non-negative integer value (i.e. 0 and up).* Optional
num_units_num_setAn array of arbitrary values.* Optional
num_units_typeA single word, consisting of only letters, digits, and underscores.* Optional
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.

Possible Errors:

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

set

URL:

https://api.liquidweb.com/bleed/Basket/Item/Config/set

Description:

Delete a basket item config

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'alerts', 'discountable', 'options', 'quote', 'totals'
basket_itemA valid UUID (Universally Unique IDentifier).* Required
keyA product option name.* Required
num_unitsAn integer value.
parent_keyA product option name.
parent_valueA product option value.
valueA product option value.* Required

Returns:

FieldTypeNotes
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* Optional
num_units_lockedA boolean value (0 or 1).* Optional
num_units_maxA non-negative integer value (i.e. 0 and up).* Optional
num_units_minA non-negative integer value (i.e. 0 and up).* Optional
num_units_num_setAn array of arbitrary values.* Optional
num_units_typeA single word, consisting of only letters, digits, and underscores.* Optional
optionsAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* Optional
num_units_lockedA boolean value (0 or 1).* Optional
num_units_maxA non-negative integer value (i.e. 0 and up).* Optional
num_units_minA non-negative integer value (i.e. 0 and up).* Optional
num_units_num_setAn array of arbitrary values.* Optional
num_units_typeA single word, consisting of only letters, digits, and underscores.* Optional
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
quoteAn array of associative arrays containing * Optional
 
alertsAn array of associative arrays containing * Optional
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
detailsAn associative array of arbitrary keys and values.
levelOne of: 'error', 'info', 'warn'
messageA string of text, containing no newlines or other control characters.
typeA single word, consisting of only letters, digits, and underscores.
discountA monetary value, such as -$.05, 0.05, or -5.00
discount_deltaA monetary value, such as -$.05, 0.05, or -5.00
discountableA non-negative integer value (i.e. 0 and up).* Optional
extra_dataAn associative array of arbitrary keys and values.* Optional
is_extraA boolean value (0 or 1).
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.* Optional
key_groupA string of text, containing no newlines or other control characters.* Optional
key_group_display_orderA string of text, containing no newlines or other control characters.* Optional
lockedA boolean value (0 or 1).* Optional
nonceA valid UUID (Universally Unique IDentifier).* Optional
num_unitsAn integer value.* Optional
num_units_incrementA positive integer value (i.e. 1 and up).* Optional
num_units_lockedA boolean value (0 or 1).* Optional
num_units_maxA non-negative integer value (i.e. 0 and up).* Optional
num_units_minA non-negative integer value (i.e. 0 and up).* Optional
num_units_num_setAn array of arbitrary values.* Optional
num_units_typeA single word, consisting of only letters, digits, and underscores.* Optional
parent_keyA product option name.* Optional
parent_valueA product option value.* Optional
priceA monetary value, such as -$.05, 0.05, or -5.00
price_deltaA monetary value, such as -$.05, 0.05, or -5.00
price_totalA monetary value, such as -$.05, 0.05, or -5.00
price_total_deltaA monetary value, such as -$.05, 0.05, or -5.00
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
tax_deltaA monetary value, such as -$.05, 0.05, or -5.00
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
taxA monetary value, such as -$.05, 0.05, or -5.00* Optional
totalsAn associative array containing the fields:* Optional
 
subtotal_costA monetary value, such as -$.05, 0.05, or -5.00
total_costA monetary value, such as -$.05, 0.05, or -5.00
validA boolean value (0 or 1).
valueA product option value.
value_commentsA string of text, containing no newlines or other control characters.* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.

Possible Errors:

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