Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

LocationDetail Type

Indicates the address details and other specifics of a FedEx location.

Remarks

This type contains the results of a search made with the FindLocations method. The fields contained by this type are listed below.

Fields

AcceptedCurrency
String

The currency that is accepted at this FedEx location. This is populated when FindLocations is called.

Attributes
Integer

This specifies what type of services this FedEx location provides. This is populated when FindLocations is called.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:

ValueMeaning
0x00000001 (AcceptsCash) Whether this location accepts cash
0x00000002 (AlreadyOpen) Whether this location is already open
0x00000004 (CopyAndPrintServices) Whether this location offers Copy and Print services
0x00000008 (DangerousGoodsServices) Whether this location offers dangerous goods services
0x00000010 (DirectMailServices) Whether this location offers Direct Mail services
0x00000020 (ExpressFreightDropoffs) Whether this location offers Express freight dropoff services
0x00000040 (ExpressParcelDropoffs) Whether this location offers Express parcel dropoff services
0x00000080 (FedExFreightDropoffs) Whether this location offers FedEx Freight dropoff services
0x00000100 (GroundDropoffs) Whether this location offers Ground dropoff services
0x00000200 (GroundHomeDeliveryDropoffs) Whether this location offers Ground Home Delivery dropoff services
0x00000400 (LocationIsInAirport) Whether this location is located in an airport
0x00000800 (NotaryServices) Whether this location offers Notary services
0x00001000 (ObservesDayLightSavingTimes) Whether this location observes day light savings time
0x00002000 (OpenTwentyFourHours) Whether this location is open 24 hours
0x00004000 (PackagingSupplies) Whether this location offers packaging supplies
0x00008000 (PackAndShip) Whether this location offers Pack and Ship services
0x00010000 (PassportPhotoServices) Whether this location offers passport photo services
0x00020000 (ReturnServices) Whether this location offers return services
0x00040000 (SaturdayDropoffs) Whether this location offers Saturday dropoff services
0x00080000 (SaturdayExpressHoldAtLocation) Whether this location offers Saturday Express Hold at Location services
0x00100000 (SignsAndBannersService) Whether this location offers Signs and Banners services
0x00200000 (SonyPictureStation) Whether this location has a Sony picture station
0x00400000 (VideoConferencing) Whether this location offers video conferencing services
0x00800000 (WeekdayExpressHoldAtLocation) Whether this location offers Weekday Express Hold at Location services
0x01000000 (WeekdayGroundHoldAtLocation) Whether this location offers Weekday Ground Hold at Location services

CarrierCount
Integer

This contains the number of Carriers returned for the current location. This is populated after a call to FindLocations.

CarrierEffectiveLatestDropoffCount
Integer

This contains the total number of effective latest dropoff times that were returned for the carrier specified by CarrierIndex.

CarrierEffectiveLatestDropoffDayOfWeek
String

This contains the day of the week for the current effective latest dropoff. This is populated when CarrierNormalLatestDropoffIndex is set.

CarrierEffectiveLatestDropoffIndex
Integer

This specifies the index for the effective latest dropoff time for the carrier specified by CarrierIndex. When CarrierIndex is set, this gets set to 0.

CarrierEffectiveLatestDropoffTime
String

This contains the current carrier's effective dropoff time for the specified day. This is populated when CarrierEffectiveLatestDropoffIndex is set.

CarrierExceptionalLatestDropoffCount
Integer

This contains the total number of exceptional latest dropoff times that were returned for the carrier specified by CarrierIndex.

CarrierExceptionalLatestDropoffDayOfWeek
String

This contains the day of the week for the current exceptional latest dropoff. This is populated when CarrierExceptionalLatestDropoffIndex is set.

CarrierExceptionalLatestDropoffIndex
Integer

This specifies the index for the exceptional latest dropoff time for the carrier specified by CarrierIndex. When CarrierIndex is set, this gets set to 0.

CarrierExceptionalLatestDropoffTime
String

This contains the current carrier's exceptional dropoff time for the specified day. This is populated when CarrierExceptionalLatestDropoffIndex is set.

CarrierIndex
Integer

This contains the current index for the array of carriers that were returned for the current location.

CarrierNormalLatestDropoffCount
Integer

This contains the total number of normal latest dropoff times that were returned for the carrier specified by CarrierIndex.

CarrierNormalLatestDropoffDayOfWeek
String

This contains the day of the week for the current normal latest dropoff. This is populated when CarrierNormalLatestDropoffIndex is set.

CarrierNormalLatestDropoffIndex
Integer

This specifies the index for the normal latest dropoff time for the carrier specified by CarrierIndex. When CarrierIndex is set, this gets set to 0.

CarrierNormalLatestDropoffTime
String

