4D Shipping SDK 2020 .NET Edition
4D Shipping SDK 2020 .NET Edition
Questions / Feedback?

ServiceDetail Type

Indicates the rates and service details of a service.

Remarks

This type represents the details (on delivery time, rates, etc.) of a service type. The fields contained by this type are listed below.

Fields

AccountBaseCharge
String

Transportation charges before surcharges and discounts applied to a ServiceType. This applies to FedEx only and is specific to the AccountNumber. After calling the GetRates method, the AccountBaseCharge will be filled with the value of discounted base charge amount specific to the AccountNumber (i.e. depending on the current rate schedule the AccountNumber is receiving from FedEx).

For Canada Post, this field will contain the base cost of the shipment before taxes (numeric 99999.99).

AccountNetCharge
String

Net charge amount applied to a ServiceType.

For FedEx, this is specific to the AccountNumber. After calling the GetRates method, the AccountNetCharge will be filled with the value of discounted net charge amount specific to the AccountNumber (i.e. depending on the current rate schedule the AccountNumber is receiving from FedEx).

For UPS, this is the value of grand total charges for account based rating applied to a shipment when using the returned ServiceType

The UPS server response will contain negotiated rate(s) only for the qualified AccountNumbers. Eligibility is determined using the combination of the UserId and AccountNumber. If the user is authorized for negotiated rates, and if negotiated rates apply to the particular service, UPS returns those rates along with the published rates in its response. Otherwise, a warning message might be returned that indicates ineligibility and only the published rates are returned in the response. For more information on negotiated rates, including authorization to receive them, please check with your UPS account representative.

This field is not used by the USPS component.

For Canada Post, this field will contain the total cost of the shipment if sent using this service including the cost of selected or required options, surcharges, discounts and taxes.

AccountTotalDiscount
String

Total discount amount applied to the shipment for a ServiceType. This is for FedEx only and is specific to the AccountNumber. After calling the GetRates method, the AccountTotalDiscount will be filled with the value of total discount applied, which is specific to the AccountNumber (i.e. depending on the current rate schedule the AccountNumber is receiving from FedEx).

For Canada Post, this field will contain the total amount of discounts.

AccountTotalSurcharge
String

Total surcharge amount for all additional services applied to a ServiceType. This is only for FedEx, and is specific to the AccountNumber. After calling the GetRates method, the AccountTotalSurcharge will be filled with the value of total surcharges applied, which is specific to the AccountNumber (i.e. depending on the current rate schedule the AccountNumber is receiving from FedEx).

For Canada Post, this field will contain the total amount of surcharges.

Aggregate
String

Aggregate of details and rates for the ServiceType in the list of available services.

BusinessDays
Integer

Number of business days from origin to destination location. This is valid only for UPS and is returned for the number of UPS business days (Monday, Tuesday, Wednesday, Thursday, Friday and Saturday) the shipment will take to travel from one location to another.

If applicable, this property is filled after a call to the GetShippingTime.

Commitments
String

Service commitments for the PackagingType when shipping to CountryCode.

This is valid only for USPS, and indicates how long it will take for the package to be delivered when shipped via PackagingType.

CustomerCenterCutoff
String

Time the UPS Customer Service Center closes.

This value is only relevant for UPS and it provides the user with the time the Customer Service Center closes. This is applicable for shipments outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

DelayDays
Integer

Number of days the shipment is delayed in customs. This is only valid for UPS requests, and is returned for requests outside the US only and when the request indicates the query is in reference to a Non-Document type of shipment.

If applicable, this property is filled after a call to the GetShippingTime.

DeliveryDate
String

This indicates the shipment delivery date for the ServiceType.

In regards to International services, the delivery date availability is limited to some postal-code supported countries. The delivery date will be returned if available. Format: YYYY-MM-DD.

For UPS, this property is filled after a call to the GetShippingTime.

This is not applicable to USPS.

For Canada Post, this field will be populated after a GetRates call and will contain the estimated date of delivery, starting from the expected mailing-date.

DeliveryDay
String

Indicates the day of the week the shipment can be delivered when using the ServiceType. Possible values are: SUN, MON, TUE, WED, THU, FRI, SAT. In regards to International services, the delivery date availability is limited to some postal-code supported countries and it will be returned if available.

