Overview
Error Handling

Methods

API Documentation (API Version bleed)

Market/Cart/Admin/Quote/

DESCRIPTION

This section of the API allows for interacting with a market cart.

create

URL:

https://api.liquidweb.com/bleed/Market/Cart/Admin/Quote/create

Description:

For the specified market cart, create a quote.

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'admin', 'discounts', 'items', 'metadata', 'totals'
basket_admin_usernameA username up to 20 characters in length if active or 24 if suspended.* Required
cart_uuidA valid UUID (Universally Unique IDentifier).
opportunity_idA valid identifier for a Salesforce object* Required

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.* Optional
adminAn associative array of arbitrary keys and values.* Optional
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discountsAn array of associative arrays containing * Optional
 
amountA floating-point value.
deferrableA boolean value (0 or 1).
discount_uuidA valid UUID (Universally Unique IDentifier).
eligibilityAn associative array containing the fields:
 
categoriesAn array of arbitrary values.
productsAn array of arbitrary values.
exclusiveA boolean value (0 or 1).
item_uuidA valid UUID (Universally Unique IDentifier).* Optional
modifiableA boolean value (0 or 1).
modifiedA boolean value (0 or 1).
month_endA non-negative integer value (i.e. 0 and up).
month_startA positive integer value (i.e. 1 and up).
ownerA string of text, containing no newlines or other control characters.
priorityA positive integer value (i.e. 1 and up).
repetitionA non-negative integer value (i.e. 0 and up).
strategyOne of: 'credit', 'percent', 'percent_mrc'
typeOne of: 'account', 'admin', 'bundle', 'coupon', 'offset', 'package', 'reseller'
expirationA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
is_expiredA boolean value (0 or 1).* Optional
is_quoteA boolean value (0 or 1).* Optional
itemsAn array of associative arrays containing * Optional
 
codeEither: a valid market bundle code, beginning with "BNDL-" and the rest beging at least 3 chars long, including at least one letter.; or a valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter.; or a valid product code, at least 3 chars long, including at least one letter.
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
detailsOne of the following:
 

An associative array containing the fields:

A market cart item containing all the details of a cart item containing a single product

* Optional
base_priceA positive floating-point value representing a price, containing 2 to 5 decimals.
capabilitiesAn array of arbitrary values.* Optional
categoriesAn array of arbitrary values.
codeA valid product code, at least 3 chars long, including at least one letter.
descriptionA string permitting tabs, carriage returns and newlines
discountableA boolean value (0 or 1).
extra_dataAn associative array of arbitrary keys and values.* Optional
global_discountableA boolean value (0 or 1).* Optional
optionsAn array of associative arrays containing
 
discountableA boolean value (0 or 1).* Optional
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.
key_groupA string of text, containing no newlines or other control characters.
key_group_display_orderA string of text, containing no newlines or other control characters.
num_unitsAn integer value.* Optional
package_to_product_option_visibilityA single word, consisting of only letters and digits.* Optional
parent_ptok_idA valid id number (a positive integer).* Optional
parent_ptov_idA valid id number (a positive integer).* Optional
priceA positive floating-point value representing a price, containing 2 to 5 decimals.
price_totalA positive floating-point value representing a price, containing 2 to 5 decimals.
ptok_idA valid id number (a positive integer).
ptov_idA valid id number (a positive integer).
valueA product option value.
value_commentsA string permitting tabs, carriage returns and newlines* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_discountableA boolean value (0 or 1).* Optional
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
package_add_onA boolean value (0 or 1).* Optional
package_custom_descriptionA string permitting tabs, carriage returns and newlines* Optional
package_custom_titleA string permitting tabs, carriage returns and newlines* Optional
package_display_orderA positive integer value (i.e. 1 and up).* Optional
package_show_descriptionA boolean value (0 or 1).* Optional
package_to_product_idA valid id number (a positive integer).* Optional
price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
product_idA valid id number (a positive integer).
propertiesAn associative array of arbitrary keys and values.* Optional
region_idA positive integer value (i.e. 1 and up).
related_package_to_product_idA valid id number (a positive integer).* Optional
series_descriptionA string permitting tabs, carriage returns and newlines* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
series_entry_cart_categoryA string permitting tabs, carriage returns and newlines* Optional
series_entry_cart_planA string permitting tabs, carriage returns and newlines* Optional
series_entry_cart_seriesA string permitting tabs, carriage returns and newlines* Optional
series_entry_display_orderA positive integer value (i.e. 1 and up).* Optional
series_entry_featuredA boolean value (0 or 1).* Optional
subdomainA single word, consisting of only letters, digits, and underscores.* Optional
subtitleA string of text, containing no newlines or other control characters.* Optional
titleA string of text, containing no newlines or other control characters.
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).

