Users Guide


Carriers

These are the current supported carriers.

"USPS"
"DHL"
"PB"
"UPS"
"UPSMI"
"FEDEX"
"LANDMARK"


Services

These are the current supported services by carrier.

USPS 
"FIRSTCLASSMAIL"
"FIRSTCLASSMAILINTERNATIONAL"
"PARCELPOST"
"PRIORITYMAIL"
"EXPRESSMAIL"
"PRIORITYMAILINTERNATIONAL"
"EXPRESSMAILINTERNATIONAL"
"MEDIAMAIL"
"LIBRARYMAIL"
"RETURNSSERVICE"
"RETAILGROUND"
"PARCELSELECTGROUND"
"FIRSTCLASSPACKAGE"
"FIRSTCLASSPACKAGEINTERNATIONAL"
"SKYMAIL"

DHL 
"EXPRESS12:00DOC"
"EXPRESS12:00"
"EXPRESS9:00DOC"
"EXPRESS9:00"
"EXPRESSWORLDWIDE"
"GLOBALMAILBUSINESS"

PB 
"ECONOMY"
"ECONOMYLIGHTWEIGHT"
"PRIORITYMAIL"
"FIRSTCLASSMAIL"
"BOUNDPRINTEDMATTER"

UPS 
"2DAYAIR"
"2DAYAIRAM"
"3DAYSELECT"
"GROUND"
"NEXTDAYAIR"
"NEXTDAYAIRSAVER"
"STANDARDTOCANADA"
"STANDARDTOMEXICO"
"SUREPOST"
"SUREPOSTLETTER"
"WORLDWIDEEXPEDITED"
"WORLDWIDEEXPRESS"
"WORLDWIDEEXPRESSPLUS"
"WORLDWIDESAVER"
"EARLYAM"

UPSMI 
"FIRSTCLASSMAIL"
"PRIORITYMAIL"
"EXPEDITEDMAILINNOVATIONS"
"PRIORITYMAILINNOVATIONS"
"ECONOMYMAILINNOVATIONS"

FedEx 
"2DAY"
"2DAYAM"
"3DAY"
"EXPRESSSAVER"
"ECONOMY2DAY"
"GROUND"
"GROUNDSERVICETOCANADA"
"HOMEDELIVERY"
"INTERNATIONALECONOMY"
"INTERNATIONALPRIORITY"
"INTERNATIONALFIRST"
"SMARTPOST"
"SMARTPOSTLETTER"
"PRIORITYOVERNIGHT"
"STANDARDOVERNIGHT"
"FIRSTOVERNIGHT"
"SAVERPACKAGE3DAY"

Landmark 
"STANDARD"
"STANDARDDDU"
"EXPEDITED"
"REGULARDDU"
"INTLSTANDARDDDU"



Package Types

These are the current supported package types.

"Package"
"FlatRateEnvelope"
"LegalFlatRateEnvelope"
"PaddedFlatRateEnvelope"
"SmallFlatRateBox"
"MediumFlatRateBox"
"LargeFlatRateBox"
"LargeFlatRateBoxAPO"
"RegionalRateBoxA"
"RegionalRateBoxB"
"RegionalRateBoxC"
"SoftPack"
"Flat"
"OversizedParcel"
"Letter"
"Envelope"
"Postcard"


Shipment Options

These are the current supported shipment options.

