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

Place non-verified service request

Request Information

URI Parameters

NameDescriptionTypeAdditional information
outletCode

The outlet code for the outlet we place the order against.

string

Required

Body Parameters

The request model

PlaceServiceRequestNonVerifiedGuestRequest
NameDescriptionTypeAdditional information
OrderFormDetailsDictionary

Dictionary to contain Order Form Details for the outlet, setup in GXP Manager.

Dictionary of string [key] and Object [value]

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

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:
{
  "orderFormDetailsDictionary": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "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-03-28T22:04:02.3384093+00:00",
  "isDeliveryDateTimeUtc": true,
  "deliverLater": "sample string 2",
  "deliveryLocationCode": "sample string 3",
  "deliveryType": "sample string 4",
  "numberOfGuests": "sample string 5",
  "paymentType": "sample string 6",
  "paymentReferenceNumber": "sample string 7",
  "sessionToken": "sample string 8"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseContainerModel
NameDescriptionTypeAdditional 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": "HdhD-nJP3IgKAAAAAAAAAAAAAAA.svt9NgVlQqZ0VOsVi7biSWa7r7B2MZdnuzYy0c2Wta4",
  "responsesIncluded": "placeServiceRequestNonVerifiedGuestResponse",
  "responses": [
    {
      "placeServiceRequestNonVerifiedGuestResponse": {
        "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"
}