POST API/V40/Interactive/Outlet/{outletCode}/PlaceVerifiedGuestOrder

Place order to outlet

Request Information

URI Parameters

Name	Description	Type	Additional information
outletCode	The outlet code for the outlet we place the order against.	string	Required

Body Parameters

The request model

PlaceOrderVerifiedGuestRequest

Name	Description	Type	Additional information
DeliveryDateTime		date
IsDeliveryDateTimeUtc		boolean
Comment	Order level comment. If associated with Pos, this will be provided to the Pos System.	string
PaymentType	Possible values are: Open, PaidByCash, PaidByCard and ChargeToRoom.	string
PaymentReferenceNumber	The reference number of a payment that has been completed	string
BasketCode	Code to identify the basket, returned after basket creation in "Interactive/Outlet/{outletCode}/AddItemsToBasket"	string	Required
GxpChequeNumber		string
NumberOfGuests		string
PaymentToken	Payment method token from Payment Provider	string
PaymentState	Possible values are: Create, Confirm,.	string
TipAmount		decimal number
NameOnCard	Name as it appears on the payment card	string
PaymentIssuerId		integer
PaymentTypeCode		PaymentTypeEnum
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:

{
  "deliveryDateTime": "2024-11-06T08:46:09.1359643+00:00",
  "isDeliveryDateTimeUtc": true,
  "comment": "sample string 2",
  "paymentType": "sample string 3",
  "paymentReferenceNumber": "sample string 4",
  "basketCode": "sample string 5",
  "gxpChequeNumber": "sample string 6",
  "numberOfGuests": "sample string 7",
  "paymentToken": "sample string 8",
  "paymentState": "sample string 9",
  "tipAmount": 1.0,
  "nameOnCard": "sample string 10",
  "paymentIssuerId": 1,
  "paymentTypeCode": null,
  "sessionToken": "sample string 11"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseContainerModel

Name	Description	Type
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": "mx27dT_-3IgKAAAAAAAAAAAAAAA.4kNfgwPtVeWLs3tyvL2LXzr1FafwOk817eZRp8pkfYY",
  "responsesIncluded": "placeOrderVerifiedGuestResponse",
  "responses": [
    {
      "placeOrderVerifiedGuestResponse": {
        "content": {
          "orderId": 1,
          "posOrderReference": "sample string 2",
          "gxpOrderReference": "sample string 3",
          "gxpChequeNumber": "sample string 4",
          "total": 5.0,
          "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
                }
              ]
            }
          ],
          "deliveryTimeUtc": "2024-11-06T08:46:09.1359643+00:00"
        },
        "succeeded": true
      }
    }
  ],
  "status": "Success"
}