POST api/v2/Orders/Create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
number	string	Required String length: inclusive between 0 and 128
docId	string	None.
estimatedValue	decimal number	Required
totalValue	decimal number	Required
warehouseFrom	integer	None.
priority	integer	Range: inclusive between 0 and 200
reserveSchema	integer	None.
marketplaceCode	integer	None.
recipientCode	string	None.
shippingDate	string	Required
recipientName	string	String length: inclusive between 0 and 128
recipientPhone	string	None.
recipientPhone2	string	None.
recipientEmail	string	None.
draftAddress	string	String length: inclusive between 0 and 1024
addressDetails	AddressDetails	None.
items	Collection of Item	Required
parameters	Collection of Parameter	None.

Request Formats

application/json, text/json

Sample:

{
  "number": "sample string 1",
  "docId": "sample string 2",
  "estimatedValue": 3.0,
  "totalValue": 4.0,
  "warehouseFrom": 1,
  "priority": 1,
  "reserveSchema": 1,
  "marketplaceCode": 1,
  "recipientCode": "sample string 5",
  "shippingDate": "sample string 6",
  "recipientName": "sample string 7",
  "recipientPhone": "sample string 8",
  "recipientPhone2": "sample string 9",
  "recipientEmail": "sample string 10",
  "draftAddress": "sample string 11",
  "addressDetails": {
    "country": "sample string 1",
    "zip": "sample string 2",
    "region": "sample string 3",
    "area": "sample string 4",
    "city": "sample string 5",
    "settlement": "sample string 6",
    "street": "sample string 7",
    "buildingNumber": "sample string 8",
    "flatNumber": "sample string 9"
  },
  "items": [
    {
      "code": "sample string 1",
      "price": 2.0,
      "discountRate": 1.0,
      "discountSum": 1.0,
      "count": 3,
      "unit": 4,
      "itemCondition": 5,
      "partNum": "sample string 6",
      "expireDate": "sample string 7",
      "parameters": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ]
    },
    {
      "code": "sample string 1",
      "price": 2.0,
      "discountRate": 1.0,
      "discountSum": 1.0,
      "count": 3,
      "unit": 4,
      "itemCondition": 5,
      "partNum": "sample string 6",
      "expireDate": "sample string 7",
      "parameters": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ]
    }
  ],
  "parameters": [
    {
      "name": "sample string 1",
      "value": "sample string 2"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreshLogicAPI.Models">
  <addressDetails>
    <area>sample string 4</area>
    <buildingNumber>sample string 8</buildingNumber>
    <city>sample string 5</city>
    <country>sample string 1</country>
    <flatNumber>sample string 9</flatNumber>
    <region>sample string 3</region>
    <settlement>sample string 6</settlement>
    <street>sample string 7</street>
    <zip>sample string 2</zip>
  </addressDetails>
  <docId>sample string 2</docId>
  <draftAddress>sample string 11</draftAddress>
  <estimatedValue>3</estimatedValue>
  <items>
    <Order.Item>
      <code>sample string 1</code>
      <count>3</count>
      <discountRate>1</discountRate>
      <discountSum>1</discountSum>
      <expireDate>sample string 7</expireDate>
      <itemCondition>5</itemCondition>
      <parameters>
        <Parameter>
          <name>sample string 1</name>
          <value>sample string 2</value>
        </Parameter>
        <Parameter>
          <name>sample string 1</name>
          <value>sample string 2</value>
        </Parameter>
      </parameters>
      <partNum>sample string 6</partNum>
      <price>2</price>
      <unit>4</unit>
    </Order.Item>
    <Order.Item>
      <code>sample string 1</code>
      <count>3</count>
      <discountRate>1</discountRate>
      <discountSum>1</discountSum>
      <expireDate>sample string 7</expireDate>
      <itemCondition>5</itemCondition>
      <parameters>
        <Parameter>
          <name>sample string 1</name>
          <value>sample string 2</value>
        </Parameter>
        <Parameter>
          <name>sample string 1</name>
          <value>sample string 2</value>
        </Parameter>
      </parameters>
      <partNum>sample string 6</partNum>
      <price>2</price>
      <unit>4</unit>
    </Order.Item>
  </items>
  <marketplaceCode>1</marketplaceCode>
  <number>sample string 1</number>
  <parameters>
    <Parameter>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </Parameter>
    <Parameter>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </Parameter>
  </parameters>
  <priority>1</priority>
  <recipientCode>sample string 5</recipientCode>
  <recipientEmail>sample string 10</recipientEmail>
  <recipientName>sample string 7</recipientName>
  <recipientPhone>sample string 8</recipientPhone>
  <recipientPhone2>sample string 9</recipientPhone2>
  <reserveSchema>1</reserveSchema>
  <shippingDate>sample string 6</shippingDate>
  <totalValue>4</totalValue>
  <warehouseFrom>1</warehouseFrom>
</Order>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.