For UPS, this property is filled after a call to the GetShippingTime.

This is not applicable to USPS.

DeliveryTime
String

Scheduled local delivery time. This is available only for UPS, and indicates the latest time of day the shipment will be delivered as guaranteed by UPS. Format: HH:MM:SS.

If applicable, this property is filled after a call to the GetShippingTime.

EffectiveNetDiscount
String

Indicates the net discount applied to a ServiceType. This is only valid for FedEx.

After calling the GetRates method, the EffectiveNetDiscount will be filled with the value of net discount applied. This is specific to the AccountNumber (i.e. depending on the current rate schedule the AccountNumber is receiving from FedEx). This is the difference between the list net charge and account net charge.

GuaranteedDescription
String

Textual description of a guaranteed delivery for a UPS service type in the list of available services returned. This is populated when the GetShippingTime method is called for UPS only.

This method is also populated for Canada Post after the GetRates method is called. The returned value will either be "true" or "false" to indicate whether the delivery date is guaranteed.

Holidays
Integer

Number of national holidays during transit. This is returned only for UPS when the shipment would be in transit during a national holiday. Holidays outside the US are taken into account. Returned for requests outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

IndemnityCoverage
String

Indicates the indemnity coverage available for this service. This property is valid only for USPS, and is only returned when TotalValue was sent in the request. It contains the lesser of maximum parcel indemnity coverage per given weight and TotalValue, if applicable. Otherwise it will be blank.

InsuranceComment
String

Explains why no InsuranceCost was returned in the response.

This field is only applicable to USPS.

If the TotalValue was sent in the request (indicating you wish to receive the InsuranceCost in the response), but no InsuranceCost was returned, then InsuranceComment will contain text explaining why no value was returned for InsuranceCost. It may be one of three reasons:

ValueMeaning
SERVICEInsurance is not available for this service.
DESTINATIONInsurance is not available to the given country via this service.
INSURED VALUEInsurance is available for the country and service, but not for the given value.

InsuranceCost
String

Insurance fee. This is applicable only to USPS and it describes the cost of purchasing insurance for this package.

ListBaseCharge
String

Transportation charges before surcharges and discounts applied to a ServiceType. After calling the GetRates method, the ListBaseCharge will be filled with the value of base charge amount.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

This does not apply to USPS.

ListNetCharge
String

Net charge amount applied to a ServiceType.

After calling the GetRates method, the ListNetCharge will be filled with the value of list net charge amount.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

ListTotalDiscount
String

Total discount amount applied to a ServiceType. This applies only to FedEx. After calling the GetRates method, the ListTotalDiscount will be filled with the value of total discount applied. This is returned in the server response only if the RateType is set to 0 (rtList) in the request.

ListTotalSurcharge
String

Total surcharge amount for all additional services applied to a ServiceType.

After calling the GetRates method, the ListTotalSurcharge will be filled with the value of total surcharges applied.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

This value does not apply to USPS.

MaxDimensions
String

Maximum dimensions of a package allowed when sending to the CountryCode. This is only applicable to USPS. After a call to GetRates, this property will contain the maximum allowable dimensions of a package sent to the CountryCode via the indicated ServiceType.

MaxWeight
String

Maximum weight of package allowed when sending to the CountryCode.

This is only applicable to USPS.

After a call to GetRates, this field will contain the maximum allowable weight (in pounds) of a package sent to the CountryCode via the indicated ServiceType.

Note: This field may contain a fractional quantity (eg: "0.2188", which indicates a max weight of 3.5 ounces).

PackagingType
String

The mail service type when shipping to CountryCode.

This is only valid for USPS international rate requests.

PackagingType indicates what type of shipping service is being used for each InternationalService. PackagingType may contain the following information:

PriorityPriority Mail rate.
FirstClassFirst Class rate.
ParcelPostParcel Post rate.
BPMBound Printed Matter rate (books, magazines).
MediaMedia Mail rate (CDs, movies, etc).
LibraryInter-library mail rate (not for public use).
ExpressExpress Mail rate.

RateScale
String

Applicable rate scale for the ServiceType.

