POST api/v2/Orders/SubmitOrder

Create or Update an Order Entry Order.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
OrderId		string	None.
EntryDate		string	None.
Entrytime		string	None.
EntryPort	Read Only	string	None.
OrderType	Read Only	string	None.
OrderStatus	Read Only	string	None.
Clerk	Read Only	string	None.
ClosingClerk	Read Only	string	None.
LocationCode		string	Required
OrderDate		string	None.
PromiseDate		string	None.
CompleteDate		string	None.
BillToCustomerId		string	Required
BillToName		string	None.
BillToAddress1		string	None.
BillToAddress2		string	None.
BillToAddress3		string	None.
BillToCity		string	None.
BillToState		string	None.
BillToZip		string	None.
BillToPhone		string	None.
BillToEmail		string	None.
ShipToCustomerId		string	Required
ShipToName		string	None.
ShipToAddress1		string	None.
ShipToAddress2		string	None.
ShipToAddress3		string	None.
ShipToCity		string	None.
ShipToState		string	None.
ShipToZip		string	None.
ShipToPhone		string	None.
ShipToEmail		string	None.
Comments		string	None.
TaxSchema		string	None.
ResaleNumber		string	None.
PurchaseOrder		string	None.
OrderedAmount	Read Only	decimal number	None.
OrderedCost	Read Only	decimal number	None.
OrderedDiscount	Read Only	decimal number	None.
ShippedAmount	Read Only	decimal number	None.
ShippedCost	Read Only	decimal number	None.
ShippedDiscount	Read Only	decimal number	None.
BackOrderedAmount	Read Only	decimal number	None.
BackOrderedCost	Read Only	decimal number	None.
BackOrderedDiscount	Read Only	decimal number	None.
OriginalOrder	Read Only	string	None.
ShippingMethod		string	None.
BillToCompany		string	None.
BillToCell		string	None.
BillToWork		string	None.
BillToFax		string	None.
ShipToCompany		string	None.
ShipToCell		string	None.
ShipToWork		string	None.
ShipToFax		string	None.
BackOrder	Read Only	string	None.
TicketDiscount	Read Only	decimal number	None.
TicketDiscountPercent	Read Only	decimal number	None.
POSId	Read Only	string	None.
ATId	Read Only	string	None.
Parts		Collection of OrderPart	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderId": "sample string 1",
  "EntryDate": "sample string 2",
  "Entrytime": "sample string 3",
  "EntryPort": "sample string 4",
  "OrderType": "sample string 5",
  "OrderStatus": "sample string 6",
  "Clerk": "sample string 7",
  "ClosingClerk": "sample string 8",
  "LocationCode": "sample string 9",
  "OrderDate": "sample string 10",
  "PromiseDate": "sample string 11",
  "CompleteDate": "sample string 12",
  "BillToCustomerId": "sample string 13",
  "BillToName": "sample string 14",
  "BillToAddress1": "sample string 15",
  "BillToAddress2": "sample string 16",
  "BillToAddress3": "sample string 17",
  "BillToCity": "sample string 18",
  "BillToState": "sample string 19",
  "BillToZip": "sample string 20",
  "BillToPhone": "sample string 21",
  "BillToEmail": "sample string 22",
  "ShipToCustomerId": "sample string 23",
  "ShipToName": "sample string 24",
  "ShipToAddress1": "sample string 25",
  "ShipToAddress2": "sample string 26",
  "ShipToAddress3": "sample string 27",
  "ShipToCity": "sample string 28",
  "ShipToState": "sample string 29",
  "ShipToZip": "sample string 30",
  "ShipToPhone": "sample string 31",
  "ShipToEmail": "sample string 32",
  "Comments": "sample string 33",
  "TaxSchema": "sample string 34",
  "ResaleNumber": "sample string 35",
  "PurchaseOrder": "sample string 36",
  "OrderedAmount": 37.0,
  "OrderedCost": 38.0,
  "OrderedDiscount": 39.0,
  "ShippedAmount": 40.0,
  "ShippedCost": 41.0,
  "ShippedDiscount": 42.0,
  "BackOrderedAmount": 43.0,
  "BackOrderedCost": 44.0,
  "BackOrderedDiscount": 45.0,
  "OriginalOrder": "sample string 46",
  "ShippingMethod": "sample string 47",
  "BillToCompany": "sample string 48",
  "BillToCell": "sample string 49",
  "BillToWork": "sample string 50",
  "BillToFax": "sample string 51",
  "ShipToCompany": "sample string 52",
  "ShipToCell": "sample string 53",
  "ShipToWork": "sample string 54",
  "ShipToFax": "sample string 55",
  "BackOrder": "sample string 56",
  "TicketDiscount": 57.0,
  "TicketDiscountPercent": 58.0,
  "POSId": "sample string 59",
  "ATId": "sample string 60",
  "Parts": [
    {
      "ItemNumber": "sample string 1",
      "Description": "sample string 2",
      "QuantityOrdered": 3.0,
      "QuantityShipped": 4.0,
      "QuantityBackOrdered": 5.0,
      "QuantityLost": 6.0,
      "Price": 7.0,
      "Discount": 8.0,
      "DiscountPercent": 9.0,
      "Extension": 10.0,
      "Cost": 1.0,
      "ItemTaxSchema": "sample string 11",
      "ReceivingMethod": "sample string 12",
      "ItemComments": "sample string 13",
      "BackOrderExtension": 14.0,
      "ShippedExtension": 15.0,
      "BeforeDiscountExtension": 16.0,
      "DistributedDiscount": 17.0,
      "Department": "sample string 18",
      "CostExtension": 19.0,
      "ShippedCostExtension": 20.0,
      "ShippedDistributedDiscount": 21.0,
      "BackOrderedCostExtension": 22.0,
      "PurchaseOrderNumbers": "sample string 23"
    },
    {
      "ItemNumber": "sample string 1",
      "Description": "sample string 2",
      "QuantityOrdered": 3.0,
      "QuantityShipped": 4.0,
      "QuantityBackOrdered": 5.0,
      "QuantityLost": 6.0,
      "Price": 7.0,
      "Discount": 8.0,
      "DiscountPercent": 9.0,
      "Extension": 10.0,
      "Cost": 1.0,
      "ItemTaxSchema": "sample string 11",
      "ReceivingMethod": "sample string 12",
      "ItemComments": "sample string 13",
      "BackOrderExtension": 14.0,
      "ShippedExtension": 15.0,
      "BeforeDiscountExtension": 16.0,
      "DistributedDiscount": 17.0,
      "Department": "sample string 18",
      "CostExtension": 19.0,
      "ShippedCostExtension": 20.0,
      "ShippedDistributedDiscount": 21.0,
      "BackOrderedCostExtension": 22.0,
      "PurchaseOrderNumbers": "sample string 23"
    }
  ]
}

