Overview
Error Handling

Methods

API Documentation (API Version bleed)

Market/Package/

DESCRIPTION

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

details

URL:

https://api.liquidweb.com/bleed/Market/Package/details

Description:

For the specified package code, return details of the package. If a version ID is not provided, the latest version regardless of whether it's published or not will be returned.

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
codeA valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter.* Required
version_idA valid id number (a positive integer).

Returns:

FieldType
codeA valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter.
last_updatedA valid date and time in YYYY-MM-DD HH:MM:SS format.
statusOne of: 'active', 'archived', 'draft', 'retired'
titleA string permitting tabs, carriage returns and newlines
versionAn associative array containing the fields:
 
allow_couponA boolean value (0 or 1).
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
currentA boolean value (0 or 1).* Optional
cyclesAn array of associative arrays containing
 
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
cycle_repetitionsAn integer value.* Optional
discount_amountA floating-point value.
idA valid id number (a positive integer).
market_package_version_idA valid id number (a positive integer).
prior_idA boolean value (0 or 1).* Optional
descriptionA string permitting tabs, carriage returns and newlines* Optional
featuresAn array of a string permitting tabs, carriage returns and newlines* Optional
idA valid id number (a positive integer).
market_package_codeA valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter.
prior_idA boolean value (0 or 1).* Optional
productsAn array of associative arrays containing * Optional
 
add_onA boolean value (0 or 1).* Optional
categoriesAn array of arbitrary values.
custom_descriptionA string permitting tabs, carriage returns and newlines* Optional
custom_titleA string permitting tabs, carriage returns and newlines* Optional
default_region_idA valid id number (a positive integer).
descriptionA string.
display_orderA positive integer value (i.e. 1 and up).
idA valid id number (a positive integer).
market_package_version_idA valid id number (a positive integer).
marketplace_descriptionA string potentially containing and/or ending with newline characters.
optionsAn array of associative arrays containing
 
descriptionA string of text, containing no newlines or other control characters.
display_orderAn integer value.* Optional
groupA string of text, containing no newlines or other control characters.
group_display_orderAn integer value.
keyA product option name.
market_package_product_idA valid id number (a positive integer).
parent_keyA product option name.* Optional
parent_ptok_idA valid id number (a positive integer).* Optional
parent_ptov_idA valid id number (a positive integer).* Optional
parent_valueA product option value.* Optional
ptok_idA valid id number (a positive integer).
valuesAn array of associative arrays containing
 
commentsA string permitting tabs, carriage returns and newlines* Optional
descriptionA string of text, containing no newlines or other control characters.
display_orderAn integer value.
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
price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
ptov_aclsAn associative array of arbitrary keys and values.* Optional
ptov_idA valid id number (a positive integer).
region_id_dataAn associative array of arbitrary keys and values.
tagsAn array of arbitrary values.* Optional
valueA product option value.
price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
primary_categoryA string permitting tabs, carriage returns and newlines
prior_idA valid id number (a positive integer).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_idA valid id number (a positive integer).
region_id_availabilityAn array of arbitrary values.
region_id_pricesAn associative array of arbitrary keys and values.
related_market_package_to_product_idA valid id number (a positive integer).* Optional
series_descriptionA string permitting tabs, carriage returns and newlines
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_featuredA boolean value (0 or 1).* Optional
show_descriptionA boolean value (0 or 1).* Optional
sub_titleA string.* Optional
tagsAn array of arbitrary values.* Optional
tax_codeA single word, consisting of only letters, digits, and underscores.* Optional
titleA string.
publishedA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Market/Package/list

Description:

Returns a list of all packages for a given search.

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
filterAn array of associative arrays containing
 
fieldOne of: 'code', 'status', 'title'* Required
termOne of the following:* Required
 
A string of text, containing no newlines or other control characters.
An array of a string of text, containing no newlines or other control characters.
order_byAn associative array containing the fields:
 
fieldThe value: 'code'* 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
return_archived

A boolean value (0 or 1).

Unless this is set to true, no results with a status of "archived" will be returned

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
 
codeA valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter.
last_updatedA valid date and time in YYYY-MM-DD HH:MM:SS format.
statusOne of: 'active', 'archived', 'draft', 'retired'
titleA string permitting tabs, carriage returns and newlines
versionAn associative array containing the fields:
 
allow_couponA boolean value (0 or 1).
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
currentA boolean value (0 or 1).* Optional
cyclesAn array of associative arrays containing
 
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
cycle_repetitionsAn integer value.* Optional
discount_amountA floating-point value.
idA valid id number (a positive integer).
market_package_version_idA valid id number (a positive integer).
prior_idA boolean value (0 or 1).* Optional
descriptionA string permitting tabs, carriage returns and newlines* Optional
featuresAn array of a string permitting tabs, carriage returns and newlines* Optional
idA valid id number (a positive integer).
market_package_codeA valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter.
prior_idA boolean value (0 or 1).* Optional
productsAn array of associative arrays containing * Optional
 
add_onA boolean value (0 or 1).* Optional
categoriesAn array of arbitrary values.
custom_descriptionA string permitting tabs, carriage returns and newlines* Optional
custom_titleA string permitting tabs, carriage returns and newlines* Optional
default_region_idA valid id number (a positive integer).
descriptionA string.
display_orderA positive integer value (i.e. 1 and up).
idA valid id number (a positive integer).
market_package_version_idA valid id number (a positive integer).
marketplace_descriptionA string potentially containing and/or ending with newline characters.
optionsAn array of associative arrays containing
 
descriptionA string of text, containing no newlines or other control characters.
display_orderAn integer value.* Optional
groupA string of text, containing no newlines or other control characters.
group_display_orderAn integer value.
keyA product option name.
market_package_product_idA valid id number (a positive integer).
parent_keyA product option name.* Optional
parent_ptok_idA valid id number (a positive integer).* Optional
parent_ptov_idA valid id number (a positive integer).* Optional
parent_valueA product option value.* Optional
ptok_idA valid id number (a positive integer).
valuesAn array of associative arrays containing
 
commentsA string permitting tabs, carriage returns and newlines* Optional
descriptionA string of text, containing no newlines or other control characters.
display_orderAn integer value.
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
price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
ptov_aclsAn associative array of arbitrary keys and values.* Optional
ptov_idA valid id number (a positive integer).
region_id_dataAn associative array of arbitrary keys and values.
tagsAn array of arbitrary values.* Optional
valueA product option value.
price_time_unitA single word, consisting of only letters, digits, hyphens, and underscores.
primary_categoryA string permitting tabs, carriage returns and newlines
prior_idA valid id number (a positive integer).* Optional
product_codeA valid product code, at least 3 chars long, including at least one letter.
product_idA valid id number (a positive integer).
region_id_availabilityAn array of arbitrary values.
region_id_pricesAn associative array of arbitrary keys and values.
related_market_package_to_product_idA valid id number (a positive integer).* Optional
series_descriptionA string permitting tabs, carriage returns and newlines
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_featuredA boolean value (0 or 1).* Optional
show_descriptionA boolean value (0 or 1).* Optional
sub_titleA string.* Optional
tagsAn array of arbitrary values.* Optional
tax_codeA single word, consisting of only letters, digits, and underscores.* Optional
titleA string.
publishedA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
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