PUT api/Basket
Adds products, or a package, to the session's basket. Each item group adds a quantity of a product at a concession. ItemId picks a specific item, such as a seat from the seating plan, and applies to every group with a quantity above 0. PackageId applies a package and checks the basket now qualifies for it. Responses: 200 with the request echoed back. 401 if the request has no session. An error (500) if the items are sold out or not on sale, or the basket doesn't qualify for the package.
Request Information
URI Parameters
None.
Body Parameters
What to add.
BasketRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemId |
Optional. A specific item to add, such as a seat's Id from the seating plan. Applies to every item group with a quantity above 0. |
globally unique identifier |
None. |
| ItemGroups |
The products to add, each with a concession and quantity. |
Collection of BasketItemGroupRequest |
None. |
| PackageId |
Optional. A package to apply to the basket. |
globally unique identifier |
None. |
Request Formats
application/json, text/json
{
"itemId": "65865a10-ea86-4ca9-90e0-786cfea8f13a",
"itemGroups": [
{
"concessionId": "d5f4da12-62a0-4e5a-9b51-e978a86a86d0",
"productId": "8755e327-8efa-4af3-adcd-2f25848bf357",
"quantity": 3,
"price": 4.0
},
{
"concessionId": "d5f4da12-62a0-4e5a-9b51-e978a86a86d0",
"productId": "8755e327-8efa-4af3-adcd-2f25848bf357",
"quantity": 3,
"price": 4.0
}
],
"packageId": "7d76283f-bdeb-4e9c-aacc-c9b2bed99de0"
}
Response Information
Resource Description
The request, unchanged.
BasketRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemId |
Optional. A specific item to add, such as a seat's Id from the seating plan. Applies to every item group with a quantity above 0. |
globally unique identifier |
None. |
| ItemGroups |
The products to add, each with a concession and quantity. |
Collection of BasketItemGroupRequest |
None. |
| PackageId |
Optional. A package to apply to the basket. |
globally unique identifier |
None. |
Response Formats
application/json, text/json
{
"itemId": "a13a26f9-700f-48ea-9586-a0fea7e4ad47",
"itemGroups": [
{
"concessionId": "75c7ec8c-a8ba-49a3-a95c-114bb0c79717",
"productId": "8f54cbbd-2f11-4325-8b33-1f107624b2ec",
"quantity": 3,
"price": 4.0
},
{
"concessionId": "75c7ec8c-a8ba-49a3-a95c-114bb0c79717",
"productId": "8f54cbbd-2f11-4325-8b33-1f107624b2ec",
"quantity": 3,
"price": 4.0
}
],
"packageId": "e76e855e-fc38-4015-8c3c-ebb2a9a1e570"
}