...
URL | Verb | Information |
---|---|---|
/products | GET | Lists all available product types |
Fields
The following fields are returned about a Product
Field | Data Type | Required | Information |
---|---|---|---|
Id | Integer | Y | May differ between Environments |
Guid | Guid | Y | Uniquely identifies the product, consistent between Environments |
Name | String | Y | |
Price | Decimal | Y | Price of purchasing one of the product |
AddOns | List of AddOn | N | Any Add Ons available for the product |
OptionGroups | List of AddOnOptionGroup | N | Any Add Ons available for the product, grouped by the Option |
The following fields are returned about an Add On
Field | Data Type | Required | Information |
---|---|---|---|
Id | Integer | Y | May differ between Environments |
Guid | Guid | Y | Uniquely identifies the add on, consistent between Environments |
Name | String | Y | |
Price | Decimal | Y | Price of purchasing one of the product |
QuantityType | QuantityType | Y | How the quantity of the add on relates to the quantity of the order line |
OptionGroup | String | N | The name of the Option Group the add on belongs to |
The following options are available for QuantityType
Value | Information |
---|---|
Each | Applies the quantity of the add on to each quantity of the base line. For example: Line quantity of 2 with an add on of quantity 3 would result in a total of 6 add ons being charged. |
Line | Only applies once per line, the quantity of the add on is independent of the quantity of the base line. |