Skip to content

docs: party role relationships on tracking request creation - #353

Merged
maurycy merged 4 commits into
mainfrom
maurycy/dev-12295-accept-party-roles-when-creating-a-tracking-request
Sep 2, 2026
Merged

docs: party role relationships on tracking request creation#353
maurycy merged 4 commits into
mainfrom
maurycy/dev-12295-accept-party-roles-when-creating-a-tracking-request

Conversation

@maurycy

@maurycy maurycy commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Docs for DEV-12295. Draft until the API change ships; merge together with it.

What

  • openapi.json: POST /tracking_requests accepts shipper, consignee, notify_party, customs_broker, freight_forwarder, and pickup_dray_carrier relationships next to customer, one party per role. Example request updated, 422 example for a party from another account.
  • Guide Assign Shipper, Consignee, and Other Parties: creation-time assignment becomes the first path, the shipment endpoints stay for existing shipments and for multiple parties in one role.
  • adding-customer guide: one sentence pointing at the other roles.
  • Changelog entry labelled Unreleased. Set the date at merge.

Contract as proposed in DEV-12295

  • Relationship per role, data is a single party.
  • Roles are written as PartyRole on the tracking request and copied to the shipment by the existing propagation.
  • Party from another account: 422 with source.pointer on the relationship, whole request rolled back.
  • Tracking request response unchanged; roles are read on the shipment.

If the implementation departs from this, update the docs here before merging.

🤖 Generated with Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@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 11:28am UTC

Request Review

@maurycy maurycy self-assigned this Sep 2, 2026
@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, 10:02 AM

@linear-code

linear-code Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

DEV-12295

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@maurycy
maurycy marked this pull request as ready for review September 2, 2026 11:27
@maurycy
maurycy merged commit d76f2f0 into main Sep 2, 2026
23 checks passed
@maurycy
maurycy deleted the maurycy/dev-12295-accept-party-roles-when-creating-a-tracking-request branch September 2, 2026 11:29
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