Web Tools API is obsolete

Created on 28 August 2024, 4 months ago

Updated 29 August 2024, 4 months ago

Problem/Motivation

The USPS web tools API is technically still functioning but no longer guaranteed to continue to operate.

https://www.usps.com/business/web-tools-apis/welcome.htm

The deadline for migrating to the new USPS Label APIs was July 14, 2024. If you're still using Web Tools Label APIs, you risk service interruptions.

Proposed resolution

We need to create a new major version that supports the new OAuth API

Remaining tasks

Create a new development branch
Find an API library that supports the new API
Change shipping method definitions to use the new service class labels (instead of numbers)
Change authentication method to OAuth

API Details

The API provides the Shipping Options API for getting a list of possible services for an origin and destination zipcode
https://developer.usps.com/api/99
Use this to get a list of rates then map the ones that were enabled in the shipping method configuration.
This API doesn't seem to support international shipments...

Can use the International Prices API to get them but each service has to be requested separately
https://developer.usps.com/api/77

📌 Task

Status

Active

Version

1.0

Component

Code

Created by

🇺🇸United States rhovland Oregon

Live updates comments and jobs are added and updated live.

Comments & Activities

Issue created by @rhovland
Comment 4 months ago →
🇺🇸United States rhovland Oregon
Comment 4 months ago →
🇺🇸United States rhovland Oregon
I have not found any PHP projects that implement the API in PHP except this one which is more of a script than a library
https://github.com/JohnAwesomeJr/php-ups-api-rate-oauth2

However I did come across this project for UPS which mentions it was partly generated using Jane using the published UPS OpenAPI spec.
https://github.com/ShipStream/ups-rest-php-sdk#development

USPS publishes OpenAPI spec files for their API. We could use that to generate most of the code for a library using Jane.
https://developer.usps.com/sites/default/files/apidoc_specs/US_Postal_Se...
https://github.com/janephp/janephp

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024