hello,
Overview
Error Handling
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/Discount/
- Market/Cart/Item/
- Market/Package/
- Market/Package/Product/
- 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/VirtualDomain/
- Server/WHM/AccessHash/
- Server/WHM/DNS/
- Server/WHM/Firewall/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Storage/ObjectStore/
- Support/Alert/
- Support/Request/
- 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)
Basket/Item/Config/
DESCRIPTION
Current Available Alsowiths:
* totals * alerts
A desired output with totals and options would have the following alsowith:
{... "alsowith":["totals"]" ...}
An output field indicating optional (other than parent_key/parent_value), is returned when the alsowith, it's key, is passed in.
alerts
URL:
https://api.liquidweb.com/bleed/Basket/Item/Config/alerts
Description:
Return alerts
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| basket_item | A valid UUID (Universally Unique IDentifier). | * Required |
| ptok | A positive integer value (i.e. 1 and up). | * Required if:
|
| ptov | A positive integer value (i.e. 1 and up). | * Required if:
|
Returns:
| Field | Type |
|---|---|
| alerts | An array of arbitrary values. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
delete
URL:
https://api.liquidweb.com/bleed/Basket/Item/Config/delete
Description:
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| basket_item | A valid UUID (Universally Unique IDentifier). | * Required |
| ptok | A positive integer value (i.e. 1 and up). | * Required if:
|
| ptov | A positive integer value (i.e. 1 and up). | * Required if:
|
Returns:
| Field | Type |
|---|---|
| deleted | A boolean value (0 or 1). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
lookup
URL:
https://api.liquidweb.com/bleed/Basket/Item/Config/lookup
Description:
Look up and return the details of a basket item config.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | An array of One of: 'alerts', 'discountable', 'totals' | |
| basket_item | A valid UUID (Universally Unique IDentifier). | * Required |
| ptok | A positive integer value (i.e. 1 and up). | * Required if:
|
| ptov | A positive integer value (i.e. 1 and up). | * Required if:
|
Returns:
| Field | Type | Notes | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| alerts | An array of associative arrays containing | * Optional | ||||||||||
| ||||||||||||
| discount | A monetary value, such as -$.05, 0.05, or -5.00 | |||||||||||
| discountable | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||||||
| extra_data | An associative array of arbitrary keys and values. | * Optional | ||||||||||
| is_extra | A boolean value (0 or 1). | |||||||||||
| key | A product option name. | |||||||||||
| key_description | A string of text, containing no newlines or other control characters. | |||||||||||
| key_display_order | An integer value. | * Optional | ||||||||||
| key_group | A string of text, containing no newlines or other control characters. | * Optional | ||||||||||
| key_group_display_order | A string of text, containing no newlines or other control characters. | * Optional | ||||||||||
| locked | A boolean value (0 or 1). | * Optional | ||||||||||
| nonce | A valid UUID (Universally Unique IDentifier). | * Optional | ||||||||||
| num_units | An integer value. | * Optional | ||||||||||
| num_units_increment | A positive integer value (i.e. 1 and up). | * Optional | ||||||||||
| num_units_locked | A boolean value (0 or 1). | * Optional | ||||||||||
| num_units_max | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||||||
| num_units_min | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||||||
| num_units_num_set | An array of arbitrary values. | * Optional | ||||||||||
| num_units_type | A single word, consisting of only letters, digits, and underscores. | * Optional | ||||||||||
| parent_key | A product option name. | * Optional | ||||||||||
| parent_value | A product option value. | * Optional | ||||||||||
| price | A monetary value, such as -$.05, 0.05, or -5.00 | |||||||||||
| price_total | A monetary value, such as -$.05, 0.05, or -5.00 | |||||||||||
| ptok | A valid id number (a positive integer). | |||||||||||
| ptov | A valid id number (a positive integer). | |||||||||||
| tax | A monetary value, such as -$.05, 0.05, or -5.00 | * Optional | ||||||||||
| totals | An associative array containing the fields: | * Optional | ||||||||||
| ||||||||||||
| valid | A boolean value (0 or 1). | |||||||||||
| value | A product option value. | |||||||||||
| value_comments | A string of text, containing no newlines or other control characters. | * Optional | ||||||||||
| value_description | A string of text, containing no newlines or other control characters. | |||||||||||
| value_display_order | An integer value. | |||||||||||
| value_price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | |||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
set
URL:
https://api.liquidweb.com/bleed/Basket/Item/Config/set
Description:
Delete a basket item config
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | An array of One of: 'alerts', 'discountable', 'totals' | |
| basket_item | A valid UUID (Universally Unique IDentifier). | * Required |
| num_units | An integer value. | |
| ptok | A positive integer value (i.e. 1 and up). | * Required |
| ptov | A positive integer value (i.e. 1 and up). |
Returns:
| Field | Type | Notes | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| alerts | An array of associative arrays containing | * Optional | ||||||||||
| ||||||||||||
| discount | A monetary value, such as -$.05, 0.05, or -5.00 | |||||||||||
| discountable | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||||||
| extra_data | An associative array of arbitrary keys and values. | * Optional | ||||||||||
| is_extra | A boolean value (0 or 1). | |||||||||||
| key | A product option name. | |||||||||||
| key_description | A string of text, containing no newlines or other control characters. | |||||||||||
| key_display_order | An integer value. | * Optional | ||||||||||
| key_group | A string of text, containing no newlines or other control characters. | * Optional | ||||||||||
| key_group_display_order | A string of text, containing no newlines or other control characters. | * Optional | ||||||||||
| locked | A boolean value (0 or 1). | * Optional | ||||||||||
| nonce | A valid UUID (Universally Unique IDentifier). | * Optional | ||||||||||
| num_units | An integer value. | * Optional | ||||||||||
| num_units_increment | A positive integer value (i.e. 1 and up). | * Optional | ||||||||||
| num_units_locked | A boolean value (0 or 1). | * Optional | ||||||||||
| num_units_max | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||||||
| num_units_min | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||||||
| num_units_num_set | An array of arbitrary values. | * Optional | ||||||||||
| num_units_type | A single word, consisting of only letters, digits, and underscores. | * Optional | ||||||||||
| parent_key | A product option name. | * Optional | ||||||||||
| parent_value | A product option value. | * Optional | ||||||||||
| price | A monetary value, such as -$.05, 0.05, or -5.00 | |||||||||||
| price_total | A monetary value, such as -$.05, 0.05, or -5.00 | |||||||||||
| ptok | A valid id number (a positive integer). | |||||||||||
| ptov | A valid id number (a positive integer). | |||||||||||
| tax | A monetary value, such as -$.05, 0.05, or -5.00 | * Optional | ||||||||||
| totals | An associative array containing the fields: | * Optional | ||||||||||
| ||||||||||||
| valid | A boolean value (0 or 1). | |||||||||||
| value | A product option value. | |||||||||||
| value_comments | A string of text, containing no newlines or other control characters. | * Optional | ||||||||||
| value_description | A string of text, containing no newlines or other control characters. | |||||||||||
| value_display_order | An integer value. | |||||||||||
| value_price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | |||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
