POST api/Integration/CreateOrder
Request Information
URI Parameters
None.
Body Parameters
CreateOrderParm| Name | Description | Type | Additional information |
|---|---|---|---|
| ToCompanyGUID | string |
None. |
|
| FromCompanyGUID | string |
None. |
|
| FromShipmentGUID | string |
None. |
|
| FromShipmentNumber | integer |
None. |
|
| BillToType | string |
None. |
|
| ShipperAccountNumber | string |
None. |
|
| BillToAccountNumber | string |
None. |
|
| ShipperName | string |
None. |
|
| ShipperPhone | string |
None. |
|
| ShipperFax | string |
None. |
|
| ShipperEmail | string |
None. |
|
| PickupAddressCode | string |
None. |
|
| PickupCompanyName | string |
None. |
|
| PickupAddress1 | string |
None. |
|
| PickupAddress2 | string |
None. |
|
| PickupAddress3 | string |
None. |
|
| PickupCityName | string |
None. |
|
| PickupStateProvID | string |
None. |
|
| PickupPostalCode | string |
None. |
|
| PickupCountryID | string |
None. |
|
| PickupAirportID | string |
None. |
|
| PickupPersonToSee | string |
None. |
|
| PickupPhoneNumber | string |
None. |
|
| PickupFaxNumber | string |
None. |
|
| PickupInstructions | string |
None. |
|
| DeliveryAddressCode | string |
None. |
|
| DeliveryCompanyName | string |
None. |
|
| DeliveryAddress1 | string |
None. |
|
| DeliveryAddress2 | string |
None. |
|
| DeliveryAddress3 | string |
None. |
|
| DeliveryCityName | string |
None. |
|
| DeliveryStateProvID | string |
None. |
|
| DeliveryPostalCode | string |
None. |
|
| DeliveryCountryID | string |
None. |
|
| DeliveryAirportID | string |
None. |
|
| DeliveryAttention | string |
None. |
|
| DeliveryPhoneNumber | string |
None. |
|
| DeliveryFaxNumber | string |
None. |
|
| DeliveryEmailAddress | string |
None. |
|
| DeliveryInstructions | string |
None. |
|
| Contents | string |
None. |
|
| Reference | string |
None. |
|
| Pieces | integer |
None. |
|
| Weight | decimal number |
None. |
|
| WeightUOM | string |
None. |
|
| Length | integer |
None. |
|
| Width | integer |
None. |
|
| Height | integer |
None. |
|
| SizeUOM | string |
None. |
|
| ReadyDate | string |
None. |
|
| ReadyTime | string |
None. |
|
| RequestedDeliveryDate | string |
None. |
|
| RequestedDeliveryTime | string |
None. |
|
| TransactionType | string |
None. |
|
| DeclaredValue | decimal number |
None. |
|
| DeclaredValueCurrencyID | string |
None. |
|
| OtherReference1 | string |
None. |
|
| OtherReference2 | string |
None. |
|
| OtherReference3 | string |
None. |
|
| OtherReference4 | string |
None. |
|
| TrackingNumber | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"ToCompanyGUID": "sample string 1",
"FromCompanyGUID": "sample string 2",
"FromShipmentGUID": "sample string 3",
"FromShipmentNumber": 4,
"BillToType": "sample string 5",
"ShipperAccountNumber": "sample string 6",
"BillToAccountNumber": "sample string 7",
"ShipperName": "sample string 8",
"ShipperPhone": "sample string 9",
"ShipperFax": "sample string 10",
"ShipperEmail": "sample string 11",
"PickupAddressCode": "sample string 12",
"PickupCompanyName": "sample string 13",
"PickupAddress1": "sample string 14",
"PickupAddress2": "sample string 15",
"PickupAddress3": "sample string 16",
"PickupCityName": "sample string 17",
"PickupStateProvID": "sample string 18",
"PickupPostalCode": "sample string 19",
"PickupCountryID": "sample string 20",
"PickupAirportID": "sample string 21",
"PickupPersonToSee": "sample string 22",
"PickupPhoneNumber": "sample string 23",
"PickupFaxNumber": "sample string 24",
"PickupInstructions": "sample string 25",
"DeliveryAddressCode": "sample string 26",
"DeliveryCompanyName": "sample string 27",
"DeliveryAddress1": "sample string 28",
"DeliveryAddress2": "sample string 29",
"DeliveryAddress3": "sample string 30",
"DeliveryCityName": "sample string 31",
"DeliveryStateProvID": "sample string 32",
"DeliveryPostalCode": "sample string 33",
"DeliveryCountryID": "sample string 34",
"DeliveryAirportID": "sample string 35",
"DeliveryAttention": "sample string 36",
"DeliveryPhoneNumber": "sample string 37",
"DeliveryFaxNumber": "sample string 38",
"DeliveryEmailAddress": "sample string 39",
"DeliveryInstructions": "sample string 40",
"Contents": "sample string 41",
"Reference": "sample string 42",
"Pieces": 43,
"Weight": 44.0,
"WeightUOM": "sample string 45",
"Length": 46,
"Width": 47,
"Height": 48,
"SizeUOM": "sample string 49",
"ReadyDate": "sample string 50",
"ReadyTime": "sample string 51",
"RequestedDeliveryDate": "sample string 52",
"RequestedDeliveryTime": "sample string 53",
"TransactionType": "sample string 54",
"DeclaredValue": 55.0,
"DeclaredValueCurrencyID": "sample string 56",
"OtherReference1": "sample string 57",
"OtherReference2": "sample string 58",
"OtherReference3": "sample string 59",
"OtherReference4": "sample string 60",
"TrackingNumber": "sample string 61"
}
application/xml, text/xml
Sample:
<CreateOrderParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <BillToAccountNumber>sample string 7</BillToAccountNumber> <BillToType>sample string 5</BillToType> <Contents>sample string 41</Contents> <DeclaredValue>55</DeclaredValue> <DeclaredValueCurrencyID>sample string 56</DeclaredValueCurrencyID> <DeliveryAddress1>sample string 28</DeliveryAddress1> <DeliveryAddress2>sample string 29</DeliveryAddress2> <DeliveryAddress3>sample string 30</DeliveryAddress3> <DeliveryAddressCode>sample string 26</DeliveryAddressCode> <DeliveryAirportID>sample string 35</DeliveryAirportID> <DeliveryAttention>sample string 36</DeliveryAttention> <DeliveryCityName>sample string 31</DeliveryCityName> <DeliveryCompanyName>sample string 27</DeliveryCompanyName> <DeliveryCountryID>sample string 34</DeliveryCountryID> <DeliveryEmailAddress>sample string 39</DeliveryEmailAddress> <DeliveryFaxNumber>sample string 38</DeliveryFaxNumber> <DeliveryInstructions>sample string 40</DeliveryInstructions> <DeliveryPhoneNumber>sample string 37</DeliveryPhoneNumber> <DeliveryPostalCode>sample string 33</DeliveryPostalCode> <DeliveryStateProvID>sample string 32</DeliveryStateProvID> <FromCompanyGUID>sample string 2</FromCompanyGUID> <FromShipmentGUID>sample string 3</FromShipmentGUID> <FromShipmentNumber>4</FromShipmentNumber> <Height>48</Height> <Length>46</Length> <OtherReference1>sample string 57</OtherReference1> <OtherReference2>sample string 58</OtherReference2> <OtherReference3>sample string 59</OtherReference3> <OtherReference4>sample string 60</OtherReference4> <PickupAddress1>sample string 14</PickupAddress1> <PickupAddress2>sample string 15</PickupAddress2> <PickupAddress3>sample string 16</PickupAddress3> <PickupAddressCode>sample string 12</PickupAddressCode> <PickupAirportID>sample string 21</PickupAirportID> <PickupCityName>sample string 17</PickupCityName> <PickupCompanyName>sample string 13</PickupCompanyName> <PickupCountryID>sample string 20</PickupCountryID> <PickupFaxNumber>sample string 24</PickupFaxNumber> <PickupInstructions>sample string 25</PickupInstructions> <PickupPersonToSee>sample string 22</PickupPersonToSee> <PickupPhoneNumber>sample string 23</PickupPhoneNumber> <PickupPostalCode>sample string 19</PickupPostalCode> <PickupStateProvID>sample string 18</PickupStateProvID> <Pieces>43</Pieces> <ReadyDate>sample string 50</ReadyDate> <ReadyTime>sample string 51</ReadyTime> <Reference>sample string 42</Reference> <RequestedDeliveryDate>sample string 52</RequestedDeliveryDate> <RequestedDeliveryTime>sample string 53</RequestedDeliveryTime> <ShipperAccountNumber>sample string 6</ShipperAccountNumber> <ShipperEmail>sample string 11</ShipperEmail> <ShipperFax>sample string 10</ShipperFax> <ShipperName>sample string 8</ShipperName> <ShipperPhone>sample string 9</ShipperPhone> <SizeUOM>sample string 49</SizeUOM> <ToCompanyGUID>sample string 1</ToCompanyGUID> <TrackingNumber>sample string 61</TrackingNumber> <TransactionType>sample string 54</TransactionType> <Weight>44</Weight> <WeightUOM>sample string 45</WeightUOM> <Width>47</Width> </CreateOrderParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CreateOrderResp| Name | Description | Type | Additional information |
|---|---|---|---|
| ShipmentNumber | integer |
None. |
|
| ShipmentGUID | string |
None. |
|
| SuccessOrFailure | string |
None. |
|
| ErrorMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ShipmentNumber": 1,
"ShipmentGUID": "sample string 2",
"SuccessOrFailure": "sample string 3",
"ErrorMessage": "sample string 4"
}
application/xml, text/xml
Sample:
<CreateOrderResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ErrorMessage>sample string 4</ErrorMessage> <ShipmentGUID>sample string 2</ShipmentGUID> <ShipmentNumber>1</ShipmentNumber> <SuccessOrFailure>sample string 3</SuccessOrFailure> </CreateOrderResp>