POST api/Order/PlaceOrder

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.

Request Formats

application/json, text/json

Sample:

{
  "StoreId": "d92ced71-74ba-4d77-be89-6adbef4e22ab",
  "Items": [
    {
      "ProductId": "8c383f06-0c71-46fa-a93a-1401658a5fb6",
      "ProductPriceId": "300e6347-44c1-440e-bb89-d84a05b60073",
      "Qty": 3,
      "Modifiers": [
        {
          "ModifierId": "7c7e1fe9-4ead-420c-b175-bdc70bd7e6b6",
          "ModifierPriceId": "1174fcf5-6e3e-4de2-adf9-4323c813da5d",
          "Qty": 3
        },
        {
          "ModifierId": "7c7e1fe9-4ead-420c-b175-bdc70bd7e6b6",
          "ModifierPriceId": "1174fcf5-6e3e-4de2-adf9-4323c813da5d",
          "Qty": 3
        }
      ]
    },
    {
      "ProductId": "8c383f06-0c71-46fa-a93a-1401658a5fb6",
      "ProductPriceId": "300e6347-44c1-440e-bb89-d84a05b60073",
      "Qty": 3,
      "Modifiers": [
        {
          "ModifierId": "7c7e1fe9-4ead-420c-b175-bdc70bd7e6b6",
          "ModifierPriceId": "1174fcf5-6e3e-4de2-adf9-4323c813da5d",
          "Qty": 3
        },
        {
          "ModifierId": "7c7e1fe9-4ead-420c-b175-bdc70bd7e6b6",
          "ModifierPriceId": "1174fcf5-6e3e-4de2-adf9-4323c813da5d",
          "Qty": 3
        }
      ]
    }
  ],
  "CardNumber": "sample string 2",
  "RedeemedProductId": "ac4bbbd2-cce9-4b27-a4ee-e7d71068909c",
  "Platform": "sample string 3",
  "IsGBDollarPay": true,
  "IsScheduled": true,
  "ScheduledAt": "2026-10-24T01:27:12.8222647+10:00"
}

application/xml, text/xml

Sample:

<OnlineOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi2.Controllers">
  <CardNumber>sample string 2</CardNumber>
  <IsGBDollarPay>true</IsGBDollarPay>
  <IsScheduled>true</IsScheduled>
  <Items>
    <OrderItemRequest>
      <Modifiers>
        <ModifierRequest>
          <ModifierId>7c7e1fe9-4ead-420c-b175-bdc70bd7e6b6</ModifierId>
          <ModifierPriceId>1174fcf5-6e3e-4de2-adf9-4323c813da5d</ModifierPriceId>
          <Qty>3</Qty>
        </ModifierRequest>
        <ModifierRequest>
          <ModifierId>7c7e1fe9-4ead-420c-b175-bdc70bd7e6b6</ModifierId>
          <ModifierPriceId>1174fcf5-6e3e-4de2-adf9-4323c813da5d</ModifierPriceId>
          <Qty>3</Qty>
        </ModifierRequest>
      </Modifiers>
      <ProductId>8c383f06-0c71-46fa-a93a-1401658a5fb6</ProductId>
      <ProductPriceId>300e6347-44c1-440e-bb89-d84a05b60073</ProductPriceId>
      <Qty>3</Qty>
    </OrderItemRequest>
    <OrderItemRequest>
      <Modifiers>
        <ModifierRequest>
          <ModifierId>7c7e1fe9-4ead-420c-b175-bdc70bd7e6b6</ModifierId>
          <ModifierPriceId>1174fcf5-6e3e-4de2-adf9-4323c813da5d</ModifierPriceId>
          <Qty>3</Qty>
        </ModifierRequest>
        <ModifierRequest>
          <ModifierId>7c7e1fe9-4ead-420c-b175-bdc70bd7e6b6</ModifierId>
          <ModifierPriceId>1174fcf5-6e3e-4de2-adf9-4323c813da5d</ModifierPriceId>
          <Qty>3</Qty>
        </ModifierRequest>
      </Modifiers>
      <ProductId>8c383f06-0c71-46fa-a93a-1401658a5fb6</ProductId>
      <ProductPriceId>300e6347-44c1-440e-bb89-d84a05b60073</ProductPriceId>
      <Qty>3</Qty>
    </OrderItemRequest>
  </Items>
  <Platform>sample string 3</Platform>
  <RedeemedProductId>ac4bbbd2-cce9-4b27-a4ee-e7d71068909c</RedeemedProductId>
  <ScheduledAt>2026-10-24T01:27:12.8222647+10:00</ScheduledAt>
  <StoreId>d92ced71-74ba-4d77-be89-6adbef4e22ab</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.