POST api/Shipper/ServiceLookup

Use this method to get a list of service based on parameters (or order entry screen)

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserGUID	Unique system defined user identifier	string	None.
ServiceAvailType	'A'=all services are available (default),'U'=service available is determined by UserService table, 'C'=service available is determined by account setup, 'V'=based on available service (with deadline codes)	string	None.
baseDateTime	This is the ready time of the shipment	date	None.
origCountryID	Two digit country code of origin (ie. US)	string	None.
origCityName	City name of origin	string	None.
origStateProvID	State/Province/Region code of origin	string	None.
origPostalCode	Postal code of origin	string	None.
origAirportID	Airport code of origin (optional)	string	None.
destCountryID	Two digit country code of destination (ie. US)	string	None.
destCityName	City name of destination	string	None.
destStateProvID	State/Province/Region code of destination	string	None.
destPostalCode	Postal code of destination	string	None.
destAirportID	Airport code of destination (optional)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "ServiceAvailType": "sample string 2",
  "baseDateTime": "2024-09-19T09:12:51.1192623+00:00",
  "origCountryID": "sample string 3",
  "origCityName": "sample string 4",
  "origStateProvID": "sample string 5",
  "origPostalCode": "sample string 6",
  "origAirportID": "sample string 7",
  "destCountryID": "sample string 8",
  "destCityName": "sample string 9",
  "destStateProvID": "sample string 10",
  "destPostalCode": "sample string 11",
  "destAirportID": "sample string 12"
}

application/xml, text/xml

Sample:

<ServiceParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <ServiceAvailType>sample string 2</ServiceAvailType>
  <UserGUID>sample string 1</UserGUID>
  <baseDateTime>2024-09-19T09:12:51.1192623+00:00</baseDateTime>
  <destAirportID>sample string 12</destAirportID>
  <destCityName>sample string 9</destCityName>
  <destCountryID>sample string 8</destCountryID>
  <destPostalCode>sample string 11</destPostalCode>
  <destStateProvID>sample string 10</destStateProvID>
  <origAirportID>sample string 7</origAirportID>
  <origCityName>sample string 4</origCityName>
  <origCountryID>sample string 3</origCountryID>
  <origPostalCode>sample string 6</origPostalCode>
  <origStateProvID>sample string 5</origStateProvID>
</ServiceParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ServiceResp

Name	Description	Type	Additional information
Services	The available services based on parameters supplied	Collection of ServiceItem	None.
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	Required
ErrorMessage	The error message if method call was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Services": [
    {
      "ServiceID": 1,
      "ServiceCode": "sample string 2",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "DeadlineCode": "sample string 5",
      "Deadline": "2024-09-19T09:12:51.1192623+00:00",
      "EstimatedChargeAmount": 1.0
    },
    {
      "ServiceID": 1,
      "ServiceCode": "sample string 2",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "DeadlineCode": "sample string 5",
      "Deadline": "2024-09-19T09:12:51.1192623+00:00",
      "EstimatedChargeAmount": 1.0
    }
  ],
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<ServiceResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Services>
    <ServiceItem>
      <Deadline>2024-09-19T09:12:51.1192623+00:00</Deadline>
      <DeadlineCode>sample string 5</DeadlineCode>
      <Description>sample string 4</Description>
      <EstimatedChargeAmount>1</EstimatedChargeAmount>
      <Name>sample string 3</Name>
      <ServiceCode>sample string 2</ServiceCode>
      <ServiceID>1</ServiceID>
    </ServiceItem>
    <ServiceItem>
      <Deadline>2024-09-19T09:12:51.1192623+00:00</Deadline>
      <DeadlineCode>sample string 5</DeadlineCode>
      <Description>sample string 4</Description>
      <EstimatedChargeAmount>1</EstimatedChargeAmount>
      <Name>sample string 3</Name>
      <ServiceCode>sample string 2</ServiceCode>
      <ServiceID>1</ServiceID>
    </ServiceItem>
  </Services>
</ServiceResp>