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

POST Apply Promo

Applys promo to a check

URI template

v1/checks/{storeIdentifier}/{checkId}/promo

Request Information

URI Parameters

Name	Type	Additional information	Description
storeIdentifier	integer	Required	Hasp key number of the site which order will be modified
checkId	string	Required	ID used to identify the check.

Body Parameters

Information that identifies the order and promo to apply.

ApplyPromoRequest

Name	Type	Additional information	Description
QueueId	string	None.	Identifier of the queue which will be modified
TableId	string	None.	Identifier of the table which will be modified
PromotionId	string	None.	Identifier for the promotion that will be applied to the order.

Request Formats

application/json, text/json

Sample:

{
  "QueueId": "sample string 1",
  "TableId": "sample string 2",
  "PromotionId": "sample string 3"
}

application/xml, text/xml

Sample:

<ApplyPromoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.MpApi.Requests">
  <PromotionId>sample string 3</PromotionId>
  <QueueId>sample string 1</QueueId>
  <TableId>sample string 2</TableId>
</ApplyPromoRequest>

Response Information

Resource Description

PromoResponse

Name	Type	Additional information	Description
PromoId	long	None.	ID that uniquely identified the instance of the promotion applied to the order.
Amount	decimal number	None.	Amount of promotion that was applied to the order.
ApiResult	StoreApiResponse	None.	The result returned by the Api

Response Formats

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

Sample:

Sample not available.