docs: document party role endpoints and the party assignment flow - #351
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
maurycy
force-pushed
the
maurycy/party-roles-api-docs
branch
from
September 2, 2026 08:51
e7d6869 to
5a701c5
Compare
Includes the regenerated Postman collection. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
maurycy
force-pushed
the
maurycy/party-roles-api-docs
branch
from
September 2, 2026 08:53
5a701c5 to
5f2b796
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
openapi.json:GET/POST /{shipments,containers}/{id}/party_roles,DELETE .../party_roles/{id}, theparty_roleschema, andflag[parties]onGET /shipmentsandGET /shipments/{id}. Party descriptions no longer say "customer only". The tracking requestcustomerrelationship in responses is documented as an account ornull, which is what the serializer returns.flag[parties]=true&include=party_roles.party, replace a role, container dray carrier, error table.adding-customerguide: cross-link, corrected response example (customerisnullfor parties 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
Authorization: Tokenagainst tnt-api request specs (not committed).mint openapi-check: valid.mint broken-links: none.git diff --check: clean.🤖 Generated with Claude Code