United States Postal Service Resources API
The Resources API from United States Postal Service — 66 operation(s) for resources.
Operations 84
DELETE
/containers/{container-id}/packages/{tracking-number}
Remove individual packages from a container
#
DELETE
/label/{trackingNumber}
Cancel a previously requested label or request a refund on label by providing…
#
GET
/branding/{imageUUID}
Retrieve a label branding image associated with your customer reference ID…
#
POST
/label-reprint/{trackingNumber}
Reprint a domestic shipping label by providing it's tracking number
#
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…
#
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
#
DELETE
/international-label
Cancel a previously requested label or request a refund on label by providing…
#
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
/reconciliation-adjustments/{CRID}/{eventType}/{startDate}/{startTime}/{endDate}/{endTime}
Reconciliation Adjustments for a CRID and date range
#
POST
/tracking/{trackingNumber}/proof-of-delivery
Receive a proof of delivery letter for a given track ID
#
Documentation
Documentation
https://developers.usps.com/Oauth
Authentication
https://developers.usps.com/getting-started
Documentation
https://developers.usps.com/addressesv3
Documentation
https://developers.usps.com/adjustmentsv3
Documentation
https://developers.usps.com/appointmentsv3
Documentation
https://developers.usps.com/carrierpickupv3
Documentation
https://developers.usps.com/containersv3
Documentation
https://developers.usps.com/domesticlabelsv3
Documentation
https://developers.usps.com/domesticpricesv3
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
Documentation
https://developers.usps.com/subscriptions-ncoav3
Documentation
https://developers.usps.com/subscriptions-package-transaction-detailsv3
Documentation
https://developers.usps.com/subscriptions-trackingv3
Documentation
https://developers.usps.com/subscriptions-trackingv3r2
Documentation
https://developers.usps.com/subscriptions-unpaid-packagesv3
Documentation
https://developers.usps.com/trackingv3
Documentation
https://developers.usps.com/trackingv3r2
Documentation
https://developers.usps.com/userinfov3
Specifications
Schemas & Data
JSONStructure
https://artifacts.apis.io/usps/json-structure/addresses-address-structure.json
JSONStructure
https://artifacts.apis.io/usps/json-structure/carrier-pickup-pickup-request-structure.json
JSONStructure
https://artifacts.apis.io/usps/json-structure/domestic-prices-base-rate-request-structure.json
JSONStructure
https://artifacts.apis.io/usps/json-structure/tracking-tracking-event-structure.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-resource-owner-token-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-client-application-token-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-client-credentials-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-authorization-code-credentials-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-refresh-token-credentials-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-token-revoke-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/addresses-address-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-adjustments-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-appointment-full-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-slot-availability-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-cancellation-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-cancellation-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-slots-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-container-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-container-idpackages-body-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-manifest-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-label-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-label-metadata-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-return-label-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-indicia-imb-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-label-vendor-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-label-multi-part-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-campaign-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-campaign-edit-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-query-string-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-campaign-edit-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-summary-success-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-detail-success-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-international-label-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-indicia-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-indicia-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-international-label-vendor-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-cancel-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-international-label-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-extra-service-rate-query-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-base-rates-query-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-total-rates-query-result-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-total-rates-query-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-post-office-location-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-drop-shipment-location-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-parcel-locker-location-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-links-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-pagination-metadata-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-shipment-tracking-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-change-of-address-search-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-records-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-mailer-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-payment-account-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-parties-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-create-odcontainer-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-create-odcontainer-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-close-odcontainer-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-reconciliation-adjustments-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-scanform-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-scanform-vendor-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-scanform-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-service-standards-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-zip5-codes-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-enrollment-statuses-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-enrollment-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-options-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-options-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-standards-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-estimates-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-adjustment-subscription-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-subscriptions-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-tracking-details-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-tracking-proof-of-delivery-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-tracking-notification-request-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-tracking-summary-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-tracking-notification-acknowledgement-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-tracking-proof-of-delivery-response-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/tracking-tracking-event-schema.json
JSONSchema
https://artifacts.apis.io/usps/json-schema/usps-resource-owner-claims-schema.json
Other Resources
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
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
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
JSONLD
https://artifacts.apis.io/usps/json-ld/united-states-postal-service-tracking-context.jsonld
Examples
https://artifacts.apis.io/usps/examples/tracking-tracking-event-example.json