POST api/Orders

Make a Order Request

Request Information

URI Parameters

None.

Body Parameters

The OrderRequest

Name	Description	Type	Additional information
ExternalOrderNumber	This is the order number / identifier provided by the webshop	string	None.
ContactPersonID	The unique ID of the contact person	integer	None.
OrderedProducts	List of OrderedProduct	Collection of OrderedProduct	None.
OrderPrice	Total price of order	decimal number	None.
DeliveryAddress	The delivery address of this order	Address	None.
BillingAddress	The billing address of this order	Address	None.
Lang2	The default language of this order, This is a 2 letter code, defaults to english(EN) if the letter code is unknown.	string	None.
OrderReference	The optional order reference of end user	string	None.
OrderMessage	The optional message of end user	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ExternalOrderNumber": "sample string 1",
  "ContactPersonID": 2,
  "OrderedProducts": [
    {
      "UniqueProductID": 1,
      "Price": 2.0,
      "AmountOrdered": 3.0
    },
    {
      "UniqueProductID": 1,
      "Price": 2.0,
      "AmountOrdered": 3.0
    }
  ],
  "OrderPrice": 3.0,
  "DeliveryAddress": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "City": "sample string 3",
    "Region": "sample string 4",
    "ZipCode": "sample string 5",
    "Country": "sample string 6"
  },
  "BillingAddress": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "City": "sample string 3",
    "Region": "sample string 4",
    "ZipCode": "sample string 5",
    "Country": "sample string 6"
  },
  "Lang2": "sample string 4",
  "OrderReference": "sample string 5",
  "OrderMessage": "sample string 6"
}

application/xml, text/xml

Sample:

<OrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATRonicLayer.BO">
  <BillingAddress>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <City>sample string 3</City>
    <Country>sample string 6</Country>
    <Region>sample string 4</Region>
    <ZipCode>sample string 5</ZipCode>
  </BillingAddress>
  <ContactPersonID>2</ContactPersonID>
  <DeliveryAddress>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <City>sample string 3</City>
    <Country>sample string 6</Country>
    <Region>sample string 4</Region>
    <ZipCode>sample string 5</ZipCode>
  </DeliveryAddress>
  <ExternalOrderNumber>sample string 1</ExternalOrderNumber>
  <Lang2>sample string 4</Lang2>
  <OrderMessage>sample string 6</OrderMessage>
  <OrderPrice>3</OrderPrice>
  <OrderReference>sample string 5</OrderReference>
  <OrderedProducts>
    <OrderedProduct>
      <AmountOrdered>3</AmountOrdered>
      <Price>2</Price>
      <UniqueProductID>1</UniqueProductID>
    </OrderedProduct>
    <OrderedProduct>
      <AmountOrdered>3</AmountOrdered>
      <Price>2</Price>
      <UniqueProductID>1</UniqueProductID>
    </OrderedProduct>
  </OrderedProducts>
</OrderRequest>

Response Information

Resource Description

A OrderResponse

OrderResponse

Name	Description	Type	Additional information
InternalOrderID	The order ID of the internal order system	integer	None.
RequestProcessed	If the order request has been successfully processed	boolean	None.
Message01	Message 1 back to end user	string	None.
Message02	Message 2 back to end user	string	None.
Message03	Message 3 back to end user	string	None.

Response Formats

application/json, text/json

Sample:

{
  "InternalOrderID": 1,
  "RequestProcessed": true,
  "Message01": "sample string 3",
  "Message02": "sample string 4",
  "Message03": "sample string 5"
}

application/xml, text/xml

Sample:

<OrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATRonicLayer.BO">
  <InternalOrderID>1</InternalOrderID>
  <Message01>sample string 3</Message01>
  <Message02>sample string 4</Message02>
  <Message03>sample string 5</Message03>
  <RequestProcessed>true</RequestProcessed>
</OrderResponse>