Overview
Error Handling

Methods

API Documentation (API Version bleed)

Market/Bundle/

DESCRIPTION

This section of the API allows for obtaining information of market bundle(s).

details

URL:

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

Description:

For the specified bundle code, return details of the bundle.

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
codeA valid market bundle code, beginning with "BNDL-" 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 bundle code, beginning with "BNDL-" 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_bundle_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_bundle_codeA valid market bundle code, beginning with "BNDL-" and the rest beging at least 3 chars long, including at least one letter.
prior_idA boolean value (0 or 1).* Optional
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/Bundle/list

Description:

Returns a list of all bundles 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 bundle code, beginning with "BNDL-" 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_bundle_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_bundle_codeA valid market bundle code, beginning with "BNDL-" and the rest beging at least 3 chars long, including at least one letter.
prior_idA boolean value (0 or 1).* Optional
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