For more information on using API

POST https://webapi.mymarketing.co.il/api/commerce/Order

Add new order

Request Information

URI Parameters

Body Parameters

Collection of ApiPostOrder

Name

Description

Type

Additional information

orderId

Gets or sets the Order ID.

string
orderName

Gets or sets the name of the order.

string
externalId

Gets or sets the external user ID.

string
externalName

Gets or sets the external name.

string
firstName

Gets or sets the first name of the customer.

string
lastName

Gets or sets the last name of the customer.

string
email

Gets or sets the email address of the customer.

string
mobile

Gets or sets the mobile number of the customer.

string
netAmount

Gets or sets the net amount of the order.

decimal number
tax

Gets or sets the tax applied to the order.

decimal number
coupon

Gets or sets the coupon code used for the order.

string
quantity

Gets or sets the quantity of items in the order.

decimal number
totalAmount

Gets or sets the total amount of the order.

decimal number
address

Gets or sets the shipping address of the order.

string
city

Gets or sets the city for the shipping address.

string
products

Gets or sets the list of products in the order.

Collection of Product
url

Gets or sets the URL associated with the order.

string
purchaseDate

Gets or sets the date of purchase.

date
lastUpdate

Gets or sets the last update date of the order.

date
purchaseType

Gets or sets the type of purchase.

string
storeId

Gets or sets the store ID associated with the order.

integer
locationType

Gets or sets the location type associated with the order.

OrderLocationType
ext1

Gets or sets the extra property 1.

string
ext2

Gets or sets the extra property 2.

string
ext3

Gets or sets the extra property 3.

string
ext4

Gets or sets the extra property 4.

string
ext5

Gets or sets the extra property 5.

string
ext6

Gets or sets the extra property 6.

string
ext7

Gets or sets the extra property 7.

string
ext8

Gets or sets the extra property 8.

string
ext9

Gets or sets the extra property 9.

string
ext10

Gets or sets the extra property 10.

string
num1

Gets or sets the numeric property 1.

integer
num2

Gets or sets the numeric property 2.

integer
num3

Gets or sets the numeric property 3.

integer
num4

Gets or sets the numeric property 4.

integer
num5

Gets or sets the numeric property 5.

integer
date1

Gets or sets the date property 1.

date
date2

Gets or sets the date property 2.

date
date3

Gets or sets the date property 3.

date

Request Formats

application/json, text/json