The RateScale indicates the rate scale (this is specific to the AccountNumber) used by FedEx to rate a shipment when shipped via the ServiceType. This is applicable for FedEx Express services only.

RateZone
String

Applicable rate zone for the ServiceType.

The RateZone indicates the zone used by FedEx to rate a shipment (this is specific to the ZipCode) when using a FedEx Express service. This is applicable for FedEx Express services only.

RestDays
Integer

Number of days the shipment is in rest due to non-business days. Returned for UPS requests outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

ServiceType
ServiceTypes

Indicates the service type in the list of available services returned.

This is populated when the GetShippingTime or GetRates methods are called.

Valid values for FedEx are:

stUnspecified (0)
stFedExPriorityOvernight (10)
stFedExStandardOvernight (11)
stFedExFirstOvernight (12)
stFedEx2Day (13)
stFedExExpressSaver (14)
stFedExGround (15)
stFedExGroundHomeDelivery (16)
stFedEx1DayFreight (17)
stFedEx2DayFreight (18)
stFedEx3DayFreight (19)
stFedExInternationalPriority (20)
stFedExInternationalEconomy (21)
stFedExInternationalFirst (22)
stFedExInternationalPriorityFreight (23)
stFedExInternationalEconomyFreight (24)
stFedExEuropeFirstInternationalPriority (25) For intra-Europe shipments only.
stFedExSmartPost (26)
stFedEx2DayAM (27)
stFedExFirstFreight (28)
stFedExFreightEconomy (30)
stFedExFreightPriority (31)
stFedExDistanceDeferred (120) For intra-UK shipments only.
stFedExNextDayAfternoon (121) For intra-UK shipments only.
stFedExNextDayEarlyMorning (122) For intra-UK shipments only.
stFedExNextDayEndOfDay (123) For intra-UK shipments only.
stFedExNextDayFreight (124) For intra-UK shipments only.
stFedExNextDayMidMorning (125) For intra-UK shipments only.

Valid values for UPS are:

Value Applicable for
stUnspecified (0)
stUPSNextDayAir (40) US Domestic Shipments; Originating in US/PR
stUPSExpress (41) Polish Domestic Shipments; All Origins
stUPS2ndDayAir (42) US Domestic Shipments; Originating in US/PR
stUPSGround (43) US Domestic Shipments; Originating in US/PR
stUPSWorldwideExpress (44) Originating in US/PR
stUPSWorldwideExpedited (45) US/PR, Canada and Non-EU origins, EXCEPT Mexico
stUPSExpedited (46) Polish Domestic Shipments; Originating in EU or Mexico
stUPSStandard (47) Polish Domestic Shipments; All Origins
stUPS3DaySelect (48) US Domestic Shipments; Originating in CA or US
stUPSNextDayAirSaver (49) US Domestic Shipments
stUPSSaver (50) US or Polish Domestic Shipments; All Origins
stUPSNextDayAirEarlyAM (51) US Domestic Shipments; Originating in CA or US/PR
stUPSExpressEarlyAM (52) Originating in CA
stUPSWorldwideExpressPlus (53)Polish Domestic Shipments; All Origins EXCEPT Canada and Mexico
stUPSExpressPlus (54) Originating in Mexico
stUPS2ndDayAirAM (55) US Domestic Shipments; Originating in US
stUPSTodayStandard (56) Polish Domestic Shipments (Stolica)
stUPSTodayCourrier (57) Polish Domestic Shipments (Stolica)
stUPSTodayInterCity (58) Polish Domestic Shipments (Stolica)
stUPSTodayExpress (59) Polish Domestic Shipments (Stolica)
stUPSTodayExpressSaver (60) Polish Domestic Shipments (Stolica)

Note: stUPSSaver (50) is a valid option for US domestic shipment, but only when sending to remote parts of Alaska or Hawaii Note: stUPSFirstClass (35), stUPSPriorityMail (36), stUPSExpeditedMailInnovations (37), stUPSPriorityMailInnovations (38), and stUPSEconomyMailInnovations (39) will not return any rates.

Valid values for USPS are:

