POST api/Ship

Use this method to create a shipment from the shipper

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
auth	Authorization token	string	Required
BillToType	Bill To Type (S=shipper(default), C=consignee, 3=third party	string	Required Max length: 1
AccountNumber	Account number (leave blank and default account will be used)	string	Required Max length: 20
PickupKeep		boolean	Required
PickupAddressCode		string	None.
PickupCompanyName		string	Required
PickupAddress1		string	None.
PickupAddress2		string	None.
PickupAddress3		string	None.
PickupCityName		string	Required
PickupStateProvID		string	None.
PickupPostalCode		string	None.
PickupCountryID		string	Required
PickupPersonToSee		string	None.
PickupPhoneNumber		string	None.
PickupFaxNumber		string	None.
PickupAfterHoursNumber		string	None.
PickupEmailAddress		string	None.
DropOff		boolean	Required
PickupReadyDateTime	Pickup ready date/time (yyyy-MM-dd HH:mm) (ignored if PickupReadyNow=true)	string	Required
PickupReadyNow	True=shipment is ready now	boolean	Required
PickupInstructions	Special instructions at pickup	string	None.
DeliveryKeep		boolean	Required
DeliveryAddressCode		string	None.
DeliveryCompanyName		string	Required
DeliveryAddress1		string	None.
DeliveryAddress2		string	None.
DeliveryAddress3		string	None.
DeliveryCityName		string	Required
DeliveryStateProvID		string	None.
DeliveryPostalCode		string	None.
DeliveryCountryID		string	Required
DeliveryAttention		string	None.
DeliveryPhoneNumber		string	None.
DeliveryFaxNumber		string	None.
DeliveryAfterHoursNumber		string	None.
DeliveryEmailAddress		string	None.
DeliverWhen		string	Required
DeliveryRequestDateTime	Requested delivery date/time (yyyy-MM-dd HH:mm) (ignored if DeliveryRequestAsap = true)	string	None.
DeliveryRequestAsap	True = deliver as soon as possible, False=see DeliveryRequestDateTime	boolean	Required
DeliveryInstructions	Special instructions at delivery	string	None.
HoldForPickup		boolean	Required
ShipperName		string	None.
ShipperPhone		string	None.
ShipperEmail		string	None.
DeclaredValue		decimal number	None.
DeclaredValueCurrencyID		string	None.
Pieces		integer	Required
Weight		decimal number	Required
DimWeight		decimal number	None.
Length		integer	None.
Width		integer	None.
Height		integer	None.
Contents		string	None.
Reference		string	None.
OtherReference1		string	None.
OtherReference2		string	None.
OtherReference3		string	None.
OtherReference4		string	None.
OtherReference5		string	None.
OtherReference6		string	None.
OtherReference7		string	None.
OtherReference8		string	None.
ServiceGUID		string	Required
NotifyShipperOrderAck		boolean	Required
NotifyShipperOrderRouted		boolean	Required
NotifyShipperDispatched		boolean	Required
NotifyShipperPickedUp		boolean	Required
NotifyShipperDepToAp		boolean	Required
NotifyShipperObcCheckin		boolean	Required
NotifyShipperDropped		boolean	Required
NotifyShipperConfirmed		boolean	Required
NotifyShipperDeparted		boolean	Required
NotifyShipperArrived		boolean	Required
NotifyShipperRecovered		boolean	Required
NotifyShipperOutForDelivery		boolean	Required
NotifyShipperDelivered		boolean	Required
NotifyShipperOrigQdt		boolean	Required
NotifyShipperChangeQdt		boolean	Required
NotifyConseeOrderAck		boolean	Required
NotifyConseeOrderRouted		boolean	Required
NotifyConseeDispatched		boolean	Required
NotifyConseePickedUp		boolean	Required
NotifyConseeDepToAp		boolean	Required
NotifyConseeObcCheckin		boolean	Required
NotifyConseeDropped		boolean	Required
NotifyConseeConfirmed		boolean	Required
NotifyConseeDeparted		boolean	Required
NotifyConseeArrived		boolean	Required
NotifyConseeRecovered		boolean	Required
NotifyConseeOutForDelivery		boolean	Required
NotifyConseeDelivered		boolean	Required
NotifyConseeOrigQdt		boolean	Required
NotifyConseeChangeQdt		boolean	Required
IsDangerousGoods		boolean	Required
DgUNNumber		string	None.
DgCommodityClass		string	None.
DgDryIceWeight		decimal number	None.
DgTransportationIndex		string	None.
DgTransportationLimit		string	None.
DgIsRadioactive		boolean	Required
DgPackingGroup		string	None.
DgQuantityAndPackType		string	None.
DgPackingInst		string	None.
DgAuthorization		string	None.
DgHandlingInfo		string	None.
DgEmergencyPhone		string	None.
DgSignatory		string	None.
DgProperName		string	None.
DgDate	DG - Date (yyyy-MM-dd)	string	None.
TextPhoneNumber		string	None.
TextNotifyPickup		boolean	Required
TextNotifyDelivery		boolean	Required
PackagingTypeGUID_Outer		string	None.
PackagingTypeGUID_Inner		string	None.
Quantity		integer	None.
DgGelPackCount		integer	None.
CarrierToProvideDryIce		boolean	Required
CarrierToProvideGelPack		boolean	Required
PieceDetail		Collection of NewPieceItem	None.
Documents		Collection of NewDocumentItem	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountNumber": "sample string 3",
  "BillToType": "sample string 2",
  "CarrierToProvideDryIce": true,
  "CarrierToProvideGelPack": true,
  "Contents": "sample string 49",
  "DeclaredValue": 1,
  "DeclaredValueCurrencyID": "sample string 46",
  "DeliverWhen": "sample string 38",
  "DeliveryAddress1": "sample string 26",
  "DeliveryAddress2": "sample string 27",
  "DeliveryAddress3": "sample string 28",
  "DeliveryAddressCode": "sample string 24",
  "DeliveryAfterHoursNumber": "sample string 36",
  "DeliveryAttention": "sample string 33",
  "DeliveryCityName": "sample string 29",
  "DeliveryCompanyName": "sample string 25",
  "DeliveryCountryID": "sample string 32",
  "DeliveryEmailAddress": "sample string 37",
  "DeliveryFaxNumber": "sample string 35",
  "DeliveryInstructions": "sample string 41",
  "DeliveryKeep": true,
  "DeliveryPhoneNumber": "sample string 34",
  "DeliveryPostalCode": "sample string 31",
  "DeliveryRequestAsap": true,
  "DeliveryRequestDateTime": "sample string 39",
  "DeliveryStateProvID": "sample string 30",
  "DgAuthorization": "sample string 99",
  "DgCommodityClass": "sample string 92",
  "DgDate": "sample string 104",
  "DgDryIceWeight": 1,
  "DgEmergencyPhone": "sample string 101",
  "DgGelPackCount": 1,
  "DgHandlingInfo": "sample string 100",
  "DgIsRadioactive": true,
  "DgPackingGroup": "sample string 96",
  "DgPackingInst": "sample string 98",
  "DgProperName": "sample string 103",
  "DgQuantityAndPackType": "sample string 97",
  "DgSignatory": "sample string 102",
  "DgTransportationIndex": "sample string 93",
  "DgTransportationLimit": "sample string 94",
  "DgUNNumber": "sample string 91",
  "DimWeight": 1,
  "Documents": [
    {
      "FileData": "sample string 2",
      "OriginalFileName": "sample string 1"
    },
    {
      "FileData": "sample string 2",
      "OriginalFileName": "sample string 1"
    }
  ],
  "DropOff": true,
  "Height": 1,
  "HoldForPickup": true,
  "IsDangerousGoods": true,
  "Length": 1,
  "NotifyConseeArrived": true,
  "NotifyConseeChangeQdt": true,
  "NotifyConseeConfirmed": true,
  "NotifyConseeDelivered": true,
  "NotifyConseeDepToAp": true,
  "NotifyConseeDeparted": true,
  "NotifyConseeDispatched": true,
  "NotifyConseeDropped": true,
  "NotifyConseeObcCheckin": true,
  "NotifyConseeOrderAck": true,
  "NotifyConseeOrderRouted": true,
  "NotifyConseeOrigQdt": true,
  "NotifyConseeOutForDelivery": true,
  "NotifyConseePickedUp": true,
  "NotifyConseeRecovered": true,
  "NotifyShipperArrived": true,
  "NotifyShipperChangeQdt": true,
  "NotifyShipperConfirmed": true,
  "NotifyShipperDelivered": true,
  "NotifyShipperDepToAp": true,
  "NotifyShipperDeparted": true,
  "NotifyShipperDispatched": true,
  "NotifyShipperDropped": true,
  "NotifyShipperObcCheckin": true,
  "NotifyShipperOrderAck": true,
  "NotifyShipperOrderRouted": true,
  "NotifyShipperOrigQdt": true,
  "NotifyShipperOutForDelivery": true,
  "NotifyShipperPickedUp": true,
  "NotifyShipperRecovered": true,
  "OtherReference1": "sample string 51",
  "OtherReference2": "sample string 52",
  "OtherReference3": "sample string 53",
  "OtherReference4": "sample string 54",
  "OtherReference5": "sample string 55",
  "OtherReference6": "sample string 56",
  "OtherReference7": "sample string 57",
  "OtherReference8": "sample string 58",
  "PackagingTypeGUID_Inner": "sample string 109",
  "PackagingTypeGUID_Outer": "sample string 108",
  "PickupAddress1": "sample string 7",
  "PickupAddress2": "sample string 8",
  "PickupAddress3": "sample string 9",
  "PickupAddressCode": "sample string 5",
  "PickupAfterHoursNumber": "sample string 17",
  "PickupCityName": "sample string 10",
  "PickupCompanyName": "sample string 6",
  "PickupCountryID": "sample string 13",
  "PickupEmailAddress": "sample string 18",
  "PickupFaxNumber": "sample string 16",
  "PickupInstructions": "sample string 22",
  "PickupKeep": true,
  "PickupPersonToSee": "sample string 14",
  "PickupPhoneNumber": "sample string 15",
  "PickupPostalCode": "sample string 12",
  "PickupReadyDateTime": "sample string 20",
  "PickupReadyNow": true,
  "PickupStateProvID": "sample string 11",
  "PieceDetail": [
    {
      "CarrierToProvideDryIce": true,
      "CarrierToProvideGelPack": true,
      "Contents": "sample string 2",
      "DeclaredValue": 1,
      "DeclaredValueCurrencyID": "sample string 6",
      "DgAuthorization": "sample string 17",
      "DgCommodityClass": "sample string 12",
      "DgDryIceWeight": 1,
      "DgGelPackCount": 1,
      "DgPackagingGroup": "sample string 14",
      "DgPackingInstr": "sample string 16",
      "DgProperName": "sample string 13",
      "DgQuantityAndPackType": "sample string 15",
      "DgUNNumber": "sample string 11",
      "DimWeight": 1,
      "Height": 1,
      "IsDangerousGoods": true,
      "IsRadioactive": true,
      "ItemSKU": "sample string 1",
      "ItemValue": 1,
      "Length": 1,
      "PackagingTypeGUID_Inner": "sample string 8",
      "PackagingTypeGUID_Outer": "sample string 7",
      "Quantity": 1,
      "Reference": "sample string 3",
      "SizeUOM": "sample string 5",
      "Weight": 1,
      "WeightUOM": "sample string 4",
      "Width": 1
    },
    {
      "CarrierToProvideDryIce": true,
      "CarrierToProvideGelPack": true,
      "Contents": "sample string 2",
      "DeclaredValue": 1,
      "DeclaredValueCurrencyID": "sample string 6",
      "DgAuthorization": "sample string 17",
      "DgCommodityClass": "sample string 12",
      "DgDryIceWeight": 1,
      "DgGelPackCount": 1,
      "DgPackagingGroup": "sample string 14",
      "DgPackingInstr": "sample string 16",
      "DgProperName": "sample string 13",
      "DgQuantityAndPackType": "sample string 15",
      "DgUNNumber": "sample string 11",
      "DimWeight": 1,
      "Height": 1,
      "IsDangerousGoods": true,
      "IsRadioactive": true,
      "ItemSKU": "sample string 1",
      "ItemValue": 1,
      "Length": 1,
      "PackagingTypeGUID_Inner": "sample string 8",
      "PackagingTypeGUID_Outer": "sample string 7",
      "Quantity": 1,
      "Reference": "sample string 3",
      "SizeUOM": "sample string 5",
      "Weight": 1,
      "WeightUOM": "sample string 4",
      "Width": 1
    }
  ],
  "Pieces": 47,
  "Quantity": 1,
  "Reference": "sample string 50",
  "ServiceGUID": "sample string 59",
  "ShipperEmail": "sample string 45",
  "ShipperName": "sample string 43",
  "ShipperPhone": "sample string 44",
  "TextNotifyDelivery": true,
  "TextNotifyPickup": true,
  "TextPhoneNumber": "sample string 105",
  "Weight": 48,
  "Width": 1,
  "auth": "sample string 1"
}