Sample: 
[
  {
    "orderId": "sample string 6",
    "orderName": "sample string 7",
    "externalId": "sample string 8",
    "externalName": "sample string 9",
    "firstName": "sample string 10",
    "lastName": "sample string 11",
    "email": "sample string 12",
    "mobile": "sample string 13",
    "netAmount": 14.1,
    "tax": 15.1,
    "coupon": "sample string 16",
    "quantity": 17.1,
    "totalAmount": 18.1,
    "address": "sample string 19",
    "city": "sample string 20",
    "products": [
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "quantity": 3.1,
        "totalamount": 4.1,
        "description": "sample string 5",
        "sku": "sample string 6",
        "type": "sample string 7",
        "category": "sample string 8",
        "brand": "sample string 9",
        "color": "sample string 10",
        "size": "sample string 11",
        "weight": 12.1,
        "unitprice": 13.1,
        "shippingprice": 14.1,
        "discount": 15.1,
        "tax": 16.1,
        "eventdate": "2016-12-24T14:12:12",
        "scheduleddate": "2016-12-24T14:12:12",
        "pickupdate": "2016-12-24T14:12:12",
        "coupon": "sample string 20",
        "totalprice": 21.1,
        "image": "sample string 22"
      },
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "quantity": 3.1,
        "totalamount": 4.1,
        "description": "sample string 5",
        "sku": "sample string 6",
        "type": "sample string 7",
        "category": "sample string 8",
        "brand": "sample string 9",
        "color": "sample string 10",
        "size": "sample string 11",
        "weight": 12.1,
        "unitprice": 13.1,
        "shippingprice": 14.1,
        "discount": 15.1,
        "tax": 16.1,
        "eventdate": "2016-12-24T14:12:12",
        "scheduleddate": "2016-12-24T14:12:12",
        "pickupdate": "2016-12-24T14:12:12",
        "coupon": "sample string 20",
        "totalprice": 21.1,
        "image": "sample string 22"
      }
    ],
    "url": "sample string 21",
    "purchaseDate": "2016-12-24T14:12:12",
    "lastUpdate": "2016-12-24T14:12:12",
    "purchaseType": "sample string 22",
    "storeId": 23,
    "locationType": "Unknown",
    "ext1": "sample string 24",
    "ext2": "sample string 25",
    "ext3": "sample string 26",
    "ext4": "sample string 27",
    "ext5": "sample string 28",
    "ext6": "sample string 29",
    "ext7": "sample string 30",
    "ext8": "sample string 31",
    "ext9": "sample string 32",
    "ext10": "sample string 33",
    "num1": 1,
    "num2": 1,
    "num3": 1,
    "num4": 1,
    "num5": 1,
    "date1": "2016-12-24T14:12:12",
    "date2": "2016-12-24T14:12:12",
    "date3": "2016-12-24T14:12:12"
  },
  {
    "orderId": "sample string 6",
    "orderName": "sample string 7",
    "externalId": "sample string 8",
    "externalName": "sample string 9",
    "firstName": "sample string 10",
    "lastName": "sample string 11",
    "email": "sample string 12",
    "mobile": "sample string 13",
    "netAmount": 14.1,
    "tax": 15.1,
    "coupon": "sample string 16",
    "quantity": 17.1,
    "totalAmount": 18.1,
    "address": "sample string 19",
    "city": "sample string 20",
    "products": [
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "quantity": 3.1,
        "totalamount": 4.1,
        "description": "sample string 5",
        "sku": "sample string 6",
        "type": "sample string 7",
        "category": "sample string 8",
        "brand": "sample string 9",
        "color": "sample string 10",
        "size": "sample string 11",
        "weight": 12.1,
        "unitprice": 13.1,
        "shippingprice": 14.1,
        "discount": 15.1,
        "tax": 16.1,
        "eventdate": "2016-12-24T14:12:12",
        "scheduleddate": "2016-12-24T14:12:12",
        "pickupdate": "2016-12-24T14:12:12",
        "coupon": "sample string 20",
        "totalprice": 21.1,
        "image": "sample string 22"
      },
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "quantity": 3.1,
        "totalamount": 4.1,
        "description": "sample string 5",
        "sku": "sample string 6",
        "type": "sample string 7",
        "category": "sample string 8",
        "brand": "sample string 9",
        "color": "sample string 10",
        "size": "sample string 11",
        "weight": 12.1,
        "unitprice": 13.1,
        "shippingprice": 14.1,
        "discount": 15.1,
        "tax": 16.1,
        "eventdate": "2016-12-24T14:12:12",
        "scheduleddate": "2016-12-24T14:12:12",
        "pickupdate": "2016-12-24T14:12:12",
        "coupon": "sample string 20",
        "totalprice": 21.1,
        "image": "sample string 22"
      }
    ],
    "url": "sample string 21",
    "purchaseDate": "2016-12-24T14:12:12",
    "lastUpdate": "2016-12-24T14:12:12",
    "purchaseType": "sample string 22",
    "storeId": 23,
    "locationType": "Unknown",
    "ext1": "sample string 24",
    "ext2": "sample string 25",
    "ext3": "sample string 26",
    "ext4": "sample string 27",
    "ext5": "sample string 28",
    "ext6": "sample string 29",
    "ext7": "sample string 30",
    "ext8": "sample string 31",
    "ext9": "sample string 32",
    "ext10": "sample string 33",
    "num1": 1,
    "num2": 1,
    "num3": 1,
    "num4": 1,
    "num5": 1,
    "date1": "2016-12-24T14:12:12",
    "date2": "2016-12-24T14:12:12",
    "date3": "2016-12-24T14:12:12"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfApiPostOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <ApiPostOrder>
    <address>sample string 19</address>
    <city>sample string 20</city>
    <coupon>sample string 16</coupon>
    <date1>2016-12-24T14:12:12</date1>
    <date2>2016-12-24T14:12:12</date2>
    <date3>2016-12-24T14:12:12</date3>
    <email>sample string 12</email>
    <ext1>sample string 24</ext1>
    <ext10>sample string 33</ext10>
    <ext2>sample string 25</ext2>
    <ext3>sample string 26</ext3>
    <ext4>sample string 27</ext4>
    <ext5>sample string 28</ext5>
    <ext6>sample string 29</ext6>
    <ext7>sample string 30</ext7>
    <ext8>sample string 31</ext8>
    <ext9>sample string 32</ext9>
    <externalId>sample string 8</externalId>
    <externalName>sample string 9</externalName>
    <firstName>sample string 10</firstName>
    <lastName>sample string 11</lastName>
    <lastUpdate>2016-12-24T14:12:12</lastUpdate>
    <locationType>Unknown</locationType>
    <mobile>sample string 13</mobile>
    <netAmount>14.1</netAmount>
    <num1>1</num1>
    <num2>1</num2>
    <num3>1</num3>
    <num4>1</num4>
    <num5>1</num5>
    <orderId>sample string 6</orderId>
    <orderName>sample string 7</orderName>
    <products>
      <Product>
        <brand>sample string 9</brand>
        <category>sample string 8</category>
        <color>sample string 10</color>
        <coupon>sample string 20</coupon>
        <description>sample string 5</description>
        <discount>15.1</discount>
        <eventdate>2016-12-24T14:12:12</eventdate>
        <id>sample string 1</id>
        <image>sample string 22</image>
        <name>sample string 2</name>
        <pickupdate>2016-12-24T14:12:12</pickupdate>
        <quantity>3.1</quantity>
        <scheduleddate>2016-12-24T14:12:12</scheduleddate>
        <shippingprice>14.1</shippingprice>
        <size>sample string 11</size>
        <sku>sample string 6</sku>
        <tax>16.1</tax>
        <totalamount>4.1</totalamount>
        <totalprice>21.1</totalprice>
        <type>sample string 7</type>
        <unitprice>13.1</unitprice>
        <weight>12.1</weight>
      </Product>
      <Product>
        <brand>sample string 9</brand>
        <category>sample string 8</category>
        <color>sample string 10</color>
        <coupon>sample string 20</coupon>
        <description>sample string 5</description>
        <discount>15.1</discount>
        <eventdate>2016-12-24T14:12:12</eventdate>
        <id>sample string 1</id>
        <image>sample string 22</image>
        <name>sample string 2</name>
        <pickupdate>2016-12-24T14:12:12</pickupdate>
        <quantity>3.1</quantity>
        <scheduleddate>2016-12-24T14:12:12</scheduleddate>
        <shippingprice>14.1</shippingprice>
        <size>sample string 11</size>
        <sku>sample string 6</sku>
        <tax>16.1</tax>
        <totalamount>4.1</totalamount>
        <totalprice>21.1</totalprice>
        <type>sample string 7</type>
        <unitprice>13.1</unitprice>
        <weight>12.1</weight>
      </Product>
    </products>
    <purchaseDate>2016-12-24T14:12:12</purchaseDate>
    <purchaseType>sample string 22</purchaseType>
    <quantity>17.1</quantity>
    <storeId>23</storeId>
    <tax>15.1</tax>
    <totalAmount>18.1</totalAmount>
    <url>sample string 21</url>
  </ApiPostOrder>
  <ApiPostOrder>
    <address>sample string 19</address>
    <city>sample string 20</city>
    <coupon>sample string 16</coupon>
    <date1>2016-12-24T14:12:12</date1>
    <date2>2016-12-24T14:12:12</date2>
    <date3>2016-12-24T14:12:12</date3>
    <email>sample string 12</email>
    <ext1>sample string 24</ext1>
    <ext10>sample string 33</ext10>
    <ext2>sample string 25</ext2>
    <ext3>sample string 26</ext3>
    <ext4>sample string 27</ext4>
    <ext5>sample string 28</ext5>
    <ext6>sample string 29</ext6>
    <ext7>sample string 30</ext7>
    <ext8>sample string 31</ext8>
    <ext9>sample string 32</ext9>
    <externalId>sample string 8</externalId>
    <externalName>sample string 9</externalName>
    <firstName>sample string 10</firstName>
    <lastName>sample string 11</lastName>
    <lastUpdate>2016-12-24T14:12:12</lastUpdate>
    <locationType>Unknown</locationType>
    <mobile>sample string 13</mobile>
    <netAmount>14.1</netAmount>
    <num1>1</num1>
    <num2>1</num2>
    <num3>1</num3>
    <num4>1</num4>
    <num5>1</num5>
    <orderId>sample string 6</orderId>
    <orderName>sample string 7</orderName>
    <products>
      <Product>
        <brand>sample string 9</brand>
        <category>sample string 8</category>
        <color>sample string 10</color>
        <coupon>sample string 20</coupon>
        <description>sample string 5</description>
        <discount>15.1</discount>
        <eventdate>2016-12-24T14:12:12</eventdate>
        <id>sample string 1</id>
        <image>sample string 22</image>
        <name>sample string 2</name>
        <pickupdate>2016-12-24T14:12:12</pickupdate>
        <quantity>3.1</quantity>
        <scheduleddate>2016-12-24T14:12:12</scheduleddate>
        <shippingprice>14.1</shippingprice>
        <size>sample string 11</size>
        <sku>sample string 6</sku>
        <tax>16.1</tax>
        <totalamount>4.1</totalamount>
        <totalprice>21.1</totalprice>
        <type>sample string 7</type>
        <unitprice>13.1</unitprice>
        <weight>12.1</weight>
      </Product>
      <Product>
        <brand>sample string 9</brand>
        <category>sample string 8</category>
        <color>sample string 10</color>
        <coupon>sample string 20</coupon>
        <description>sample string 5</description>
        <discount>15.1</discount>
        <eventdate>2016-12-24T14:12:12</eventdate>
        <id>sample string 1</id>
        <image>sample string 22</image>
        <name>sample string 2</name>
        <pickupdate>2016-12-24T14:12:12</pickupdate>
        <quantity>3.1</quantity>
        <scheduleddate>2016-12-24T14:12:12</scheduleddate>
        <shippingprice>14.1</shippingprice>
        <size>sample string 11</size>
        <sku>sample string 6</sku>
        <tax>16.1</tax>
        <totalamount>4.1</totalamount>
        <totalprice>21.1</totalprice>
        <type>sample string 7</type>
        <unitprice>13.1</unitprice>
        <weight>12.1</weight>
      </Product>
    </products>
    <purchaseDate>2016-12-24T14:12:12</purchaseDate>
    <purchaseType>sample string 22</purchaseType>
    <quantity>17.1</quantity>
    <storeId>23</storeId>
    <tax>15.1</tax>
    <totalAmount>18.1</totalAmount>
    <url>sample string 21</url>
  </ApiPostOrder>
</ArrayOfApiPostOrder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Order id

OrdersUpsertResponse

Name

Description

Type

Additional information

success

integer
errors

Dictionary of string [key] and string [value]

Response Formats

application/json, text/json

Sample: 
{
  "success": 1,
  "errors": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample: 
<OrdersUpsertResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.Commerce">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Errors>
  <Success>1</Success>
</OrdersUpsertResponse>