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

ServiceType Property

Identifies the domestic service to use in a ship request.

Syntax

 ezship.getServiceType([callback])
 ezship.setServiceType( serviceType, [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 getServiceType([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 setServiceType([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

This property is required to be provided in a ship request.

Valid values for FedEx are:

stFedExPriorityOvernight (10)
stFedExStandardOvernight (11)
stFedExFirstOvernight (12)
stFedEx2Day (13)
stFedExExpressSaver (14)
stFedExGround (15) PackageType should be set to Your Packaging.
stFedExGroundHomeDelivery (16) available to residential addresses only; PackageType should be set to Your Packaging.
stFedEx1DayFreight (17) PackageType should be set to Your Packaging.
stFedEx2DayFreight (18) PackageType should be set to Your Packaging.
stFedEx3DayFreight (19) PackageType should be set to Your Packaging.
stFedEx2DayAM (27)
stFedExFirstFreight (28)
stFedExFreightEconomy (30)
stFedExFreightPriority (31)
stFedExDistanceDeferred (120)
stFedExNextDayAfternoon (121)
stFedExNextDayEarlyMorning (122)
stFedExNextDayEndOfDay (123)
stFedExNextDayFreight (124)
stFedExNextDayMidMorning (125)

Valid values for UPS are:

stUPSFirstClass(35) US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSPriorityMail(36) US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSExpeditedMailInnovations(37) US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSNextDayAir (40) US Domestic Shipments
stUPS2ndDayAir (42) US Domestic Shipments
stUPSGround (43) US Domestic Shipments
stUPS3DaySelect (48) US Domestic Shipments
stUPSNextDayAirSaver (49) US Domestic Shipments
stUPSSaver (50) US Domestic Shipments, only available when shipping to remote parts of Alaska or Hawaii
stUPSNextDayAirEarlyAM (51) US Domestic Shipments
stUPS2ndDayAirAM (55) US Domestic Shipments

Valid values for USPS are:

stUSPSExpress (70)
stUSPSFirstClass (71)
stUSPSPriority (72)
stUSPSParcelPost (73)
stUSPSMedia (75)
stUSPSLibrary (76)
stUSPSParcelSelect (79) (Endicia and Stamps.com only)
stUSPSCriticalMail (80) (Endicia and Stamps.com only)
stUSPSStandardMail (81) (Endicia only)

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

This property is not available at design time.

Data Type

Integer

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