USPS
Connection Requirements
client_idstringrequiredThe client_id field for carrier connection.
client_secretstringrequiredThe client_secret field for carrier connection.
account_typestringThe account_type field for carrier connection.
account_numberstringThe account_number field for carrier connection.
Carrier Configuration
role_namestringConfiguration option for role_name.
mailer_idstringConfiguration option for mailer_id.
permit_zipstringConfiguration option for permit_zip.
permit_numberstringConfiguration option for permit_number.
customer_registration_idstringConfiguration option for customer_registration_id.
shipping_optionslistConfiguration option for shipping_options.
shipping_serviceslistConfiguration option for shipping_services.
Available Services
| Service Name | Service Code |
|---|---|
| USPS Standard Service | usps_standard_service |
| PARCEL_SELECT | usps_parcel_select |
| PARCEL_SELECT_LIGHTWEIGHT | usps_parcel_select_lightweight |
| PRIORITY_MAIL_EXPRESS | usps_priority_mail_express |
| PRIORITY_MAIL | usps_priority_mail |
| FIRST-CLASS_PACKAGE_SERVICE | usps_first_class_package_service |
| LIBRARY_MAIL | usps_library_mail |
| MEDIA_MAIL | usps_media_mail |
| BOUND_PRINTED_MATTER | usps_bound_printed_matter |
| USPS_CONNECT_LOCAL | usps_connect_local |
| USPS_CONNECT_MAIL | usps_connect_mail |
| USPS_CONNECT_NEXT_DAY | usps_connect_next_day |
| USPS_CONNECT_REGIONAL | usps_connect_regional |
| USPS_CONNECT_SAME_DAY | usps_connect_same_day |
| USPS_GROUND_ADVANTAGE | usps_ground_advantage |
| USPS_RETAIL_GROUND | usps_retail_ground |
| ALL | usps_all |
Shipping Options
| Option | Code | Type |
|---|---|---|
| usps_label_delivery_service | 415 | boolean |
| usps_tracking_plus_6_months | 480 | boolean |
| usps_tracking_plus_1_year | 481 | boolean |
| usps_tracking_plus_3_years | 482 | boolean |
| usps_tracking_plus_5_years | 483 | boolean |
| usps_tracking_plus_7_years | 484 | boolean |
| usps_tracking_plus_10_years | 485 | boolean |
| usps_tracking_plus_signature_3_years | 486 | boolean |
| usps_tracking_plus_signature_5_years | 487 | boolean |
| usps_tracking_plus_signature_7_years | 488 | boolean |
| usps_tracking_plus_signature_10_years | 489 | boolean |
| usps_hazardous_materials_air_eligible_ethanol | 810 | boolean |
| usps_hazardous_materials_class_1_toy_propellant_safety_fuse_package | 811 | boolean |
| usps_hazardous_materials_class_3_flammable_and_combustible_liquids | 812 | boolean |
| usps_hazardous_materials_class_7_radioactive_materials | 813 | boolean |
| usps_hazardous_materials_class_8_air_eligible_corrosive_materials | 814 | boolean |
| usps_hazardous_materials_class_8_nonspillable_wet_batteries | 815 | boolean |
| usps_hazardous_materials_class_9_lithium_battery_marked_ground_only | 816 | boolean |
| usps_hazardous_materials_class_9_lithium_battery_returns | 817 | boolean |
| usps_hazardous_materials_class_9_marked_lithium_batteries | 818 | boolean |
| usps_hazardous_materials_class_9_dry_ice | 819 | boolean |
| usps_hazardous_materials_class_9_unmarked_lithium_batteries | 820 | boolean |
| usps_hazardous_materials_class_9_magnetized_materials | 821 | boolean |
| usps_hazardous_materials_division_4_1_mailable_flammable_solids_and_safety_matches | 822 | boolean |
| usps_hazardous_materials_division_5_1_oxidizers | 823 | boolean |
| usps_hazardous_materials_division_5_2_organic_peroxides | 824 | boolean |
| usps_hazardous_materials_division_6_1_toxic_materials | 825 | boolean |
| usps_hazardous_materials_division_6_2_biological_materials | 826 | boolean |
| usps_hazardous_materials_excepted_quantity_provision | 827 | boolean |
| usps_hazardous_materials_ground_only_hazardous_materials | 828 | boolean |
| usps_hazardous_materials_air_eligible_id8000_consumer_commodity | 829 | boolean |
| usps_hazardous_materials_lighters | 830 | boolean |
| usps_hazardous_materials_limited_quantity_ground | 831 | boolean |
| usps_hazardous_materials_small_quantity_provision_markings_required | 832 | boolean |
| usps_hazardous_materials | 857 | boolean |
| usps_certified_mail | 910 | boolean |
| usps_certified_mail_restricted_delivery | 911 | boolean |
| usps_certified_mail_adult_signature_required | 912 | boolean |
| usps_certified_mail_adult_signature_restricted_delivery | 913 | boolean |
| usps_collect_on_delivery | 915 | float |
| usps_collect_on_delivery_restricted_delivery | 917 | boolean |
| usps_tracking_electronic | 920 | boolean |
| usps_signature_confirmation | 921 | boolean |
| usps_adult_signature_required | 922 | boolean |
| usps_adult_signature_restricted_delivery | 923 | boolean |
| usps_signature_confirmation_restricted_delivery | 924 | boolean |
| usps_priority_mail_express_merchandise_insurance | 925 | boolean |
| usps_insurance_bellow_500 | 930 | float |
| usps_insurance_above_500 | 931 | float |
| usps_insurance_restricted_delivery | 934 | boolean |
| usps_registered_mail | 940 | boolean |
| usps_registered_mail_restricted_delivery | 941 | boolean |
| usps_return_receipt | 955 | boolean |
| usps_return_receipt_electronic | 957 | boolean |
| usps_signature_requested_priority_mail_express_only | 981 | boolean |
| usps_parcel_locker_delivery | 984 | boolean |
| usps_po_to_addressee_priority_mail_express_only | 986 | boolean |
| usps_price_type | priceType | string |
| usps_facility_id | facilityId | string |
| usps_hold_for_pickup | holdForPickup | boolean |
| usps_rate_indicator | rateIndicator | string |
| usps_processing_category | processingCategory | string |
| usps_carrier_release | carrierRelease | boolean |
| usps_physical_signature_required | physicalSignatureRequired | boolean |
| usps_restriction_type | restrictionType | string |