POST api/v1/Orders/Create

Request Information

URI Parameters

None.

Body Parameters

Order
NameDescriptionTypeAdditional information
number

string

Required

String length: inclusive between 0 and 128

docId

string

None.

type

integer

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.

deliveryDetails

DeliveryDetails

None.

items

Collection of OrderItem

Required

parameters

Collection of Parameter

None.

dsc

string

String length: inclusive between 0 and 2000

seats

integer

None.

pid

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "number": "sample string 1",
  "docId": "sample string 2",
  "type": 1,
  "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"
  },
  "deliveryDetails": {
    "clubPaymentType": 1,
    "clubServiceType": 1,
    "deliveryTimeFrom": 1,
    "deliveryTimeTo": 1,
    "deliveryDate": "sample string 1",
    "deliveryMethod": 2,
    "deliveryService": 3,
    "deliveryCost": 4.0,
    "comment": "sample string 5",
    "selfPickupPoint": "sample string 6",
    "dimensionSide1": 1,
    "dimensionSide2": 1,
    "dimensionSide3": 1,
    "weight": 1.0,
    "dalliPaymentType": "sample string 7",
    "dpdServiceCode": "sample string 8",
    "dpdCargoRegistered": 1,
    "getrixServiceType": "sample string 9",
    "grastinServiceType": 1,
    "pickpointPostageType": 1,
    "pickpointGettingType": 1,
    "pickpointConditionsOfReturn": 1,
    "pickpointPaymentReturnTyp": "sample string 10",
    "postRfServiceType": "sample string 11",
    "sdekServiceType": 1,
    "sdekAddServices": [
      1,
      2
    ]
  },
  "items": [
    {
      "price": 1.0,
      "discountRate": 1.0,
      "discountSum": 1.0,
      "count": 2.0,
      "itemCondition": 3,
      "partNum": "sample string 4",
      "expireDate": "sample string 5",
      "itemSubCondition": 1,
      "parameters": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "makeDate": "sample string 6",
      "weightExpected": 1.0,
      "code": "sample string 7",
      "unit": 8
    },
    {
      "price": 1.0,
      "discountRate": 1.0,
      "discountSum": 1.0,
      "count": 2.0,
      "itemCondition": 3,
      "partNum": "sample string 4",
      "expireDate": "sample string 5",
      "itemSubCondition": 1,
      "parameters": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "makeDate": "sample string 6",
      "weightExpected": 1.0,
      "code": "sample string 7",
      "unit": 8
    }
  ],
  "parameters": [
    {
      "name": "sample string 1",
      "value": "sample string 2"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2"
    }
  ],
  "dsc": "sample string 12",
  "seats": 1,
  "pid": 1
}

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>
  <deliveryDetails>
    <clubPaymentType>1</clubPaymentType>
    <clubServiceType>1</clubServiceType>
    <comment>sample string 5</comment>
    <dalliPaymentType>sample string 7</dalliPaymentType>
    <deliveryCost>4</deliveryCost>
    <deliveryDate>sample string 1</deliveryDate>
    <deliveryMethod>2</deliveryMethod>
    <deliveryService>3</deliveryService>
    <deliveryTimeFrom>1</deliveryTimeFrom>
    <deliveryTimeTo>1</deliveryTimeTo>
    <dimensionSide1>1</dimensionSide1>
    <dimensionSide2>1</dimensionSide2>
    <dimensionSide3>1</dimensionSide3>
    <dpdCargoRegistered>1</dpdCargoRegistered>
    <dpdServiceCode>sample string 8</dpdServiceCode>
    <getrixServiceType>sample string 9</getrixServiceType>
    <grastinServiceType>1</grastinServiceType>
    <pickpointConditionsOfReturn>1</pickpointConditionsOfReturn>
    <pickpointGettingType>1</pickpointGettingType>
    <pickpointPaymentReturnTyp>sample string 10</pickpointPaymentReturnTyp>
    <pickpointPostageType>1</pickpointPostageType>
    <postRfServiceType>sample string 11</postRfServiceType>
    <sdekAddServices xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </sdekAddServices>
    <sdekServiceType>1</sdekServiceType>
    <selfPickupPoint>sample string 6</selfPickupPoint>
    <weight>1</weight>
  </deliveryDetails>
  <docId>sample string 2</docId>
  <draftAddress>sample string 11</draftAddress>
  <dsc>sample string 12</dsc>
  <estimatedValue>3</estimatedValue>
  <items>
    <Order.OrderItem>
      <code>sample string 7</code>
      <unit>8</unit>
      <count>2</count>
      <discountRate>1</discountRate>
      <discountSum>1</discountSum>
      <expireDate>sample string 5</expireDate>
      <itemCondition>3</itemCondition>
      <itemSubCondition>1</itemSubCondition>
      <makeDate>sample string 6</makeDate>
      <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 4</partNum>
      <price>1</price>
      <weightExpected>1</weightExpected>
    </Order.OrderItem>
    <Order.OrderItem>
      <code>sample string 7</code>
      <unit>8</unit>
      <count>2</count>
      <discountRate>1</discountRate>
      <discountSum>1</discountSum>
      <expireDate>sample string 5</expireDate>
      <itemCondition>3</itemCondition>
      <itemSubCondition>1</itemSubCondition>
      <makeDate>sample string 6</makeDate>
      <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 4</partNum>
      <price>1</price>
      <weightExpected>1</weightExpected>
    </Order.OrderItem>
  </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>
  <pid>1</pid>
  <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>
  <seats>1</seats>
  <shippingDate>sample string 6</shippingDate>
  <totalValue>4</totalValue>
  <type>1</type>
  <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.