Overview
Error Handling

Methods

API Documentation (API Version bleed)

Market/Bundle/Package/

DESCRIPTION

This section of the API allows for interacting with packages for a given bundle.

list

URL:

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

Description:

Returns a list of all packages of a bundle for a given search.

Parameters:

ParameterTypeNotes
codeA valid market bundle code, beginning with "BNDL-" and the rest beging at least 3 chars long, including at least one letter.* Required
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
version_idA valid id number (a positive integer).

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
 
add_onA boolean value (0 or 1).* Optional
display_orderA positive integer value (i.e. 1 and up).
idA valid id number (a positive integer).
market_bundle_version_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
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