POST api/Ship

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserGUID	string	Required Max length: 36
BillToType	string	Required Max length: 1
ShipperAccountNumber	string	Required Max length: 20
ConsigneeAccountNumber	string	Max length: 20
ThirdPartyAccountNumber	string	Max length: 20
ShipperName	string	Required Max length: 50
ShipperPhone	string	Max length: 25
ShipperFax	string	Max length: 25
ShipperEmail	string	Max length: 100
PickupAddressCode	string	Max length: 15
PickupCompanyName	string	Required Max length: 50
PickupAddress1	string	Max length: 50
PickupAddress2	string	Max length: 50
PickupAddress3	string	Max length: 50
PickupCityName	string	Required Max length: 50
PickupStateProvID	string	Max length: 3
PickupPostalCode	string	Max length: 10
PickupCountryID	string	Required Max length: 2
PickupPersonToSee	string	Max length: 50
PickupPhoneNumber	string	Max length: 25
PickupFaxNumber	string	Max length: 25
PickupInstructions	string	Max length: 500
DeliveryAddressCode	string	Max length: 15
DeliveryCompanyName	string	Required Max length: 50
DeliveryAddress1	string	Max length: 50
DeliveryAddress2	string	Max length: 50
DeliveryAddress3	string	Max length: 50
DeliveryCityName	string	Required Max length: 50
DeliveryStateProvID	string	Max length: 3
DeliveryPostalCode	string	Max length: 10
DeliveryCountryID	string	Required Max length: 2
DeliveryAttention	string	Max length: 50
DeliveryPhoneNumber	string	Max length: 25
DeliveryFaxNumber	string	Max length: 25
DeliveryEmailAddress	string	Max length: 100
DeliveryInstructions	string	Max length: 500
Contents	string	Required Max length: 100
Reference	string	Max length: 50
Pieces	integer	Required Range: inclusive between 1 and 9999
Weight	decimal number	Required Range: inclusive between 0.5 and 99999
WeightUOM	string	Required Max length: 2
Length	integer	Range: inclusive between 1 and 9999
Width	integer	Range: inclusive between 1 and 9999
Height	integer	Range: inclusive between 1 and 9999
SizeUOM	string	Required Max length: 2
ServiceCode	string	Required Max length: 15
ReadyDate	string	Required Max length: 10
ReadyTime	string	Required Max length: 5
RequestedDeliveryDate	string	Max length: 10
RequestedDeliveryTime	string	Max length: 5
DeclaredValue	decimal number	Range: inclusive between 1 and 999999
DeclaredValueCurrencyID	string	Max length: 3
OtherReferenceTypeID1	integer	None.
OtherReferenceTypeID2	integer	None.
OtherReferenceTypeID3	integer	None.
OtherReferenceTypeID4	integer	None.
OtherReferenceTypeID5	integer	None.
OtherReferenceTypeID6	integer	None.
OtherReferenceTypeID7	integer	None.
OtherReferenceTypeID8	integer	None.
OtherReference1	string	Max length: 50
OtherReference2	string	Max length: 50
OtherReference3	string	Max length: 50
OtherReference4	string	Max length: 50
OtherReference5	string	Max length: 50
OtherReference6	string	Max length: 50
OtherReference7	string	Max length: 50
OtherReference8	string	Max length: 50
TrackingNumber	string	Max length: 20
AesITN	string	Max length: 10

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "BillToType": "sample string 2",
  "ShipperAccountNumber": "sample string 3",
  "ConsigneeAccountNumber": "sample string 4",
  "ThirdPartyAccountNumber": "sample string 5",
  "ShipperName": "sample string 6",
  "ShipperPhone": "sample string 7",
  "ShipperFax": "sample string 8",
  "ShipperEmail": "sample string 9",
  "PickupAddressCode": "sample string 10",
  "PickupCompanyName": "sample string 11",
  "PickupAddress1": "sample string 12",
  "PickupAddress2": "sample string 13",
  "PickupAddress3": "sample string 14",
  "PickupCityName": "sample string 15",
  "PickupStateProvID": "sample string 16",
  "PickupPostalCode": "sample string 17",
  "PickupCountryID": "sample string 18",
  "PickupPersonToSee": "sample string 19",
  "PickupPhoneNumber": "sample string 20",
  "PickupFaxNumber": "sample string 21",
  "PickupInstructions": "sample string 22",
  "DeliveryAddressCode": "sample string 23",
  "DeliveryCompanyName": "sample string 24",
  "DeliveryAddress1": "sample string 25",
  "DeliveryAddress2": "sample string 26",
  "DeliveryAddress3": "sample string 27",
  "DeliveryCityName": "sample string 28",
  "DeliveryStateProvID": "sample string 29",
  "DeliveryPostalCode": "sample string 30",
  "DeliveryCountryID": "sample string 31",
  "DeliveryAttention": "sample string 32",
  "DeliveryPhoneNumber": "sample string 33",
  "DeliveryFaxNumber": "sample string 34",
  "DeliveryEmailAddress": "sample string 35",
  "DeliveryInstructions": "sample string 36",
  "Contents": "sample string 37",
  "Reference": "sample string 38",
  "Pieces": 39,
  "Weight": 40.0,
  "WeightUOM": "sample string 41",
  "Length": 42,
  "Width": 43,
  "Height": 44,
  "SizeUOM": "sample string 45",
  "ServiceCode": "sample string 46",
  "ReadyDate": "sample string 47",
  "ReadyTime": "sample string 48",
  "RequestedDeliveryDate": "sample string 49",
  "RequestedDeliveryTime": "sample string 50",
  "DeclaredValue": 51.0,
  "DeclaredValueCurrencyID": "sample string 52",
  "OtherReferenceTypeID1": 53,
  "OtherReferenceTypeID2": 54,
  "OtherReferenceTypeID3": 55,
  "OtherReferenceTypeID4": 56,
  "OtherReferenceTypeID5": 57,
  "OtherReferenceTypeID6": 58,
  "OtherReferenceTypeID7": 59,
  "OtherReferenceTypeID8": 60,
  "OtherReference1": "sample string 61",
  "OtherReference2": "sample string 62",
  "OtherReference3": "sample string 63",
  "OtherReference4": "sample string 64",
  "OtherReference5": "sample string 65",
  "OtherReference6": "sample string 66",
  "OtherReference7": "sample string 67",
  "OtherReference8": "sample string 68",
  "TrackingNumber": "sample string 69",
  "AesITN": "sample string 70"
}

application/xml, text/xml

Sample:

<CreateOrderParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper1.Models">
  <AesITN>sample string 70</AesITN>
  <BillToType>sample string 2</BillToType>
  <ConsigneeAccountNumber>sample string 4</ConsigneeAccountNumber>
  <Contents>sample string 37</Contents>
  <DeclaredValue>51</DeclaredValue>
  <DeclaredValueCurrencyID>sample string 52</DeclaredValueCurrencyID>
  <DeliveryAddress1>sample string 25</DeliveryAddress1>
  <DeliveryAddress2>sample string 26</DeliveryAddress2>
  <DeliveryAddress3>sample string 27</DeliveryAddress3>
  <DeliveryAddressCode>sample string 23</DeliveryAddressCode>
  <DeliveryAttention>sample string 32</DeliveryAttention>
  <DeliveryCityName>sample string 28</DeliveryCityName>
  <DeliveryCompanyName>sample string 24</DeliveryCompanyName>
  <DeliveryCountryID>sample string 31</DeliveryCountryID>
  <DeliveryEmailAddress>sample string 35</DeliveryEmailAddress>
  <DeliveryFaxNumber>sample string 34</DeliveryFaxNumber>
  <DeliveryInstructions>sample string 36</DeliveryInstructions>
  <DeliveryPhoneNumber>sample string 33</DeliveryPhoneNumber>
  <DeliveryPostalCode>sample string 30</DeliveryPostalCode>
  <DeliveryStateProvID>sample string 29</DeliveryStateProvID>
  <Height>44</Height>
  <Length>42</Length>
  <OtherReference1>sample string 61</OtherReference1>
  <OtherReference2>sample string 62</OtherReference2>
  <OtherReference3>sample string 63</OtherReference3>
  <OtherReference4>sample string 64</OtherReference4>
  <OtherReference5>sample string 65</OtherReference5>
  <OtherReference6>sample string 66</OtherReference6>
  <OtherReference7>sample string 67</OtherReference7>
  <OtherReference8>sample string 68</OtherReference8>
  <OtherReferenceTypeID1>53</OtherReferenceTypeID1>
  <OtherReferenceTypeID2>54</OtherReferenceTypeID2>
  <OtherReferenceTypeID3>55</OtherReferenceTypeID3>
  <OtherReferenceTypeID4>56</OtherReferenceTypeID4>
  <OtherReferenceTypeID5>57</OtherReferenceTypeID5>
  <OtherReferenceTypeID6>58</OtherReferenceTypeID6>
  <OtherReferenceTypeID7>59</OtherReferenceTypeID7>
  <OtherReferenceTypeID8>60</OtherReferenceTypeID8>
  <PickupAddress1>sample string 12</PickupAddress1>
  <PickupAddress2>sample string 13</PickupAddress2>
  <PickupAddress3>sample string 14</PickupAddress3>
  <PickupAddressCode>sample string 10</PickupAddressCode>
  <PickupCityName>sample string 15</PickupCityName>
  <PickupCompanyName>sample string 11</PickupCompanyName>
  <PickupCountryID>sample string 18</PickupCountryID>
  <PickupFaxNumber>sample string 21</PickupFaxNumber>
  <PickupInstructions>sample string 22</PickupInstructions>
  <PickupPersonToSee>sample string 19</PickupPersonToSee>
  <PickupPhoneNumber>sample string 20</PickupPhoneNumber>
  <PickupPostalCode>sample string 17</PickupPostalCode>
  <PickupStateProvID>sample string 16</PickupStateProvID>
  <Pieces>39</Pieces>
  <ReadyDate>sample string 47</ReadyDate>
  <ReadyTime>sample string 48</ReadyTime>
  <Reference>sample string 38</Reference>
  <RequestedDeliveryDate>sample string 49</RequestedDeliveryDate>
  <RequestedDeliveryTime>sample string 50</RequestedDeliveryTime>
  <ServiceCode>sample string 46</ServiceCode>
  <ShipperAccountNumber>sample string 3</ShipperAccountNumber>
  <ShipperEmail>sample string 9</ShipperEmail>
  <ShipperFax>sample string 8</ShipperFax>
  <ShipperName>sample string 6</ShipperName>
  <ShipperPhone>sample string 7</ShipperPhone>
  <SizeUOM>sample string 45</SizeUOM>
  <ThirdPartyAccountNumber>sample string 5</ThirdPartyAccountNumber>
  <TrackingNumber>sample string 69</TrackingNumber>
  <UserGUID>sample string 1</UserGUID>
  <Weight>40</Weight>
  <WeightUOM>sample string 41</WeightUOM>
  <Width>43</Width>
</CreateOrderParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateOrderResponse

Name	Type	Additional information
ShipmentNumber	integer	None.
IsSuccessful	boolean	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ShipmentNumber": 1,
  "IsSuccessful": true,
  "ErrorMessage": "sample string 3"
}

application/xml, text/xml

Sample:

<CreateOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper1.Models">
  <ErrorMessage>sample string 3</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <ShipmentNumber>1</ShipmentNumber>
</CreateOrderResponse>