"DELIVERY CONFIRMATION"
"SIGNATURE CONFIRMATION"
"CERTIFIED MAIL"
"HOLD FOR PICKUP"
"OPEN AND DISTRIBUTE"
"SUNDAY DELIVERY"
"HOLIDAY DELIVERY"
"RETURN RECEIPT"
"ELECTRONIC RETURN RECEIPT"
"RETURN RECEIPT FOR MERCHANDISE"
"FRAGILE"
"ADULT SIGNATURE REQUIRED"
"ADULT SIGNATURE RESTRICTED DELIVERY"
"DIRECT SIGNATURE REQUIRED"
"INDIRECT SIGNATURE REQUIRED"
"SERVICE DEFAULT SIGNATURE"
"AM DELIVERY"
"RESTRICTED DELIVERY"
"REGISTERED MAIL"
"REGISTERED MAIL AMOUNT"
"INSURE SHIPMENT"
"INSURE SHIPMENT AMOUNT"
"COLLECT ON DELIVERY"
"COLLECT ON DELIVERY AMOUNT"
"HAZMAT"
"HAZMAT DESCRIPTION"
"HAZMAT PHONENUMBER"
"COMMERCIAL INVOICE"
"PLT"
"RETURN LABEL"
"CUSTOM TEXT 1"
"CUSTOM TEXT 2"
"CUSTOM TEXT 3"
"BILL TO PARTY TYPE"
"BILL TO ACCOUNT NUMBER"
"BILL TO COUNTRY CODE"
"BILL TO POSTAL CODE"
"DUTY DELIVERY PAYER"
"DUTY DELIVERY PAYER ACCOUNT NUMBER"
"DUTY DELIVERY PAYER COUNTRY CODE"
"DUTY DELIVERY PAYER POSTAL CODE"

Note:

  • The three "Custom Text" options are available and displayed on the label based on the carrier or USPS broker specifications.



Tracking Action Status Codes

These are the current action status codes for tracking shipments.

"Unknown"
"ReadyForPickup"
"OrigenScan"
"DepartureScan"
"Arrival"
"DestinationScan"
"Delivered"
"Delayed"
"Refused"
"DeliveryAttempted"
"PickupAtCarrierFacility"
"PickupDelayed"
"DeliveryFailedReturning"
"BadDeliveryAddressDelay"
"SenderStopped"
"LostPackage"
"HoldForFutureDelivery"
"OutForDelivery"
"WeatherDelay"
"DamageInTransit"
"InTransit"
"VoidInfoReceived"
"CannotDeliverToPOBox"
"PickupScan"
"ReceivedByLocalPostOffice"
"TransferredToLocalPostOffice"
"ImportScan"
"ExportScan"
"CarrierChangedDelivery"
"ArrivedAtCarrierFacility"
"DepartedCarrierFacility"
"ShippingInfoSentToCarrier"
"Undeliverable"
"Pending"
"Voided"


Get Shipment Status Codes

These are the current shipment status codes for USPS when PackageHub Wallet is used:

"Processed"
"RefundInitiated"
"RefundApproved"
"RefundRejected"
"Refunded"

Otherwise the following shipment status codes will be available:

"Processed"
"Refunded"

Detailed description for each shipment status:

  • Processed: The shipment was successfully created on the carrier, a label was returned and is ready for shipping.
  • RefundInitiated: The shipment was successfully sent to the carrier for cancellation.
  • RefundApproved: The shipment was canceled correctly on the carrier but the refund has not been processed yet.
  • RefundRejected: The refund was denied because the carrier has detected the shipment in transit.
  • Refunded: The shipment was canceled correctly and it has been refunded.


Billing To Party Type

These are the current values valid for the Billing To Party Type option:

"Sender"
"Recipient"
"ThirdParty"

Note:

  • Bill to party type shipping options can be used on UPS, DHL and FedEx.
  • BILL TO PARTY TYPE is not required and by default Sender will be set
  • BILL TO ACCOUNT NUMBER is not required to BILL TO PARTY TYPE Sender and by default the account number of the account used will be taken, on the other hand for Recipient and Third party is required
  • BILL TO COUNTRY CODE and BILL TO POSTAL CODE are required to UPS



Duty Delivery Payer Options

These are the current values valid for the Duty Delivery Payer option:

"Sender"
"Recipient"
"ThirdParty"

Note:

  • Delivery duty payer shipping options can be used on UPS, DHL and FedEx.
  • DUTY DELIVERY PAYER is not required and by default Sender will be set
  • DUTY DELIVERY PAYER ACCOUNT NUMBER is not required to DUTY DELIVERY PAYER Sender and Recipient and by default the account number of the account used will be taken to Sender, on the other hand for Third party is required
  • DUTY DELIVERY PAYER COUNTRY CODE and DUTY DELIVERY PAYER POSTAL CODE are required to UPS