POST api/Order

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerId	integer	None.
CompanyId	string	None.
ShipToId	integer	None.
PoNo	string	None.
ShipToName	string	None.
ShipToAddress1	string	None.
ShipToAddress2	string	None.
ShipToAddress3	string	None.
ShipToCity	string	None.
ShipToState	string	None.
ZipCode	string	None.
ShipToPhone	string	None.
BillToName	string	None.
BillToAddress1	string	None.
BillToAddress2	string	None.
BillToAddress3	string	None.
BillToCity	string	None.
BillToState	string	None.
BillToZipCode	string	None.
BillToPhone	string	None.
CarrierId	string	None.
CarrierMethodId	string	None.
DeliveryInstruction	string	None.
LastFour	string	None.
PaymentAccountID	string	None.
ValidationCode	string	None.
ContractId	string	None.
Contact	string	None.
WebOrderId	string	None.
OrderStatus	string	None.
ErrorMessage	string	None.
p1	string	None.
p2	string	None.
p3	string	None.
OrderLines	Collection of P21OrderLine	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "CompanyId": "sample string 2",
  "ShipToId": 3,
  "PoNo": "sample string 4",
  "ShipToName": "sample string 5",
  "ShipToAddress1": "sample string 6",
  "ShipToAddress2": "sample string 7",
  "ShipToAddress3": "sample string 8",
  "ShipToCity": "sample string 9",
  "ShipToState": "sample string 10",
  "ZipCode": "sample string 11",
  "ShipToPhone": "sample string 12",
  "BillToName": "sample string 13",
  "BillToAddress1": "sample string 14",
  "BillToAddress2": "sample string 15",
  "BillToAddress3": "sample string 16",
  "BillToCity": "sample string 17",
  "BillToState": "sample string 18",
  "BillToZipCode": "sample string 19",
  "BillToPhone": "sample string 20",
  "CarrierId": "sample string 21",
  "CarrierMethodId": "sample string 22",
  "DeliveryInstruction": "sample string 23",
  "LastFour": "sample string 24",
  "PaymentAccountID": "sample string 25",
  "ValidationCode": "sample string 26",
  "ContractId": "sample string 27",
  "Contact": "sample string 28",
  "WebOrderId": "sample string 29",
  "OrderStatus": "sample string 30",
  "ErrorMessage": "sample string 31",
  "p1": "sample string 32",
  "p2": "sample string 33",
  "p3": "sample string 34",
  "OrderLines": [
    {
      "LineNo": 1,
      "ItemId": "sample string 2",
      "UnitOfMeasure": "sample string 3",
      "UnitPrice": 4.1,
      "UnitQuantity": 5.1
    },
    {
      "LineNo": 1,
      "ItemId": "sample string 2",
      "UnitOfMeasure": "sample string 3",
      "UnitPrice": 4.1,
      "UnitQuantity": 5.1
    }
  ]
}

application/xml, text/xml

Sample:

<P21Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ADIGlobal.MagentoAPI.Models">
  <BillToAddress1>sample string 14</BillToAddress1>
  <BillToAddress2>sample string 15</BillToAddress2>
  <BillToAddress3>sample string 16</BillToAddress3>
  <BillToCity>sample string 17</BillToCity>
  <BillToName>sample string 13</BillToName>
  <BillToPhone>sample string 20</BillToPhone>
  <BillToState>sample string 18</BillToState>
  <BillToZipCode>sample string 19</BillToZipCode>
  <CarrierId>sample string 21</CarrierId>
  <CarrierMethodId>sample string 22</CarrierMethodId>
  <CompanyId>sample string 2</CompanyId>
  <Contact>sample string 28</Contact>
  <ContractId>sample string 27</ContractId>
  <CustomerId>1</CustomerId>
  <DeliveryInstruction>sample string 23</DeliveryInstruction>
  <ErrorMessage>sample string 31</ErrorMessage>
  <LastFour>sample string 24</LastFour>
  <OrderLines>
    <P21OrderLine>
      <ItemId>sample string 2</ItemId>
      <LineNo>1</LineNo>
      <UnitOfMeasure>sample string 3</UnitOfMeasure>
      <UnitPrice>4.1</UnitPrice>
      <UnitQuantity>5.1</UnitQuantity>
    </P21OrderLine>
    <P21OrderLine>
      <ItemId>sample string 2</ItemId>
      <LineNo>1</LineNo>
      <UnitOfMeasure>sample string 3</UnitOfMeasure>
      <UnitPrice>4.1</UnitPrice>
      <UnitQuantity>5.1</UnitQuantity>
    </P21OrderLine>
  </OrderLines>
  <OrderStatus>sample string 30</OrderStatus>
  <PaymentAccountID>sample string 25</PaymentAccountID>
  <PoNo>sample string 4</PoNo>
  <ShipToAddress1>sample string 6</ShipToAddress1>
  <ShipToAddress2>sample string 7</ShipToAddress2>
  <ShipToAddress3>sample string 8</ShipToAddress3>
  <ShipToCity>sample string 9</ShipToCity>
  <ShipToId>3</ShipToId>
  <ShipToName>sample string 5</ShipToName>
  <ShipToPhone>sample string 12</ShipToPhone>
  <ShipToState>sample string 10</ShipToState>
  <ValidationCode>sample string 26</ValidationCode>
  <WebOrderId>sample string 29</WebOrderId>
  <ZipCode>sample string 11</ZipCode>
  <p1>sample string 32</p1>
  <p2>sample string 33</p2>
  <p3>sample string 34</p3>
</P21Order>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

P21Order

