For more information on using API

POST http://webapi.mymarketing.co.il/api/commerce/Cart

Add new cart

Request Information

URI Parameters

Body Parameters

ApiCart

Name

Description

Type

Additional information

id

Gets or sets the unique identifier of the cart.

string
name

Gets or sets the name associated with the cart.

string
firstname

Gets or sets the first name of the person associated with the cart.

string
lastname

Gets or sets the last name of the person associated with the cart.

string
email

Gets or sets the email address of the person associated with the cart.

string
mobile

Gets or sets the mobile phone number of the person associated with the cart.

string
netamount

Gets or sets the net amount for the cart (before tax).

decimal number
tax

Gets or sets the tax amount applied to the cart.

decimal number
coupon

Gets or sets the coupon code applied to the cart, if any.

string
quantity

Gets or sets the quantity of items in the cart.

decimal number
totalamount

Gets or sets the total amount for the cart (including tax).

decimal number
address

Gets or sets the address associated with the cart.

string
city

Gets or sets the city associated with the cart.

string
products

Gets or sets the list of products in the cart.

Collection of ApiOrderProduct
url

Gets or sets the URL associated with the cart, if any.

string
purchasedate

Gets or sets the date when the cart was purchased.

date
lastupdate

Gets or sets the date when the cart was last updated, if available.

date
purchaseType

Gets or sets the purchase type (e.g., online, in-store).

string
storeid

Gets or sets the store ID where the cart was created or purchased.

integer
locationtype

Gets or sets the location type for the cart (e.g., delivery, pick-up).

OrderLocationType
ext1

Gets or sets an additional external parameter (custom extension 1).

string
ext2

Gets or sets an additional external parameter (custom extension 2).

string
ext3

Gets or sets an additional external parameter (custom extension 3).

string
ext4

Gets or sets an additional external parameter (custom extension 4).

string
ext5

Gets or sets an additional external parameter (custom extension 5).

string
ext6

Gets or sets an additional external parameter (custom extension 6).

string
ext7

Gets or sets an additional external parameter (custom extension 7).

string
ext8

Gets or sets an additional external parameter (custom extension 8).

string
ext9

Gets or sets an additional external parameter (custom extension 9).

string
ext10

Gets or sets an additional external parameter (custom extension 10).

string
num1

Gets or sets a numeric custom parameter (custom number 1).

integer
num2

Gets or sets a numeric custom parameter (custom number 2).

integer
num3

Gets or sets a numeric custom parameter (custom number 3).

integer
num4

Gets or sets a numeric custom parameter (custom number 4).

integer
num5

Gets or sets a numeric custom parameter (custom number 5).

integer
Date1

Gets or sets a custom date parameter (custom date 1).

date
Date2

Gets or sets a custom date parameter (custom date 2).

date
Date3

Gets or sets a custom date parameter (custom date 3).

date

Request Formats

application/json, text/json

Sample: 
{
  "id": "sample string 1",
  "name": "sample string 2",
  "firstname": "sample string 3",
  "lastname": "sample string 4",
  "email": "sample string 5",
  "mobile": "sample string 6",
  "netamount": 7.1,
  "tax": 8.1,
  "coupon": "sample string 9",
  "quantity": 10.1,
  "totalamount": 11.1,
  "address": "sample string 12",
  "city": "sample string 13",
  "products": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "totalamount": 3.1,
      "description": "sample string 4",
      "sku": "sample string 5",
      "type": "sample string 6",
      "category": "sample string 7",
      "brand": "sample string 8",
      "color": "sample string 9",
      "size": "sample string 10",
      "weight": 11.1,
      "quantity": 12.1,
      "unitprice": 13.1,
      "shippingprice": 14.1,
      "discount": 15.1,
      "tax": 16.1,
      "coupon": "sample string 17",
      "totalprice": 18.1,
      "image": "sample string 19",
      "eventdate": "2016-12-24T14:12:12",
      "scheduleddate": "2016-12-24T14:12:12",
      "pickupdate": "2016-12-24T14:12:12"
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "totalamount": 3.1,
      "description": "sample string 4",
      "sku": "sample string 5",
      "type": "sample string 6",
      "category": "sample string 7",
      "brand": "sample string 8",
      "color": "sample string 9",
      "size": "sample string 10",
      "weight": 11.1,
      "quantity": 12.1,
      "unitprice": 13.1,
      "shippingprice": 14.1,
      "discount": 15.1,
      "tax": 16.1,
      "coupon": "sample string 17",
      "totalprice": 18.1,
      "image": "sample string 19",
      "eventdate": "2016-12-24T14:12:12",
      "scheduleddate": "2016-12-24T14:12:12",
      "pickupdate": "2016-12-24T14:12:12"
    }
  ],
  "url": "sample string 14",
  "purchasedate": "2016-12-24T14:12:12",
  "lastupdate": "2016-12-24T14:12:12",
  "purchaseType": "sample string 16",
  "storeid": 17,
  "locationtype": "Unknown",
  "ext1": "sample string 18",
  "ext2": "sample string 19",
  "ext3": "sample string 20",
  "ext4": "sample string 21",
  "ext5": "sample string 22",
  "ext6": "sample string 23",
  "ext7": "sample string 24",
  "ext8": "sample string 25",
  "ext9": "sample string 26",
  "ext10": "sample string 27",
  "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: 
