POST toastSupportAPI/promotionRequest

Request Information

URI Parameters

None.

Body Parameters

PromotionRequest
NameDescriptionTypeAdditional information
newPromotion

NewPromotion

None.

requestDateTime

date

None.

check

Check

None.

appliedPromotions

Collection of AppliedPromotion

None.

promotionsToActOn

Collection of AppliedPromotion

None.

Request Formats

application/json, text/json

Sample:
{
  "newPromotion": {
    "promoCode": "sample string 1",
    "discountAmount": 2.0,
    "appliedDate": "sample string 3",
    "appliedBusinessDate": 4
  },
  "requestDateTime": "2024-05-18T04:07:01.3048133-04:00",
  "check": {
    "displayNumber": "sample string 1",
    "totalAmount": 1.0,
    "selections": [
      {
        "displayName": "sample string 1",
        "quantity": 1.0,
        "item": {
          "guid": "sample string 1"
        },
        "modifiers": [
          {
            "displayName": "sample string 1",
            "quantity": 1.0,
            "item": {
              "guid": "sample string 1"
            },
            "price": 1.0,
            "parenItemGuid": "sample string 2"
          },
          {
            "displayName": "sample string 1",
            "quantity": 1.0,
            "item": {
              "guid": "sample string 1"
            },
            "price": 1.0,
            "parenItemGuid": "sample string 2"
          }
        ],
        "preDiscountPrice": 1.0
      },
      {
        "displayName": "sample string 1",
        "quantity": 1.0,
        "item": {
          "guid": "sample string 1"
        },
        "modifiers": [
          {
            "displayName": "sample string 1",
            "quantity": 1.0,
            "item": {
              "guid": "sample string 1"
            },
            "price": 1.0,
            "parenItemGuid": "sample string 2"
          },
          {
            "displayName": "sample string 1",
            "quantity": 1.0,
            "item": {
              "guid": "sample string 1"
            },
            "price": 1.0,
            "parenItemGuid": "sample string 2"
          }
        ],
        "preDiscountPrice": 1.0
      }
    ]
  },
  "appliedPromotions": [
    {
      "externalId": "sample string 1",
      "appliedDiscountGuid": "sample string 2",
      "name": "sample string 3",
      "referenceId": "sample string 4",
      "promoCode": "sample string 5",
      "discountAmount": 6.0,
      "appliedDate": "sample string 7",
      "appliedBusinessDate": 8
    },
    {
      "externalId": "sample string 1",
      "appliedDiscountGuid": "sample string 2",
      "name": "sample string 3",
      "referenceId": "sample string 4",
      "promoCode": "sample string 5",
      "discountAmount": 6.0,
      "appliedDate": "sample string 7",
      "appliedBusinessDate": 8
    }
  ],
  "promotionsToActOn": [
    {
      "externalId": "sample string 1",
      "appliedDiscountGuid": "sample string 2",
      "name": "sample string 3",
      "referenceId": "sample string 4",
      "promoCode": "sample string 5",
      "discountAmount": 6.0,
      "appliedDate": "sample string 7",
      "appliedBusinessDate": 8
    },
    {
      "externalId": "sample string 1",
      "appliedDiscountGuid": "sample string 2",
      "name": "sample string 3",
      "referenceId": "sample string 4",
      "promoCode": "sample string 5",
      "discountAmount": 6.0,
      "appliedDate": "sample string 7",
      "appliedBusinessDate": 8
    }
  ]
}

application/xml, text/xml

Sample:
<PromotionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <AppliedPromotions>
    <AppliedPromotion>
      <AppliedBusinessDate>8</AppliedBusinessDate>
      <AppliedDate>sample string 7</AppliedDate>
      <DiscountAmount>6</DiscountAmount>
      <PromoCode>sample string 5</PromoCode>
      <AppliedDiscountGuid>sample string 2</AppliedDiscountGuid>
      <ExternalId>sample string 1</ExternalId>
      <Name>sample string 3</Name>
      <ReferenceId>sample string 4</ReferenceId>
    </AppliedPromotion>
    <AppliedPromotion>
      <AppliedBusinessDate>8</AppliedBusinessDate>
      <AppliedDate>sample string 7</AppliedDate>
      <DiscountAmount>6</DiscountAmount>
      <PromoCode>sample string 5</PromoCode>
      <AppliedDiscountGuid>sample string 2</AppliedDiscountGuid>
      <ExternalId>sample string 1</ExternalId>
      <Name>sample string 3</Name>
      <ReferenceId>sample string 4</ReferenceId>
    </AppliedPromotion>
  </AppliedPromotions>
  <Check>
    <CheckNumber>sample string 1</CheckNumber>
    <Selections>
      <Selection>
        <DisplayName>sample string 1</DisplayName>
        <Item>
          <Guid>sample string 1</Guid>
        </Item>
        <Modifiers>
          <Modifiers>
            <DisplayName>sample string 1</DisplayName>
            <Item>
              <Guid>sample string 1</Guid>
            </Item>
            <ParenItemGuid>sample string 2</ParenItemGuid>
            <Price>1</Price>
            <Quantity>1</Quantity>
          </Modifiers>
          <Modifiers>
            <DisplayName>sample string 1</DisplayName>
            <Item>
              <Guid>sample string 1</Guid>
            </Item>
            <ParenItemGuid>sample string 2</ParenItemGuid>
            <Price>1</Price>
            <Quantity>1</Quantity>
          </Modifiers>
        </Modifiers>
        <Price>1</Price>
        <Quantity>1</Quantity>
      </Selection>
      <Selection>
        <DisplayName>sample string 1</DisplayName>
        <Item>
          <Guid>sample string 1</Guid>
        </Item>
        <Modifiers>
          <Modifiers>
            <DisplayName>sample string 1</DisplayName>
            <Item>
              <Guid>sample string 1</Guid>
            </Item>
            <ParenItemGuid>sample string 2</ParenItemGuid>
            <Price>1</Price>
            <Quantity>1</Quantity>
          </Modifiers>
          <Modifiers>
            <DisplayName>sample string 1</DisplayName>
            <Item>
              <Guid>sample string 1</Guid>
            </Item>
            <ParenItemGuid>sample string 2</ParenItemGuid>
            <Price>1</Price>
            <Quantity>1</Quantity>
          </Modifiers>
        </Modifiers>
        <Price>1</Price>
        <Quantity>1</Quantity>
      </Selection>
    </Selections>
    <Total>1</Total>
  </Check>
  <NewPromotion>
    <AppliedBusinessDate>4</AppliedBusinessDate>
    <AppliedDate>sample string 3</AppliedDate>
    <DiscountAmount>2</DiscountAmount>
    <PromoCode>sample string 1</PromoCode>
  </NewPromotion>
  <PromotionsToActOn>
    <AppliedPromotion>
      <AppliedBusinessDate>8</AppliedBusinessDate>
      <AppliedDate>sample string 7</AppliedDate>
      <DiscountAmount>6</DiscountAmount>
      <PromoCode>sample string 5</PromoCode>
      <AppliedDiscountGuid>sample string 2</AppliedDiscountGuid>
      <ExternalId>sample string 1</ExternalId>
      <Name>sample string 3</Name>
      <ReferenceId>sample string 4</ReferenceId>
    </AppliedPromotion>
    <AppliedPromotion>
      <AppliedBusinessDate>8</AppliedBusinessDate>
      <AppliedDate>sample string 7</AppliedDate>
      <DiscountAmount>6</DiscountAmount>
      <PromoCode>sample string 5</PromoCode>
      <AppliedDiscountGuid>sample string 2</AppliedDiscountGuid>
      <ExternalId>sample string 1</ExternalId>
      <Name>sample string 3</Name>
      <ReferenceId>sample string 4</ReferenceId>
    </AppliedPromotion>
  </PromotionsToActOn>
  <RequestDateTime>2024-05-18T04:07:01.3048133-04:00</RequestDateTime>
</PromotionRequest>

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 'PromotionRequest'.

Response Information

Resource Description

HttpResponseMessage

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.