POST api/Ship

Used to create a new shipment in CourierCloud. The method is secure and requires a UserGUID to be assigned.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserGUID	Unique user GUID assigned for security purposes	string	Required Max length: 36
BillToType	Bill to "S"hipper, "C"onsignee or "3"rd party	string	Required Max length: 1
ShipperAccountNumber	Shippers account number	string	Required Max length: 20
ConsigneeAccountNumber	Consignee account number	string	Max length: 20
ThirdPartyAccountNumber	Third party account number	string	Max length: 20
ShipperName	The name of person shipping the package.	string	Required Max length: 50
ShipperPhone	The shippers phone number.	string	Max length: 25
ShipperFax	The shippers fax number.	string	Max length: 25
ShipperEmail	The shippers email address.	string	Max length: 100
PickupAddressCode	An address code used to identify the pickup address	string	Max length: 15
PickupCompanyName	The name of the company at the pickup location	string	Required Max length: 50
PickupAddress1	Address line 1 at the pickup location	string	Max length: 50
PickupAddress2	Address line 2 at the pickup location	string	Max length: 50
PickupAddress3	Address line 3 at the pickup location	string	Max length: 50
PickupCityName	The city name at the pickup location	string	Required Max length: 50
PickupStateProvID	The state or province at the pickup location	string	Max length: 3
PickupPostalCode	The postal code at the pickup location	string	Max length: 10
PickupCountryID	The country identifier at the pickup location	string	Required Max length: 2
PickupPersonToSee	The person to see at the pickup location	string	Max length: 50
PickupPhoneNumber	The phone number at the pickup location	string	Max length: 25
PickupFaxNumber	The fax number at the pickup location	string	Max length: 25
PickupInstructions	The pickup instructions at the pickup location	string	Max length: 500
DeliveryAddressCode	An address code used to identify the delivery address	string	Max length: 15
DeliveryCompanyName	The name of the company at the pickup location	string	Required Max length: 50
DeliveryAddress1	The address line 1 at the delivery location	string	Max length: 50
DeliveryAddress2	The address line 2 at the delivery location	string	Max length: 50
DeliveryAddress3	The address line 3 at the delivery location	string	Max length: 50
DeliveryCityName	The name of the city at the delivery location	string	Required Max length: 50
DeliveryStateProvID	The state or province at the delivery location	string	Max length: 3
DeliveryPostalCode	The postal code at the delivery location	string	Max length: 10
DeliveryCountryID	The country ID at the delivery location (ie. US)	string	Required Max length: 2
DeliveryAttention	The attention to person at the delivery location	string	Max length: 50
DeliveryPhoneNumber	The phone number at the delivery location	string	Max length: 25
DeliveryFaxNumber	The fax number at the delivery location	string	Max length: 25
DeliveryEmailAddress	The email address at the delivery location	string	Max length: 100
DeliveryInstructions	The delivery instructions at the delivery location	string	Max length: 500
Contents	The description of the contents at of the shipment	string	Required Max length: 100
Reference	Customer specified reference value for the shipment	string	Max length: 50
Pieces	Number of pieces in the shipment	integer	Required Range: inclusive between 1 and 9999
Weight	Total actual weight of the shipment	decimal number	Required Range: inclusive between 0.5 and 99999
WeightUOM	Weight unit of measure (LB,KG)	string	Required Max length: 2
Length	Length of each piece in the shipment	integer	Range: inclusive between 1 and 9999
Width	Width of each piece in the shipment	integer	Range: inclusive between 1 and 9999
Height	Height of each piece in the shipment	integer	Range: inclusive between 1 and 9999
SizeUOM	Size unit of measure (IN,CM)	string	Required Max length: 2
ServiceCode	Code of the service required for shipment	string	Required Max length: 15
ReadyDate	Date shipment will be ready for pickup (YYYY-MM-dd)	string	Required Max length: 10
ReadyTime	Time of day shipment will be ready for pickup (HH:mm)	string	Required Max length: 5
RequestedDeliveryDate	Requested delivery Date (YYYY-MM-dd)	string	Max length: 10
RequestedDeliveryTime	Requested delivery Time (HH:mm)	string	Max length: 5
DeclaredValue	Declared value of shipment	decimal number	Range: inclusive between 1 and 999999
DeclaredValueCurrencyID	Current of declared value (ie. USD)	string	Max length: 3
OtherReferenceTypeID1	Custom reference type id (can be set in user profile)	integer	None.
OtherReferenceTypeID2	Custom reference type id (can be set in user profile)	integer	None.
OtherReferenceTypeID3	Custom reference type id (can be set in user profile)	integer	None.
OtherReferenceTypeID4	Custom reference type id (can be set in user profile)	integer	None.
OtherReferenceTypeID5	Custom reference type id (can be set in user profile)	integer	None.
OtherReferenceTypeID6	Custom reference type id (can be set in user profile)	integer	None.
OtherReferenceTypeID7	Custom reference type id (can be set in user profile)	integer	None.
OtherReferenceTypeID8	Custom reference type id (can be set in user profile)	integer	None.
OtherReference1	Custom reference value	string	Max length: 50
OtherReference2	Custom reference value	string	Max length: 50
OtherReference3	Custom reference value	string	Max length: 50
OtherReference4	Custom reference value	string	Max length: 50
OtherReference5	Custom reference value	string	Max length: 50
OtherReference6	Custom reference value	string	Max length: 50
OtherReference7	Custom reference value	string	Max length: 50
OtherReference8	Custom reference value	string	Max length: 50
TrackingNumber	Tracking number, specify only if using pre-printed airbills	string	Max length: 20
AesITN	ITN# used by AES	string	Max length: 10
IsWillCall	IsWillCall filed used to set Shipment Status to "Will Call"	boolean	None.

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",
  "IsWillCall": true
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateOrderResponse

Name	Description	Type	Additional information
ShipmentNumber	Unique shipment number used to reference shipment	integer	None.
IsSuccessful	If true, then method call was successful	boolean	None.
ErrorMessage	Contains an error message is method call failed	string	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<CreateOrderResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsSuccessful>true</IsSuccessful>
  <ErrorMessage>sample string 3</ErrorMessage>
  <ShipmentNumber>1</ShipmentNumber>
</CreateOrderResponse>