From 24a48fc37ffb8d8cdd94012ce1cff29c371b9a73 Mon Sep 17 00:00:00 2001 From: Andrew Pirelli Date: Thu, 10 Sep 2026 04:41:02 +0000 Subject: [PATCH 1/5] Add USPS tracker registration API examples for docs. Co-authored-by: Cursor --- .../usps-tracker-registrations/create.sh | 11 ++++++++++ .../usps-tracker-registrations/list.sh | 2 ++ .../usps-tracker-registrations/retrieve.sh | 2 ++ .../usps-tracker-registrations/create.py | 15 +++++++++++++ .../usps-tracker-registrations/list.py | 7 ++++++ .../usps-tracker-registrations/retrieve.py | 7 ++++++ .../usps-tracker-registrations/create.json | 22 +++++++++++++++++++ .../usps-tracker-registrations/list.json | 17 ++++++++++++++ .../usps-tracker-registrations/retrieve.json | 13 +++++++++++ .../usps-tracker-registrations/create.rb | 21 ++++++++++++++++++ .../usps-tracker-registrations/list.rb | 11 ++++++++++ .../usps-tracker-registrations/retrieve.rb | 11 ++++++++++ 12 files changed, 139 insertions(+) create mode 100644 official/docs/curl/current/usps-tracker-registrations/create.sh create mode 100644 official/docs/curl/current/usps-tracker-registrations/list.sh create mode 100644 official/docs/curl/current/usps-tracker-registrations/retrieve.sh create mode 100644 official/docs/python/current/usps-tracker-registrations/create.py create mode 100644 official/docs/python/current/usps-tracker-registrations/list.py create mode 100644 official/docs/python/current/usps-tracker-registrations/retrieve.py create mode 100644 official/docs/responses/usps-tracker-registrations/create.json create mode 100644 official/docs/responses/usps-tracker-registrations/list.json create mode 100644 official/docs/responses/usps-tracker-registrations/retrieve.json create mode 100644 official/docs/ruby/current/usps-tracker-registrations/create.rb create mode 100644 official/docs/ruby/current/usps-tracker-registrations/list.rb create mode 100644 official/docs/ruby/current/usps-tracker-registrations/retrieve.rb diff --git a/official/docs/curl/current/usps-tracker-registrations/create.sh b/official/docs/curl/current/usps-tracker-registrations/create.sh new file mode 100644 index 00000000..1624f915 --- /dev/null +++ b/official/docs/curl/current/usps-tracker-registrations/create.sh @@ -0,0 +1,11 @@ +curl -X POST https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations \ + -u "EASYPOST_API_KEY": \ + -H "Content-Type: application/json" \ + -d '{ + "tracker_registrations": [ + { + "tracking_code": "9400111899223344556677", + "product_value": "25.50" + } + ] +}' diff --git a/official/docs/curl/current/usps-tracker-registrations/list.sh b/official/docs/curl/current/usps-tracker-registrations/list.sh new file mode 100644 index 00000000..c2f9f2c9 --- /dev/null +++ b/official/docs/curl/current/usps-tracker-registrations/list.sh @@ -0,0 +1,2 @@ +curl -X GET https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations \ + -u "EASYPOST_API_KEY": diff --git a/official/docs/curl/current/usps-tracker-registrations/retrieve.sh b/official/docs/curl/current/usps-tracker-registrations/retrieve.sh new file mode 100644 index 00000000..1c2cbcec --- /dev/null +++ b/official/docs/curl/current/usps-tracker-registrations/retrieve.sh @@ -0,0 +1,2 @@ +curl -X GET https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations/utr_0123456789abcdef0123456789abcdef \ + -u "EASYPOST_API_KEY": diff --git a/official/docs/python/current/usps-tracker-registrations/create.py b/official/docs/python/current/usps-tracker-registrations/create.py new file mode 100644 index 00000000..8db1850f --- /dev/null +++ b/official/docs/python/current/usps-tracker-registrations/create.py @@ -0,0 +1,15 @@ +import requests + +response = requests.post( + "https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations", + auth=("EASYPOST_API_KEY", ""), + json={ + "tracker_registrations": [ + { + "tracking_code": "9400111899223344556677", + "product_value": "25.50", + } + ] + }, +) +print(response.json()) diff --git a/official/docs/python/current/usps-tracker-registrations/list.py b/official/docs/python/current/usps-tracker-registrations/list.py new file mode 100644 index 00000000..bf0289fb --- /dev/null +++ b/official/docs/python/current/usps-tracker-registrations/list.py @@ -0,0 +1,7 @@ +import requests + +response = requests.get( + "https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations", + auth=("EASYPOST_API_KEY", ""), +) +print(response.json()) diff --git a/official/docs/python/current/usps-tracker-registrations/retrieve.py b/official/docs/python/current/usps-tracker-registrations/retrieve.py new file mode 100644 index 00000000..8856140f --- /dev/null +++ b/official/docs/python/current/usps-tracker-registrations/retrieve.py @@ -0,0 +1,7 @@ +import requests + +response = requests.get( + "https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations/utr_0123456789abcdef0123456789abcdef", + auth=("EASYPOST_API_KEY", ""), +) +print(response.json()) diff --git a/official/docs/responses/usps-tracker-registrations/create.json b/official/docs/responses/usps-tracker-registrations/create.json new file mode 100644 index 00000000..49b467a1 --- /dev/null +++ b/official/docs/responses/usps-tracker-registrations/create.json @@ -0,0 +1,22 @@ +{ + "summary": { + "processed_count": 1, + "failed_count": 0 + }, + "tracker_registrations": [ + { + "id": "utr_0123456789abcdef0123456789abcdef", + "tracking_code": "9400111899223344556677", + "product_value": "25.50", + "shipment_date": "2026-01-15", + "status": "MONITORING", + "tracker_public_id": "trk_0123456789abcdef0123456789abcdef", + "claim_type": null, + "claims_usps_id": null, + "consent_accepted_at": "2026-01-15T12:00:00Z", + "created_at": "2026-01-15T12:00:00Z", + "updated_at": "2026-01-15T12:00:01Z" + } + ], + "failed_registrations": {} +} diff --git a/official/docs/responses/usps-tracker-registrations/list.json b/official/docs/responses/usps-tracker-registrations/list.json new file mode 100644 index 00000000..26cc6ae9 --- /dev/null +++ b/official/docs/responses/usps-tracker-registrations/list.json @@ -0,0 +1,17 @@ +{ + "tracker_registrations": [ + { + "id": "utr_0123456789abcdef0123456789abcdef", + "tracking_code": "9400111899223344556677", + "product_value": "25.50", + "shipment_date": "2026-01-15", + "status": "MONITORING", + "tracker_public_id": "trk_0123456789abcdef0123456789abcdef", + "claim_type": null, + "claims_usps_id": null, + "consent_accepted_at": "2026-01-15T12:00:00Z", + "created_at": "2026-01-15T12:00:00Z", + "updated_at": "2026-01-15T12:00:01Z" + } + ] +} diff --git a/official/docs/responses/usps-tracker-registrations/retrieve.json b/official/docs/responses/usps-tracker-registrations/retrieve.json new file mode 100644 index 00000000..9dc1d0b5 --- /dev/null +++ b/official/docs/responses/usps-tracker-registrations/retrieve.json @@ -0,0 +1,13 @@ +{ + "id": "utr_0123456789abcdef0123456789abcdef", + "tracking_code": "9400111899223344556677", + "product_value": "25.50", + "shipment_date": "2026-01-15", + "status": "MONITORING", + "tracker_public_id": "trk_0123456789abcdef0123456789abcdef", + "claim_type": null, + "claims_usps_id": null, + "consent_accepted_at": "2026-01-15T12:00:00Z", + "created_at": "2026-01-15T12:00:00Z", + "updated_at": "2026-01-15T12:00:01Z" +} diff --git a/official/docs/ruby/current/usps-tracker-registrations/create.rb b/official/docs/ruby/current/usps-tracker-registrations/create.rb new file mode 100644 index 00000000..29feca57 --- /dev/null +++ b/official/docs/ruby/current/usps-tracker-registrations/create.rb @@ -0,0 +1,21 @@ +require 'net/http' +require 'json' +require 'uri' + +uri = URI('https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations') +request = Net::HTTP::Post.new(uri) +request.basic_auth('EASYPOST_API_KEY', '') +request['Content-Type'] = 'application/json' +request.body = { + tracker_registrations: [ + { + tracking_code: '9400111899223344556677', + product_value: '25.50', + }, + ], +}.to_json + +response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http| + http.request(request) +end +puts response.body diff --git a/official/docs/ruby/current/usps-tracker-registrations/list.rb b/official/docs/ruby/current/usps-tracker-registrations/list.rb new file mode 100644 index 00000000..71245c0d --- /dev/null +++ b/official/docs/ruby/current/usps-tracker-registrations/list.rb @@ -0,0 +1,11 @@ +require 'net/http' +require 'uri' + +uri = URI('https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations') +request = Net::HTTP::Get.new(uri) +request.basic_auth('EASYPOST_API_KEY', '') + +response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http| + http.request(request) +end +puts response.body diff --git a/official/docs/ruby/current/usps-tracker-registrations/retrieve.rb b/official/docs/ruby/current/usps-tracker-registrations/retrieve.rb new file mode 100644 index 00000000..69a10be2 --- /dev/null +++ b/official/docs/ruby/current/usps-tracker-registrations/retrieve.rb @@ -0,0 +1,11 @@ +require 'net/http' +require 'uri' + +uri = URI('https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations/utr_0123456789abcdef0123456789abcdef') +request = Net::HTTP::Get.new(uri) +request.basic_auth('EASYPOST_API_KEY', '') + +response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http| + http.request(request) +end +puts response.body From 85afda46330ad60b7a59f4956d4f34a08792517d Mon Sep 17 00:00:00 2001 From: Andrew Pirelli Date: Thu, 10 Sep 2026 17:39:43 +0000 Subject: [PATCH 2/5] Drop Python and Ruby snippets for USPS tracker registrations. Client libraries do not expose this endpoint yet; document curl and response examples only until native SDK support ships. Co-authored-by: Cursor --- .../usps-tracker-registrations/create.py | 15 ------------- .../usps-tracker-registrations/list.py | 7 ------- .../usps-tracker-registrations/retrieve.py | 7 ------- .../usps-tracker-registrations/create.rb | 21 ------------------- .../usps-tracker-registrations/list.rb | 11 ---------- .../usps-tracker-registrations/retrieve.rb | 11 ---------- 6 files changed, 72 deletions(-) delete mode 100644 official/docs/python/current/usps-tracker-registrations/create.py delete mode 100644 official/docs/python/current/usps-tracker-registrations/list.py delete mode 100644 official/docs/python/current/usps-tracker-registrations/retrieve.py delete mode 100644 official/docs/ruby/current/usps-tracker-registrations/create.rb delete mode 100644 official/docs/ruby/current/usps-tracker-registrations/list.rb delete mode 100644 official/docs/ruby/current/usps-tracker-registrations/retrieve.rb diff --git a/official/docs/python/current/usps-tracker-registrations/create.py b/official/docs/python/current/usps-tracker-registrations/create.py deleted file mode 100644 index 8db1850f..00000000 --- a/official/docs/python/current/usps-tracker-registrations/create.py +++ /dev/null @@ -1,15 +0,0 @@ -import requests - -response = requests.post( - "https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations", - auth=("EASYPOST_API_KEY", ""), - json={ - "tracker_registrations": [ - { - "tracking_code": "9400111899223344556677", - "product_value": "25.50", - } - ] - }, -) -print(response.json()) diff --git a/official/docs/python/current/usps-tracker-registrations/list.py b/official/docs/python/current/usps-tracker-registrations/list.py deleted file mode 100644 index bf0289fb..00000000 --- a/official/docs/python/current/usps-tracker-registrations/list.py +++ /dev/null @@ -1,7 +0,0 @@ -import requests - -response = requests.get( - "https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations", - auth=("EASYPOST_API_KEY", ""), -) -print(response.json()) diff --git a/official/docs/python/current/usps-tracker-registrations/retrieve.py b/official/docs/python/current/usps-tracker-registrations/retrieve.py deleted file mode 100644 index 8856140f..00000000 --- a/official/docs/python/current/usps-tracker-registrations/retrieve.py +++ /dev/null @@ -1,7 +0,0 @@ -import requests - -response = requests.get( - "https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations/utr_0123456789abcdef0123456789abcdef", - auth=("EASYPOST_API_KEY", ""), -) -print(response.json()) diff --git a/official/docs/ruby/current/usps-tracker-registrations/create.rb b/official/docs/ruby/current/usps-tracker-registrations/create.rb deleted file mode 100644 index 29feca57..00000000 --- a/official/docs/ruby/current/usps-tracker-registrations/create.rb +++ /dev/null @@ -1,21 +0,0 @@ -require 'net/http' -require 'json' -require 'uri' - -uri = URI('https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations') -request = Net::HTTP::Post.new(uri) -request.basic_auth('EASYPOST_API_KEY', '') -request['Content-Type'] = 'application/json' -request.body = { - tracker_registrations: [ - { - tracking_code: '9400111899223344556677', - product_value: '25.50', - }, - ], -}.to_json - -response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http| - http.request(request) -end -puts response.body diff --git a/official/docs/ruby/current/usps-tracker-registrations/list.rb b/official/docs/ruby/current/usps-tracker-registrations/list.rb deleted file mode 100644 index 71245c0d..00000000 --- a/official/docs/ruby/current/usps-tracker-registrations/list.rb +++ /dev/null @@ -1,11 +0,0 @@ -require 'net/http' -require 'uri' - -uri = URI('https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations') -request = Net::HTTP::Get.new(uri) -request.basic_auth('EASYPOST_API_KEY', '') - -response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http| - http.request(request) -end -puts response.body diff --git a/official/docs/ruby/current/usps-tracker-registrations/retrieve.rb b/official/docs/ruby/current/usps-tracker-registrations/retrieve.rb deleted file mode 100644 index 69a10be2..00000000 --- a/official/docs/ruby/current/usps-tracker-registrations/retrieve.rb +++ /dev/null @@ -1,11 +0,0 @@ -require 'net/http' -require 'uri' - -uri = URI('https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations/utr_0123456789abcdef0123456789abcdef') -request = Net::HTTP::Get.new(uri) -request.basic_auth('EASYPOST_API_KEY', '') - -response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http| - http.request(request) -end -puts response.body From dc1d7cd5093e7023673039bc80baa82ae37a4079 Mon Sep 17 00:00:00 2001 From: Andrew Pirelli Date: Thu, 10 Sep 2026 18:42:26 +0000 Subject: [PATCH 3/5] INSR-110: use placeholder id in retrieve curl example. Match other retrieve examples by documenting utr_... instead of a full sample id. Co-authored-by: Cursor --- .../docs/curl/current/usps-tracker-registrations/retrieve.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/official/docs/curl/current/usps-tracker-registrations/retrieve.sh b/official/docs/curl/current/usps-tracker-registrations/retrieve.sh index 1c2cbcec..123098fa 100644 --- a/official/docs/curl/current/usps-tracker-registrations/retrieve.sh +++ b/official/docs/curl/current/usps-tracker-registrations/retrieve.sh @@ -1,2 +1,2 @@ -curl -X GET https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations/utr_0123456789abcdef0123456789abcdef \ +curl -X GET https://api.easypost.com/v2/carrier_claims/usps_tracker_registrations/utr_... \ -u "EASYPOST_API_KEY": From 186fa8adb6f74d8fe3715c33fd4454903a54ea26 Mon Sep 17 00:00:00 2001 From: Andrew Pirelli Date: Fri, 11 Sep 2026 06:14:14 +0000 Subject: [PATCH 4/5] INSR-110: expand USPS tracker registration example payloads. Include recipient and mail_class fields in curl/response samples so docs match the API contract. Co-authored-by: Cursor --- .../docs/curl/current/usps-tracker-registrations/create.sh | 6 +++++- .../docs/responses/usps-tracker-registrations/create.json | 7 +++++++ .../docs/responses/usps-tracker-registrations/list.json | 7 +++++++ .../responses/usps-tracker-registrations/retrieve.json | 7 +++++++ 4 files changed, 26 insertions(+), 1 deletion(-) diff --git a/official/docs/curl/current/usps-tracker-registrations/create.sh b/official/docs/curl/current/usps-tracker-registrations/create.sh index 1624f915..e65c58b4 100644 --- a/official/docs/curl/current/usps-tracker-registrations/create.sh +++ b/official/docs/curl/current/usps-tracker-registrations/create.sh @@ -5,7 +5,11 @@ curl -X POST https://api.easypost.com/v2/carrier_claims/usps_tracker_registratio "tracker_registrations": [ { "tracking_code": "9400111899223344556677", - "product_value": "25.50" + "product_value": "25.50", + "recipient": { + "first_name": "Jane", + "last_name": "Doe" + } } ] }' diff --git a/official/docs/responses/usps-tracker-registrations/create.json b/official/docs/responses/usps-tracker-registrations/create.json index 49b467a1..8b4ea04e 100644 --- a/official/docs/responses/usps-tracker-registrations/create.json +++ b/official/docs/responses/usps-tracker-registrations/create.json @@ -8,6 +8,13 @@ "id": "utr_0123456789abcdef0123456789abcdef", "tracking_code": "9400111899223344556677", "product_value": "25.50", + "mail_class_code": "PM", + "recipient": { + "first_name": "Jane", + "last_name": "Doe", + "company": null + }, + "product_description": "Other", "shipment_date": "2026-01-15", "status": "MONITORING", "tracker_public_id": "trk_0123456789abcdef0123456789abcdef", diff --git a/official/docs/responses/usps-tracker-registrations/list.json b/official/docs/responses/usps-tracker-registrations/list.json index 26cc6ae9..b4e51846 100644 --- a/official/docs/responses/usps-tracker-registrations/list.json +++ b/official/docs/responses/usps-tracker-registrations/list.json @@ -4,6 +4,13 @@ "id": "utr_0123456789abcdef0123456789abcdef", "tracking_code": "9400111899223344556677", "product_value": "25.50", + "mail_class_code": "PM", + "recipient": { + "first_name": "Jane", + "last_name": "Doe", + "company": null + }, + "product_description": "Other", "shipment_date": "2026-01-15", "status": "MONITORING", "tracker_public_id": "trk_0123456789abcdef0123456789abcdef", diff --git a/official/docs/responses/usps-tracker-registrations/retrieve.json b/official/docs/responses/usps-tracker-registrations/retrieve.json index 9dc1d0b5..c8968bab 100644 --- a/official/docs/responses/usps-tracker-registrations/retrieve.json +++ b/official/docs/responses/usps-tracker-registrations/retrieve.json @@ -2,6 +2,13 @@ "id": "utr_0123456789abcdef0123456789abcdef", "tracking_code": "9400111899223344556677", "product_value": "25.50", + "mail_class_code": "PM", + "recipient": { + "first_name": "Jane", + "last_name": "Doe", + "company": null + }, + "product_description": "Other", "shipment_date": "2026-01-15", "status": "MONITORING", "tracker_public_id": "trk_0123456789abcdef0123456789abcdef", From e82befb5f08c701bb032376870cce70d43cc5718 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 11 Sep 2026 06:33:48 +0000 Subject: [PATCH 5/5] INSR-110: rename USPS response fixtures and add has_more Co-authored-by: apeasypost <205667805+apeasypost@users.noreply.github.com> --- .../{create.json => usps-tracker-registrations-create.json} | 0 .../{list.json => usps-tracker-registrations-list.json} | 3 ++- ...{retrieve.json => usps-tracker-registrations-retrieve.json} | 0 3 files changed, 2 insertions(+), 1 deletion(-) rename official/docs/responses/usps-tracker-registrations/{create.json => usps-tracker-registrations-create.json} (100%) rename official/docs/responses/usps-tracker-registrations/{list.json => usps-tracker-registrations-list.json} (96%) rename official/docs/responses/usps-tracker-registrations/{retrieve.json => usps-tracker-registrations-retrieve.json} (100%) diff --git a/official/docs/responses/usps-tracker-registrations/create.json b/official/docs/responses/usps-tracker-registrations/usps-tracker-registrations-create.json similarity index 100% rename from official/docs/responses/usps-tracker-registrations/create.json rename to official/docs/responses/usps-tracker-registrations/usps-tracker-registrations-create.json diff --git a/official/docs/responses/usps-tracker-registrations/list.json b/official/docs/responses/usps-tracker-registrations/usps-tracker-registrations-list.json similarity index 96% rename from official/docs/responses/usps-tracker-registrations/list.json rename to official/docs/responses/usps-tracker-registrations/usps-tracker-registrations-list.json index b4e51846..a77d5fd7 100644 --- a/official/docs/responses/usps-tracker-registrations/list.json +++ b/official/docs/responses/usps-tracker-registrations/usps-tracker-registrations-list.json @@ -20,5 +20,6 @@ "created_at": "2026-01-15T12:00:00Z", "updated_at": "2026-01-15T12:00:01Z" } - ] + ], + "has_more": false } diff --git a/official/docs/responses/usps-tracker-registrations/retrieve.json b/official/docs/responses/usps-tracker-registrations/usps-tracker-registrations-retrieve.json similarity index 100% rename from official/docs/responses/usps-tracker-registrations/retrieve.json rename to official/docs/responses/usps-tracker-registrations/usps-tracker-registrations-retrieve.json