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

Place verified service request

Request Information

URI Parameters

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

Body Parameters

The request model

PlaceServiceRequestVerifiedGuestRequest

Name	Description	Type	Additional information
NumberOfGuests		integer
Item		ServiceRequestItem
DeliveryDateTime		date
IsDeliveryDateTimeUtc		boolean
DeliverLater	Possible values are: Now, Later and Future.	string
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
DeliveryType	Possible values are: Room, DeliveryLocation, Collection and Unknown. If using DeliveryLocation, please also send deliveryLocationCode in its respective field.	string
NumberOfGuests		string
PaymentType	Possible values are: Open, PaidByCash, PaidByCard and ChargeToRoom.	string
PaymentReferenceNumber		string
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:

{
  "numberOfGuests": 1,
  "item": {
    "categoryItemCode": "sample string 1",
    "options": [
      {
        "modifierCode": "sample string 1",
        "optionCode": "sample string 2"
      },
      {
        "modifierCode": "sample string 1",
        "optionCode": "sample string 2"
      }
    ],
    "comment": "sample string 2"
  },
  "deliveryDateTime": "2024-11-28T11:05:26.7380171+00:00",
  "isDeliveryDateTimeUtc": true,
  "deliverLater": "sample string 3",
  "deliveryLocationCode": "sample string 4",
  "deliveryType": "sample string 5",
  "paymentType": "sample string 7",
  "paymentReferenceNumber": "sample string 8",
  "paymentTypeCode": null,
  "sessionToken": "sample string 9"
}

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": "FdtYkJwP3YgKAAAAAAAAAAAAAAA.k4LYw7K0EZ1qCtsyamhFAyqA60v3OHaOmitkSF7giBw",
  "responsesIncluded": "placeServiceRequestVerifiedGuestResponse",
  "responses": [
    {
      "placeServiceRequestVerifiedGuestResponse": {
        "content": {
          "orderId": 1,
          "sosServiceRequestId": "sample string 2",
          "gxpOrderReference": "sample string 3",
          "total": 4.0,
          "unavailableItem": {
            "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"
}