Rate Parameters¶
UPS¶
PickupType¶
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 |
largePackage¶
If present, LargePackageIndicator will be set.
Example:
<?php
$package->setParameter('largePackage', 'true');
$rate->addPackageToShipment($package);
Stamps.com¶
packagingType¶
Value | Description |
---|---|
Letter | Letter. Currently unsupported. |
Large Envelope | or Flat Large envelope or flat - Has one dimension that is between 11 1⁄2” and |
Thick Envelope | 15” long, 6 1/18” and 12” high, or 1⁄4” and 3⁄4 thick. Thick envelope. Envelopes or flats greater than 3⁄4” at the thickest point. |
Flat Rate Padded Envelope | USPS flat rate padded envelope. |
Package | Package. Longest side plus the distance around the thickest part is less than or equal to 84” |
Flat Rate Box | USPS flat rate box. A special 11” x 8 1⁄2” x 5 1⁄2” or 14” x 3.5” x 12” USPS box that clearly indicates “Flat Rate Box”. |
Small Flat Rate Box | USPS small flat rate box. A special 8-5/8” x 5-3/8” x 1-5/8” USPS box that clearly indicates “Small Flat Rate Box”. |
Large Flat Rate Box | USPS large flat rate box. A special 12” x 12” x 6” USPS box that clearly indicates “Large Flat Rate Box”. |
Flat Rate Envelope | USPS flat rate envelope. A special cardboard envelope provided by the USPS that clearly indicates “Flat Rate”. |
Large Package | Large package. Longest side plus the distance around the thickest part is over 84” and less than or equal to 108”. |
Oversized Package | Oversized package. Longest side plus the distance around the thickest part is over 108” and less than or equal to 130”. |
service¶
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 |
US-CM | USPS Critical Mail |
US-PS | USPS Parcel Select |
US-LM | USPS Library Mail |
USPS¶
firstClassMailType¶
LETTER FLAT PARCEL
service¶
- FIRST CLASS
- PRIORITY
- PRIORITY COMMERCIAL
- EXPRESS
- EXPRESS COMMERCIAL
- EXPRESS SH
- EXPRESS SH COMMERCIAL
- EXPRESS HFP
- EXPRESS HFP
- COMMERCIAL
- BPM
- PARCEL
- MEDIA
- LIBRARY
- ALL
- ONLINE
shipCode¶
Valid US Zip Code
toCode¶
Valid US Zip Code
weightPounds¶
Weight in pounds
weightOunces¶
Weight in ounces
packagingType¶
- VARIABLE
- FLAT RATE BOX
- MD FLAT RATE BOX
- FLAT RATE ENVELOPE
- SM FLAT RATE BOX
- LG FLAT RATE BOX
- RECTANGULAR
- NONRECTANGULAR
length¶
Value must be numeric. Units are inches. Required when service contains one of the PRIORITY variants and Size is LARGE.
width¶
Value must be numeric. Units are inches. Required when service contains one of the PRIORITY variants and Size is LARGE.
height¶
Value must be numeric. Units are inches. Required when service contains one of the PRIORITY variants and Size is LARGE.
DHL¶
packagingType¶
Value | Description |
---|---|
FLY | Flyer/Smalls - pieces that are too small, thin or light to be sorted on a standard conveyor, or for which it makes sense to group pieces into larger units for sort purposes. |
COY | Parcels/Conveyables - pieces that can be handled onto a system, less than 31.5 kg and up to 60 * 60 * 120cm. |
NCY | Non-conveyables - Pieces that cannot on their own be sorted on standard conveyor. |
PAL | Pallets – large, irregular or heavy pieces, Palletized with weight upto 1000 KG. |
DBL | Double Pallets – large, irregular or heavy pieces, Palletized with weight upto 1000 KG. |
BOX | Parcels that are conveyable have the shape of a box. Up to 70kg. |