Error Handling
Methods
- Account/
- Account/Auth/
- Account/Auth/TwoFactor/
- Account/BillingAddress/
- Account/ChangeOrder/Source/
- Account/ChatPassword/
- Account/Contact/
- Account/CreditCard/
- Account/Cycle/
- Account/Limits/
- Account/PasswordReset/
- Account/Paymethod/
- Account/SSH/Key/
- Account/Settings/
- Account/Subscriptions/
- Account/User/
- Account/User/StateData/
- Acronis/Backup/
- Asset/
- Asset/Connections/
- Asset/ControlPanel/Credentials/
- Asset/Measurements/
- Asset/Monitoring/
- Attribution/
- Basket/
- Basket/Domain/
- Basket/Item/
- Basket/Item/Config/
- Billing/
- Billing/Bill/
- Billing/Credit/
- Billing/CreditCard/Profile/
- Billing/Cycle/
- Billing/Invoice/
- Billing/Invoice/Preview/
- Billing/PayPal/Agreement/
- Billing/PayPal/Payment/
- Billing/Payment/
- Billing/Payment/Profile/
- BusinessEmail/Customer/
- BusinessEmail/Domain/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Private/Parent/
- Cloud/Server/
- Cloud/Template/
- CloudSites/
- CloudSites/Usage/
- CodeGuard/User/
- Contact/
- Coupon/
- Coupon/Claim/
- Domain/
- Domain/Services/
- HostedEmail/Customer/
- HostedEmail/Domain/
- Licensing/
- Licensing/Cpanel/
- Licensing/Plesk/
- Market/Bundle/
- Market/Bundle/Package/
- Market/Cart/
- Market/Cart/Admin/Quote/
- Market/Cart/Discount/
- Market/Cart/Helpers/Configurator/
- Market/Cart/Item/
- Market/Package/
- Market/Package/Product/
- Market/Place/
- Meta/Timing/
- Migration/
- Migration/Account/
- Migration/Account/Server/
- Migration/Account/Server/Access/
- Migration/Destination/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/MWP/
- Monitoring/Services/
- Network/CDN/User/
- Network/CDN/Zone/
- Network/DNS/Domain/
- Network/DNS/Domain/Contact/
- Network/DNS/Domain/Nameserver/
- Network/DNS/Domain/Transfer/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/DNS/Zone/History/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/SSHKey/
- Network/Util/
- Network/Zone/
- Notifications/
- OneTimeSecret/
- Order/AddOn/
- Product/
- Product/Addon/
- Product/Marketplace/
- Product/Series/
- Project/
- SSL/Certificate/
- Salesforce/Account/InterWorx/
- Salesforce/Chat/Auth/
- Salesforce/User/
- Server/
- Server/Auth/
- Server/Power/
- Server/VirtualDomain/
- Server/WHM/AccessHash/
- Server/WHM/DNS/
- Server/WHM/Firewall/
- Signup/Basic/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Storage/ObjectStore/
- Support/Alert/
- Support/Request/
- Support/Request/Attachment/
- Support/SystemStatus/
- Support/Ticket/Auth/
- Tags/Product/
- UserTask/
- Utilities/Info/
- VIP/
- VMware/vCloud/vDC/
- VPN/
- VPN/User/
- WWW/Cart/
- WordPress/Domain/
API Documentation (API Version bleed)
Product/Marketplace/
DESCRIPTION
This section of the API handles product marketplace operations.
Current Available Alsowiths:
- product - startingPrice* - defaultPrice* - marketplacePrices* - 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:
Parameter | Type | Notes |
---|---|---|
alsowith | An array of | |
product_code | A valid product code, at least 3 chars long, including at least one letter. | * Required |
public | Either: a boolean value (0 or 1).; or An array of a boolean value (0 or 1). | * Optional
|
Returns:
Field | Type | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
active | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
addonDetails | An associative array containing the fields: | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | A string potentially containing and/or ending with newline characters. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
display_order | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product | An associative array containing the fields: | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_code | A valid product code, at least 3 chars long, including at least one letter. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
public | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
series_description | A string of text, containing no newlines or other control characters. | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
series_display_order | A non-negative integer value (i.e. 0 and up). | * Optional |
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:
Parameter | Type | Notes | ||||||
---|---|---|---|---|---|---|---|---|
alsowith | An array of | |||||||
order_by | An associative array containing the fields: | |||||||
| ||||||||
page_num | A positive integer value (i.e. 1 and up). | * Optional
| ||||||
page_size | A positive integer value (i.e. 1 and up). | * Optional
| ||||||
product_code | Either: 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. | |||||||
public | Either: a boolean value (0 or 1).; or An array of a boolean value (0 or 1). | * Optional
|
Returns:
Field | Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
item_count | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
item_total | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | An array of associative arrays containing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_num | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_size | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_total | A 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:
Parameter | Type | Notes | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
alsowith | A single word, consisting of only letters, digits, and underscores. | |||||||||||||||
keywords | An array of associative arrays containing | * Required | ||||||||||||||
| ||||||||||||||||
order_by | An associative array containing the fields: | |||||||||||||||
| ||||||||||||||||
page_num | A positive integer value (i.e. 1 and up). | * Optional
| ||||||||||||||
page_size | A positive integer value (i.e. 1 and up). | * Optional
| ||||||||||||||
public | Either: a boolean value (0 or 1).; or An array of a boolean value (0 or 1). | * Optional
| ||||||||||||||
series_description | An associative array of arbitrary keys and values. | |||||||||||||||
tag_category | A single word, consisting of only letters, digits, hyphens, and underscores. | |||||||||||||||
tags | One of the following: | * Required if:
| ||||||||||||||
|
Returns:
Field | Type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
paged_data | An associative array containing the fields: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unique_tags | An 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