Skip to content

docs: document party role endpoints and the party assignment flow - #351

Merged
maurycy merged 12 commits into
mainfrom
maurycy/party-roles-api-docs
Sep 2, 2026
Merged

docs: document party role endpoints and the party assignment flow#351
maurycy merged 12 commits into
mainfrom
maurycy/party-roles-api-docs

Conversation

@maurycy

@maurycy maurycy commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

What

  • openapi.json: GET/POST /{shipments,containers}/{id}/party_roles, DELETE .../party_roles/{id}, the party_role schema, and flag[parties] on GET /shipments and GET /shipments/{id}. Party descriptions no longer say "customer only". The tracking request customer relationship in responses is documented as an account or null, which is what the serializer returns.
  • New reference group Party Roles (6 pages) next to Parties.
  • New guide Assign Shipper, Consignee, and Other Parties: create party, get the shipment ID from the tracking request, assign roles on the shipment, read them back with flag[parties]=true&include=party_roles.party, replace a role, container dray carrier, error table.
  • adding-customer guide: cross-link, corrected response example (customer is null for parties without a linked account).
  • Changelog entry for September 2, 2026. Older entry reworded from "unbacked party" to "party without a linked account".

Tracking request party role endpoints exist but are left undocumented on purpose.

Why

A customer asked for an API way to set shipper, consignee, and freight forwarder instead of the dashboard bulk update. The endpoints exist and accept API keys, but were undocumented.

Verification

  • Every endpoint, status code, and error message in the docs was exercised with Authorization: Token against tnt-api request specs (not committed).
  • mint openapi-check: valid. mint broken-links: none. git diff --check: clean.
  • Postman collection is regenerated by CI.

🤖 Generated with Claude Code

@maurycy maurycy self-assigned this Sep 2, 2026
@vercel

vercel Bot commented Sep 2, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
api Ready Ready Preview Sep 2, 2026 9:56am UTC

Request Review

@mintlify

mintlify Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
terminal49 🟢 Ready View Preview Sep 2, 2026, 8:43 AM

Includes the regenerated Postman collection.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@maurycy
maurycy force-pushed the maurycy/party-roles-api-docs branch from 5a701c5 to 5f2b796 Compare September 2, 2026 08:53
@maurycy
maurycy merged commit 03dbb90 into main Sep 2, 2026
23 checks passed
@maurycy
maurycy deleted the maurycy/party-roles-api-docs branch September 2, 2026 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant