POST api/Ship/CreateOrder

Used this method to create an order. If multiple piece shipment, use the PieceDetail element below to specify details, and leave the details in the root elements blank.

Request Information

URI Parameters

None.

Body Parameters

CreateOrderParm

Name	Description	Type	Additional information
UserGUID	Unique system generated user identifier	string	Required
BillToType	Bill to account type (S=shipper, C=consignee, 3=third party)	string	Required
ShipperAccountNumber	Shipper 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	Name of person shipping	string	Required Max length: 50
ShipperPhone	Phone number of shipper	string	Max length: 25
ShipperFax	Fax number of shipper	string	Max length: 25
ShipperEmail	Email address of shipper	string	Max length: 100
PickupAddressCode	Pickup address code	string	Max length: 15
PickupCompanyName	Company name at pickup	string	Required Max length: 50
PickupAddress1	Address line 1 at pickup	string	Max length: 50
PickupAddress2	Address line 2 at pickup	string	Max length: 50
PickupAddress3	Address line 3 at pickup	string	Max length: 50
PickupCityName	City name at pickup	string	Required Max length: 50
PickupStateProvID	State or province ID at pickup	string	Max length: 3
PickupPostalCode	Postal code at pickup	string	Max length: 10
PickupCountryID	Country ID at pickup (ie. US)	string	Required Max length: 2
PickupPersonToSee	Person to see at pickup	string	Max length: 50
PickupPhoneNumber	Phone number at pickup	string	Max length: 25
PickupFaxNumber	Fax number at pickup	string	Max length: 25
PickupInstructions	Special instructions at pickup	string	Max length: 500
DeliveryAddressCode	Code that identifies delivery address	string	Max length: 15
DeliveryCompanyName	Company name at delivery address	string	Required Max length: 50
DeliveryAddress1	Address line 1 at delivery address	string	Max length: 50
DeliveryAddress2	Address line 2 at delivery address	string	Max length: 50
DeliveryAddress3	Address line 3 at delivery address	string	Max length: 50
DeliveryCityName	City name at delivery address	string	Required Max length: 50
DeliveryStateProvID	State or province ID at delivery address	string	Max length: 3
DeliveryPostalCode	Postal code at delivery address	string	Max length: 10
DeliveryCountryID	Country code at delivery (ie. US)	string	Required Max length: 2
DeliveryAttention	Attention person at delivery address	string	Max length: 50
DeliveryPhoneNumber	Phone number at delivery	string	Max length: 25
DeliveryFaxNumber	Fax number at delivery	string	Max length: 25
DeliveryEmailAddress	Email address at delivery	string	Max length: 100
DeliveryInstructions	Special instructions at delivery	string	Max length: 500
Contents	Contents of shipment	string	Max length: 100
Reference	Main reference value	string	Max length: 50
Pieces	Number of pieces	integer	Required
Weight	Total weight of shipment	decimal number	Required
WeightUOM	Weight unit of measure (LB,KG)	string	Required
Length	Length of each piece in shipment	integer	None.
Width	Width of each piece in shipment	integer	None.
Height	Height of each piece in shipment	integer	None.
SizeUOM	Size unit of measure (IN,CM)	string	Required
ServiceCode	Code of the service requested for shipment	string	Required
ReadyDate	Date that shipment will be ready for pickup (yyyy-MM-dd format)	string	Required Max length: 10
ReadyTime	Time that shipment will be ready for pickup (HH:mm format)	string	Required Max length: 5
RequestedDeliveryDate	Optional requested delivery date (yyyy-MM-dd format)	string	Max length: 10
RequestedDeliveryTime	Optional requested delivery time (HH:mm format)	string	Max length: 5
DeclaredValue	Delcared value of the shipment	decimal number	None.
DeclaredValueCurrencyID	Currency of the declared value (ie. USD)	string	Max length: 3
OtherReferenceTypeID1	Number that identifies the type of reference field specified in OtherReference1 field	integer	None.
OtherReferenceTypeID2	Number that identifies the type of reference field specified in OtherReference2 field	integer	None.
OtherReferenceTypeID3	Number that identifies the type of reference field specified in OtherReference3 field	integer	None.
OtherReferenceTypeID4	Number that identifies the type of reference field specified in OtherReference4 field	integer	None.
OtherReferenceTypeID5	Number that identifies the type of reference field specified in OtherReference5 field	integer	None.
OtherReferenceTypeID6	Number that identifies the type of reference field specified in OtherReference6 field	integer	None.
OtherReferenceTypeID7	Number that identifies the type of reference field specified in OtherReference7 field	integer	None.
OtherReferenceTypeID8	Number that identifies the type of reference field specified in OtherReference8 field	integer	None.
OtherReference1	Other reference value	string	Max length: 50
OtherReference2	Other reference value	string	Max length: 50
OtherReference3	Other reference value	string	Max length: 50
OtherReference4	Other reference value	string	Max length: 50
OtherReference5	Other reference value	string	Max length: 50
OtherReference6	Other reference value	string	Max length: 50
OtherReference7	Other reference value	string	Max length: 50
OtherReference8	Other reference value	string	Max length: 50
TrackingNumber	The pre-printed or pre-assigned tracking number for this shipment	string	Max length: 20
IsDangerousGoods	Shipment is dangerous goods (true, false)	boolean	None.
IsRadioactive	Shipment is radioactive (true, false)?	boolean	None.
DgUNNumber	UN # for dangerous goods	string	None.
DgCommodityClass	Commodity class for dangerous goods	string	None.
DgProperName	Commodity proper name for dangerous goods	string	None.
DgDryIceWeight	Weight of the dry ice	decimal number	None.
DgGelPackCount	Number of gel packs	integer	None.
CarrierToProvideDryIce	Carrier to provide dry ice (true=carrier provides, false=shipper provides)	boolean	None.
CarrierToProvideGelPack	Carrier to provide gel pack (true=carrier provides, false=shipper provides)	boolean	None.
PackagingTypeCode	Type of outer packaging (see code list)	string	None.
PackagingTypeCodeInner	Type of inner packaging (see code list)	string	None.
Quantity	Quantity in piece	integer	None.
PieceDetail	Contains the detail information regarding a piece (use only when multiple piece shipment)	Collection of PieceItem	None.
Notes	Contains any miscellanous notes that should be associated with the order	Collection of Note	None.
OrderSource	Source of Shipment. Anoop Meethal : 28 Aug 2024 : Modify Shipper API to include 'OrderSource' Parameter	string	Max length: 1
Commodity	Source of Shipment. Anoop Meethal : 30 Aug 2024 : 56089 : Modify Shipper API to include 'Commodity' Parameter	string	Max length: 100