Name	Type	Additional information
CustomerId	integer	None.
CompanyId	string	None.
ShipToId	integer	None.
PoNo	string	None.
ShipToName	string	None.
ShipToAddress1	string	None.
ShipToAddress2	string	None.
ShipToAddress3	string	None.
ShipToCity	string	None.
ShipToState	string	None.
ZipCode	string	None.
ShipToPhone	string	None.
BillToName	string	None.
BillToAddress1	string	None.
BillToAddress2	string	None.
BillToAddress3	string	None.
BillToCity	string	None.
BillToState	string	None.
BillToZipCode	string	None.
BillToPhone	string	None.
CarrierId	string	None.
CarrierMethodId	string	None.
DeliveryInstruction	string	None.
LastFour	string	None.
PaymentAccountID	string	None.
ValidationCode	string	None.
ContractId	string	None.
Contact	string	None.
WebOrderId	string	None.
OrderStatus	string	None.
ErrorMessage	string	None.
p1	string	None.
p2	string	None.
p3	string	None.
OrderLines	Collection of P21OrderLine	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "CompanyId": "sample string 2",
  "ShipToId": 3,
  "PoNo": "sample string 4",
  "ShipToName": "sample string 5",
  "ShipToAddress1": "sample string 6",
  "ShipToAddress2": "sample string 7",
  "ShipToAddress3": "sample string 8",
  "ShipToCity": "sample string 9",
  "ShipToState": "sample string 10",
  "ZipCode": "sample string 11",
  "ShipToPhone": "sample string 12",
  "BillToName": "sample string 13",
  "BillToAddress1": "sample string 14",
  "BillToAddress2": "sample string 15",
  "BillToAddress3": "sample string 16",
  "BillToCity": "sample string 17",
  "BillToState": "sample string 18",
  "BillToZipCode": "sample string 19",
  "BillToPhone": "sample string 20",
  "CarrierId": "sample string 21",
  "CarrierMethodId": "sample string 22",
  "DeliveryInstruction": "sample string 23",
  "LastFour": "sample string 24",
  "PaymentAccountID": "sample string 25",
  "ValidationCode": "sample string 26",
  "ContractId": "sample string 27",
  "Contact": "sample string 28",
  "WebOrderId": "sample string 29",
  "OrderStatus": "sample string 30",
  "ErrorMessage": "sample string 31",
  "p1": "sample string 32",
  "p2": "sample string 33",
  "p3": "sample string 34",
  "OrderLines": [
    {
      "LineNo": 1,
      "ItemId": "sample string 2",
      "UnitOfMeasure": "sample string 3",
      "UnitPrice": 4.1,
      "UnitQuantity": 5.1
    },
    {
      "LineNo": 1,
      "ItemId": "sample string 2",
      "UnitOfMeasure": "sample string 3",
      "UnitPrice": 4.1,
      "UnitQuantity": 5.1
    }
  ]
}

application/xml, text/xml

Sample:

<P21Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ADIGlobal.MagentoAPI.Models">
  <BillToAddress1>sample string 14</BillToAddress1>
  <BillToAddress2>sample string 15</BillToAddress2>
  <BillToAddress3>sample string 16</BillToAddress3>
  <BillToCity>sample string 17</BillToCity>
  <BillToName>sample string 13</BillToName>
  <BillToPhone>sample string 20</BillToPhone>
  <BillToState>sample string 18</BillToState>
  <BillToZipCode>sample string 19</BillToZipCode>
  <CarrierId>sample string 21</CarrierId>
  <CarrierMethodId>sample string 22</CarrierMethodId>
  <CompanyId>sample string 2</CompanyId>
  <Contact>sample string 28</Contact>
  <ContractId>sample string 27</ContractId>
  <CustomerId>1</CustomerId>
  <DeliveryInstruction>sample string 23</DeliveryInstruction>
  <ErrorMessage>sample string 31</ErrorMessage>
  <LastFour>sample string 24</LastFour>
  <OrderLines>
    <P21OrderLine>
      <ItemId>sample string 2</ItemId>
      <LineNo>1</LineNo>
      <UnitOfMeasure>sample string 3</UnitOfMeasure>
      <UnitPrice>4.1</UnitPrice>
      <UnitQuantity>5.1</UnitQuantity>
    </P21OrderLine>
    <P21OrderLine>
      <ItemId>sample string 2</ItemId>
      <LineNo>1</LineNo>
      <UnitOfMeasure>sample string 3</UnitOfMeasure>
      <UnitPrice>4.1</UnitPrice>
      <UnitQuantity>5.1</UnitQuantity>
    </P21OrderLine>
  </OrderLines>
  <OrderStatus>sample string 30</OrderStatus>
  <PaymentAccountID>sample string 25</PaymentAccountID>
  <PoNo>sample string 4</PoNo>
  <ShipToAddress1>sample string 6</ShipToAddress1>
  <ShipToAddress2>sample string 7</ShipToAddress2>
  <ShipToAddress3>sample string 8</ShipToAddress3>
  <ShipToCity>sample string 9</ShipToCity>
  <ShipToId>3</ShipToId>
  <ShipToName>sample string 5</ShipToName>
  <ShipToPhone>sample string 12</ShipToPhone>
  <ShipToState>sample string 10</ShipToState>
  <ValidationCode>sample string 26</ValidationCode>
  <WebOrderId>sample string 29</WebOrderId>
  <ZipCode>sample string 11</ZipCode>
  <p1>sample string 32</p1>
  <p2>sample string 33</p2>
  <p3>sample string 34</p3>
</P21Order>