application/xml, text/xml

Sample:

<ShipParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <AccountNumber>sample string 3</AccountNumber>
  <BillToType>sample string 2</BillToType>
  <CarrierToProvideDryIce>true</CarrierToProvideDryIce>
  <CarrierToProvideGelPack>true</CarrierToProvideGelPack>
  <Contents>sample string 49</Contents>
  <DeclaredValue>1</DeclaredValue>
  <DeclaredValueCurrencyID>sample string 46</DeclaredValueCurrencyID>
  <DeliverWhen>sample string 38</DeliverWhen>
  <DeliveryAddress1>sample string 26</DeliveryAddress1>
  <DeliveryAddress2>sample string 27</DeliveryAddress2>
  <DeliveryAddress3>sample string 28</DeliveryAddress3>
  <DeliveryAddressCode>sample string 24</DeliveryAddressCode>
  <DeliveryAfterHoursNumber>sample string 36</DeliveryAfterHoursNumber>
  <DeliveryAttention>sample string 33</DeliveryAttention>
  <DeliveryCityName>sample string 29</DeliveryCityName>
  <DeliveryCompanyName>sample string 25</DeliveryCompanyName>
  <DeliveryCountryID>sample string 32</DeliveryCountryID>
  <DeliveryEmailAddress>sample string 37</DeliveryEmailAddress>
  <DeliveryFaxNumber>sample string 35</DeliveryFaxNumber>
  <DeliveryInstructions>sample string 41</DeliveryInstructions>
  <DeliveryKeep>true</DeliveryKeep>
  <DeliveryPhoneNumber>sample string 34</DeliveryPhoneNumber>
  <DeliveryPostalCode>sample string 31</DeliveryPostalCode>
  <DeliveryRequestAsap>true</DeliveryRequestAsap>
  <DeliveryRequestDateTime>sample string 39</DeliveryRequestDateTime>
  <DeliveryStateProvID>sample string 30</DeliveryStateProvID>
  <DgAuthorization>sample string 99</DgAuthorization>
  <DgCommodityClass>sample string 92</DgCommodityClass>
  <DgDate>sample string 104</DgDate>
  <DgDryIceWeight>1</DgDryIceWeight>
  <DgEmergencyPhone>sample string 101</DgEmergencyPhone>
  <DgGelPackCount>1</DgGelPackCount>
  <DgHandlingInfo>sample string 100</DgHandlingInfo>
  <DgIsRadioactive>true</DgIsRadioactive>
  <DgPackingGroup>sample string 96</DgPackingGroup>
  <DgPackingInst>sample string 98</DgPackingInst>
  <DgProperName>sample string 103</DgProperName>
  <DgQuantityAndPackType>sample string 97</DgQuantityAndPackType>
  <DgSignatory>sample string 102</DgSignatory>
  <DgTransportationIndex>sample string 93</DgTransportationIndex>
  <DgTransportationLimit>sample string 94</DgTransportationLimit>
  <DgUNNumber>sample string 91</DgUNNumber>
  <DimWeight>1</DimWeight>
  <Documents>
    <NewDocumentItem>
      <FileData>sample string 2</FileData>
      <OriginalFileName>sample string 1</OriginalFileName>
    </NewDocumentItem>
    <NewDocumentItem>
      <FileData>sample string 2</FileData>
      <OriginalFileName>sample string 1</OriginalFileName>
    </NewDocumentItem>
  </Documents>
  <DropOff>true</DropOff>
  <Height>1</Height>
  <HoldForPickup>true</HoldForPickup>
  <IsDangerousGoods>true</IsDangerousGoods>
  <Length>1</Length>
  <NotifyConseeArrived>true</NotifyConseeArrived>
  <NotifyConseeChangeQdt>true</NotifyConseeChangeQdt>
  <NotifyConseeConfirmed>true</NotifyConseeConfirmed>
  <NotifyConseeDelivered>true</NotifyConseeDelivered>
  <NotifyConseeDepToAp>true</NotifyConseeDepToAp>
  <NotifyConseeDeparted>true</NotifyConseeDeparted>
  <NotifyConseeDispatched>true</NotifyConseeDispatched>
  <NotifyConseeDropped>true</NotifyConseeDropped>
  <NotifyConseeObcCheckin>true</NotifyConseeObcCheckin>
  <NotifyConseeOrderAck>true</NotifyConseeOrderAck>
  <NotifyConseeOrderRouted>true</NotifyConseeOrderRouted>
  <NotifyConseeOrigQdt>true</NotifyConseeOrigQdt>
  <NotifyConseeOutForDelivery>true</NotifyConseeOutForDelivery>
  <NotifyConseePickedUp>true</NotifyConseePickedUp>
  <NotifyConseeRecovered>true</NotifyConseeRecovered>
  <NotifyShipperArrived>true</NotifyShipperArrived>
  <NotifyShipperChangeQdt>true</NotifyShipperChangeQdt>
  <NotifyShipperConfirmed>true</NotifyShipperConfirmed>
  <NotifyShipperDelivered>true</NotifyShipperDelivered>
  <NotifyShipperDepToAp>true</NotifyShipperDepToAp>
  <NotifyShipperDeparted>true</NotifyShipperDeparted>
  <NotifyShipperDispatched>true</NotifyShipperDispatched>
  <NotifyShipperDropped>true</NotifyShipperDropped>
  <NotifyShipperObcCheckin>true</NotifyShipperObcCheckin>
  <NotifyShipperOrderAck>true</NotifyShipperOrderAck>
  <NotifyShipperOrderRouted>true</NotifyShipperOrderRouted>
  <NotifyShipperOrigQdt>true</NotifyShipperOrigQdt>
  <NotifyShipperOutForDelivery>true</NotifyShipperOutForDelivery>
  <NotifyShipperPickedUp>true</NotifyShipperPickedUp>
  <NotifyShipperRecovered>true</NotifyShipperRecovered>
  <OtherReference1>sample string 51</OtherReference1>
  <OtherReference2>sample string 52</OtherReference2>
  <OtherReference3>sample string 53</OtherReference3>
  <OtherReference4>sample string 54</OtherReference4>
  <OtherReference5>sample string 55</OtherReference5>
  <OtherReference6>sample string 56</OtherReference6>
  <OtherReference7>sample string 57</OtherReference7>
  <OtherReference8>sample string 58</OtherReference8>
  <PackagingTypeGUID_Inner>sample string 109</PackagingTypeGUID_Inner>
  <PackagingTypeGUID_Outer>sample string 108</PackagingTypeGUID_Outer>
  <PickupAddress1>sample string 7</PickupAddress1>
  <PickupAddress2>sample string 8</PickupAddress2>
  <PickupAddress3>sample string 9</PickupAddress3>
  <PickupAddressCode>sample string 5</PickupAddressCode>
  <PickupAfterHoursNumber>sample string 17</PickupAfterHoursNumber>
  <PickupCityName>sample string 10</PickupCityName>
  <PickupCompanyName>sample string 6</PickupCompanyName>
  <PickupCountryID>sample string 13</PickupCountryID>
  <PickupEmailAddress>sample string 18</PickupEmailAddress>
  <PickupFaxNumber>sample string 16</PickupFaxNumber>
  <PickupInstructions>sample string 22</PickupInstructions>
  <PickupKeep>true</PickupKeep>
  <PickupPersonToSee>sample string 14</PickupPersonToSee>
  <PickupPhoneNumber>sample string 15</PickupPhoneNumber>
  <PickupPostalCode>sample string 12</PickupPostalCode>
  <PickupReadyDateTime>sample string 20</PickupReadyDateTime>
  <PickupReadyNow>true</PickupReadyNow>
  <PickupStateProvID>sample string 11</PickupStateProvID>
  <PieceDetail>
    <NewPieceItem>
      <CarrierToProvideDryIce>true</CarrierToProvideDryIce>
      <CarrierToProvideGelPack>true</CarrierToProvideGelPack>
      <Contents>sample string 2</Contents>
      <DeclaredValue>1</DeclaredValue>
      <DeclaredValueCurrencyID>sample string 6</DeclaredValueCurrencyID>
      <DgAuthorization>sample string 17</DgAuthorization>
      <DgCommodityClass>sample string 12</DgCommodityClass>
      <DgDryIceWeight>1</DgDryIceWeight>
      <DgGelPackCount>1</DgGelPackCount>
      <DgPackagingGroup>sample string 14</DgPackagingGroup>
      <DgPackingInstr>sample string 16</DgPackingInstr>
      <DgProperName>sample string 13</DgProperName>
      <DgQuantityAndPackType>sample string 15</DgQuantityAndPackType>
      <DgUNNumber>sample string 11</DgUNNumber>
      <DimWeight>1</DimWeight>
      <Height>1</Height>
      <IsDangerousGoods>true</IsDangerousGoods>
      <IsRadioactive>true</IsRadioactive>
      <ItemSKU>sample string 1</ItemSKU>
      <ItemValue>1</ItemValue>
      <Length>1</Length>
      <PackagingTypeGUID_Inner>sample string 8</PackagingTypeGUID_Inner>
      <PackagingTypeGUID_Outer>sample string 7</PackagingTypeGUID_Outer>
      <Quantity>1</Quantity>
      <Reference>sample string 3</Reference>
      <SizeUOM>sample string 5</SizeUOM>
      <Weight>1</Weight>
      <WeightUOM>sample string 4</WeightUOM>
      <Width>1</Width>
    </NewPieceItem>
    <NewPieceItem>
      <CarrierToProvideDryIce>true</CarrierToProvideDryIce>
      <CarrierToProvideGelPack>true</CarrierToProvideGelPack>
      <Contents>sample string 2</Contents>
      <DeclaredValue>1</DeclaredValue>
      <DeclaredValueCurrencyID>sample string 6</DeclaredValueCurrencyID>
      <DgAuthorization>sample string 17</DgAuthorization>
      <DgCommodityClass>sample string 12</DgCommodityClass>
      <DgDryIceWeight>1</DgDryIceWeight>
      <DgGelPackCount>1</DgGelPackCount>
      <DgPackagingGroup>sample string 14</DgPackagingGroup>
      <DgPackingInstr>sample string 16</DgPackingInstr>
      <DgProperName>sample string 13</DgProperName>
      <DgQuantityAndPackType>sample string 15</DgQuantityAndPackType>
      <DgUNNumber>sample string 11</DgUNNumber>
      <DimWeight>1</DimWeight>
      <Height>1</Height>
      <IsDangerousGoods>true</IsDangerousGoods>
      <IsRadioactive>true</IsRadioactive>
      <ItemSKU>sample string 1</ItemSKU>
      <ItemValue>1</ItemValue>
      <Length>1</Length>
      <PackagingTypeGUID_Inner>sample string 8</PackagingTypeGUID_Inner>
      <PackagingTypeGUID_Outer>sample string 7</PackagingTypeGUID_Outer>
      <Quantity>1</Quantity>
      <Reference>sample string 3</Reference>
      <SizeUOM>sample string 5</SizeUOM>
      <Weight>1</Weight>
      <WeightUOM>sample string 4</WeightUOM>
      <Width>1</Width>
    </NewPieceItem>
  </PieceDetail>
  <Pieces>47</Pieces>
  <Quantity>1</Quantity>
  <Reference>sample string 50</Reference>
  <ServiceGUID>sample string 59</ServiceGUID>
  <ShipperEmail>sample string 45</ShipperEmail>
  <ShipperName>sample string 43</ShipperName>
  <ShipperPhone>sample string 44</ShipperPhone>
  <TextNotifyDelivery>true</TextNotifyDelivery>
  <TextNotifyPickup>true</TextNotifyPickup>
  <TextPhoneNumber>sample string 105</TextPhoneNumber>
  <Weight>48</Weight>
  <Width>1</Width>
  <auth>sample string 1</auth>
</ShipParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShipResp

Name	Description	Type	Additional information
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
ShipmentNumber	Unique external shipment number	integer	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<ShipResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <ShipmentNumber>3</ShipmentNumber>
</ShipResp>