Request Formats

application/json, text/json

Sample:

{
  "BillToType": "sample string 2",
  "CarrierToProvideDryIce": true,
  "CarrierToProvideGelPack": true,
  "Commodity": "sample string 78",
  "ConsigneeAccountNumber": "sample string 4",
  "Contents": "sample string 37",
  "DeclaredValue": 48,
  "DeclaredValueCurrencyID": "sample string 49",
  "DeliveryAddress1": "sample string 25",
  "DeliveryAddress2": "sample string 26",
  "DeliveryAddress3": "sample string 27",
  "DeliveryAddressCode": "sample string 23",
  "DeliveryAttention": "sample string 32",
  "DeliveryCityName": "sample string 28",
  "DeliveryCompanyName": "sample string 24",
  "DeliveryCountryID": "sample string 31",
  "DeliveryEmailAddress": "sample string 35",
  "DeliveryFaxNumber": "sample string 34",
  "DeliveryInstructions": "sample string 36",
  "DeliveryPhoneNumber": "sample string 33",
  "DeliveryPostalCode": "sample string 30",
  "DeliveryStateProvID": "sample string 29",
  "DgCommodityClass": "sample string 70",
  "DgDryIceWeight": 1,
  "DgGelPackCount": 1,
  "DgProperName": "sample string 71",
  "DgUNNumber": "sample string 69",
  "Height": 1,
  "IsDangerousGoods": true,
  "IsRadioactive": true,
  "Length": 1,
  "Notes": [
    {
      "Text": "sample string 1"
    },
    {
      "Text": "sample string 1"
    }
  ],
  "OrderSource": "sample string 77",
  "OtherReference1": "sample string 58",
  "OtherReference2": "sample string 59",
  "OtherReference3": "sample string 60",
  "OtherReference4": "sample string 61",
  "OtherReference5": "sample string 62",
  "OtherReference6": "sample string 63",
  "OtherReference7": "sample string 64",
  "OtherReference8": "sample string 65",
  "OtherReferenceTypeID1": 50,
  "OtherReferenceTypeID2": 51,
  "OtherReferenceTypeID3": 52,
  "OtherReferenceTypeID4": 53,
  "OtherReferenceTypeID5": 54,
  "OtherReferenceTypeID6": 55,
  "OtherReferenceTypeID7": 56,
  "OtherReferenceTypeID8": 57,
  "PackagingTypeCode": "sample string 74",
  "PackagingTypeCodeInner": "sample string 75",
  "PickupAddress1": "sample string 12",
  "PickupAddress2": "sample string 13",
  "PickupAddress3": "sample string 14",
  "PickupAddressCode": "sample string 10",
  "PickupCityName": "sample string 15",
  "PickupCompanyName": "sample string 11",
  "PickupCountryID": "sample string 18",
  "PickupFaxNumber": "sample string 21",
  "PickupInstructions": "sample string 22",
  "PickupPersonToSee": "sample string 19",
  "PickupPhoneNumber": "sample string 20",
  "PickupPostalCode": "sample string 17",
  "PickupStateProvID": "sample string 16",
  "PieceDetail": [
    {
      "CarrierToProvideDryIce": true,
      "CarrierToProvideGelPack": true,
      "Contents": "sample string 6",
      "CountryOfOrigin": "sample string 10",
      "DeclaredValue": 1,
      "DeclaredValueCurrencyID": "sample string 8",
      "DgCommodityClass": "sample string 15",
      "DgDryIceWeight": 1,
      "DgGelPackCount": 1,
      "DgProperName": "sample string 16",
      "DgUNNumber": "sample string 14",
      "HSCode": "sample string 9",
      "Height": "sample string 4",
      "IsDangerousGoods": true,
      "IsRadioactive": true,
      "Length": "sample string 2",
      "PackagingTypeCode": "sample string 19",
      "PackagingTypeCodeInner": "sample string 20",
      "Quantity": 21,
      "Reference": "sample string 7",
      "SizeUOM": "sample string 5",
      "TemperatureType": "sample string 11",
      "Weight": 1,
      "WeightUOM": "sample string 1",
      "Width": "sample string 3"
    },
    {
      "CarrierToProvideDryIce": true,
      "CarrierToProvideGelPack": true,
      "Contents": "sample string 6",
      "CountryOfOrigin": "sample string 10",
      "DeclaredValue": 1,
      "DeclaredValueCurrencyID": "sample string 8",
      "DgCommodityClass": "sample string 15",
      "DgDryIceWeight": 1,
      "DgGelPackCount": 1,
      "DgProperName": "sample string 16",
      "DgUNNumber": "sample string 14",
      "HSCode": "sample string 9",
      "Height": "sample string 4",
      "IsDangerousGoods": true,
      "IsRadioactive": true,
      "Length": "sample string 2",
      "PackagingTypeCode": "sample string 19",
      "PackagingTypeCodeInner": "sample string 20",
      "Quantity": 21,
      "Reference": "sample string 7",
      "SizeUOM": "sample string 5",
      "TemperatureType": "sample string 11",
      "Weight": 1,
      "WeightUOM": "sample string 1",
      "Width": "sample string 3"
    }
  ],
  "Pieces": 39,
  "Quantity": 76,
  "ReadyDate": "sample string 44",
  "ReadyTime": "sample string 45",
  "Reference": "sample string 38",
  "RequestedDeliveryDate": "sample string 46",
  "RequestedDeliveryTime": "sample string 47",
  "ServiceCode": "sample string 43",
  "ShipperAccountNumber": "sample string 3",
  "ShipperEmail": "sample string 9",
  "ShipperFax": "sample string 8",
  "ShipperName": "sample string 6",
  "ShipperPhone": "sample string 7",
  "SizeUOM": "sample string 42",
  "ThirdPartyAccountNumber": "sample string 5",
  "TrackingNumber": "sample string 66",
  "UserGUID": "sample string 1",
  "Weight": 40,
  "WeightUOM": "sample string 41",
  "Width": 1
}