application/xml, text/xml

Sample:

<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <ATId>sample string 60</ATId>
  <BackOrder>sample string 56</BackOrder>
  <BackOrderedAmount>43</BackOrderedAmount>
  <BackOrderedCost>44</BackOrderedCost>
  <BackOrderedDiscount>45</BackOrderedDiscount>
  <BillToAddress1>sample string 15</BillToAddress1>
  <BillToAddress2>sample string 16</BillToAddress2>
  <BillToAddress3>sample string 17</BillToAddress3>
  <BillToCell>sample string 49</BillToCell>
  <BillToCity>sample string 18</BillToCity>
  <BillToCompany>sample string 48</BillToCompany>
  <BillToCustomerId>sample string 13</BillToCustomerId>
  <BillToEmail>sample string 22</BillToEmail>
  <BillToFax>sample string 51</BillToFax>
  <BillToName>sample string 14</BillToName>
  <BillToPhone>sample string 21</BillToPhone>
  <BillToState>sample string 19</BillToState>
  <BillToWork>sample string 50</BillToWork>
  <BillToZip>sample string 20</BillToZip>
  <Clerk>sample string 7</Clerk>
  <ClosingClerk>sample string 8</ClosingClerk>
  <Comments>sample string 33</Comments>
  <CompleteDate>sample string 12</CompleteDate>
  <EntryDate>sample string 2</EntryDate>
  <EntryPort>sample string 4</EntryPort>
  <Entrytime>sample string 3</Entrytime>
  <LocationCode>sample string 9</LocationCode>
  <OrderDate>sample string 10</OrderDate>
  <OrderId>sample string 1</OrderId>
  <OrderStatus>sample string 6</OrderStatus>
  <OrderType>sample string 5</OrderType>
  <OrderedAmount>37</OrderedAmount>
  <OrderedCost>38</OrderedCost>
  <OrderedDiscount>39</OrderedDiscount>
  <OriginalOrder>sample string 46</OriginalOrder>
  <POSId>sample string 59</POSId>
  <Parts>
    <OrderPart>
      <BackOrderExtension>14</BackOrderExtension>
      <BackOrderedCostExtension>22</BackOrderedCostExtension>
      <BeforeDiscountExtension>16</BeforeDiscountExtension>
      <Cost>1</Cost>
      <CostExtension>19</CostExtension>
      <Department>sample string 18</Department>
      <Description>sample string 2</Description>
      <Discount>8</Discount>
      <DiscountPercent>9</DiscountPercent>
      <DistributedDiscount>17</DistributedDiscount>
      <Extension>10</Extension>
      <ItemComments>sample string 13</ItemComments>
      <ItemNumber>sample string 1</ItemNumber>
      <ItemTaxSchema>sample string 11</ItemTaxSchema>
      <Price>7</Price>
      <PurchaseOrderNumbers>sample string 23</PurchaseOrderNumbers>
      <QuantityBackOrdered>5</QuantityBackOrdered>
      <QuantityLost>6</QuantityLost>
      <QuantityOrdered>3</QuantityOrdered>
      <QuantityShipped>4</QuantityShipped>
      <ReceivingMethod>sample string 12</ReceivingMethod>
      <ShippedCostExtension>20</ShippedCostExtension>
      <ShippedDistributedDiscount>21</ShippedDistributedDiscount>
      <ShippedExtension>15</ShippedExtension>
    </OrderPart>
    <OrderPart>
      <BackOrderExtension>14</BackOrderExtension>
      <BackOrderedCostExtension>22</BackOrderedCostExtension>
      <BeforeDiscountExtension>16</BeforeDiscountExtension>
      <Cost>1</Cost>
      <CostExtension>19</CostExtension>
      <Department>sample string 18</Department>
      <Description>sample string 2</Description>
      <Discount>8</Discount>
      <DiscountPercent>9</DiscountPercent>
      <DistributedDiscount>17</DistributedDiscount>
      <Extension>10</Extension>
      <ItemComments>sample string 13</ItemComments>
      <ItemNumber>sample string 1</ItemNumber>
      <ItemTaxSchema>sample string 11</ItemTaxSchema>
      <Price>7</Price>
      <PurchaseOrderNumbers>sample string 23</PurchaseOrderNumbers>
      <QuantityBackOrdered>5</QuantityBackOrdered>
      <QuantityLost>6</QuantityLost>
      <QuantityOrdered>3</QuantityOrdered>
      <QuantityShipped>4</QuantityShipped>
      <ReceivingMethod>sample string 12</ReceivingMethod>
      <ShippedCostExtension>20</ShippedCostExtension>
      <ShippedDistributedDiscount>21</ShippedDistributedDiscount>
      <ShippedExtension>15</ShippedExtension>
    </OrderPart>
  </Parts>
  <PromiseDate>sample string 11</PromiseDate>
  <PurchaseOrder>sample string 36</PurchaseOrder>
  <ResaleNumber>sample string 35</ResaleNumber>
  <ShipToAddress1>sample string 25</ShipToAddress1>
  <ShipToAddress2>sample string 26</ShipToAddress2>
  <ShipToAddress3>sample string 27</ShipToAddress3>
  <ShipToCell>sample string 53</ShipToCell>
  <ShipToCity>sample string 28</ShipToCity>
  <ShipToCompany>sample string 52</ShipToCompany>
  <ShipToCustomerId>sample string 23</ShipToCustomerId>
  <ShipToEmail>sample string 32</ShipToEmail>
  <ShipToFax>sample string 55</ShipToFax>
  <ShipToName>sample string 24</ShipToName>
  <ShipToPhone>sample string 31</ShipToPhone>
  <ShipToState>sample string 29</ShipToState>
  <ShipToWork>sample string 54</ShipToWork>
  <ShipToZip>sample string 30</ShipToZip>
  <ShippedAmount>40</ShippedAmount>
  <ShippedCost>41</ShippedCost>
  <ShippedDiscount>42</ShippedDiscount>
  <ShippingMethod>sample string 47</ShippingMethod>
  <TaxSchema>sample string 34</TaxSchema>
  <TicketDiscount>57</TicketDiscount>
  <TicketDiscountPercent>58</TicketDiscountPercent>
</Order>

Response Information

Resource Description

SubmitOrderResult

Name	Description	Type	Additional information
OrderId		string	None.
Result		string	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderId": "sample string 1",
  "Result": "sample string 2"
}

application/xml, text/xml

Sample:

<SubmitOrderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <OrderId>sample string 1</OrderId>
  <Result>sample string 2</Result>
</SubmitOrderResult>