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": "e512655d-248e-4240-8ae8-b46bfa03245f",
"Items": [
{
"ProductId": "bad2e619-33c1-4464-8718-eea707a29e22",
"ProductPriceId": "a635fa4c-6f8f-4723-a22c-c4946cec8704",
"Qty": 3,
"Modifiers": [
{
"ModifierId": "30e2a2ec-b40a-4b5c-8d14-5fe9fdb6c92a",
"ModifierPriceId": "51cfb0c6-6e14-480c-b663-fa2635708f38",
"Qty": 3
},
{
"ModifierId": "30e2a2ec-b40a-4b5c-8d14-5fe9fdb6c92a",
"ModifierPriceId": "51cfb0c6-6e14-480c-b663-fa2635708f38",
"Qty": 3
}
]
},
{
"ProductId": "bad2e619-33c1-4464-8718-eea707a29e22",
"ProductPriceId": "a635fa4c-6f8f-4723-a22c-c4946cec8704",
"Qty": 3,
"Modifiers": [
{
"ModifierId": "30e2a2ec-b40a-4b5c-8d14-5fe9fdb6c92a",
"ModifierPriceId": "51cfb0c6-6e14-480c-b663-fa2635708f38",
"Qty": 3
},
{
"ModifierId": "30e2a2ec-b40a-4b5c-8d14-5fe9fdb6c92a",
"ModifierPriceId": "51cfb0c6-6e14-480c-b663-fa2635708f38",
"Qty": 3
}
]
}
],
"CardNumber": "sample string 2",
"RedeemedProductId": "9b1c0048-46da-42b5-b8a7-5d5719d9195a",
"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>30e2a2ec-b40a-4b5c-8d14-5fe9fdb6c92a</ModifierId>
<ModifierPriceId>51cfb0c6-6e14-480c-b663-fa2635708f38</ModifierPriceId>
<Qty>3</Qty>
</ModifierRequest>
<ModifierRequest>
<ModifierId>30e2a2ec-b40a-4b5c-8d14-5fe9fdb6c92a</ModifierId>
<ModifierPriceId>51cfb0c6-6e14-480c-b663-fa2635708f38</ModifierPriceId>
<Qty>3</Qty>
</ModifierRequest>
</Modifiers>
<ProductId>bad2e619-33c1-4464-8718-eea707a29e22</ProductId>
<ProductPriceId>a635fa4c-6f8f-4723-a22c-c4946cec8704</ProductPriceId>
<Qty>3</Qty>
</OrderItemRequest>
<OrderItemRequest>
<Modifiers>
<ModifierRequest>
<ModifierId>30e2a2ec-b40a-4b5c-8d14-5fe9fdb6c92a</ModifierId>
<ModifierPriceId>51cfb0c6-6e14-480c-b663-fa2635708f38</ModifierPriceId>
<Qty>3</Qty>
</ModifierRequest>
<ModifierRequest>
<ModifierId>30e2a2ec-b40a-4b5c-8d14-5fe9fdb6c92a</ModifierId>
<ModifierPriceId>51cfb0c6-6e14-480c-b663-fa2635708f38</ModifierPriceId>
<Qty>3</Qty>
</ModifierRequest>
</Modifiers>
<ProductId>bad2e619-33c1-4464-8718-eea707a29e22</ProductId>
<ProductPriceId>a635fa4c-6f8f-4723-a22c-c4946cec8704</ProductPriceId>
<Qty>3</Qty>
</OrderItemRequest>
</Items>
<Platform>sample string 3</Platform>
<RedeemedProductId>9b1c0048-46da-42b5-b8a7-5d5719d9195a</RedeemedProductId>
<StoreId>e512655d-248e-4240-8ae8-b46bfa03245f</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.