stUnspecified (0)
stUSPSExpress (70)
stUSPSFirstClass (71)
stUSPSPriority (72)
stUSPSParcelPost (73)
stUSPSMedia (75)
stUSPSLibrary (76)
stUSPSOnline (77) (USPS Only)
stUSPSParcelSelect (79) (Endicia only)
stUSPSCriticalMail (80) (Endicia only)
stUSPSStandardMail (81) (Endicia only)

Please note that the RequestedService stUSPSBoundPrintedMatter (74) is no longer supported by USPS or Endicia.

Valid values for Canada Post are:

stCanadaRegularParcel (90)
stCanadaExpeditedParcel (91)
stCanadaXpresspost (92)
stCanadaXpresspostCertified (93)
stCanadaPriority (94)
stCanadaPriorityEnvelopeUSA (95)
stCanadaPriorityPakUSA (96)
stCanadaPriorityParcelUSA (97)
stCanadaXpresspostUSA (98)
stCanadaExpeditedParcelUSA (99)
stCanadaSmallPacketAirUSA (100)
stCanadaSmallPacketLandUSA (101)
stCanadaPriorityEnvelopeInternational (102)
stCanadaPriorityPakInternational (103)
stCanadaPriorityParcelInternational (104)
stCanadaXpresspostInternational (105)
stCanadaSmallPacketAirInternational (106)
stCanadaSmallPacketLandInternational (107)
stCanadaParcelAirInternational (108)
stCanadaParcelLandInternational (109)

ServiceTypeDescription
String

Indicates the textual description of a service type in the list of available services returned.

Possible returned values for FedEx are:

Service Type Service Type Description
10 PRIORITY_OVERNIGHT
11 STANDARD_OVERNIGHT
12 FIRST_OVERNIGHT
13 FEDEX_2_DAY
14 FEDEX_EXPRESS_SAVER
15 FEDEX_GROUND
16 GROUND_HOME_DELIVERY
17 FEDEX_1_DAY_FREIGHT
18 FEDEX_2_DAY_FREIGHT
19 FEDEX_3_DAY_FREIGHT
20 INTERNATIONAL_PRIORITY
21 INTERNATIONAL_ECONOMY
22 INTERNATIONAL_FIRST
23 INTERNATIONAL_PRIORITY_FREIGHT
24 INTERNATIONAL_ECONOMY_FREIGHT
25 EUROPE_FIRST_INTERNATIONAL_PRIORITY
26 FEDEX_SMART_POST
27 FEDEX_2_DAY_AM
28 FEDEX_FIRST_FREIGHT
29 FEDEX_FREIGHT_ECONOMY
30 FEDEX_FREIGHT_PRIORITY
120 FEDEX_DISTANCE_DEFERRED
121 FEDEX_NEXT_DAY_AFTERNOON
122 FEDEX_NEXT_DAY_EARLY_MORNING
123 FEDEX_NEXT_DAY_END_OF_DAY
124 FEDEX_NEXT_DAY_FREIGHT
125 FEDEX_NEXT_DAY_MID_MORNING

ShipDate
String

Date UPS picks up the package from the origin. In the event the ShipDate differs from the ShipDate provided in the request, a warning message will be returned.

This is only applicable to UPS GetShippingTime.

Format: YYYY-MM-DD.

ShipTime
String

Time UPS picks up the package from the origin. It is returned for requests outside the US. If applicable, this property is filled after a call to the GetShippingTime.

This is only applicable to UPS GetShippingTime.

Format: HH:MM:SS

SignatureType
String

Indicates the textual description of the delivery signature services option required by FedEx for the ServiceType. This might be different from the requested SignatureType.

Possible returned values are:

ADULT
DIRECT
INDIRECT
NO_SIGNATURE_REQUIRED
SERVICE_DEFAULT

TransitTime
String

Expected number of days in transit from pickup to delivery for the ServiceType. This is an estimate only and depends on the customs clearance times. It is optional to be returned in the server reply.

Possible values are: ONE_DAY, TWO_DAYS, THREE_DAYS, FOUR_DAYS, FIVE_DAYS, SIX_DAYS, SEVEN_DAYS, EIGHT_DAYS, NINE_DAYS, and UNKNOWN.

Constructors

 
 
Copyright (c) 2019 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7233]