Release Notes & API Docs
Product and developer-experience teams
Product and developer teams: release notes, a public changelog and an API reference.
Use this templateRelease Notes & API Docs
Keep one list of what shipped, one list of what each API endpoint does, and publish the parts customers should read.
Public changelog
API reference
Writing release notes
People
Releases
| Version | Status | Type | Audience | Release date | Released on | Highlights |
|---|---|---|---|---|---|---|
| 3.0.0 | Planned | Jan 7, 2027 | — | Removes the old tracking endpoints and the legacy auth header. | ||
| 2.4.1 | Rolling out | Nov 20, 2026 | — | Performance work on rate lookups. | ||
| 2.4.0 | Released | Oct 28, 2026 | Oct 28, 2026 | Batch shipments and webhook signing. | ||
| 2.3.1 | Released | Sep 21, 2026 | Sep 21, 2026 | Fixes for time zones on tracking events. | ||
| 2.3.0 | Released | Sep 4, 2026 | Sep 4, 2026 | Address validation and label reprints. |
Changes
| Change | Release | Kind | Area | Author | Pull request | Created |
|---|---|---|---|---|---|---|
| Validate a shipping address before buying a label | 2.3.0 | Sabine Moreau | https://code.parcelwise.net/pull/900 | — | ||
| Reprint a label without charging again | 2.3.0 | Thabo Mokoena | https://code.parcelwise.net/pull/901 | — | ||
| Faster label PDF generation | 2.3.0 | Thabo Mokoena | https://code.parcelwise.net/pull/902 | — | ||
| Tracking events show the carrier’s local time zone | 2.3.1 | Sabine Moreau | https://code.parcelwise.net/pull/903 | — | ||
| Duplicate tracking events no longer appear | 2.3.1 | Thabo Mokoena | https://code.parcelwise.net/pull/904 | — | ||
| Create up to 100 shipments in one request | 2.4.0 | Ivor Pettigrew | https://code.parcelwise.net/pull/905 | — | ||
| Webhooks are signed with a per-account secret | 2.4.0 | Ivor Pettigrew | https://code.parcelwise.net/pull/906 | — | ||
| Clearer errors when a weight is missing | 2.4.0 | Thabo Mokoena | https://code.parcelwise.net/pull/907 | — |
This is the page customers see. It lists only public releases, newest first.
Customers read this page. Lead with what they can now do, not with how it was built.
| Version | Status | Type | Audience | Release date | Released on | Highlights |
|---|---|---|---|---|---|---|
| 3.0.0 | Planned | Jan 7, 2027 | — | Removes the old tracking endpoints and the legacy auth header. | ||
| 2.4.1 | Rolling out | Nov 20, 2026 | — | Performance work on rate lookups. | ||
| 2.4.0 | Released | Oct 28, 2026 | Oct 28, 2026 | Batch shipments and webhook signing. |
Everything that changed
| Change | Release | Kind | Area | Author | Pull request | Created |
|---|---|---|---|---|---|---|
| Validate a shipping address before buying a label | 2.3.0 | Sabine Moreau | https://code.parcelwise.net/pull/900 | — | ||
| Reprint a label without charging again | 2.3.0 | Thabo Mokoena | https://code.parcelwise.net/pull/901 | — | ||
| Faster label PDF generation | 2.3.0 | Thabo Mokoena | https://code.parcelwise.net/pull/902 | — |
Base address: https://api.parcelwise.net. Send your token as Authorization: Bearer.
| Endpoint | Method | Path | Resource | Auth | Status | API version |
|---|---|---|---|---|---|---|
| Create shipment | /shipments | Stable | ||||
| Create shipments in batch | /shipments/batch | Beta | ||||
| Get shipment | /shipments/{id} | Stable |
Status meanings
Errors
401 unauthorized
The token is missing, expired or revoked.
422 unprocessable
A field failed validation. The response lists each field and why.
429 too many requests
Slow down. The Retry-After header says when to try again.
Lead with the benefit — “Create 100 shipments at once” beats “Batch endpoint added.”
One change, one line — details belong in the reference.
Mark breaking changes loudly — say what to do instead.
Before publishing
Every public change has a plain-language title
Breaking changes list a migration step
The API reference matches the release
Support has read the notes
| Version | Status | Type | Audience | Release date | Released on | Highlights |
|---|---|---|---|---|---|---|
| 3.0.0 | Planned | Jan 7, 2027 | — | Removes the old tracking endpoints and the legacy auth header. | ||
| 2.4.1 | Rolling out | Nov 20, 2026 | — | Performance work on rate lookups. | ||
| 2.4.0 | Released | Oct 28, 2026 | Oct 28, 2026 | Batch shipments and webhook signing. |
What's inside
4 tables · 12 views · 1 form · 1 row action · 1 agent5 pages
- Release Notes & API Docs
- Public changelog
- API reference
- Writing release notes
- People
3 tables
- Changes2 views · 13 sample rows
- Releases6 views · 5 sample rows
- Endpoints3 views · 12 sample rows
Questions
- What is included in the Release Notes & API Docs template?
- 5 pages (Release Notes & API Docs, Public changelog, API reference, Writing release notes and People) and 3 tables (Changes, Releases and Endpoints), filled with 30 sample rows so every view opens with realistic data.
- Who is the Release Notes & API Docs template for?
- Product and developer-experience teams.
- Is the Release Notes & API Docs template free?
- Yes. Sign up free, press Use this template, and a full copy is added to your workspace.
- Can I change the template after I use it?
- Yes. Every page, table, column and view in your copy is yours to rename, edit or delete, and the sample rows can be cleared.
Related workspaces
Design system boardProduct teams: colors, type, spacing, corners and shadows as one editable board.
Design System DocsDesign and front-end teams: document components, usage rules, owners and status.
Docs HubTeams that write a lot: every document in one place with status, owner and review.
Team Wiki & Company HomeCompanies of 10 to 200: a company home with news, team pages and a wiki that stays fresh.
Tech Spec & RFC LibraryEngineering teams: write technical proposals, get them reviewed and log the decision.
SOP LibraryTeams: write down how work gets done, with owners, approvers and review dates.