RequestedService Property

Service type for which the shipping rate is requested.

Syntax

 uspsrates.getRequestedService([callback])
 uspsrates.setRequestedService( requestedService, [callback])

Possible Values

  0 (stUnspecified), 
  10 (stFedExPriorityOvernight), 
  11 (stFedExStandardOvernight), 
  12 (stFedExFirstOvernight), 
  13 (stFedEx2Day), 
  14 (stFedExExpressSaver), 
  15 (stFedExGround), 
  16 (stFedExGroundHomeDelivery), 
  17 (stFedEx1DayFreight), 
  18 (stFedEx2DayFreight), 
  19 (stFedEx3DayFreight), 
  20 (stFedExInternationalPriority), 
  21 (stFedExInternationalEconomy), 
  22 (stFedExInternationalFirst), 
  23 (stFedExInternationalPriorityFreight), 
  24 (stFedExInternationalEconomyFreight), 
  25 (stFedExEuropeFirstInternationalPriority), 
  26 (stFedExSmartPost), 
  27 (stFedEx2DayAM), 
  28 (stFedExFirstFreight), 
  29 (stFedExInternationalGround), 
  30 (stFedExFreightEconomy), 
  31 (stFedExFreightPriority), 
  35 (stUPSFirstClass), 
  36 (stUPSPriorityMail), 
  37 (stUPSExpeditedMailInnovations), 
  38 (stUPSPriorityMailInnovations), 
  39 (stUPSEconomyMailInnovations), 
  40 (stUPSNextDayAir), 
  41 (stUPSExpress), 
  42 (stUPS2ndDayAir), 
  43 (stUPSGround), 
  44 (stUPSWorldwideExpress), 
  45 (stUPSWorldwideExpedited), 
  46 (stUPSExpedited), 
  47 (stUPSStandard), 
  48 (stUPS3DaySelect), 
  49 (stUPSNextDayAirSaver), 
  50 (stUPSSaver), 
  51 (stUPSNextDayAirEarlyAM), 
  52 (stUPSExpressEarlyAM), 
  53 (stUPSWorldwideExpressPlus), 
  54 (stUPSExpressPlus), 
  55 (stUPS2ndDayAirAM), 
  56 (stUPSTodayStandard), 
  57 (stUPSTodayCourrier), 
  58 (stUPSTodayInterCity), 
  59 (stUPSTodayExpress), 
  60 (stUPSTodayExpressSaver), 
  61 (stUPSWorldwideExpressFreight), 
  62 (stUPSSurePostLessThan1LB), 
  63 (stUPSSurePost1LBOrGreater), 
  64 (stUPSSurePostBPM), 
  65 (stUPSSurePostMedia), 
  70 (stUSPSExpress), 
  71 (stUSPSFirstClass), 
  72 (stUSPSPriority), 
  73 (stUSPSParcelPost), 
  75 (stUSPSMedia), 
  76 (stUSPSLibrary), 
  77 (stUSPSOnline), 
  78 (stUSPSGlobalExpress), 
  79 (stUSPSParcelSelect), 
  80 (stUSPSCriticalMail), 
  81 (stUSPSStandardMail), 
  82 (stUSPSExpressMailInternational), 
  83 (stUSPSFirstClassMailInternational), 
  84 (stUSPSPriorityMailInternational), 
  90 (stCanadaRegularParcel), 
  91 (stCanadaExpeditedParcel), 
  92 (stCanadaXpresspost), 
  93 (stCanadaLibrary), 
  94 (stCanadaPriority), 
  95 (stCanadaPriorityEnvelopeUSA), 
  96 (stCanadaPriorityPakUSA), 
  97 (stCanadaPriorityParcelUSA), 
  98 (stCanadaXpresspostUSA), 
  99 (stCanadaExpeditedParcelUSA), 
  100 (stCanadaSmallPacketAirUSA), 
  101 (stCanadaTrackedPacketUSA), 
  102 (stCanadaTrackedPacketLVMUSA), 
  103 (stCanadaPriorityEnvelopeInternational), 
  104 (stCanadaPriorityPakInternational), 
  105 (stCanadaPriorityParcelInternational), 
  106 (stCanadaXpresspostInternational), 
  107 (stCanadaSmallPacketAirInternational), 
  108 (stCanadaSmallPacketLandInternational), 
  109 (stCanadaParcelAirInternational), 
  110 (stCanadaParcelLandInternational), 
  111 (stCanadaTrackedPacketInternational), 
  120 (stFedExDistanceDeferred), 
  121 (stFedExNextDayAfternoon), 
  122 (stFedExNextDayEarlyMorning), 
  123 (stFedExNextDayEndOfDay), 
  124 (stFedExNextDayFreight), 
  125 (stFedExNextDayMidMorning)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getRequestedService([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setRequestedService([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

If you send a request with the RequestedService set to svcPriority, after a call to GetRates, the price to send a Priority Mail package will be returned in ServiceListNetCharge. However, if you set the RequestedService to stUnspecified, the rates for all service types will be returned.

The RequestedService is used to filter the postage rates that are returned by service type. If you are only interested in Priority Mail rates, there is no need to receive Parcel Post or Library mail, for instance. Rates will be returned in the ServiceListNetCharge array property, with the service it corresponds located in the ServiceType and ServiceTypeDescription properties.

This property is only valid for domestic shipments.

The stUnspecified value is not valid when PostageProvider is set to ppEndicia.

The available service types for USPS include:

Valid values for USPS are:

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

Please note that some ShipmentSpecialServices flags such as Hold For Pickup, Premium Service (Sunday/Holiday), and Commercial will affect the rate.

Also, please note that all ServiceListNetCharges are also dependant on the SenderZipCode, SenderZipCode (or SenderCountryCode for international shipments), PackageWeight, PackageSize and PackageType. Priority Mail packages larger than 1 cubic foot in size also require PackageLength, PackageWidth, and PackageHeight to accurately calculate the postage.

Note that when using any of the commercial service types, you must use the CommercialRate configuration setting to retrieve the commercial rate for the postage service at index i.

Data Type

Integer