POST v1/checks/{storeIdentifier}/{checkId}?timeout={timeout}

POST Modify Check

Adds a list of items to a check and a list of comps to the check.

URI template

v1/checks/{storeIdentifier}/{checkId}?timeout={timeout}

Request Information

URI Parameters

Name	Type	Additional information	Description
storeIdentifier	integer	Required	Store at which the check was opened.
checkId	integer	Required	Id of the check to modify.
timeout	integer	Default value is 30000	The timeout for this command

Body Parameters

Request body. Contains information of the items to be added to check.

ModifyCheckRequest

Name	Type	Additional information	Description
EmployeeId	string	Required	Id of the Employee serving the table.
EmployeeInstructions	string	Required Max length: 122	Instructions for the employee serving the table.
Items	Collection of CheckItem	Required	List of items to be added to the check.

Name

Type

Additional information

Description

EmployeeId

string

Required

Id of the Employee serving the table.

EmployeeInstructions

string

Required

Max length: 122

Instructions for the employee serving the table.

Items

Collection of CheckItem

Required

List of items to be added to the check.

Request Formats

application/json, text/json

Sample:

{
  "EmployeeId": "sample string 1",
  "EmployeeInstructions": "sample string 2",
  "Items": [
    {
      "$id": "2",
      "ReferenceId": 1,
      "Type": 2,
      "Level": 3,
      "PosItemId": 4,
      "ModCode": 5,
      "Name": "sample string 6",
      "Seat": 7,
      "Price": 8.0
    },
    {
      "$ref": "2"
    }
  ]
}

application/xml, text/xml

Sample:

<ModifyCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.MpApi.Requests">
  <EmployeeId>sample string 1</EmployeeId>
  <EmployeeInstructions>sample string 2</EmployeeInstructions>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/StoreConnect.MpApi.Models">
    <d2p1:CheckItem>
      <d2p1:Level>3</d2p1:Level>
      <d2p1:ModCode>5</d2p1:ModCode>
      <d2p1:Name>sample string 6</d2p1:Name>
      <d2p1:PosItemId>4</d2p1:PosItemId>
      <d2p1:Price>8</d2p1:Price>
      <d2p1:ReferenceId>1</d2p1:ReferenceId>
      <d2p1:Seat>7</d2p1:Seat>
      <d2p1:Type>2</d2p1:Type>
    </d2p1:CheckItem>
    <d2p1:CheckItem>
      <d2p1:Level>3</d2p1:Level>
      <d2p1:ModCode>5</d2p1:ModCode>
      <d2p1:Name>sample string 6</d2p1:Name>
      <d2p1:PosItemId>4</d2p1:PosItemId>
      <d2p1:Price>8</d2p1:Price>
      <d2p1:ReferenceId>1</d2p1:ReferenceId>
      <d2p1:Seat>7</d2p1:Seat>
      <d2p1:Type>2</d2p1:Type>
    </d2p1:CheckItem>
  </Items>
</ModifyCheckRequest>

Response Information

Resource Description

Whether or not items were successfully added to check.

IApiResult

Name	Type	Additional information
nResultCode	integer	None.
sResultMessage	string	None.
ResultCode	integer	None.
ResultMessage	string	None.
TransactionId	globally unique identifier	None.
OrderId	string	None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.