POST pos/loyalty/punchh/redemption/void

Authorized only.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CustomerEmail		string	None.
RedemptionResponses		Collection of RedemptionResponse	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerEmail": "sample string 1",
  "RedemptionResponses": [
    {
      "status": "sample string 1",
      "redemption_amount": 2.1,
      "category": "sample string 3",
      "qualified_menu_items": [
        {
          "item_name": "sample string 1",
          "menu_item_id": "sample string 11",
          "item_qty": "sample string 3",
          "item_amount": 0.0,
          "menu_item_type": "sample string 10",
          "menu_major_group": "sample string 12",
          "menu_family": "sample string 13",
          "serial_number": "sample string 8",
          "amount": "0",
          "item_type": "sample string 10",
          "item_id": "sample string 11",
          "item_group": "sample string 12",
          "item_family": "sample string 13"
        },
        {
          "item_name": "sample string 1",
          "menu_item_id": "sample string 11",
          "item_qty": "sample string 3",
          "item_amount": 0.0,
          "menu_item_type": "sample string 10",
          "menu_major_group": "sample string 12",
          "menu_family": "sample string 13",
          "serial_number": "sample string 8",
          "amount": "0",
          "item_type": "sample string 10",
          "item_id": "sample string 11",
          "item_group": "sample string 12",
          "item_family": "sample string 13"
        }
      ],
      "redemption_id": 4,
      "redemption_code": "sample string 5"
    },
    {
      "status": "sample string 1",
      "redemption_amount": 2.1,
      "category": "sample string 3",
      "qualified_menu_items": [
        {
          "item_name": "sample string 1",
          "menu_item_id": "sample string 11",
          "item_qty": "sample string 3",
          "item_amount": 0.0,
          "menu_item_type": "sample string 10",
          "menu_major_group": "sample string 12",
          "menu_family": "sample string 13",
          "serial_number": "sample string 8",
          "amount": "0",
          "item_type": "sample string 10",
          "item_id": "sample string 11",
          "item_group": "sample string 12",
          "item_family": "sample string 13"
        },
        {
          "item_name": "sample string 1",
          "menu_item_id": "sample string 11",
          "item_qty": "sample string 3",
          "item_amount": 0.0,
          "menu_item_type": "sample string 10",
          "menu_major_group": "sample string 12",
          "menu_family": "sample string 13",
          "serial_number": "sample string 8",
          "amount": "0",
          "item_type": "sample string 10",
          "item_id": "sample string 11",
          "item_group": "sample string 12",
          "item_family": "sample string 13"
        }
      ],
      "redemption_id": 4,
      "redemption_code": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<PunchhVoidRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Mobile.WebApi.Controllers">
  <CustomerEmail>sample string 1</CustomerEmail>
  <RedemptionResponses xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Models.Punchh">
    <d2p1:RedemptionResponse>
      <d2p1:Category>sample string 3</d2p1:Category>
      <d2p1:QualifiedMenuItems>
        <d2p1:MenuItem>
          <d2p1:Amount>0</d2p1:Amount>
          <d2p1:Family>sample string 13</d2p1:Family>
          <d2p1:InnerId>sample string 14</d2p1:InnerId>
          <d2p1:ItemAmount>0</d2p1:ItemAmount>
          <d2p1:ItemId>sample string 11</d2p1:ItemId>
          <d2p1:ItemName>sample string 1</d2p1:ItemName>
          <d2p1:ItemQty>sample string 3</d2p1:ItemQty>
          <d2p1:ItemType>sample string 10</d2p1:ItemType>
          <d2p1:MajorGroup>sample string 12</d2p1:MajorGroup>
          <d2p1:MenuFamily>sample string 13</d2p1:MenuFamily>
          <d2p1:MenuItemId>sample string 11</d2p1:MenuItemId>
          <d2p1:MenuItemType>sample string 10</d2p1:MenuItemType>
          <d2p1:MenuMajorGroup>sample string 12</d2p1:MenuMajorGroup>
          <d2p1:SerialNumber>sample string 8</d2p1:SerialNumber>
        </d2p1:MenuItem>
        <d2p1:MenuItem>
          <d2p1:Amount>0</d2p1:Amount>
          <d2p1:Family>sample string 13</d2p1:Family>
          <d2p1:InnerId>sample string 14</d2p1:InnerId>
          <d2p1:ItemAmount>0</d2p1:ItemAmount>
          <d2p1:ItemId>sample string 11</d2p1:ItemId>
          <d2p1:ItemName>sample string 1</d2p1:ItemName>
          <d2p1:ItemQty>sample string 3</d2p1:ItemQty>
          <d2p1:ItemType>sample string 10</d2p1:ItemType>
          <d2p1:MajorGroup>sample string 12</d2p1:MajorGroup>
          <d2p1:MenuFamily>sample string 13</d2p1:MenuFamily>
          <d2p1:MenuItemId>sample string 11</d2p1:MenuItemId>
          <d2p1:MenuItemType>sample string 10</d2p1:MenuItemType>
          <d2p1:MenuMajorGroup>sample string 12</d2p1:MenuMajorGroup>
          <d2p1:SerialNumber>sample string 8</d2p1:SerialNumber>
        </d2p1:MenuItem>
      </d2p1:QualifiedMenuItems>
      <d2p1:RedemptionAmount>2.1</d2p1:RedemptionAmount>
      <d2p1:RedemptionCode>sample string 5</d2p1:RedemptionCode>
      <d2p1:RedemptionId>4</d2p1:RedemptionId>
      <d2p1:Status>sample string 1</d2p1:Status>
    </d2p1:RedemptionResponse>
    <d2p1:RedemptionResponse>
      <d2p1:Category>sample string 3</d2p1:Category>
      <d2p1:QualifiedMenuItems>
        <d2p1:MenuItem>
          <d2p1:Amount>0</d2p1:Amount>
          <d2p1:Family>sample string 13</d2p1:Family>
          <d2p1:InnerId>sample string 14</d2p1:InnerId>
          <d2p1:ItemAmount>0</d2p1:ItemAmount>
          <d2p1:ItemId>sample string 11</d2p1:ItemId>
          <d2p1:ItemName>sample string 1</d2p1:ItemName>
          <d2p1:ItemQty>sample string 3</d2p1:ItemQty>
          <d2p1:ItemType>sample string 10</d2p1:ItemType>
          <d2p1:MajorGroup>sample string 12</d2p1:MajorGroup>
          <d2p1:MenuFamily>sample string 13</d2p1:MenuFamily>
          <d2p1:MenuItemId>sample string 11</d2p1:MenuItemId>
          <d2p1:MenuItemType>sample string 10</d2p1:MenuItemType>
          <d2p1:MenuMajorGroup>sample string 12</d2p1:MenuMajorGroup>
          <d2p1:SerialNumber>sample string 8</d2p1:SerialNumber>
        </d2p1:MenuItem>
        <d2p1:MenuItem>
          <d2p1:Amount>0</d2p1:Amount>
          <d2p1:Family>sample string 13</d2p1:Family>
          <d2p1:InnerId>sample string 14</d2p1:InnerId>
          <d2p1:ItemAmount>0</d2p1:ItemAmount>
          <d2p1:ItemId>sample string 11</d2p1:ItemId>
          <d2p1:ItemName>sample string 1</d2p1:ItemName>
          <d2p1:ItemQty>sample string 3</d2p1:ItemQty>
          <d2p1:ItemType>sample string 10</d2p1:ItemType>
          <d2p1:MajorGroup>sample string 12</d2p1:MajorGroup>
          <d2p1:MenuFamily>sample string 13</d2p1:MenuFamily>
          <d2p1:MenuItemId>sample string 11</d2p1:MenuItemId>
          <d2p1:MenuItemType>sample string 10</d2p1:MenuItemType>
          <d2p1:MenuMajorGroup>sample string 12</d2p1:MenuMajorGroup>
          <d2p1:SerialNumber>sample string 8</d2p1:SerialNumber>
        </d2p1:MenuItem>
      </d2p1:QualifiedMenuItems>
      <d2p1:RedemptionAmount>2.1</d2p1:RedemptionAmount>
      <d2p1:RedemptionCode>sample string 5</d2p1:RedemptionCode>
      <d2p1:RedemptionId>4</d2p1:RedemptionId>
      <d2p1:Status>sample string 1</d2p1:Status>
    </d2p1:RedemptionResponse>
  </RedemptionResponses>
</PunchhVoidRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.

POST pos/loyalty/punchh/redemption/void

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

URI parameters

Headers | Add header

Body

Status

Headers

Body