POST v1/orders

Request Information

URI Parameters

None.

Body Parameters

OrderRequest
NameDescriptionTypeAdditional information
WebOrderID

string

None.

OrderedDate

string

None.

DeliveryComments

string

None.

IsSale

boolean

None.

OrderItems

Collection of OrderItems

None.

Request Formats

application/json, text/json

Sample:
{
  "WebOrderID": "sample string 1",
  "OrderedDate": "sample string 2",
  "DeliveryComments": "sample string 3",
  "IsSale": true,
  "OrderItems": [
    {
      "WebItemID": "sample string 1",
      "sku": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "ShippingFirstName": "sample string 5",
      "ShippingLastName": "sample string 6",
      "ShippingAddress1": "sample string 7",
      "ShippingTown": "sample string 8",
      "ShippingPostcode": "sample string 9",
      "Address1": "sample string 10",
      "Address2": "sample string 11",
      "Town": "sample string 12",
      "Postcode": "sample string 13",
      "CustomerEmail": "sample string 14",
      "BillingEmail": "sample string 15",
      "PhoneNo": "sample string 16",
      "GrandTotal": 1.0,
      "ShipInclTaxPrice": 1.0,
      "TradeDeliveryFirstName": "sample string 17",
      "TradeDeliveryLastName": "sample string 18",
      "TradeDeliveryEmail": "sample string 19",
      "TradeDeliveryTel": "sample string 20",
      "Quantity": 1,
      "Price": 1.0,
      "TotalPrice": 1.0,
      "AmountReceived": 1.0,
      "PaymentID": "sample string 21",
      "TotalDue": 1.0
    },
    {
      "WebItemID": "sample string 1",
      "sku": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "ShippingFirstName": "sample string 5",
      "ShippingLastName": "sample string 6",
      "ShippingAddress1": "sample string 7",
      "ShippingTown": "sample string 8",
      "ShippingPostcode": "sample string 9",
      "Address1": "sample string 10",
      "Address2": "sample string 11",
      "Town": "sample string 12",
      "Postcode": "sample string 13",
      "CustomerEmail": "sample string 14",
      "BillingEmail": "sample string 15",
      "PhoneNo": "sample string 16",
      "GrandTotal": 1.0,
      "ShipInclTaxPrice": 1.0,
      "TradeDeliveryFirstName": "sample string 17",
      "TradeDeliveryLastName": "sample string 18",
      "TradeDeliveryEmail": "sample string 19",
      "TradeDeliveryTel": "sample string 20",
      "Quantity": 1,
      "Price": 1.0,
      "TotalPrice": 1.0,
      "AmountReceived": 1.0,
      "PaymentID": "sample string 21",
      "TotalDue": 1.0
    }
  ]
}

application/xml, text/xml

Sample:
<OrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RadiatorAPI.Models">
  <DeliveryComments>sample string 3</DeliveryComments>
  <IsSale>true</IsSale>
  <OrderItems>
    <OrderItems>
      <Address1>sample string 10</Address1>
      <Address2>sample string 11</Address2>
      <AmountReceived>1</AmountReceived>
      <BillingEmail>sample string 15</BillingEmail>
      <CustomerEmail>sample string 14</CustomerEmail>
      <FirstName>sample string 3</FirstName>
      <GrandTotal>1</GrandTotal>
      <LastName>sample string 4</LastName>
      <PaymentID>sample string 21</PaymentID>
      <PhoneNo>sample string 16</PhoneNo>
      <Postcode>sample string 13</Postcode>
      <Price>1</Price>
      <Quantity>1</Quantity>
      <ShipInclTaxPrice>1</ShipInclTaxPrice>
      <ShippingAddress1>sample string 7</ShippingAddress1>
      <ShippingFirstName>sample string 5</ShippingFirstName>
      <ShippingLastName>sample string 6</ShippingLastName>
      <ShippingPostcode>sample string 9</ShippingPostcode>
      <ShippingTown>sample string 8</ShippingTown>
      <TotalDue>1</TotalDue>
      <TotalPrice>1</TotalPrice>
      <Town>sample string 12</Town>
      <TradeDeliveryEmail>sample string 19</TradeDeliveryEmail>
      <TradeDeliveryFirstName>sample string 17</TradeDeliveryFirstName>
      <TradeDeliveryLastName>sample string 18</TradeDeliveryLastName>
      <TradeDeliveryTel>sample string 20</TradeDeliveryTel>
      <WebItemID>sample string 1</WebItemID>
      <sku>sample string 2</sku>
    </OrderItems>
    <OrderItems>
      <Address1>sample string 10</Address1>
      <Address2>sample string 11</Address2>
      <AmountReceived>1</AmountReceived>
      <BillingEmail>sample string 15</BillingEmail>
      <CustomerEmail>sample string 14</CustomerEmail>
      <FirstName>sample string 3</FirstName>
      <GrandTotal>1</GrandTotal>
      <LastName>sample string 4</LastName>
      <PaymentID>sample string 21</PaymentID>
      <PhoneNo>sample string 16</PhoneNo>
      <Postcode>sample string 13</Postcode>
      <Price>1</Price>
      <Quantity>1</Quantity>
      <ShipInclTaxPrice>1</ShipInclTaxPrice>
      <ShippingAddress1>sample string 7</ShippingAddress1>
      <ShippingFirstName>sample string 5</ShippingFirstName>
      <ShippingLastName>sample string 6</ShippingLastName>
      <ShippingPostcode>sample string 9</ShippingPostcode>
      <ShippingTown>sample string 8</ShippingTown>
      <TotalDue>1</TotalDue>
      <TotalPrice>1</TotalPrice>
      <Town>sample string 12</Town>
      <TradeDeliveryEmail>sample string 19</TradeDeliveryEmail>
      <TradeDeliveryFirstName>sample string 17</TradeDeliveryFirstName>
      <TradeDeliveryLastName>sample string 18</TradeDeliveryLastName>
      <TradeDeliveryTel>sample string 20</TradeDeliveryTel>
      <WebItemID>sample string 1</WebItemID>
      <sku>sample string 2</sku>
    </OrderItems>
  </OrderItems>
  <OrderedDate>sample string 2</OrderedDate>
  <WebOrderID>sample string 1</WebOrderID>
</OrderRequest>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.