Overview
Error Handling

Methods

API Documentation (API Version bleed)

Product/Marketplace/

DESCRIPTION

This section of the API handles product marketplace operations.

Current Available Alsowiths:

	- product
	- startingPrice*
	- features*

* Chained alsowith, used with product alsowith (see below for example)

A desired output with product details and the product's starting price would have the following alsowith:

	{... "alsowith":["product", ["product", "startingPrice", "features"] ] ...}

An output field indicating optional, is returned when the alsowith, it's key, is passed in.

details

URL:

https://api.liquidweb.com/bleed/Product/Marketplace/details

Description:

This method can be used to obtain details for an active product in the marketplace

Parameters:

ParameterTypeNotes
alsowithAn array of
product_codeA valid product code, at least 3 chars long, including at least one letter.* Required

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
descriptionA string of text, containing no newlines or other control characters.
display_orderA non-negative integer value (i.e. 0 and up).
productAn associative array containing the fields:* Optional
 
defaultPriceAn associative array containing the fields:* Optional
 
monthA monetary value, such as -$.05, 0.05, or -5.00
descriptionA string of text, containing no newlines or other control characters.
featuresAn array of a string of text, containing no newlines or other control characters.* Optional
product_descriptionA string of text, containing no newlines or other control characters.
startingPriceAn associative array containing the fields:* Optional
 
monthA monetary value, such as -$.05, 0.05, or -5.00
sub_titleEither: a string.; or perl undef only.
titleEither: a string.; or perl undef only.
product_codeA valid product code, at least 3 chars long, including at least one letter.

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Product/Marketplace/list

Description:

This method can be used to list details for active products in the marketplace

Parameters:

ParameterTypeNotes
alsowithAn array of
order_byAn associative array containing the fields:
 
fieldOne of: 'active', 'created_date', 'display_order', 'product_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
product_codeEither: a valid product code, at least 3 chars long, including at least one letter.; or An array of a valid product code, at least 3 chars long, including at least one letter.

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
 
activeA boolean value (0 or 1).
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
descriptionA string of text, containing no newlines or other control characters.
display_orderA non-negative integer value (i.e. 0 and up).
productAn associative array containing the fields:* Optional
 
defaultPriceAn associative array containing the fields:* Optional
 
monthA monetary value, such as -$.05, 0.05, or -5.00
descriptionA string of text, containing no newlines or other control characters.
featuresAn array of a string of text, containing no newlines or other control characters.* Optional
product_descriptionA string of text, containing no newlines or other control characters.
startingPriceAn associative array containing the fields:* Optional
 
monthA monetary value, such as -$.05, 0.05, or -5.00
sub_titleEither: a string.; or perl undef only.
titleEither: a string.; or perl undef only.
product_codeA valid product code, at least 3 chars long, including at least one letter.
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

productsForTags

URL:

https://api.liquidweb.com/bleed/Product/Marketplace/productsForTags

Description:

This method, similar to the list method but allows for filtering of products that must have at least specified tags and/or one of the tags specified. The tags remaining (unique) to the filtered marketplace products are also provided.

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
order_byAn associative array containing the fields:
 
fieldOne of: 'active', 'created_date', 'display_order', 'product_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
tagsAn associative array containing the fields:* Required
 
must_haveAn array of a string consisting of only letters, digits, hyphens, spaces, and underscores.
one_ofAn array of a string consisting of only letters, digits, hyphens, spaces, and underscores.

Returns:

FieldType
paged_dataAn associative array containing the fields:
 
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
 
activeA boolean value (0 or 1).
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
descriptionA string of text, containing no newlines or other control characters.
display_orderA non-negative integer value (i.e. 0 and up).
productAn associative array containing the fields:* Optional
 
defaultPriceAn associative array containing the fields:* Optional
 
monthA monetary value, such as -$.05, 0.05, or -5.00
descriptionA string of text, containing no newlines or other control characters.
featuresAn array of a string of text, containing no newlines or other control characters.* Optional
product_descriptionA string of text, containing no newlines or other control characters.
startingPriceAn associative array containing the fields:* Optional
 
monthA monetary value, such as -$.05, 0.05, or -5.00
sub_titleEither: a string.; or perl undef only.
titleEither: a string.; or perl undef only.
product_codeA valid product code, at least 3 chars long, including at least one letter.
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).
unique_tagsAn array of a string consisting of only letters, digits, hyphens, spaces, and underscores.

Possible Errors:

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