This contains the current carrier's normal dropoff time for the specified day. This is populated when CarrierNormalLatestDropoffIndex is set.

CarrierType
CarrierTypes

This contains the type of carrier the current carrier is. This is populated when CarrierIndex is set.

The possible values are as follows:

ValueDescription
lctFDXC (0) FedEx Cargo
lctFDXE (1) FedEx Express
lctFDXG (2) FedEx Ground
lctFXCC (3) FedEx Custom Critical
lctFXFR (4) FedEx Freight
lctFXSP (5) FedEx Smart Post

CarrierTypeDescription
String

The textual description of the rfCarrierType;. This is populated when CarrierIndex is set.

City
String

Name of the city that the current location is in.

CompanyName
String

The name of the business at this FedEx location. This is populated when FindLocations is called.

CountryCode
String

This contains the country code for the current location. This is populated when FindLocations is called.

EffectiveHoursCount
Integer

This contains the number of effective hours that were returned for the current location. This is populated after a call to FindLocations.

EffectiveHoursDayOfWeek
String

This contains the day of the week for which the effective hours are being specified. This is populated when EffectiveHoursIndex is set.

EffectiveHoursDescription
String

This contains the description for the effective hours, specified by EffectiveHoursIndex, for the current location.

EffectiveHoursIndex
Integer

This specifies the current index for the array containing the current location's effective hours.

EffectiveHoursOperationalHours
String

This contains the time range for the effective hours, specified by EffectiveHoursIndex, that the current location is open.

Email
String

The email address provided for the current location. This is populated when FindLocations is called.

EntityId
String

The entity ID for the current location. This is populated when FindLocations is called.

ExceptionalHoursCount
Integer

This contains the number of exceptional hours that were returned for the current location. This is populated after a call to FindLocations.

ExceptionalHoursDayOfWeek
String

This contains the day of the week for which the exceptional hours are being specified. This is populated when ExceptionalHoursIndex is set.

ExceptionalHoursDescription
String

This contains the description for the exceptional hours, specified by ExceptionalHoursIndex, for the current location.

ExceptionalHoursIndex
Integer

This specifies the current index for the array containing the current location's exceptional hours.

ExceptionalHoursOperationalHours
String

This contains the time range for the exceptional hours, specified by ExceptionalHoursIndex, that the current location is open.

Fax
String

This contains the fax number for the current location. This is populated when FindLocations is called.

GeographicCoordinates
String

This contains the geographic coordinates of the current location. This is populated when FindLocations is called.

The latitude and longitude will be specified in decimal format and separated by a comma. For example 35.912366,-78.939459

HolidayCount
Integer

This contains the number of holidays that the current FedEx location observes.

HolidayDate
String

This is the date of the holiday specified by HolidayIndex.

HolidayIndex
Integer

This contains the index of the current holiday the FedEx location observes.

HolidayName
String

This contains the name of the holiday specified by HolidayIndex.

Id
String

Business identifier that can be used by IRV attendant to look directions to this FedEx location. This is populated when FindLocations is called.

MapURL
String

This contains the URL to the google map showing the location.

NormalHoursCount
Integer

This contains the number of normal hours that were returned for the current location. This is populated after a call to FindLocations.

NormalHoursDayOfWeek
String

This contains the day of the week for which the normal hours are being specified. This is populated when NormalHoursIndex is set.

NormalHoursDescription
String

This contains the description for the normal hours, specified by NormalHoursIndex, that the current location is open.

NormalHoursIndex
Integer

This specifies the current index for the array containing the current location's normal hours.

NormalHoursOperationalHours
String

This contains the time range for the normal hours, specified by NormalHoursIndex, that the current location is open.

PersonName
String

The name of the person listed as the contact for the current location. This is populated after a call to FindLocations.

Phone
String

The phone number for the current location. This is populated after a call to FindLocations.

SpecialInstructions
String

This contains any special instructions provided for the current location. This is populated after a call to FindLocations.

State
String

State or province code of the current location. This is populated after a call to FindLocations.

StoreNumber
Integer

The store number for the current location. This is populated after a call to FindLocations.

StreetAddress
String

Street address or intersection of this FedEx location. This is populated after a call to FindLocations.

Type
FedExLocationTypes

The type of this FedEx location. This is populated after a call to FindLocations.

Possible values are as follows:

Value Description
fltAuthorizedShipCenter (0) Authorized Ship Center
fltExpressStation (1) Express Station
fltFreightServiceCenter (2) Freight Service Center
fltGroundTerminal (3) Ground Terminal
fltHomeDeliveryStation (4) Home Delivery Station
fltFedExOffice (5) FedEx Office
fltSelfServiceStation (6) Self Service Station
fltSmartPostHub (7) Smart Post Hub

ZipCode
String

The postal code for the current location. This is populated after a call to FindLocations.

Constructors

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0