Overview
Error Handling

Methods

API Documentation (API Version v1)

Order/AddOn/

DESCRIPTION

API methods for finding and adding additional items onto an order.

add

URL:

https://api.liquidweb.com/v1/Order/AddOn/add

Description:

Adds one or more addons to an order.

Parameters:

ParameterTypeNotes
addon_idEither: a positive integer value (i.e. 1 and up).; or An array of a positive integer value (i.e. 1 and up).* Required
order_idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldType
addonsAn array of associative arrays containing
 
descriptionA string permitting tabs, carriage returns and newlines
idA positive integer value (i.e. 1 and up).
image_urlA string permitting tabs, carriage returns and newlines
priceAn associative array of arbitrary keys and values.
product_codeA valid product code, at least 3 chars long, including at least one letter.
titleA string permitting tabs, carriage returns and newlines

Possible Errors:

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

findmatches

URL:

https://api.liquidweb.com/v1/Order/AddOn/findmatches

Description:

Find all the addons that match a given order_id.

Parameters:

ParameterTypeNotes
order_idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldType
addonsAn array of associative arrays containing
 
descriptionA string permitting tabs, carriage returns and newlines
idA positive integer value (i.e. 1 and up).
image_urlA string permitting tabs, carriage returns and newlines
priceAn associative array of arbitrary keys and values.
product_codeA valid product code, at least 3 chars long, including at least one letter.
titleA string permitting tabs, carriage returns and newlines

Possible Errors:

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