POST v1/Orders/{siteId}/{orderId}/CheckIn

Check in order

URI template

v1/Orders/{siteId}/{orderId}/CheckIn

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId	Site id	integer	Required
orderId	Order id	integer	Required

Body Parameters

Order check in information

InCheckInOrder

Name	Description	Type	Additional information
Destination	Describes where the order is suppose to be at	DestinationType	Required
Vehicle	Information describing the Vehicle. Not supported on check-in with Aloha.	Vehicle	None.
CurbSideZone	Nullable The location in relation to the store	string	None.
ApplicationName	Nullable The name of the application, this is use for loggin purposes at the Site	string	None.
OriginType	Where this checkin order initiated from	CheckInOriginType	Required
OriginId	Nullable The id associated with check in origin	integer	None.
Vector	Nullable The location where this order is suppose to go to	CheckInVectorType	None.
VectorId	Nullable Id associated with the vector type	integer	None.
Intent	Describes how the customer intends to pick up the order	CheckInIntent	Required
AssignLoyalty	Nullable Loyalty will not be processed at the POS if value is set to false. Default: True	boolean	None.
SendEmail	Checkin confirmation email will be sent by default unless value is set to false.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Destination": 0,
  "Vehicle": {
    "$id": "2",
    "Make": "sample string 1",
    "Model": "sample string 2",
    "Color": "sample string 3"
  },
  "LaneIdentifier": "sample string 4",
  "CurbSideZone": "sample string 5",
  "ApplicationName": "sample string 6",
  "OriginType": 0,
  "OriginId": 7,
  "Vector": 0,
  "VectorId": 8,
  "Intent": 0,
  "AssignLoyalty": true,
  "SendEmail": true
}

application/xml, text/xml

Sample:

<InCheckInOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound">
  <ApplicationName>sample string 6</ApplicationName>
  <AssignLoyalty>true</AssignLoyalty>
  <CurbSideZone>sample string 5</CurbSideZone>
  <Destination>DestinationNull</Destination>
  <Intent>DriveThru</Intent>
  <LaneIdentifier>sample string 4</LaneIdentifier>
  <OriginId>7</OriginId>
  <OriginType>Web</OriginType>
  <SendEmail>true</SendEmail>
  <Vector>Terminal</Vector>
  <VectorId>8</VectorId>
  <Vehicle xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
    <d2p1:Color>sample string 3</d2p1:Color>
    <d2p1:Make>sample string 1</d2p1:Make>
    <d2p1:Model>sample string 2</d2p1:Model>
  </Vehicle>
</InCheckInOrder>

Response Information

Resource Description

The result object with details about check in. Known internal errors are BadRequest, NotFound, OrderSubmittedNoChanges, OperationTimedOut, Error

OrderCheckInResult

Name	Description	Type	Additional information
ResultCode	Result code for the error	CheckInResultCodes	None.
ErrorCode	The raw error code	integer	None.
ErrorMessage	The error message from the POS	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultCode": 0,
  "ErrorCode": 1,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<OrderCheckInResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response">
  <ErrorCode>1</ErrorCode>
  <ErrorMessage>sample string 2</ErrorMessage>
  <ResultCode>Success</ResultCode>
</OrderCheckInResult>

Error Description

Detailed description of errors.

APIErrors

Name	Description	Type	Additional information
Errors		Collection of APIError	None.