application/xml, text/xml

Sample:

<CreateOrderParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <BillToType>sample string 2</BillToType>
  <CarrierToProvideDryIce>true</CarrierToProvideDryIce>
  <CarrierToProvideGelPack>true</CarrierToProvideGelPack>
  <Commodity>sample string 78</Commodity>
  <ConsigneeAccountNumber>sample string 4</ConsigneeAccountNumber>
  <Contents>sample string 37</Contents>
  <DeclaredValue>48</DeclaredValue>
  <DeclaredValueCurrencyID>sample string 49</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>
  <DgCommodityClass>sample string 70</DgCommodityClass>
  <DgDryIceWeight>1</DgDryIceWeight>
  <DgGelPackCount>1</DgGelPackCount>
  <DgProperName>sample string 71</DgProperName>
  <DgUNNumber>sample string 69</DgUNNumber>
  <Height>1</Height>
  <IsDangerousGoods>true</IsDangerousGoods>
  <IsRadioactive>true</IsRadioactive>
  <Length>1</Length>
  <Notes>
    <Note>
      <Text>sample string 1</Text>
    </Note>
    <Note>
      <Text>sample string 1</Text>
    </Note>
  </Notes>
  <OrderSource>sample string 77</OrderSource>
  <OtherReference1>sample string 58</OtherReference1>
  <OtherReference2>sample string 59</OtherReference2>
  <OtherReference3>sample string 60</OtherReference3>
  <OtherReference4>sample string 61</OtherReference4>
  <OtherReference5>sample string 62</OtherReference5>
  <OtherReference6>sample string 63</OtherReference6>
  <OtherReference7>sample string 64</OtherReference7>
  <OtherReference8>sample string 65</OtherReference8>
  <OtherReferenceTypeID1>50</OtherReferenceTypeID1>
  <OtherReferenceTypeID2>51</OtherReferenceTypeID2>
  <OtherReferenceTypeID3>52</OtherReferenceTypeID3>
  <OtherReferenceTypeID4>53</OtherReferenceTypeID4>
  <OtherReferenceTypeID5>54</OtherReferenceTypeID5>
  <OtherReferenceTypeID6>55</OtherReferenceTypeID6>
  <OtherReferenceTypeID7>56</OtherReferenceTypeID7>
  <OtherReferenceTypeID8>57</OtherReferenceTypeID8>
  <PackagingTypeCode>sample string 74</PackagingTypeCode>
  <PackagingTypeCodeInner>sample string 75</PackagingTypeCodeInner>
  <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>
  <PieceDetail>
    <PieceItem>
      <CarrierToProvideDryIce>true</CarrierToProvideDryIce>
      <CarrierToProvideGelPack>true</CarrierToProvideGelPack>
      <Contents>sample string 6</Contents>
      <CountryOfOrigin>sample string 10</CountryOfOrigin>
      <DeclaredValue>1</DeclaredValue>
      <DeclaredValueCurrencyID>sample string 8</DeclaredValueCurrencyID>
      <DgCommodityClass>sample string 15</DgCommodityClass>
      <DgDryIceWeight>1</DgDryIceWeight>
      <DgGelPackCount>1</DgGelPackCount>
      <DgProperName>sample string 16</DgProperName>
      <DgUNNumber>sample string 14</DgUNNumber>
      <HSCode>sample string 9</HSCode>
      <Height>sample string 4</Height>
      <IsDangerousGoods>true</IsDangerousGoods>
      <IsRadioactive>true</IsRadioactive>
      <Length>sample string 2</Length>
      <PackagingTypeCode>sample string 19</PackagingTypeCode>
      <PackagingTypeCodeInner>sample string 20</PackagingTypeCodeInner>
      <Quantity>21</Quantity>
      <Reference>sample string 7</Reference>
      <SizeUOM>sample string 5</SizeUOM>
      <TemperatureType>sample string 11</TemperatureType>
      <Weight>1</Weight>
      <WeightUOM>sample string 1</WeightUOM>
      <Width>sample string 3</Width>
    </PieceItem>
    <PieceItem>
      <CarrierToProvideDryIce>true</CarrierToProvideDryIce>
      <CarrierToProvideGelPack>true</CarrierToProvideGelPack>
      <Contents>sample string 6</Contents>
      <CountryOfOrigin>sample string 10</CountryOfOrigin>
      <DeclaredValue>1</DeclaredValue>
      <DeclaredValueCurrencyID>sample string 8</DeclaredValueCurrencyID>
      <DgCommodityClass>sample string 15</DgCommodityClass>
      <DgDryIceWeight>1</DgDryIceWeight>
      <DgGelPackCount>1</DgGelPackCount>
      <DgProperName>sample string 16</DgProperName>
      <DgUNNumber>sample string 14</DgUNNumber>
      <HSCode>sample string 9</HSCode>
      <Height>sample string 4</Height>
      <IsDangerousGoods>true</IsDangerousGoods>
      <IsRadioactive>true</IsRadioactive>
      <Length>sample string 2</Length>
      <PackagingTypeCode>sample string 19</PackagingTypeCode>
      <PackagingTypeCodeInner>sample string 20</PackagingTypeCodeInner>
      <Quantity>21</Quantity>
      <Reference>sample string 7</Reference>
      <SizeUOM>sample string 5</SizeUOM>
      <TemperatureType>sample string 11</TemperatureType>
      <Weight>1</Weight>
      <WeightUOM>sample string 1</WeightUOM>
      <Width>sample string 3</Width>
    </PieceItem>
  </PieceDetail>
  <Pieces>39</Pieces>
  <Quantity>76</Quantity>
  <ReadyDate>sample string 44</ReadyDate>
  <ReadyTime>sample string 45</ReadyTime>
  <Reference>sample string 38</Reference>
  <RequestedDeliveryDate>sample string 46</RequestedDeliveryDate>
  <RequestedDeliveryTime>sample string 47</RequestedDeliveryTime>
  <ServiceCode>sample string 43</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 42</SizeUOM>
  <ThirdPartyAccountNumber>sample string 5</ThirdPartyAccountNumber>
  <TrackingNumber>sample string 66</TrackingNumber>
  <UserGUID>sample string 1</UserGUID>
  <Weight>40</Weight>
  <WeightUOM>sample string 41</WeightUOM>
  <Width>1</Width>
</CreateOrderParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateOrderResp

Name	Description	Type	Additional information
IsSuccessful	Method call was successful (true) or failed (false)	boolean	None.
ErrorMessage	Error message if method call failed for any reason	string	None.
ShipmentNumber	Unique system generated shipment number	integer	None.
DeliveryAirportID	The airport ID of delivery	string	None.
DeliveryInstructions	The delivery instructions for the shipment	string	None.
FileName	Suggested file name to use for the report	string	None.
FileData	Base64 encoded string of the raw report file data	string	None.
DeliveryNumber	Passed Load ID in the Main reference	string	None.

Response Formats

application/json, text/json

Sample:

{
  "DeliveryAirportID": "sample string 4",
  "DeliveryInstructions": "sample string 5",
  "DeliveryNumber": "sample string 8",
  "ErrorMessage": "sample string 2",
  "FileData": "sample string 7",
  "FileName": "sample string 6",
  "IsSuccessful": true,
  "ShipmentNumber": 3
}

application/xml, text/xml

Sample:

<CreateOrderResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <DeliveryAirportID>sample string 4</DeliveryAirportID>
  <DeliveryInstructions>sample string 5</DeliveryInstructions>
  <DeliveryNumber>sample string 8</DeliveryNumber>
  <ErrorMessage>sample string 2</ErrorMessage>
  <FileData>sample string 7</FileData>
  <FileName>sample string 6</FileName>
  <IsSuccessful>true</IsSuccessful>
  <ShipmentNumber>3</ShipmentNumber>
</CreateOrderResp>