POST api/Ship/GetAvailableServices

Use this method to get a list of available services and estimated rates

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
AccountNumber	Account number	string	Required Max length: 20
PickupAddressCode	An address code used to identify the pickup address	string	Max length: 15
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
DeliveryAddressCode	An address code used to identify the delivery address	string	Max length: 15
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
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
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
DeclaredValue	Declared value of shipment	decimal number	Range: inclusive between 1 and 999999
DeclaredValueCurrencyID	Current of declared value (ie. USD)	string	Max length: 3
DistanceUOM	The distance unit of measure (MI=mile, KM=kilometers)	string	Max length: 2
PieceDetail	Contains the detail information regarding a piece (use only when multiple piece shipment)	Collection of Piece	None.

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "AccountNumber": "sample string 2",
  "PickupAddressCode": "sample string 3",
  "PickupCityName": "sample string 4",
  "PickupStateProvID": "sample string 5",
  "PickupPostalCode": "sample string 6",
  "PickupCountryID": "sample string 7",
  "DeliveryAddressCode": "sample string 8",
  "DeliveryCityName": "sample string 9",
  "DeliveryStateProvID": "sample string 10",
  "DeliveryPostalCode": "sample string 11",
  "DeliveryCountryID": "sample string 12",
  "Pieces": 13,
  "Weight": 14.0,
  "WeightUOM": "sample string 15",
  "Length": 16,
  "Width": 17,
  "Height": 18,
  "SizeUOM": "sample string 19",
  "ReadyDate": "sample string 20",
  "ReadyTime": "sample string 21",
  "DeclaredValue": 22.0,
  "DeclaredValueCurrencyID": "sample string 23",
  "DistanceUOM": "sample string 24",
  "PieceDetail": [
    {
      "Weight": 1.0,
      "WeightUOM": "sample string 1",
      "Length": "sample string 2",
      "Width": "sample string 3",
      "Height": "sample string 4",
      "SizeUOM": "sample string 5",
      "Contents": "sample string 6",
      "Reference": "sample string 7",
      "DeclaredValue": 1.0,
      "DeclaredValueCurrencyID": "sample string 8",
      "HSCode": "sample string 9",
      "CountryOfOrigin": "sample string 10",
      "TemperatureType": "sample string 11",
      "IsDangerousGoods": true,
      "IsRadioactive": true,
      "DgUNNumber": "sample string 14",
      "DgCommodityClass": "sample string 15",
      "DgProperName": "sample string 16",
      "Quantity": 1
    },
    {
      "Weight": 1.0,
      "WeightUOM": "sample string 1",
      "Length": "sample string 2",
      "Width": "sample string 3",
      "Height": "sample string 4",
      "SizeUOM": "sample string 5",
      "Contents": "sample string 6",
      "Reference": "sample string 7",
      "DeclaredValue": 1.0,
      "DeclaredValueCurrencyID": "sample string 8",
      "HSCode": "sample string 9",
      "CountryOfOrigin": "sample string 10",
      "TemperatureType": "sample string 11",
      "IsDangerousGoods": true,
      "IsRadioactive": true,
      "DgUNNumber": "sample string 14",
      "DgCommodityClass": "sample string 15",
      "DgProperName": "sample string 16",
      "Quantity": 1
    }
  ]
}

application/xml, text/xml

Sample:

<GetAvailableServiceParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper.Models">
  <AccountNumber>sample string 2</AccountNumber>
  <DeclaredValue>22</DeclaredValue>
  <DeclaredValueCurrencyID>sample string 23</DeclaredValueCurrencyID>
  <DeliveryAddressCode>sample string 8</DeliveryAddressCode>
  <DeliveryCityName>sample string 9</DeliveryCityName>
  <DeliveryCountryID>sample string 12</DeliveryCountryID>
  <DeliveryPostalCode>sample string 11</DeliveryPostalCode>
  <DeliveryStateProvID>sample string 10</DeliveryStateProvID>
  <DistanceUOM>sample string 24</DistanceUOM>
  <Height>18</Height>
  <Length>16</Length>
  <PickupAddressCode>sample string 3</PickupAddressCode>
  <PickupCityName>sample string 4</PickupCityName>
  <PickupCountryID>sample string 7</PickupCountryID>
  <PickupPostalCode>sample string 6</PickupPostalCode>
  <PickupStateProvID>sample string 5</PickupStateProvID>
  <PieceDetail>
    <Piece>
      <Contents>sample string 6</Contents>
      <CountryOfOrigin>sample string 10</CountryOfOrigin>
      <DeclaredValue>1</DeclaredValue>
      <DeclaredValueCurrencyID>sample string 8</DeclaredValueCurrencyID>
      <DgCommodityClass>sample string 15</DgCommodityClass>
      <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>
      <Quantity>1</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>
    </Piece>
    <Piece>
      <Contents>sample string 6</Contents>
      <CountryOfOrigin>sample string 10</CountryOfOrigin>
      <DeclaredValue>1</DeclaredValue>
      <DeclaredValueCurrencyID>sample string 8</DeclaredValueCurrencyID>
      <DgCommodityClass>sample string 15</DgCommodityClass>
      <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>
      <Quantity>1</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>
    </Piece>
  </PieceDetail>
  <Pieces>13</Pieces>
  <ReadyDate>sample string 20</ReadyDate>
  <ReadyTime>sample string 21</ReadyTime>
  <SizeUOM>sample string 19</SizeUOM>
  <UserGUID>sample string 1</UserGUID>
  <Weight>14</Weight>
  <WeightUOM>sample string 15</WeightUOM>
  <Width>17</Width>
</GetAvailableServiceParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetAvailableServicesResp

Name	Description	Type	Additional information
Services	List of available services	Collection of Service	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:

{
  "Services": null,
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<GetAvailableServicesResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Services i:nil="true" />
</GetAvailableServicesResp>