Skip to content

Fill gaps from assistant conversations: clarify customer party vs account IDs - #492

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/9a5a44fb
Open

mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/9a5a44fb

Conversation

@mintlify

@mintlify mintlify Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Explains which customer ID integrations should store and how to match customers on shipments and webhook payloads.

Changes

  • Added a "Match customers in API responses and webhooks" section to the Add a Customer guide.
  • Explains that the party ID differs from the account ID in relationships.customer, and that relationships.customer is null for parties created via POST /v2/parties.
  • Explains how to match customers by party ID through GET /v2/shipments/{id}/party_roles and filter[customer_id].

Context

Several recent assistant conversations asked which customer ID appears in webhooks and which one to store. Every statement in the new section matches the OpenAPI spec and the existing guide.

Not resolved: the Aug 10, 2026 changelog says customers without a linked account are exposed under their party ID. The API reference says relationships.customer is null in that case. Engineering should confirm which behavior is current.


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

@mintlify

mintlify Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated
terminal49 🟢 Ready View Preview Oct 26, 2026, 4:11 PM

@greptile-apps

greptile-apps Bot commented Oct 26, 2026

Copy link
Copy Markdown

PR author is in the excluded authors list.

@vercel

vercel Bot commented Oct 26, 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 Oct 26, 2026 4:10pm UTC

Request Review

@github-actions github-actions Bot added the risk-shadow:high Shadow-only risk signal: high label Oct 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Shadow risk calibration

Signal Result Authority
Path classifier risk:low Deterministic advisory policy
heuristic fallback risk-shadow:high Shadow only

Calibration result: disagreement (low vs high).

Shadow risk never blocks or enables merge. Keep it in observation mode until roughly 50 pull requests have human-reviewed labels, then calibrate before considering any policy use.

@github-actions github-actions Bot added the risk:unknown Advisory evidence unavailable or changed; no merge permission label Oct 26, 2026
@github-actions github-actions Bot added risk:low Advisory path risk only; no merge permission and removed risk:unknown Advisory evidence unavailable or changed; no merge permission labels Oct 26, 2026

@SylvainGravejat SylvainGravejat left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Analysis done with Claude)

Checked against tnt-api: relationships.customer is the customer party's linked account and null without one (shipment_serializer.rb, tracking_request_serializer.rb), so the API reference is right and the open question about the Aug 10 changelog resolves to null. filter[customer_id] accepts both IDs, and the party-roles endpoint includes the party.

Two small additions to consider:

  • On a shipment shared with you by another account, relationships.customer is omitted entirely, so its absence doesn't mean "no customer".
  • Filtering by an account ID also matches that account's own shipments that have no customer role (the creator fallback documented in List filters).

This branch was successfully deployed

2 active deployments
staging - docs — 11808056 Deployed Oct 26, 2026 by mintlify[bot]
Preview — 11808056 Deployed Oct 26, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

risk:low Advisory path risk only; no merge permission risk-shadow:high Shadow-only risk signal: high

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant