POST api/Order/PlaceOrderBalanceReward

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
StoreId	globally unique identifier	None.
Items	Collection of OrderItemRequest	None.
CardNumber	string	None.
RedeemedProductId	globally unique identifier	None.
Platform	string	None.
IsGBDollarPay	boolean	None.
IsScheduled	boolean	None.
ScheduledAt	date	None.
IsCatering	boolean	None.
CustomerName	string	None.
Cat_Reference	string	None.
Cat_Email	string	None.
Cat_PhoneNumber	string	None.
CateringStatus	string	None.
CateringNote	string	None.
DietaryRequirements	string	None.
Allergies	string	None.
SpecialInstructions	string	None.

Request Formats

application/json, text/json

Sample:

{
  "StoreId": "5b6f34f9-1db4-4c16-88d3-935df549123f",
  "Items": [
    {
      "ProductId": "f233e851-43eb-4a84-9f5d-a3989422ed6f",
      "ProductPriceId": "fb1cce67-05cc-4b89-ba3b-1f56626daf62",
      "Qty": 3,
      "Modifiers": [
        {
          "ModifierId": "f59c5c8d-8b1d-45c8-88f0-2e8735eae6c1",
          "ModifierPriceId": "e08c6b5e-bc51-4080-a727-3311123b84dc",
          "Qty": 3
        },
        {
          "ModifierId": "f59c5c8d-8b1d-45c8-88f0-2e8735eae6c1",
          "ModifierPriceId": "e08c6b5e-bc51-4080-a727-3311123b84dc",
          "Qty": 3
        }
      ]
    },
    {
      "ProductId": "f233e851-43eb-4a84-9f5d-a3989422ed6f",
      "ProductPriceId": "fb1cce67-05cc-4b89-ba3b-1f56626daf62",
      "Qty": 3,
      "Modifiers": [
        {
          "ModifierId": "f59c5c8d-8b1d-45c8-88f0-2e8735eae6c1",
          "ModifierPriceId": "e08c6b5e-bc51-4080-a727-3311123b84dc",
          "Qty": 3
        },
        {
          "ModifierId": "f59c5c8d-8b1d-45c8-88f0-2e8735eae6c1",
          "ModifierPriceId": "e08c6b5e-bc51-4080-a727-3311123b84dc",
          "Qty": 3
        }
      ]
    }
  ],
  "CardNumber": "sample string 2",
  "RedeemedProductId": "22989df5-9c29-495f-a02b-b4e3fc561805",
  "Platform": "sample string 3",
  "IsGBDollarPay": true,
  "IsScheduled": true,
  "ScheduledAt": "2026-11-08T03:31:33.7564206+10:00",
  "IsCatering": true,
  "CustomerName": "sample string 7",
  "Cat_Reference": "sample string 8",
  "Cat_Email": "sample string 9",
  "Cat_PhoneNumber": "sample string 10",
  "CateringStatus": "sample string 11",
  "CateringNote": "sample string 12",
  "DietaryRequirements": "sample string 13",
  "Allergies": "sample string 14",
  "SpecialInstructions": "sample string 15"
}

application/xml, text/xml

Sample:

<OnlineOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi2.Controllers">
  <Allergies>sample string 14</Allergies>
  <CardNumber>sample string 2</CardNumber>
  <Cat_Email>sample string 9</Cat_Email>
  <Cat_PhoneNumber>sample string 10</Cat_PhoneNumber>
  <Cat_Reference>sample string 8</Cat_Reference>
  <CateringNote>sample string 12</CateringNote>
  <CateringStatus>sample string 11</CateringStatus>
  <CustomerName>sample string 7</CustomerName>
  <DietaryRequirements>sample string 13</DietaryRequirements>
  <IsCatering>true</IsCatering>
  <IsGBDollarPay>true</IsGBDollarPay>
  <IsScheduled>true</IsScheduled>
  <Items>
    <OrderItemRequest>
      <Modifiers>
        <ModifierRequest>
          <ModifierId>f59c5c8d-8b1d-45c8-88f0-2e8735eae6c1</ModifierId>
          <ModifierPriceId>e08c6b5e-bc51-4080-a727-3311123b84dc</ModifierPriceId>
          <Qty>3</Qty>
        </ModifierRequest>
        <ModifierRequest>
          <ModifierId>f59c5c8d-8b1d-45c8-88f0-2e8735eae6c1</ModifierId>
          <ModifierPriceId>e08c6b5e-bc51-4080-a727-3311123b84dc</ModifierPriceId>
          <Qty>3</Qty>
        </ModifierRequest>
      </Modifiers>
      <ProductId>f233e851-43eb-4a84-9f5d-a3989422ed6f</ProductId>
      <ProductPriceId>fb1cce67-05cc-4b89-ba3b-1f56626daf62</ProductPriceId>
      <Qty>3</Qty>
    </OrderItemRequest>
    <OrderItemRequest>
      <Modifiers>
        <ModifierRequest>
          <ModifierId>f59c5c8d-8b1d-45c8-88f0-2e8735eae6c1</ModifierId>
          <ModifierPriceId>e08c6b5e-bc51-4080-a727-3311123b84dc</ModifierPriceId>
          <Qty>3</Qty>
        </ModifierRequest>
        <ModifierRequest>
          <ModifierId>f59c5c8d-8b1d-45c8-88f0-2e8735eae6c1</ModifierId>
          <ModifierPriceId>e08c6b5e-bc51-4080-a727-3311123b84dc</ModifierPriceId>
          <Qty>3</Qty>
        </ModifierRequest>
      </Modifiers>
      <ProductId>f233e851-43eb-4a84-9f5d-a3989422ed6f</ProductId>
      <ProductPriceId>fb1cce67-05cc-4b89-ba3b-1f56626daf62</ProductPriceId>
      <Qty>3</Qty>
    </OrderItemRequest>
  </Items>
  <Platform>sample string 3</Platform>
  <RedeemedProductId>22989df5-9c29-495f-a02b-b4e3fc561805</RedeemedProductId>
  <ScheduledAt>2026-11-08T03:31:33.7564206+10:00</ScheduledAt>
  <SpecialInstructions>sample string 15</SpecialInstructions>
  <StoreId>5b6f34f9-1db4-4c16-88d3-935df549123f</StoreId>
</OnlineOrderRequest>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.