An associative array containing the fields:

A market cart item containing all the details of a cart item containing a market package

* Optional
bundle_add_onA boolean value (0 or 1).* Optional
bundle_display_orderA positive integer value (i.e. 1 and up).* Optional
bundle_to_package_idA valid id number (a positive integer).* Optional
codeA valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter.
productsAn array of associative arrays containing
 
base_priceA positive floating-point value representing a price, containing 2 to 5 decimals.
capabilitiesAn array of arbitrary values.* Optional
categoriesAn array of arbitrary values.
codeA valid product code, at least 3 chars long, including at least one letter.
descriptionA string permitting tabs, carriage returns and newlines
discountableA boolean value (0 or 1).
extra_dataAn associative array of arbitrary keys and values.* Optional
global_discountableA boolean value (0 or 1).* Optional
optionsAn array of associative arrays containing
 
discountableA boolean value (0 or 1).* Optional
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.
key_groupA string of text, containing no newlines or other control characters.
key_group_display_orderA string of text, containing no newlines or other control characters.
num_unitsAn integer value.* Optional
package_to_product_option_visibilityA single word, consisting of only letters and digits.* Optional
parent_ptok_idA valid id number (a positive integer).* Optional
parent_ptov_idA valid id number (a positive integer).* Optional
priceA positive floating-point value representing a price, containing 2 to 5 decimals.
price_totalA positive floating-point value representing a price, containing 2 to 5 decimals.
ptok_idA valid id number (a positive integer).
ptov_idA valid id number (a positive integer).
valueA product option value.
value_commentsA string permitting tabs, carriage returns and newlines* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_discountableA boolean value (0 or 1).* Optional
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
package_add_onA boolean value (0 or 1).* Optional
package_custom_descriptionA string permitting tabs, carriage returns and newlines* Optional
package_custom_titleA string permitting tabs, carriage returns and newlines* Optional
package_display_orderA positive integer value (i.e. 1 and up).* Optional
package_show_descriptionA boolean value (0 or 1).* Optional
package_to_product_idA valid id number (a positive integer).* Optional
price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
product_idA valid id number (a positive integer).
propertiesAn associative array of arbitrary keys and values.* Optional
region_idA positive integer value (i.e. 1 and up).
related_package_to_product_idA valid id number (a positive integer).* Optional
series_descriptionA string permitting tabs, carriage returns and newlines* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
series_entry_cart_categoryA string permitting tabs, carriage returns and newlines* Optional
series_entry_cart_planA string permitting tabs, carriage returns and newlines* Optional
series_entry_cart_seriesA string permitting tabs, carriage returns and newlines* Optional
series_entry_display_orderA positive integer value (i.e. 1 and up).* Optional
series_entry_featuredA boolean value (0 or 1).* Optional
subdomainA single word, consisting of only letters, digits, and underscores.* Optional
subtitleA string of text, containing no newlines or other control characters.* Optional
titleA string of text, containing no newlines or other control characters.
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).
propertiesAn associative array of arbitrary keys and values.* Optional
titleA string of text, containing no newlines or other control characters.
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).
version_idA valid id number (a positive integer).

An associative array containing the fields:

A market cart item containing all the details of a cart item containing a market bundle

* Optional
codeA valid market bundle code, beginning with "BNDL-" and the rest beging at least 3 chars long, including at least one letter.
packagesAn array of associative arrays containing
 
bundle_add_onA boolean value (0 or 1).* Optional
bundle_display_orderA positive integer value (i.e. 1 and up).* Optional
bundle_to_package_idA valid id number (a positive integer).* Optional
codeA valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter.
productsAn array of associative arrays containing
 
