# United States Postal Service Resources API

**Canonical:** https://apis.io/apis/usps/usps-resources-api/  
**Provider:** United States Postal Service — https://apis.io/providers/usps/  
**Base URL:** https://apis.usps.com/addresses/v3  
**Documentation:** https://developers.usps.com/Oauth

United States Postal Service Resources API is one of 7 APIs that [United States Postal Service](https://apis.io/providers/usps/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 78 JSON Schema definitions. Tagged areas include Resources. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a JSON-LD context, and 78 JSON Schemas.

The Resources API from United States Postal Service — 66 operation(s) for resources.

## Operations (60 of 84)

| Method | Path | Summary |
|---|---|---|
| GET | `/address` | Returns the best standardized address for a given address |
| GET | `/city-state` | Returns the city and state for a given ZIP Code |
| GET | `/zipcode` | Returns the ZIP Code for a given address |
| GET | `/adjustments/{CRID}/{trackingNumber}/{eventType}` | Adjustments for a tracking number |
| POST | `/fast-appointments/appointment` | Create an appointment |
| PUT | `/fast-appointments/appointment` | Update an appointment |
| DELETE | `/fast-appointments/appointment` | Cancel an appointment |
| POST | `/appointment-availability` | Request to find available appointment times |
| GET | `/carrier-pickup/eligibility` | Check pick-up address eligibility |
| POST | `/carrier-pickup` | Schedule a carrier pickup |
| GET | `/carrier-pickup/{confirmationNumber}` | Get a previously scheduled carrier pickup |
| PUT | `/carrier-pickup/{confirmationNumber}` | Update a previously scheduled carrier pickup |
| DELETE | `/carrier-pickup/{confirmationNumber}` | Cancel a previously scheduled carrier pickup |
| POST | `/containers/{container-id}/packages` | Add packages or mail to a container manifest |
| DELETE | `/containers/{container-id}/packages` | Remove all packages from a container |
| DELETE | `/containers/{container-id}/packages/{tracking-number}` | Remove individual packages from a container |
| POST | `/containers` | Create a container label |
| POST | `/containers/manifest` | Closes a container |
| POST | `/label` | Create a domestic shipping label |
| DELETE | `/label` | Cancel a previously requested label or request a refund on label by providing… |
| POST | `/return-label` | Create a domestic returns shipping label |
| DELETE | `/label/{trackingNumber}` | Cancel a previously requested label or request a refund on label by providing… |
| PATCH | `/label/{trackingNumber}` | Edit label attributes |
| POST | `/indicia` | Create a First-Class letter, flat, or card indicia |
| POST | `/indicia/imb` | Create an Intelligent Mail Barcode (IMB) label for First-Class letters, flats… |
| DELETE | `/indicia/imb/{imb}` | Cancel a previously requested Intelligent Mail Barcode (IMB) label for… |
| POST | `/branding` | Upload an SVG image to be used as a label branding image |
| GET | `/branding` | Retrieve a paginated list of label branding images associated with your… |
| GET | `/branding/{imageUUID}` | Retrieve a label branding image associated with your customer reference ID… |
| DELETE | `/branding/{imageUUID}` | Delete a previously uploaded label branding image by imageUUID |
| PATCH | `/branding/{imageUUID}` | Rename the previously uploaded Label Branding Image by imageUUID |
| POST | `/label-reprint/{trackingNumber}` | Reprint a domestic shipping label by providing it's tracking number |
| POST | `/label-reprint` | Reprint a domestic shipping label by providing the X-Idempotency-Key header… |
| POST | `/base-rates/search` | Performs a search for base price using the submitted rate ingredients |
| POST | `/extra-service-rates/search` | Search for extra services using rate ingredients |
| POST | `/base-rates-list/search` | Search for eligible products using rate ingredients |
| POST | `/total-rates/search` | Returns a list of eligible prices including extra service fees given a set of… |
| POST | `/letter-rates/search` | Performs a search for First-Class Mail letter prices using the submitted rate… |
| POST | `/campaigns/{CRID}` | Create an Informed Delivery campaign |
| GET | `/campaigns/{CRID}` | Search all campaigns for Submitter CRID |
| GET | `/campaigns/{CRID}/{campaignID}` | Return a single Informed Delivery campaign |
| DELETE | `/campaigns/{CRID}/{campaignID}` | Cancel an Informed Delivery campaign |
| PUT | `/campaigns/{CRID}/{campaignID}` | Edit an Informed Delivery campaign |
| POST | `/campaigns/{CRID}/{campaignID}/pieces` | Add IMBs to a NON-SEQ campaign |
| GET | `/campaigns/{CRID}/callback` | Search all callback keys for Submitter CRID |
| GET | `/campaigns/{CRID}/{callbackKey}/summary` | Return summary-level information on a single callback key transaction |
| GET | `/campaigns/{CRID}/{callbackKey}/detail` | Return IMB-level errors for a single callback key transaction |
| POST | `/international-label` | Create a international shipping label |
| DELETE | `/international-label` | Cancel a previously requested label or request a refund on label by providing… |
| POST | `/international-label-reprint/{trackingNumber}` | Reprint an international shipping label |
| POST | `/international-label-reprint` | Reprint an international shipping label by providing the X-Idempotency-Key… |
| DELETE | `/international-label/{trackingNumber}` | Cancel a previously requested label or request a refund on label by providing… |
| GET | `/international-service-standard` | Get service standard message |
| GET | `/dropoff-locations` | Lookup a valid entry location for destination entry parcels |
| GET | `/post-office-locations` | Get a list of post office locations based on the search criteria |
| GET | `/parcel-locker-locations` | Get a list of USPS Parcel Lockers based on the search criteria |
| POST | `/shipment-tracking` | Create a shipment tracking event |
| POST | `/search` | Used to search for change of addresses |
| POST | `/token` | Generate OAuth tokens |
| POST | `/revoke` | Invalidate OAuth tokens |

…and 24 more operations. They are listed in full on the page.

## Machine-readable artifacts (125)

- **OpenAPI** — https://artifacts.apis.io/usps/openapi/usps-resources-api-openapi.yml
- **Documentation** — https://developers.usps.com/Oauth
- **Authentication** — https://developers.usps.com/getting-started
- **Documentation** — https://developers.usps.com/addressesv3
- **JSONStructure** — https://artifacts.apis.io/usps/json-structure/addresses-address-structure.json
- **JSONLD** — https://artifacts.apis.io/usps/json-ld/united-states-postal-service-addresses-context.jsonld
- **Examples** — https://artifacts.apis.io/usps/examples/addresses-address-example.json
- **Documentation** — https://developers.usps.com/adjustmentsv3
- **Documentation** — https://developers.usps.com/appointmentsv3
- **Documentation** — https://developers.usps.com/carrierpickupv3
- **JSONStructure** — https://artifacts.apis.io/usps/json-structure/carrier-pickup-pickup-request-structure.json
- **JSONLD** — https://artifacts.apis.io/usps/json-ld/united-states-postal-service-carrier-context.jsonld
- **Examples** — https://artifacts.apis.io/usps/examples/carrier-pickup-pickup-request-example.json
- **Documentation** — https://developers.usps.com/containersv3
- **Documentation** — https://developers.usps.com/domesticlabelsv3
- **Documentation** — https://developers.usps.com/domesticpricesv3
- **JSONStructure** — https://artifacts.apis.io/usps/json-structure/domestic-prices-base-rate-request-structure.json
- **JSONLD** — https://artifacts.apis.io/usps/json-ld/united-states-postal-service-domestic-context.jsonld
- **Examples** — https://artifacts.apis.io/usps/examples/domestic-prices-base-rate-request-example.json
- **Documentation** — https://developers.usps.com/informeddeliverymailcampaignsv3
- **Documentation** — https://developers.usps.com/informeddeliverypackagecampaignsv3
- **Documentation** — https://developers.usps.com/internationallabelsv3-comingsoon
- **Documentation** — https://developers.usps.com/internationalpricesv3
- **Documentation** — https://developers.usps.com/internationalstandardsv3
- **Documentation** — https://developers.usps.com/locationsv3
- **Documentation** — https://developers.usps.com/logistics-shipmentsv3
- **Documentation** — https://developers.usps.com/ncoav3
- **Documentation** — https://developers.usps.com/paymentsv3
- **Documentation** — https://developers.usps.com/pmodv3
- **Documentation** — https://developers.usps.com/qrcodesv3
- **Documentation** — https://developers.usps.com/reconciliationadjustmentsv3
- **Documentation** — https://developers.usps.com/scanv3
- **Documentation** — https://developers.usps.com/service-standards-file-download-v3
- **Documentation** — https://developers.usps.com/servicestandardsdirectoryv3
- **Documentation** — https://developers.usps.com/shipenrollmentv3
- **Documentation** — https://developers.usps.com/shippingoptionsv3
- **Documentation** — https://developers.usps.com/standardsv3
- **Documentation** — https://developers.usps.com/subscriptions-addressesv3
- **Documentation** — https://developers.usps.com/subscriptions-adjustmentsv3
- **Documentation** — https://developers.usps.com/subscriptions-disputesv3
- …and 85 more, listed in full on the page.

## Other United States Postal Service APIs (6)

- [United States Postal Service Addresses API](https://apis.io/apis/usps/usps-addresses-api/)
- [United States Postal Service Carrier Pickup API](https://apis.io/apis/usps/usps-carrier-pickup-api/)
- [United States Postal Service Domestic Prices API](https://apis.io/apis/usps/usps-domestic-prices-api/)
- [United States Postal Service Files API](https://apis.io/apis/usps/usps-files-api/)
- [United States Postal Service Listener URL Specification API](https://apis.io/apis/usps/usps-listener-url-specification-api/)
- [United States Postal Service Tracking API](https://apis.io/apis/usps/usps-tracking-api/)

## Tags

Resources

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/usps/usps-resources-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/usps/.