Basket Lines
Basket Lines represent an item in the Basket. A line is how the User adds a Project into the Basket so it can be ordered.
Requires:
Actions
| URL | Verb | Information |
|---|---|---|
| /basket/{Guid}/line | POST | Creates a new line for the basket identified by the Guid |
| /basket/{Guid}/line/{Id} | PUT | Updates the line |
| /basket/{Guid}/line/{Id} | DELETE | Removes the line from the basket |
Attributes
The following attributes are for creating or updating a basket line.
| Field | Data Type | Required | Information |
|---|---|---|---|
| ProjectGuid | Guid | Y | The Guid of the Project to be ordered |
| Quantity | Integer | Y | Quantity of the Project to be ordered |
| AddOns | Array of BasketLineAddOn | N | List of add ons to be added to the line |
The following attributes are requires for Add Ons when modifying a basket line.
| Field | Data Type | Required | Information |
|---|---|---|---|
| AddOnId | Integer | Y | Id of the add on in the Product definition |
| Quantity | Integer | Y | Quantity of the add on to add to the line |
When modifying a basket line, the response includes both the updated line, and the updated entire basket.
| Field | Data Type | Required | Information |
|---|---|---|---|
| Line | Basket Line Details | N | Fields described below. Can be left undefined, for example when deleting a line. |
| Basket | Basket | Y | The updated entire Basket. |
The following details are returned about a basket line.
| Field | Data Type | Required | Information |
|---|---|---|---|
| Id | Integer | Y | Used to uniquely identify a basket line |
| ProjectGuid | String | Y | The Guid of the Project to be ordered |
| Quantity | Integer | Y | Quantity of the Project to be ordered |
| Total | Decimal | Y | The total cost of the basket line |
| AddOns | List Of BasketLineAddOnDetails | N | The list of add ons configured on the line |
The following details are returned about a basket lines add on.
| Field | Data Type | Required | Information |
|---|---|---|---|
| AddOnId | Integer | Y | Id of the add on in the Product definition |
| Quantity | Integer | Y | Quantity of the add on to be ordered |
| QuantityType | Quantity Type | Y | Describes how the quantity of the add on relates to the quantity of the line |
| QuantityTotal | Integer | Y | The total number of add ons for the line (based on the base line quantity and the quantity type) |
| Total | Decimal | Y | The total cost of this add on for this basket line |