Skip to content

docs: document initial_custom_fields on create tracking request - #319

Merged
dodeja merged 3 commits into
mainfrom
cursor/rebase-initial-custom-fields-docs-8521
Aug 14, 2026
Merged

docs: document initial_custom_fields on create tracking request#319
dodeja merged 3 commits into
mainfrom
cursor/rebase-initial-custom-fields-docs-8521

Conversation

@dodeja

@dodeja dodeja commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Rebase of #299 onto current main. The original PR was conflicting (mostly generated Postman churn) while DEV-10929 is already deployed.

What this documents

POST /v2/tracking_requests accepts initial_custom_fields so callers can stage shipment- and container-scoped custom field values before those records exist.

  • shipment[] applies to the created shipment (Shipment definitions)
  • containers[] applies to matching containers (Container definitions)
  • Omit number (or pass "") to broadcast a container value to every container on the shipment

Changes

  • OpenAPI request schema + MSC BL example
  • Create-tracking-request reference page with a request example
  • Regenerated Postman collection from OpenAPI

One small accuracy fix vs #299: the MDX example SCAC is MSCU (not MEDU).

Verification

  • git diff --check
  • docs/openapi.json parses
  • Postman regenerated with openapi2postmanv2

#299 can be closed in favor of this PR.

Test plan

  • Confirm the live create-tracking-request contract matches this schema (number vs Linear's original container_number; Container vs Cargo entity type)
  • Preview the create-tracking-request page in Mintlify
  • After merge, regenerate the TypeScript SDK so createTrackingRequest includes the new field
Open in Web Open in Cursor 

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

Greptile Summary

This PR documents the deployed initial_custom_fields input for creating tracking requests.

  • Adds shipment-scoped and per-container custom-field schemas and examples to the OpenAPI source of truth.
  • Adds explanatory guidance and a complete request example to the tracking-request reference page.
  • Regenerates the Postman collection from the updated OpenAPI specification.

Confidence Score: 5/5

The documentation change appears safe to merge, with no actionable defect established in the changed contract or generated artifacts.

The OpenAPI and MDX representations agree on the new request shape and semantics, while the stale SDK and live-contract verification are explicitly acknowledged follow-up work rather than hidden regressions.

Important Files Changed

Filename Overview
docs/openapi.json Adds a consistent initial_custom_fields request schema and example for shipment and container custom-field values.
docs/api-docs/api-reference/tracking-requests/create-a-tracking-request.mdx Documents definition scoping, targeted container values, and omission or empty-string broadcast semantics.
Terminal49-API.postman_collection.json Regenerates the collection from OpenAPI; most unrelated changes are nondeterministic IDs and example values rather than new contract changes.

Reviews (1): Last reviewed commit: "chore: regenerate Postman collection fro..." | Re-trigger Greptile

Context used:

cursoragent and others added 2 commits August 14, 2026 03:28
Rebase of #299 onto current main. Documents the shipped DEV-10929
request field without the stale Postman conflict.

Co-authored-by: Akshay Dodeja <dodeja@gmail.com>
Co-authored-by: Akshay Dodeja <dodeja@gmail.com>
@mintlify

mintlify Bot commented Aug 14, 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 Aug 14, 2026, 3:28 AM

@vercel

vercel Bot commented Aug 14, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
api Ready Ready Preview Aug 14, 2026 3:29am

Request Review

@dodeja
dodeja marked this pull request as ready for review August 14, 2026 03:28
@dodeja
dodeja merged commit 36fa5bd into main Aug 14, 2026
7 checks passed
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.

2 participants