docs: document initial_custom_fields on create tracking request - #319
Merged
Conversation
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>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
dodeja
marked this pull request as ready for review
August 14, 2026 03:28
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.
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_requestsacceptsinitial_custom_fieldsso callers can stage shipment- and container-scoped custom field values before those records exist.shipment[]applies to the created shipment (Shipmentdefinitions)containers[]applies to matching containers (Containerdefinitions)number(or pass"") to broadcast a container value to every container on the shipmentChanges
One small accuracy fix vs #299: the MDX example SCAC is
MSCU(notMEDU).Verification
git diff --checkdocs/openapi.jsonparsesopenapi2postmanv2#299 can be closed in favor of this PR.
Test plan
numbervs Linear's originalcontainer_number;ContainervsCargoentity type)createTrackingRequestincludes the new fieldNeed help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.Greptile Summary
This PR documents the deployed
initial_custom_fieldsinput for creating tracking requests.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
initial_custom_fieldsrequest schema and example for shipment and container custom-field values.Reviews (1): Last reviewed commit: "chore: regenerate Postman collection fro..." | Re-trigger Greptile
Context used:
@terminal49/sdk)