<ApiCart xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>sample string 1</Id>
  <Name>sample string 2</Name>
  <FirstName>sample string 3</FirstName>
  <LastName>sample string 4</LastName>
  <Email>sample string 5</Email>
  <Mobile>sample string 6</Mobile>
  <NetAmount>7.1</NetAmount>
  <Tax>8.1</Tax>
  <Coupon>sample string 9</Coupon>
  <Quantity>10.1</Quantity>
  <TotalAmount>11.1</TotalAmount>
  <Address>sample string 12</Address>
  <City>sample string 13</City>
  <Products>
    <ApiOrderProduct>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <TotalAmount>3.1</TotalAmount>
      <Description>sample string 4</Description>
      <Sku>sample string 5</Sku>
      <Type>sample string 6</Type>
      <Category>sample string 7</Category>
      <Brand>sample string 8</Brand>
      <Color>sample string 9</Color>
      <Size>sample string 10</Size>
      <Weight>11.1</Weight>
      <Quantity>12.1</Quantity>
      <UnitPrice>13.1</UnitPrice>
      <ShippingPrice>14.1</ShippingPrice>
      <Discount>15.1</Discount>
      <Tax>16.1</Tax>
      <Coupon>sample string 17</Coupon>
      <TotalPrice>18.1</TotalPrice>
      <Image>sample string 19</Image>
      <EventDate>2016-12-24T14:12:12</EventDate>
      <ScheduledDate>2016-12-24T14:12:12</ScheduledDate>
      <PickupDate>2016-12-24T14:12:12</PickupDate>
    </ApiOrderProduct>
    <ApiOrderProduct>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <TotalAmount>3.1</TotalAmount>
      <Description>sample string 4</Description>
      <Sku>sample string 5</Sku>
      <Type>sample string 6</Type>
      <Category>sample string 7</Category>
      <Brand>sample string 8</Brand>
      <Color>sample string 9</Color>
      <Size>sample string 10</Size>
      <Weight>11.1</Weight>
      <Quantity>12.1</Quantity>
      <UnitPrice>13.1</UnitPrice>
      <ShippingPrice>14.1</ShippingPrice>
      <Discount>15.1</Discount>
      <Tax>16.1</Tax>
      <Coupon>sample string 17</Coupon>
      <TotalPrice>18.1</TotalPrice>
      <Image>sample string 19</Image>
      <EventDate>2016-12-24T14:12:12</EventDate>
      <ScheduledDate>2016-12-24T14:12:12</ScheduledDate>
      <PickupDate>2016-12-24T14:12:12</PickupDate>
    </ApiOrderProduct>
  </Products>
  <Url>sample string 14</Url>
  <PurchaseDate>2016-12-24T14:12:12</PurchaseDate>
  <LastUpdate>2016-12-24T14:12:12</LastUpdate>
  <PurchaseType>sample string 16</PurchaseType>
  <StoreId>17</StoreId>
  <LocationType>Unknown</LocationType>
  <Ext1>sample string 18</Ext1>
  <Ext2>sample string 19</Ext2>
  <Ext3>sample string 20</Ext3>
  <Ext4>sample string 21</Ext4>
  <Ext5>sample string 22</Ext5>
  <Ext6>sample string 23</Ext6>
  <Ext7>sample string 24</Ext7>
  <Ext8>sample string 25</Ext8>
  <Ext9>sample string 26</Ext9>
  <Ext10>sample string 27</Ext10>
  <Num1>1</Num1>
  <Num2>1</Num2>
  <Num3>1</Num3>
  <Num4>1</Num4>
  <Num5>1</Num5>
  <Date1>2016-12-24T14:12:12</Date1>
  <Date2>2016-12-24T14:12:12</Date2>
  <Date3>2016-12-24T14:12:12</Date3>
</ApiCart>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Cart 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>