base_priceA positive floating-point value representing a price, containing 2 to 5 decimals.
capabilitiesAn array of arbitrary values.* Optional
categoriesAn array of arbitrary values.
codeA valid product code, at least 3 chars long, including at least one letter.
descriptionA string permitting tabs, carriage returns and newlines
discountableA boolean value (0 or 1).
extra_dataAn associative array of arbitrary keys and values.* Optional
global_discountableA boolean value (0 or 1).* Optional
optionsAn array of associative arrays containing
 
discountableA boolean value (0 or 1).* Optional
keyA product option name.
key_descriptionA string of text, containing no newlines or other control characters.
key_display_orderAn integer value.
key_groupA string of text, containing no newlines or other control characters.
key_group_display_orderA string of text, containing no newlines or other control characters.
num_unitsAn integer value.* Optional
package_to_product_option_visibilityA single word, consisting of only letters and digits.* Optional
parent_ptok_idA valid id number (a positive integer).* Optional
parent_ptov_idA valid id number (a positive integer).* Optional
priceA positive floating-point value representing a price, containing 2 to 5 decimals.
price_totalA positive floating-point value representing a price, containing 2 to 5 decimals.
ptok_idA valid id number (a positive integer).
ptov_idA valid id number (a positive integer).
valueA product option value.
value_commentsA string permitting tabs, carriage returns and newlines* Optional
value_descriptionA string of text, containing no newlines or other control characters.
value_discountableA boolean value (0 or 1).* Optional
value_display_orderAn integer value.
value_price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
package_add_onA boolean value (0 or 1).* Optional
package_custom_descriptionA string permitting tabs, carriage returns and newlines* Optional
package_custom_titleA string permitting tabs, carriage returns and newlines* Optional
package_display_orderA positive integer value (i.e. 1 and up).* Optional
package_show_descriptionA boolean value (0 or 1).* Optional
package_to_product_idA valid id number (a positive integer).* Optional
price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
product_idA valid id number (a positive integer).
propertiesAn associative array of arbitrary keys and values.* Optional
region_idA positive integer value (i.e. 1 and up).
related_package_to_product_idA valid id number (a positive integer).* Optional
series_descriptionA string permitting tabs, carriage returns and newlines* Optional
series_display_orderA positive integer value (i.e. 1 and up).* Optional
series_entry_cart_categoryA string permitting tabs, carriage returns and newlines* Optional
series_entry_cart_planA string permitting tabs, carriage returns and newlines* Optional
series_entry_cart_seriesA string permitting tabs, carriage returns and newlines* Optional
series_entry_display_orderA positive integer value (i.e. 1 and up).* Optional
series_entry_featuredA boolean value (0 or 1).* Optional
subdomainA single word, consisting of only letters, digits, and underscores.* Optional
subtitleA string of text, containing no newlines or other control characters.* Optional
titleA string of text, containing no newlines or other control characters.
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).
propertiesAn associative array of arbitrary keys and values.* Optional
titleA string of text, containing no newlines or other control characters.
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).
version_idA valid id number (a positive integer).
propertiesAn associative array of arbitrary keys and values.* Optional
titleA string of text, containing no newlines or other control characters.
uuidA valid UUID (Universally Unique IDentifier).
validA boolean value (0 or 1).
version_idA valid id number (a positive integer).
typeA string of text, containing no newlines or other control characters.
unitsA positive integer value (i.e. 1 and up).
uuidA valid UUID (Universally Unique IDentifier).
metadataAn associative array of arbitrary keys and values.* Optional
orderableA boolean value (0 or 1).
shareA valid UUID (Universally Unique IDentifier).
statusA single word, consisting of only letters, digits, and underscores.
totalsAn associative array containing the fields:* Optional
 
chargesAn array of associative arrays containing
 
billingAn array of associative arrays containing
 
cartAn associative array containing the fields:
 
costAn associative array containing the fields:
 
discountableA monetary value, such as -$.05, 0.05, or -5.00
non_discountableA monetary value, such as -$.05, 0.05, or -5.00
totalA monetary value, such as -$.05, 0.05, or -5.00
discountsAn array of associative arrays containing
 
amountA floating-point value.
amount_offA monetary value, such as -$.05, 0.05, or -5.00
discount_uuidAn array of a valid UUID (Universally Unique IDentifier).
ineligible_product_uuidsAn array of a valid UUID (Universally Unique IDentifier).
typeOne of: 'account', 'admin', 'bundle', 'coupon', 'offset', 'package', 'reseller'
itemsA positive integer value (i.e. 1 and up).
priceAn associative array containing the fields:
 
