POST v1/checks/{storeIdentifier}/{checkId}/status

POST Add Status by Check ID

Add a status to a check by Check ID.

URI template

v1/checks/{storeIdentifier}/{checkId}/status

Request Information

URI Parameters

Name	Type	Additional information	Description
storeIdentifier	integer	Required	Store at which the check exists.
checkId	integer	Required	ID of the check to which the status will be added.

Body Parameters

Status text to be added.

AddStatusRequest

Name	Type	Additional information	Description
status	string	None.

Request Formats

application/json, text/json

Sample:

{
  "status": "sample string 1"
}

application/xml, text/xml

Sample:

<AddStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Requests">
  <status>sample string 1</status>
</AddStatusRequest>

Response Information

Resource Description

StoreApiResponse

Name	Type	Additional information	Description
TransactionId	globally unique identifier	None.	The Transaction Id on the POS
ResultCode	integer	None.	The Result Code returned by the POS
ResultMessage	string	None.	The message returned by the store api

Response Formats

application/json, text/json

Sample:

{
  "TransactionId": "00000000-0000-0000-0000-000000000000",
  "ResultCode": 123,
  "ResultMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<StoreApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses">
  <ResultCode>123</ResultCode>
  <ResultMessage>sample string 1</ResultMessage>
  <TransactionId>00000000-0000-0000-0000-000000000000</TransactionId>
</StoreApiResponse>