Shipment Parameters

Quick Reference

Parameter Required Values
verifyAddress Yes validate,nonvalidate
debugMode Yes 0,1 Controls testing vs. production enviornments
shipper Yes Your Name or Company Name
shipContact Cond Shipper contact name
shipPhone No Shipper contact phone number
shipmentDescription Cond Specific descriptions
signatureType No 1, 2, 3 - See Below for descriptions
returnCode Yes* 8, 9, etc.
accountNumber Yes Shipper’s 6 digit account number
pickupType Yes 01 for Daily Pickup for more see pickupType below
shipAddr1 Yes The address of the shipper
shipAddr2 No Eg. Suite 10
shipCity Yes Shipper’s City
shipState Cond Shipper’s state or province code
shipCode Cond Shipper’s postal code
toCompany Cond Recipient company name
toName Cond Recipient contact name
toAttentionName Cond Recipient attention name
toAddr1 Yes Recipient Address Line 1
toAddr2 No The second line of the recipient’s address
toCity Yes Recipient City
toState Cond Recipient state or province
toCode Cond Recipient postal code
toCountry Yes Recipient two-character country code
fromName Yes* Pickup location’s company/contact name
fromAddr1 Yes* Address line 1 of the pickup location
fromAddr2 No Address line 2 of the pickup location
fromAddr3 No Address line 3 of the pickup location
fromCity Yes* Pickup location’s city
fromState Cond State/province code of pickup location
fromCode Cond Pickup location’s postal code fromCountry Cond Pickup location’s two-letter country code
service Yes UPS Service type
serviceDescription No Description of service code
labelPrintMethodCode Yes Label print method code that labels are to be generated
labelDescription No Description of label code
lengthUnit Yes IN, CM
labelImageFormat Cond Must be set to GIF if labelPrintMethodCode is set to GIF
referenceCode No See Below
referenceValue No See Below
referenceCode2 No See Below
referenceValue2 No See Below
dropoffType Yes See Below
largePackage No true, set to blank to unset
billThirdParty No Set to true for third party billing
thirdPartyAccount Yes* Required if billThirdParty is enabled
thirdPartyPostalCode Yes* Required if billThirdParty is enabled
thirdPartyCountryCode Yes* Required if billThirdParty is enabled

debugMode

Debug mode is used primarily for changing the URL RocketShipIt uses from testing servers to production servers.

signatureType

Value Description
1 Delivery Confirmation
2 Signature Required
3 Adult Signature Required

pickupType

Used for telling RocketShipIt how you are going to deliver the package to the carrier.

UPS

Value Description
01 Daily Pickup
03 Customer Counter
06 One Time Pickup
07 On Call Air
11 Suggested Retail Rates
19 Letter Center
20 Air Service Center

referenceCode

Used for setting reference values to be printed on the label. A pair is necssary, referenceCode and referenceValue.

Note

Some of these reference values are cut off at 35 characters, if you need a longer reference value use ‘02’ as the referenceCode parameter.

UPS

Value Description
AJ Accounts Receivable Customer Account
AT Appropriation Number
BM Bill of Lading Number
9V Collect on Delivery (COD) Number
ON Dealer Order Number
DP Department Number
3Q Food and Drug Administration (FDA) Product Code
IK Invoice Number
MK Manifest Key Number
MJ Model Number
PM Part Number
PC Production Code
PO Purchase Order Number
RQ Purchase Request Number
RZ Return Authorization Number
SA Salesperson Number
SE Serial Number
ST Store Number
TN Transaction Reference Number

service

UPS

Value Description
01 UPS Next Day Air
02 UPS 2nd Day Air
03 UPS Ground
07 UPS Worldwide Express
08 UPS Worldwide Expedited
11 UPS Standard
12 UPS 3 Day Select
13 UPS Next Day Air Saver
14 UPS Next Day Air Early AM
54 UPS Worldwide Express Plus
59 UPS Second Day Air AM
65 UPS Worldwide Saver
M2 UPS First-Class Mail
M3 UPS Priority Mail
M4 UPS Expedited Mail Innovations
M5 UPS Priority Mail Innovations
M6 UPS Economy Mail Innovations

FedEx

Value Description
EUROPE_FIRST_INTERNATIONAL_PRIORITY Europe First International Priority
FEDEX_2_DAY FedEx 2 Day
FEDEX_2_DAY_AM FedEx 2Day A.M.
FEDEX_EXPRESS_SAVER FedEx Express Saver
FEDEX_GROUND FedEx Ground
FIRST_OVERNIGHT FedEx First Overnight
GROUND_HOME_DELIVERY FedEx Home Delivery (Must mark as residential)
INTERNATIONAL_ECONOMY FedEx International Economy
INTERNATIONAL_FIRST FedEx First
INTERNATIONAL_PRIORITY FedEx International Priority
PRIORITY_OVERNIGHT FedEx Priority Overnight
SMART_POST FedEx Smart Post
STANDARD_OVERNIGHT FedEx Standard Overnight
FEDEX_FREIGHT Fedex Freight
FEDEX_1_DAY_FREIGHT FedEx 1 Day Freight
FEDEX_2_DAY_FREIGHT FedEx 2 Day Freight
FEDEX_3_DAY_FREIGHT FedEX 3 Day Freight
FEDEX_NATIONAL_FREIGHT FedEx National Freight
INTERNATIONAL_ECONOMY_FREIGHT FedEx International Economy Freight
INTERNATIONAL_PRIORITY_FREIGHT FedEx International Priority Freight

USPS

Value Description
US-FC USPS First-Class Mail
US-MM USPS Media Mail
US-PP USPS Parcel Post
US-PM USPS Priority Mail
US-XM USPS Express Mail
US-EMI USPS Express Mail International
US-PMI USPS Priority Mail International
US-FCI USPS First Class Mail International

DHL

Value Description
0 LOGISTICS SERVICES
1 CUSTOMS SERVICES
2 EASY SHOP
3 EASY SHOP
4 JETLINE
5 SPRINTLINE
6 SECURELINE
7 EXPRESS EASY EXPRESS EASY XED Y-Doc
8 EXPRESS EASY EXPRESS EASY XEP N-Non Doc
9 EUROPACK
A AUTO REVERSALS
B BREAK BULK EXPRESS
C MEDICAL EXPRESS
D EXPRESS WORLDWIDE
E EXPRESS
F FREIGHT WORLDWIDE
G DOMESTIC ECONOMY
H ECONOMY SELECT
I BREAK BULK ECONOMY
J JUMBO BOX
K EXPRESS 9:00 EXPRESS 9:00 TDK Y-Doc
L EXPRESS 10:30 EXPRESS 10:30 TDL Y-Doc
M EXPRESS 10:30 EXPRESS 10:30 TDM N-Non Doc
N DOMESTIC EXPRESS
O OTHERS
P EXPRESS WORLDWIDE EXPRESS WORLDWIDE WPX N-Non Doc
Q MEDICAL EXPRESS MEDICAL EXPRESS WMX N-Non Doc
R GLOBALMAIL BUSINESS GLOBALMAIL BUSINESS GMB Y-Doc
S SAME DAY SAME DAY SDX Y-Doc
T EXPRESS 12:00 EXPRESS 12:00 TDT Y-Doc
U EXPRESS WORLDWIDE EXPRESS WORLDWIDE ECX Y-Doc
V EUROPACK EUROPACK EPP N-Non Doc
W ECONOMY SELECT ECONOMY SELECT ESU Y-Doc
X EXPRESS ENVELOPE EXPRESS ENVELOPE XPD Y-Doc
Y EXPRESS 12:00 EXPRESS 12:00 TDY N-Non Doc
Z DESTINATION CHARGES DESTINATION

CanadaPost

Value Description
Domestic  
DOM.RP Regular Parcel
DOM.EP Expedited Parcel
DOM.XP Xpresspost
DOM.PC Priority
USA  
USA.PW.ENV Priority Worldwide Envelope USA
USA.PW.PAK Priority Worldwide pak USA
USA.XP Xpresspost USA
USA.EP Expedited Parcel USA
USA.SP.AIR Small Packet USA Air
USA.TP Tracked Packet – USA
International  
INT.PW.ENV Priority Worldwide Envelope Int’l
INT.PW.PAK Priority Worldwide pak Int’l
INT.PW.PARCEL Priority Worldwide parcel Int’l
INT.XP Xpresspost International
INT.SP.AIR Small Packet International Air
INT.SP.SURF Small Packet International Surface
INT.TP Tracked Packet – International

imageType

FedEx

Value Description
PNG PNG Image
PDF PDF
DPL Thermal Printing
EPL2 Thermal Printing
ZPLII Thermal Printing

USPS

Value Description
gif GIF Image
pdf PDF
png PNG Image
jpg JPEG Image
epl Thermal Printing

Stamps.com

Note

These are case sensitive. RocketShipIt will try and convert them to the proper format if you forget.

Value Description
Gif GIF Image
Png PNG Image
Jpg JPEG Image
Pdf PDF
PrintOncePdf PDF
EncryptedPngUrl PNG Image
Zpl Thermal Printing
Epl Thermal Printing
Auto Auto

dropoffType

FedEx

Value Description
REGULAR_PICKUP Regular Pickup
REQUEST_COURIER Request Courier
DROP_BOX Drop Box
BUSINESS_SERVICE_CENTER Business Service Center
STATION Station

labelStockType

  • PAPER_4X6
  • PAPER_4X8
  • PAPER_4X9
  • PAPER_7X4.75
  • PAPER_8.5X11_BOTTOM_HALF_LABEL
  • PAPER_8.5X11_TOP_HALF_LABEL
  • STOCK_4X6
  • STOCK_4X6.75_LEADING_DOC_TAB
  • STOCK_4X6.75_TRAILING_DOC_TAB
  • STOCK_4X8
  • STOCK_4X9_LEADING_DOC_TAB
  • STOCK_4X9_TRAILING_DOC_TAB

customsContentType

USPS

  • Commercial Sample
  • Gift
  • Document
  • Other

packagingType

Stamps.com

  • Large Envelope or Flat
  • Thick Envelope
  • Package
  • Flat Rate Box
  • Small Flat Rate Box
  • Large Flat Rate Box
  • Flat Rate Envelope
  • Large Package
  • Oversize Package
  • Regional Rate Box A
  • Regional Rate Box B
  • Legal Flat Rate Envelope
  • Regional Rate Box C

DHL

Value Description
BD Jumbo Document
BP Jumbo Parcel
CP Customer-provided
DC Document
DF DHL Flyer
DM Domestic
ED Express Document
EE DHL Express Envelope
FR Freight
JB Jumbo box
JD Jumbo Junior Document
JJ Junior jumbo Box
JP Jumbo Junior Parcel
OD Other DHL Packaging
PA Parcel
YP Your packaging