discountableA monetary value, such as -$.05, 0.05, or -5.00
non_discountableA monetary value, such as -$.05, 0.05, or -5.00
totalA monetary value, such as -$.05, 0.05, or -5.00
itemsAn array of associative arrays containing
 
costAn associative array containing the fields:
 
discountableA monetary value, such as -$.05, 0.05, or -5.00
non_discountableA monetary value, such as -$.05, 0.05, or -5.00
productsAn array of associative arrays containing
 
base_price_discountableA monetary value, such as -$.05, 0.05, or -5.00
base_price_non_discountableA monetary value, such as -$.05, 0.05, or -5.00
discountableA monetary value, such as -$.05, 0.05, or -5.00
non_discountableA 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.
product_uuidA valid UUID (Universally Unique IDentifier).
totalA monetary value, such as -$.05, 0.05, or -5.00
totalA monetary value, such as -$.05, 0.05, or -5.00
discountsAn array of associative arrays containing
 
amountA floating-point value.
amount_offA monetary value, such as -$.05, 0.05, or -5.00
discount_uuidA valid UUID (Universally Unique IDentifier).
ineligible_product_uuidsAn array of a valid UUID (Universally Unique IDentifier).
typeOne of: 'account', 'admin', 'bundle', 'coupon', 'offset', 'package', 'reseller'
item_uuidA valid UUID (Universally Unique IDentifier).
priceAn associative array containing the fields:
 
discountableA monetary value, such as -$.05, 0.05, or -5.00
non_discountableA monetary value, such as -$.05, 0.05, or -5.00
productsAn array of associative arrays containing
 
base_price_discountableA monetary value, such as -$.05, 0.05, or -5.00
base_price_non_discountableA monetary value, such as -$.05, 0.05, or -5.00
discountableA monetary value, such as -$.05, 0.05, or -5.00
non_discountableA 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.
product_uuidA valid UUID (Universally Unique IDentifier).
totalA monetary value, such as -$.05, 0.05, or -5.00
totalA monetary value, such as -$.05, 0.05, or -5.00
month_endA positive integer value (i.e. 1 and up).
month_startA positive integer value (i.e. 1 and up).
monthsA positive integer value (i.e. 1 and up).
occurrenceA positive integer value (i.e. 1 and up).
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
creditsAn array of associative arrays containing
 
amount_offA monetary value, such as -$.05, 0.05, or -5.00
item_uuidA valid UUID (Universally Unique IDentifier).* Optional
month_endA positive integer value (i.e. 1 and up).
month_startA positive integer value (i.e. 1 and up).
monthsA positive integer value (i.e. 1 and up).
summaryAn associative array containing the fields:
 
cartAn associative array containing the fields:
 
amount_off_todayA monetary value, such as -$.05, 0.05, or -5.00
costA monetary value, such as -$.05, 0.05, or -5.00
due_todayA monetary value, such as -$.05, 0.05, or -5.00
priceA monetary value, such as -$.05, 0.05, or -5.00
itemsAn array of associative arrays containing
 
costA monetary value, such as -$.05, 0.05, or -5.00
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
discountsAn array of associative arrays containing
 
amountA monetary value, such as -$.05, 0.05, or -5.00
amount_off_todayA monetary value, such as -$.05, 0.05, or -5.00
discount_uuidA valid UUID (Universally Unique IDentifier).
ownerA string of text, containing no newlines or other control characters.
repetitionsA non-negative integer value (i.e. 0 and up).
typeOne of: 'account', 'admin', 'bundle', 'coupon', 'offset', 'package', 'reseller'
item_uuidA valid UUID (Universally Unique IDentifier).
priceA monetary value, such as -$.05, 0.05, or -5.00
timelineAn array of associative arrays containing
 
costA monetary value, such as -$.05, 0.05, or -5.00
cyclesAn array of a valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
monthA positive integer value (i.e. 1 and up).
priceA monetary value, such as -$.05, 0.05, or -5.00
updatedA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
uuidA valid UUID (Universally Unique IDentifier).
versionA positive integer value (i.e. 1 and up).

Possible Errors:

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