BTC Postage Link Builder Documentation
This tool allows you to generate a URL that prefills all or part of a new label form. The simplest way to generate a prefill URL is to use our prefill link builder tool. Developers who want to generate BTC Postage URLs within their applications can refer to the following available prefill options.
Prefill links should use this base URL (https://btcpostage.com/?) and all params should be appended to the URL. All parameters are optional and are used to prefill a user-editable label form. No API key is required.
Link Parameters
| Name | Description |
|---|---|
| service | The carrier that will deliver the package. Click here to see a list of valid carriers. |
| package_type | Determines if the package will be flat rate or custom. Click here to see a list of valid package types. |
| weight_lbs | Weight of the package in pounds. This value is added to weight_oz to obtain the final weight. Ignored unless the package type is custom. |
| weight_oz | Weight of the package in ounces. This value is added to weight_lbs to obtain the final weight. Ignored unless the package type is custom. |
| height | Height of the package in inches. Ignored unless the package type is custom. |
| width | Width of the package in inches. Ignored unless the package type is custom. |
| depth | Length/depth of the package in inches. Ignored unless the package type is custom. |
| from_name | Name of the sender. |
| from_street | Street component of the sender address. |
| from_apt | Apartment or second street line of the sender address. |
| from_city | City of the sender address. |
| from_state | State of the sender address. |
| from_zip | Zip code of the sender address. |
| from_country | Country of the sender address. |
| from_phone | Phone number of the sender. |
| to_name | Name of the receiver. |
| to_street | Street component of the receiver address. |
| to_apt | Apartment or second street line of the receiver address. |
| to_city | City of the receiver address. |
| to_state | State of the receiver address. |
| to_zip | Zip code of the receiver address. |
| to_country | Country of the receiver address. |
| to_phone | Phone number of the receiver. |
| redirect | URL you would like the user to return to after purchase. |
Carriers
| Name | Description |
|---|---|
| usps | United States Postal Service |
| fedex | Federal Express |
| ups | United Parcel Service |
Carrier Service Options
| Name | Description |
|---|---|
| USPS | |
| GroundAdvantage | USPS Ground Advantage |
| Priority | USPS Priority Mail |
| Express | USPS Priority Mail Express |
| MediaMail | USPS Media Mail |
| First Class International | USPS First-Class Mail International |
| Priority International | USPS Priority Mail International |
| Express International | USPS Priority Mail Express International |
| FedEx | |
| FEDEX_GROUND | FedEx Ground |
| FEDEX_2_DAY | FedEx 2Day® |
| FEDEX_2_DAY_AM | FedEx 2Day® A.M. |
| FEDEX_EXPRESS_SAVER | FedEx Express Saver® |
| STANDARD_OVERNIGHT | FedEx Standard Overnight® |
| FIRST_OVERNIGHT | FedEx First Overnight® |
| PRIORITY_OVERNIGHT | FedEx Priority Overnight® |
| INTERNATIONAL_ECONOMY | FedEx International Economy® |
| INTERNATIONAL_FIRST | FedEx International First® |
| INTERNATIONAL_PRIORITY | FedEx International Priority® |
| GROUND_HOME_DELIVERY | FedEx Home Delivery® |
| SMART_POST | FedEx SmartPost |
| FEDEX_INTERNATIONAL_CONNECT_PLUS | FedEx International Connect Plus |
| UPS | |
| Ground | UPS® Ground |
| NextDayAir | UPS Next Day Air® |
| NextDayAirSaver | UPS Next Day Air Saver® |
| NextDayAirEarlyAM | UPS Next Day Air® Early A.M. |
| 2ndDayAir | UPS 2nd Day Air® |
| 3DaySelect | UPS 3 Day Select® |
Package Types
| Name | Description |
|---|---|
| USPS | |
| custom | Custom size box or package |
| Letter | Must be a flat surface with a maximum weight of 3.5oz. Minimum dimensions: 3 1/2" x 5 1/2'. Maximum dimensions: 4 1/4" x 6". |
| Parcel | Maximum size is 108" in combined length and girth (distance around the thickest part). Contents must weigh less than 70 lbs. |
| FlatRateEnvelope | Uses pre-purchased 12-1/2" x 9-1/2" package. Contents must weigh less than 70 lbs (4 lbs for international). |
| FlatRateLegalEnvelope | Uses pre-purchased 15" x 9 1/2" package. Contents must weigh less than 70 lbs (4 lbs for international). |
| SmallFlatRateBox | Uses pre-purchased 8 5/8" x 5 3/8" x 1 5/8" package. Contents must weigh less than 70 lbs. |
| MediumFlatRateBox | Uses pre-purchased 11" x 8 1/2" x 5 1/2" package. Contents must weigh less than 70 lbs. |
| LargeFlatRateBox | Uses pre-purchased 12" x 12" x 5 1/2" package. Contents must weigh less than 70 lbs. |
| FedEx | |
| custom | Minumum size 6" x 4" x 1". Minimum weight 16 oz. |
| fedex_box_small | Uses pre-purchased 12.25" x 10.9" x 1.5" or 8.75" x 2.63" x 11.25" package. Contents must weigh no more than 20 lbs. |
| fedex_box_medium | Uses pre-purchased 13.25" x 11.5" x 2.38" or 8.75" x 4.38" x 11.25" package. Contents must weigh no more than 20 lbs. |
| fedex_box_large | Uses pre-purchased 17.88" x 12.38" x 3" or 8.75" x 7.75" x 11.25" package. Contents must weigh no more than 20 lbs. |
| UPS | |
| custom | Custom size box or package |
| ups_box_small | Uses pre-purchased 13" x 11" x 2" |
| ups_box_medium | Uses pre-purchased 15" x 11" x 3" |
| ups_box_large | Uses pre-purchased 18" x 13" x 3" |