POST brinkSupportAPI/Locations/{storeId}/Orders/{orderId}/Redeem

Request Information

URI Parameters

Name	Description	Type	Additional information
storeId		string	Required
orderId		string	Required

Body Parameters

BrinkRedeemRequest

Name	Description	Type	Additional information
order		BrinkOrder	None.
offerCode		string	None.

Request Formats

application/json, text/json

Sample:

{
  "order": {
    "id": 1,
    "closed": true,
    "openTime": "2025-07-02T03:42:37.2173417-04:00",
    "items": [
      {
        "id": 1,
        "itemId": 2,
        "description": "sample string 3",
        "price": 4.1,
        "parentEntryId": 5,
        "quantity": 6,
        "modifiers": [
          {
            "id": 1,
            "itemId": 2,
            "description": "sample string 3",
            "price": 4.1,
            "parentItemId": 5
          },
          {
            "id": 1,
            "itemId": 2,
            "description": "sample string 3",
            "price": 4.1,
            "parentItemId": 5
          }
        ]
      },
      {
        "id": 1,
        "itemId": 2,
        "description": "sample string 3",
        "price": 4.1,
        "parentEntryId": 5,
        "quantity": 6,
        "modifiers": [
          {
            "id": 1,
            "itemId": 2,
            "description": "sample string 3",
            "price": 4.1,
            "parentItemId": 5
          },
          {
            "id": 1,
            "itemId": 2,
            "description": "sample string 3",
            "price": 4.1,
            "parentItemId": 5
          }
        ]
      }
    ],
    "discounts": [
      {
        "id": 1,
        "amount": 2.1,
        "discountId": 3,
        "name": "sample string 4",
        "serializedLoyaltyReward": "sample string 5"
      },
      {
        "id": 1,
        "amount": 2.1,
        "discountId": 3,
        "name": "sample string 4",
        "serializedLoyaltyReward": "sample string 5"
      }
    ]
  },
  "offerCode": "sample string 1"
}

application/xml, text/xml

Sample:

<BrinkRedeemRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <OfferCode>sample string 1</OfferCode>
  <Order>
    <Closed>true</Closed>
    <Discounts>
      <BrinkOrderDiscount>
        <Amount>2.1</Amount>
        <DiscountId>3</DiscountId>
        <Id>1</Id>
        <Name>sample string 4</Name>
        <SerializedLoyaltyReward>sample string 5</SerializedLoyaltyReward>
      </BrinkOrderDiscount>
      <BrinkOrderDiscount>
        <Amount>2.1</Amount>
        <DiscountId>3</DiscountId>
        <Id>1</Id>
        <Name>sample string 4</Name>
        <SerializedLoyaltyReward>sample string 5</SerializedLoyaltyReward>
      </BrinkOrderDiscount>
    </Discounts>
    <Id>1</Id>
    <OpenTime>2025-07-02T03:42:37.2173417-04:00</OpenTime>
    <OrderItems>
      <BrinkOrderItem>
        <Id>1</Id>
        <ItemId>2</ItemId>
        <ItemName>sample string 3</ItemName>
        <Modifiers>
          <BrinkOrderItemModifier>
            <Id>1</Id>
            <ItemId>2</ItemId>
            <ItemName>sample string 3</ItemName>
            <ParentItemId>5</ParentItemId>
            <Price>4.1</Price>
          </BrinkOrderItemModifier>
          <BrinkOrderItemModifier>
            <Id>1</Id>
            <ItemId>2</ItemId>
            <ItemName>sample string 3</ItemName>
            <ParentItemId>5</ParentItemId>
            <Price>4.1</Price>
          </BrinkOrderItemModifier>
        </Modifiers>
        <ParentEntryId>5</ParentEntryId>
        <Price>4.1</Price>
        <Quantity>6</Quantity>
      </BrinkOrderItem>
      <BrinkOrderItem>
        <Id>1</Id>
        <ItemId>2</ItemId>
        <ItemName>sample string 3</ItemName>
        <Modifiers>
          <BrinkOrderItemModifier>
            <Id>1</Id>
            <ItemId>2</ItemId>
            <ItemName>sample string 3</ItemName>
            <ParentItemId>5</ParentItemId>
            <Price>4.1</Price>
          </BrinkOrderItemModifier>
          <BrinkOrderItemModifier>
            <Id>1</Id>
            <ItemId>2</ItemId>
            <ItemName>sample string 3</ItemName>
            <ParentItemId>5</ParentItemId>
            <Price>4.1</Price>
          </BrinkOrderItemModifier>
        </Modifiers>
        <ParentEntryId>5</ParentEntryId>
        <Price>4.1</Price>
        <Quantity>6</Quantity>
      </BrinkOrderItem>
    </OrderItems>
  </Order>
</BrinkRedeemRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BrinkRedeemRequest'.

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.