POST api/Order/PlaceOrder
Request Information
URI Parameters
None.
Body Parameters
OnlineOrderRequest| Name | Description | 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. |
Request Formats
application/json, text/json
Sample:
{
"StoreId": "aa38e590-1a89-48b4-9fc6-921442d3a75e",
"Items": [
{
"ProductId": "17f124c3-3b66-493a-a3e7-292b44f87a40",
"ProductPriceId": "924a7351-b0c6-4db1-800a-048ad3c2fe97",
"Qty": 3,
"Modifiers": [
{
"ModifierId": "d6722daa-4f84-444e-bece-921c682c741a",
"ModifierPriceId": "3d36d26a-b13d-4acb-b036-df0a0a9b0e44",
"Qty": 3
},
{
"ModifierId": "d6722daa-4f84-444e-bece-921c682c741a",
"ModifierPriceId": "3d36d26a-b13d-4acb-b036-df0a0a9b0e44",
"Qty": 3
}
]
},
{
"ProductId": "17f124c3-3b66-493a-a3e7-292b44f87a40",
"ProductPriceId": "924a7351-b0c6-4db1-800a-048ad3c2fe97",
"Qty": 3,
"Modifiers": [
{
"ModifierId": "d6722daa-4f84-444e-bece-921c682c741a",
"ModifierPriceId": "3d36d26a-b13d-4acb-b036-df0a0a9b0e44",
"Qty": 3
},
{
"ModifierId": "d6722daa-4f84-444e-bece-921c682c741a",
"ModifierPriceId": "3d36d26a-b13d-4acb-b036-df0a0a9b0e44",
"Qty": 3
}
]
}
],
"CardNumber": "sample string 2",
"RedeemedProductId": "e38b966e-0605-426e-9a5d-ab3d8f79c3b4",
"Platform": "sample string 3",
"IsGBDollarPay": true
}
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>
<Items>
<OrderItemRequest>
<Modifiers>
<ModifierRequest>
<ModifierId>d6722daa-4f84-444e-bece-921c682c741a</ModifierId>
<ModifierPriceId>3d36d26a-b13d-4acb-b036-df0a0a9b0e44</ModifierPriceId>
<Qty>3</Qty>
</ModifierRequest>
<ModifierRequest>
<ModifierId>d6722daa-4f84-444e-bece-921c682c741a</ModifierId>
<ModifierPriceId>3d36d26a-b13d-4acb-b036-df0a0a9b0e44</ModifierPriceId>
<Qty>3</Qty>
</ModifierRequest>
</Modifiers>
<ProductId>17f124c3-3b66-493a-a3e7-292b44f87a40</ProductId>
<ProductPriceId>924a7351-b0c6-4db1-800a-048ad3c2fe97</ProductPriceId>
<Qty>3</Qty>
</OrderItemRequest>
<OrderItemRequest>
<Modifiers>
<ModifierRequest>
<ModifierId>d6722daa-4f84-444e-bece-921c682c741a</ModifierId>
<ModifierPriceId>3d36d26a-b13d-4acb-b036-df0a0a9b0e44</ModifierPriceId>
<Qty>3</Qty>
</ModifierRequest>
<ModifierRequest>
<ModifierId>d6722daa-4f84-444e-bece-921c682c741a</ModifierId>
<ModifierPriceId>3d36d26a-b13d-4acb-b036-df0a0a9b0e44</ModifierPriceId>
<Qty>3</Qty>
</ModifierRequest>
</Modifiers>
<ProductId>17f124c3-3b66-493a-a3e7-292b44f87a40</ProductId>
<ProductPriceId>924a7351-b0c6-4db1-800a-048ad3c2fe97</ProductPriceId>
<Qty>3</Qty>
</OrderItemRequest>
</Items>
<Platform>sample string 3</Platform>
<RedeemedProductId>e38b966e-0605-426e-9a5d-ab3d8f79c3b4</RedeemedProductId>
<StoreId>aa38e590-1a89-48b4-9fc6-921442d3a75e</StoreId>
</OnlineOrderRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.