POST API/V40/Interactive/Outlet/{outletCode}/AddItemsToBasket
Creates new basket with items
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| outletCode |
The outlet code |
string |
Required |
Body Parameters
The request model
AddItemsToBasketRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Items |
List of Basket Items. |
Collection of BasketItem | |
| DeliveryDateTime | date | ||
| IsDeliveryDateTimeUtc | boolean | ||
| DeliverLater |
Possible values are: Now, Later and Future. |
string |
Required |
| DeliveryType |
Possible values are: Room, DeliveryLocation, Collection and Unknown. If using DeliveryLocation, please also send deliveryLocationCode in its respective field. |
string |
Required |
| DeliveryLocationCode |
Code to identify the delivery location when using the DeliveryType 'DeliverLocation'. To retrieve a list of valid delivery location codes for the outlet, please use '/Interactive/Outlet/{request.OutletCode}/DeliveryLocation'. |
string | |
| GuestFacingDiscountCode |
Guest-facing code for a discount. |
string | |
| StaffId | string | ||
| SessionToken |
The token associated with this session of API interactions. This token should always be included in API calls, because it contains important session state information. |
string |
Required |
Request Formats
application/json, text/json
Sample:
{
"items": [
{
"categoryItemCode": "sample string 1",
"posItemCode": "sample string 2",
"quantity": 3,
"comments": "sample string 4",
"options": [
{
"modifierCode": "sample string 1",
"optionCode": "sample string 2",
"posItemCode": "sample string 3"
},
{
"modifierCode": "sample string 1",
"optionCode": "sample string 2",
"posItemCode": "sample string 3"
}
],
"relatedParentCategoryItemCode": "sample string 5",
"itemPriceCode": "sample string 6",
"sectionCode": "sample string 7"
},
{
"categoryItemCode": "sample string 1",
"posItemCode": "sample string 2",
"quantity": 3,
"comments": "sample string 4",
"options": [
{
"modifierCode": "sample string 1",
"optionCode": "sample string 2",
"posItemCode": "sample string 3"
},
{
"modifierCode": "sample string 1",
"optionCode": "sample string 2",
"posItemCode": "sample string 3"
}
],
"relatedParentCategoryItemCode": "sample string 5",
"itemPriceCode": "sample string 6",
"sectionCode": "sample string 7"
}
],
"deliveryDateTime": "2024-11-06T08:43:23.6939321+00:00",
"isDeliveryDateTimeUtc": true,
"deliverLater": "sample string 2",
"deliveryType": "sample string 3",
"deliveryLocationCode": "sample string 4",
"guestFacingDiscountCode": "sample string 5",
"staffId": "sample string 6",
"sessionToken": "sample string 7"
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseContainerModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SessionToken |
The token associated with this session of API interactions. Generally this is the same token passed with the API request parameters, but under certain circumstances this can be changed before being sent back to the caller. |
string | |
| ResponsesIncluded |
A list of response messages names contained in this composite message, for easy pre-parsing. |
string | |
| Responses |
A list of response messages contained in this composite message. |
Collection of Object | |
| Status |
The success status the composite message. |
CompositeStatus |
Response Formats
application/json, text/json
Sample:
{
"sessionToken": "OaoeEz_-3IgKAAAAAAAAAAAAAAA.tCS-g0sO4OhAsByrB5Of03FJAIKHtY7UziOFNEy8-_U",
"responsesIncluded": "addItemsToBasketResponse",
"responses": [
{
"addItemsToBasketResponse": {
"content": {
"total": 1.0,
"subtotal": 2.0,
"deliveryChargeAmount": 3.0,
"posTaxChargeAmount": 4.0,
"gxpFlatExtraCharges": 5.0,
"gxpTaxForExtraCharges": 6.0,
"gxpTaxChargeAmount": 7.0,
"discountAmount": 8.0,
"estimatedDeliveryTimeUtc": "2024-11-06T08:43:23.6939321+00:00",
"basketCode": "sample string 9",
"items": [
{
"categoryItemCode": "sample string 1",
"posItemCode": "sample string 2",
"quantity": 3,
"comments": "sample string 4",
"options": [
{
"modifierCode": "sample string 1",
"optionCode": "sample string 2",
"posItemCode": "sample string 3"
},
{
"modifierCode": "sample string 1",
"optionCode": "sample string 2",
"posItemCode": "sample string 3"
}
],
"relatedParentCategoryItemCode": "sample string 5",
"itemPriceCode": "sample string 6",
"sectionCode": "sample string 7"
},
{
"categoryItemCode": "sample string 1",
"posItemCode": "sample string 2",
"quantity": 3,
"comments": "sample string 4",
"options": [
{
"modifierCode": "sample string 1",
"optionCode": "sample string 2",
"posItemCode": "sample string 3"
},
{
"modifierCode": "sample string 1",
"optionCode": "sample string 2",
"posItemCode": "sample string 3"
}
],
"relatedParentCategoryItemCode": "sample string 5",
"itemPriceCode": "sample string 6",
"sectionCode": "sample string 7"
}
],
"discount": {
"name": "sample string 1",
"amount": 2.0,
"discountType": "sample string 3"
},
"posTotalSurcharge": 10.0,
"taxBreakdown": [
{
"name": "sample string 1",
"amount": 2.0,
"description": "sample string 3",
"taxClassName": "sample string 4",
"taxClassDescription": "sample string 5"
},
{
"name": "sample string 1",
"amount": 2.0,
"description": "sample string 3",
"taxClassName": "sample string 4",
"taxClassDescription": "sample string 5"
}
],
"serviceChargeBreakdown": [
{
"name": "sample string 1",
"price": 2.0,
"chargeType": "FixedRate",
"description": "sample string 3"
},
{
"name": "sample string 1",
"price": 2.0,
"chargeType": "FixedRate",
"description": "sample string 3"
}
],
"unavailableItems": [
{
"name": "sample string 1",
"code": "sample string 2",
"availabilityPeriods": [
{
"startTime": "00:00:00.1234567",
"endTime": "00:00:00.1234567",
"isMonday": true,
"isTuesday": true,
"isWednesday": true,
"isThursday": true,
"isFriday": true,
"isSaturday": true,
"isSunday": true
},
{
"startTime": "00:00:00.1234567",
"endTime": "00:00:00.1234567",
"isMonday": true,
"isTuesday": true,
"isWednesday": true,
"isThursday": true,
"isFriday": true,
"isSaturday": true,
"isSunday": true
}
]
},
{
"name": "sample string 1",
"code": "sample string 2",
"availabilityPeriods": [
{
"startTime": "00:00:00.1234567",
"endTime": "00:00:00.1234567",
"isMonday": true,
"isTuesday": true,
"isWednesday": true,
"isThursday": true,
"isFriday": true,
"isSaturday": true,
"isSunday": true
},
{
"startTime": "00:00:00.1234567",
"endTime": "00:00:00.1234567",
"isMonday": true,
"isTuesday": true,
"isWednesday": true,
"isThursday": true,
"isFriday": true,
"isSaturday": true,
"isSunday": true
}
]
}
]
},
"succeeded": true
}
}
],
"status": "Success"
}