{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Terminal49","description":"Developer documentation for the Terminal49 API, DataSync, SDK, and MCP server for container tracking, shipment visibility, webhooks, and integrations.","colors":{"primary":"#1A9E52","light":"#1A9E52","dark":"#2ACD6C"},"logo":{"light":"https://mintcdn.com/terminal49/vf64v0nfd3Z9JQ4O/logos/light.svg?fit=max\u0026auto=format\u0026n=vf64v0nfd3Z9JQ4O\u0026q=85\u0026s=d4e213611d22dd79c263b9d1ffa46eea","dark":"https://mintcdn.com/terminal49/vf64v0nfd3Z9JQ4O/logos/dark.svg?fit=max\u0026auto=format\u0026n=vf64v0nfd3Z9JQ4O\u0026q=85\u0026s=4458f17b851e3549033b9bedb71fe3ba"},"favicon":"https://mintcdn.com/terminal49/tUOgDh5QtR_8-BBX/logos/favicon.svg?fit=max\u0026auto=format\u0026n=tUOgDh5QtR_8-BBX\u0026q=85\u0026s=cb027195e481e03988cbd56028fc2444","appearance":{"default":"light","strict":false},"navbar":{"links":[{"href":"https://www.terminal49.com/demo","label":"Talk To Us"}],"primary":{"type":"button","label":"Get Started","href":"https://app.terminal49.com/register"}},"footer":{"socials":{"twitter":"https://twitter.com/terminal49","linkedin":"https://www.linkedin.com/company/terminal49"},"links":[{"header":"Resources","items":[{"label":"Blog","href":"https://www.terminal49.com/blog"},{"label":"Contact","href":"https://www.terminal49.com/contact"},{"label":"Book a Demo","href":"https://www.terminal49.com/demo"}]},{"header":"Product","items":[{"label":"Sign in","href":"https://app.terminal49.com/"},{"label":"Start Free Trial","href":"https://app.terminal49.com/register"}]}]},"seo":{"metatags":{"og:type":"website","og:site_name":"Terminal49 Docs","twitter:card":"summary_large_image","twitter:site":"@terminal49"},"indexing":"all"},"integrations":{"gtm":{"tagId":"GTM-K8CDPJJG"},"posthog":{"apiKey":"phc_rBNVF6dUk5HU5m3pX9yZZWoehXoqZTCeKXFXCEoJzEyq","apiHost":"https://f.terminal49.com","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"terminal49","hasAudioNarration":false,"actualSubdomain":"terminal49","customDomains":["terminal49.com"],"gitSource":{"type":"github","owner":"terminal49","repo":"api","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af10f832f2e026614e862e3","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"SDK Docs","count":109},{"language":"default","tag":"API Reference","count":105},{"language":"default","tag":"TypeScript API Reference","count":104},{"language":"default","tag":"Managers","count":42},{"language":"default","tag":"Developer Guide","count":35},{"language":"default","tag":"Models","count":21},{"language":"default","tag":"MCP","count":16},{"language":"default","tag":"Client","count":13},{"language":"default","tag":"Containers","count":11},{"language":"default","tag":"Documents","count":11}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@terminal49.com","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6921e1f7f5047ea275ad7af0","deploymentId":"660c368041a00f5c82bccd87","questionText":"How do I get the ETA?","status":"active","generatedBy":"manual","createdAt":"2025-11-22T16:16:55.122Z","updatedAt":"2025-11-22T16:16:55.122Z","__v":0},{"_id":"6921e1caf5047ea275ad7837","deploymentId":"660c368041a00f5c82bccd87","questionText":"How do I get a containers LFD (last free day)?","status":"active","generatedBy":"manual","createdAt":"2025-11-22T16:16:10.178Z","updatedAt":"2025-11-22T16:16:10.178Z","__v":0},{"_id":"6921e1b5f5047ea275ad7732","deploymentId":"660c368041a00f5c82bccd87","questionText":"How do I start tracking a bill of lading?","status":"active","generatedBy":"manual","createdAt":"2025-11-22T16:15:49.020Z","updatedAt":"2025-11-22T16:15:49.020Z","__v":0}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"sdk/reference/types/models/interfaces/CustomField","slug":"/sdk/reference/types/models/interfaces/CustomField","pageMetadata":{"title":"Interface: CustomField","description":"CustomField interface in the Terminal49 TypeScript SDK, the account-defined custom field value attached to a container, shipment, or tracking request.","href":"/sdk/reference/types/models/interfaces/CustomField"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"CustomField interface in the Terminal49 TypeScript SDK, the account-defined custom field value attached to a container, shipment, or tracking request.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`interface-customfield`,children:`Interface: CustomField`}),`\n`,_jsx(_components.p,{children:`Account-defined custom field value on a container, shipment, or tracking request.`}),`\n`,_jsx(Heading,{level:`2`,id:`properties`,children:`Properties`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Property`}),_jsx(_components.th,{children:`Type`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(`a`,{id:`property-datatype`}),` `,_jsx(_components.code,{children:`dataType?`})]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(`a`,{id:`property-displayvalue`}),` `,_jsx(_components.code,{children:`displayValue?`})]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`string`}),` | `,_jsx(_components.code,{children:`null`})]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(`a`,{id:`property-id`}),` `,_jsx(_components.code,{children:`id`})]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(`a`,{id:`property-name`}),` `,_jsx(_components.code,{children:`name?`})]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(`a`,{id:`property-slug`}),` `,_jsx(_components.code,{children:`slug`})]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(`a`,{id:`property-updatedat`}),` `,_jsx(_components.code,{children:`updatedAt?`})]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`string`}),` | `,_jsx(_components.code,{children:`null`})]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(`a`,{id:`property-value`}),` `,_jsx(_components.code,{children:`value`})]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`unknown`})})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Interface: CustomField","description":"CustomField interface in the Terminal49 TypeScript SDK, the account-defined custom field value attached to a container, shipment, or tracking request.","href":"/sdk/reference/types/models/interfaces/CustomField"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Interface: CustomField","slug":"interface-customfield","depth":1,"children":[]},{"title":"Properties","slug":"properties","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/terminal49/bf5953d390eb98ad/segment.js","/docs/_mintlify/custom/terminal49/6a1836b84932e871/webmcp.js"],"subdomain":"terminal49","siteName":"Terminal49","title":"Interface: CustomField - Terminal49","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T00:08:25.520Z","originalFileLocation":"sdk/reference/types/models/interfaces/CustomField.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"CustomField interface in the Terminal49 TypeScript SDK, the account-defined custom field value attached to a container, shipment, or tracking request.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Terminal49\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Interface: CustomField - Terminal49\">\u003cmeta data-mint-head property=\"og:description\" content=\"CustomField interface in the Terminal49 TypeScript SDK, the account-defined custom field value attached to a container, shipment, or tracking request.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Terminal49 Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://terminal49.com/docs/sdk/reference/types/models/interfaces/CustomField\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://terminal49.mintlify.site/docs/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Interface%3A+CustomField\u0026amp;description=CustomField+interface+in+the+Terminal49+TypeScript+SDK%2C+the+account-defined+custom+field+value+attached+to+a+container%2C+shipment%2C+or+tracking+request.\u0026amp;theme=7be098b423a76a1dd960de64\u0026amp;signature=4961e329559e75c98a6569302b1552884a521d683cca5d3076de19566073f25b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Interface: CustomField - Terminal49\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"CustomField interface in the Terminal49 TypeScript SDK, the account-defined custom field value attached to a container, shipment, or tracking request.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://terminal49.mintlify.site/docs/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Interface%3A+CustomField\u0026amp;description=CustomField+interface+in+the+Terminal49+TypeScript+SDK%2C+the+account-defined+custom+field+value+attached+to+a+container%2C+shipment%2C+or+tracking+request.\u0026amp;theme=7be098b423a76a1dd960de64\u0026amp;signature=4961e329559e75c98a6569302b1552884a521d683cca5d3076de19566073f25b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Terminal49\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A9E52\">\u003clink data-mint-head rel=\"canonical\" href=\"https://terminal49.com/docs/sdk/reference/types/models/interfaces/CustomField\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/sdk/reference/types/models/interfaces/CustomField.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://terminal49.com/#organization\",\"name\":\"Terminal49\",\"url\":\"https://terminal49.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/terminal49/vf64v0nfd3Z9JQ4O/logos/light.svg?fit=max\u0026auto=format\u0026n=vf64v0nfd3Z9JQ4O\u0026q=85\u0026s=d4e213611d22dd79c263b9d1ffa46eea\"}},{\"@type\":\"WebSite\",\"@id\":\"https://terminal49.com/docs#website\",\"name\":\"Terminal49\",\"url\":\"https://terminal49.com/docs\",\"publisher\":{\"@id\":\"https://terminal49.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://terminal49.com/docs/sdk/reference/types/models/interfaces/CustomField#webpage\",\"url\":\"https://terminal49.com/docs/sdk/reference/types/models/interfaces/CustomField\",\"name\":\"Interface: CustomField\",\"description\":\"CustomField interface in the Terminal49 TypeScript SDK, the account-defined custom field value attached to a container, shipment, or tracking request.\",\"dateModified\":\"2026-10-05T00:08:25.520Z\",\"isPartOf\":{\"@id\":\"https://terminal49.com/docs#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://terminal49.com/docs/sdk/reference/types/models/interfaces/CustomField#article\",\"headline\":\"Interface: CustomField\",\"name\":\"Interface: CustomField\",\"description\":\"CustomField interface in the Terminal49 TypeScript SDK, the account-defined custom field value attached to a container, shipment, or tracking request.\",\"url\":\"https://terminal49.com/docs/sdk/reference/types/models/interfaces/CustomField\",\"mainEntityOfPage\":{\"@id\":\"https://terminal49.com/docs/sdk/reference/types/models/interfaces/CustomField#webpage\"},\"dateModified\":\"2026-10-05T00:08:25.520Z\",\"publisher\":{\"@id\":\"https://terminal49.com/#organization\"},\"isPartOf\":{\"@id\":\"https://terminal49.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Terminal49\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Terminal49","nav":{"global":{},"tabs":[{"tab":"Developer Guide","icon":"book","groups":[{"group":" ","pages":[{"title":"Terminal49 Developer Documentation","sidebarTitle":"Home","mode":"frame","href":"/home"}]},{"group":"Getting Started","icon":"play","pages":[{"title":"Start Here: Track Shipments with the Terminal49 API","sidebarTitle":"1. Start Here","href":"/api-docs/getting-started/start-here"},{"title":"Track Shipments and Containers","sidebarTitle":"2. Tracking Shipments \u0026 Containers","href":"/api-docs/getting-started/tracking-shipments-and-containers"},{"title":"List Shipments and Containers","sidebarTitle":"3. List Shipments \u0026 Containers","href":"/api-docs/getting-started/list-shipments-and-containers"},{"title":"Receive shipment status updates with webhooks","sidebarTitle":"4. Status Updates","href":"/api-docs/getting-started/receive-status-updates"}]},{"group":"Tracking Fundamentals","icon":"compass","pages":[{"title":"Tracking request lifecycle","href":"/api-docs/in-depth-guides/tracking-request-lifecycle"},{"title":"Terminal49 Container Statuses","href":"/api-docs/in-depth-guides/container-statuses"},{"title":"Event Timestamps","href":"/api-docs/in-depth-guides/event-timestamps"},{"title":"Container Holds, Fees, and Release Readiness","href":"/api-docs/in-depth-guides/holds-and-fees"},{"title":"Identify your carrier with Infer Tracking Number","sidebarTitle":"Infer Tracking Number 🆕","href":"/api-docs/in-depth-guides/auto-detect-carrier"},{"title":"Add a Customer to a Tracking Request","href":"/api-docs/in-depth-guides/adding-customer"},{"title":"Assign Shipper, Consignee, and Other Parties","href":"/api-docs/in-depth-guides/assigning-parties"}]},{"group":"Webhooks \u0026 Events","icon":"webhook","pages":[{"title":"Why Webhooks","sidebarTitle":"Overview","href":"/api-docs/webhooks/overview"},{"title":"Set up webhooks","sidebarTitle":"Set Up Webhooks","href":"/api-docs/in-depth-guides/webhooks"},{"title":"Webhook event catalog","sidebarTitle":"Event Catalog","href":"/api-docs/webhooks/event-catalog"},{"title":"Webhook Payloads","sidebarTitle":"Payloads","href":"/api-docs/webhooks/payloads"},{"title":"Terminal49 Webhook Event Examples","href":"/api-docs/useful-info/webhook-events-examples"},{"group":"Use Cases","pages":[{"title":"Monitor ETA Changes with Webhooks","sidebarTitle":"ETA Monitoring","href":"/api-docs/webhooks/use-cases/eta-monitoring"},{"title":"Alert on LFD Changes and Container Availability","sidebarTitle":"LFD \u0026 Availability Alerts","href":"/api-docs/webhooks/use-cases/lfd-alerts"},{"title":"Track container milestones with webhooks","sidebarTitle":"Milestone Tracking","href":"/api-docs/webhooks/use-cases/milestone-tracking"}]},{"title":"Webhook best practices","sidebarTitle":"Best Practices","href":"/api-docs/webhooks/best-practices"}]},{"group":"Integrations \u0026 Embeds","icon":"puzzle-piece","pages":[{"title":"Integrate rail container tracking data","mode":"wide","href":"/api-docs/in-depth-guides/rail-integration-guide"},{"title":"Vessel and Container Route Data","mode":"wide","href":"/api-docs/in-depth-guides/routing"},{"title":"Terminal49 Map Embed Guide","href":"/api-docs/in-depth-guides/terminal49-map"},{"title":"Tracking widget embed guide","href":"/api-docs/in-depth-guides/terminal49-widget"},{"title":"Direct Links to Shipments and Containers","sidebarTitle":"Tracking Page Links","href":"/api-docs/in-depth-guides/dashboard-deep-linking"},{"title":"Document processing workflows","sidebarTitle":"Document Processing Workflows","href":"/api-docs/in-depth-guides/document-processing-workflows"}]},{"group":"Platform \u0026 Reference","icon":"book-open","pages":[{"title":"Rate Limiting","href":"/api-docs/in-depth-guides/rate-limiting"},{"title":"Include related resources in API responses","href":"/api-docs/in-depth-guides/including-resources"},{"title":"Filter shipments and containers with the API","href":"/api-docs/in-depth-guides/filtering-shipments-and-containers"},{"title":"Terminal49 API Quickstart","sidebarTitle":"Quick Start Guide","href":"/api-docs/in-depth-guides/quickstart"},{"title":"Terminal49 API Pricing","href":"/api-docs/useful-info/pricing"},{"title":"Entitlements and Paid Features","href":"/api-docs/useful-info/entitlements"},{"title":"Terminal49 Test Tracking Numbers","href":"/api-docs/useful-info/test-numbers"},{"title":"Tracking request retry behavior","href":"/api-docs/useful-info/tracking-request-retrying"}]}]},{"tab":"API Reference","icon":"code","groups":[{"group":" ","pages":[{"title":"Terminal49 API Reference: Ocean Container Tracking","sidebarTitle":"Introduction","href":"/api-docs/api-reference/introduction"},{"title":"Shipment and container list filter reference","sidebarTitle":"List filters","href":"/api-docs/api-reference/list-filters"}]},{"group":"Tracking Requests","icon":"search","pages":[{"title":"List tracking requests","openapi":"get /tracking_requests","href":"/api-docs/api-reference/tracking-requests/list-tracking-requests"},{"title":"Create a tracking request","openapi":"post /tracking_requests","href":"/api-docs/api-reference/tracking-requests/create-a-tracking-request"},{"title":"Get a tracking request","openapi":"get /tracking_requests/{id}","href":"/api-docs/api-reference/tracking-requests/get-a-single-tracking-request"},{"title":"Edit a tracking request","openapi":"patch /tracking_requests/{id}","href":"/api-docs/api-reference/tracking-requests/edit-a-tracking-request"},{"title":"Cancel a tracking request","openapi":"patch /tracking_requests/{id}/cancel","href":"/api-docs/api-reference/tracking-requests/cancel-a-tracking-request"},{"title":"Infer Tracking Number (Beta)","sidebarTitle":"Infer Tracking Number 🆕","openapi":"post /tracking_requests/infer_number","href":"/api-docs/api-reference/tracking-requests/auto-detect-carrier"},{"title":"List tracking request custom fields","openapi":"get /tracking_requests/{tracking_request_id}/custom_fields","href":"/api-docs/api-reference/tracking-requests/list-tracking-request-custom-fields"},{"title":"Create tracking request custom field","openapi":"post /tracking_requests/{tracking_request_id}/custom_fields","href":"/api-docs/api-reference/tracking-requests/create-tracking-request-custom-field"},{"title":"Update tracking request custom field","openapi":"patch /tracking_requests/{tracking_request_id}/custom_fields/{api_slug}","href":"/api-docs/api-reference/tracking-requests/update-tracking-request-custom-field"},{"title":"Delete tracking request custom field","openapi":"delete /tracking_requests/{tracking_request_id}/custom_fields/{api_slug}","href":"/api-docs/api-reference/tracking-requests/delete-tracking-request-custom-field"}]},{"group":"Shipments","icon":"ship","pages":[{"title":"List shipments","openapi":"get /shipments","href":"/api-docs/api-reference/shipments/list-shipments"},{"title":"Get a shipment","openapi":"get /shipments/{id}","href":"/api-docs/api-reference/shipments/get-a-shipment"},{"title":"Edit a shipment","openapi":"patch /shipments/{id}","href":"/api-docs/api-reference/shipments/edit-a-shipment"},{"title":"List shipment custom fields","openapi":"get /shipments/{shipment_id}/custom_fields","href":"/api-docs/api-reference/shipments/list-shipment-custom-fields"},{"title":"Create shipment custom field","openapi":"post /shipments/{shipment_id}/custom_fields","href":"/api-docs/api-reference/shipments/create-shipment-custom-field"},{"title":"Update shipment custom field","openapi":"patch /shipments/{shipment_id}/custom_fields/{api_slug}","href":"/api-docs/api-reference/shipments/update-shipment-custom-field"},{"title":"Delete shipment custom field","openapi":"delete /shipments/{shipment_id}/custom_fields/{api_slug}","href":"/api-docs/api-reference/shipments/delete-shipment-custom-field"},{"title":"Stop tracking a shipment","openapi":"patch /shipments/{id}/stop_tracking","href":"/api-docs/api-reference/shipments/stop-tracking-shipment"},{"title":"Resume tracking a shipment","openapi":"patch /shipments/{id}/resume_tracking","href":"/api-docs/api-reference/shipments/resume-tracking-shipment"}]},{"group":"Containers","icon":"warehouse","pages":[{"title":"List containers","openapi":"get /containers","href":"/api-docs/api-reference/containers/list-containers"},{"title":"Edit a container","openapi":"patch /containers/{id}","href":"/api-docs/api-reference/containers/edit-a-container"},{"title":"Get a container","openapi":"get /containers/{id}","href":"/api-docs/api-reference/containers/get-a-container"},{"title":"List container custom fields","openapi":"get /containers/{container_id}/custom_fields","href":"/api-docs/api-reference/containers/list-container-custom-fields"},{"title":"Create container custom field","openapi":"post /containers/{container_id}/custom_fields","href":"/api-docs/api-reference/containers/create-container-custom-field"},{"title":"Update container custom field","openapi":"patch /containers/{container_id}/custom_fields/{api_slug}","href":"/api-docs/api-reference/containers/update-container-custom-field"},{"title":"Delete container custom field","openapi":"delete /containers/{container_id}/custom_fields/{api_slug}","href":"/api-docs/api-reference/containers/delete-container-custom-field"},{"title":"Refresh a container","openapi":"patch /containers/{id}/refresh","href":"/api-docs/api-reference/containers/refresh-container"},{"title":"Get container map GeoJSON","openapi":"get /containers/{id}/map_geojson","href":"/api-docs/api-reference/containers/get-container-map-geojson"},{"title":"Get a container's raw events","openapi":"get /containers/{id}/raw_events","href":"/api-docs/api-reference/containers/get-a-containers-raw-events"},{"title":"Get a container's transport events","openapi":"get /containers/{id}/transport_events","href":"/api-docs/api-reference/containers/get-a-containers-transport-events"}]},{"group":"Documents","icon":"file","pages":[{"title":"List documents","openapi":"get /documents","href":"/api-docs/api-reference/documents/list-documents"},{"title":"Upload a document","openapi":"post /documents","href":"/api-docs/api-reference/documents/upload-a-document"},{"title":"Get a document","openapi":"get /documents/{id}","href":"/api-docs/api-reference/documents/get-a-document"},{"title":"Edit a document","openapi":"patch /documents/{id}","href":"/api-docs/api-reference/documents/edit-a-document"},{"title":"Delete a document","openapi":"delete /documents/{id}","href":"/api-docs/api-reference/documents/delete-a-document"},{"title":"List document types","openapi":"get /documents/types","href":"/api-docs/api-reference/documents/list-document-types"},{"title":"Get a document download URL","openapi":"get /documents/{id}/download_url","href":"/api-docs/api-reference/documents/get-a-document-download-url"},{"title":"Re-extract a document","openapi":"post /documents/{id}/reextract","href":"/api-docs/api-reference/documents/re-extract-a-document"},{"title":"Re-classify a document","openapi":"post /documents/{id}/reclassify","href":"/api-docs/api-reference/documents/re-classify-a-document"},{"title":"Re-link a document","openapi":"post /documents/{id}/relink","href":"/api-docs/api-reference/documents/re-link-a-document"},{"title":"Rotate a document","openapi":"post /documents/{id}/rotate","href":"/api-docs/api-reference/documents/rotate-a-document"}]},{"group":"Email Submissions","icon":"envelope","pages":[{"title":"List email submissions","openapi":"get /email_submissions","href":"/api-docs/api-reference/email-submissions/list-email-submissions"},{"title":"Get an email submission","openapi":"get /email_submissions/{id}","href":"/api-docs/api-reference/email-submissions/get-an-email-submission"}]},{"group":"Document Schemas","icon":"brackets-curly","pages":[{"title":"Get a document schema","openapi":"get /document_schemas/{id}","href":"/api-docs/api-reference/document-schemas/get-a-document-schema"}]},{"group":"Document Representations","icon":"binary","pages":[{"title":"Document representations resource","href":"/api-docs/api-reference/document-representations/document-representations-resource"}]},{"group":"Search","icon":"magnifying-glass","pages":[{"title":"Search","openapi":"get /search","href":"/api-docs/api-reference/search/search"}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"Get a single webhook","openapi":"get /webhooks/{id}","href":"/api-docs/api-reference/webhooks/get-single-webhook"},{"title":"Delete a webhook","openapi":"delete /webhooks/{id}","href":"/api-docs/api-reference/webhooks/delete-a-webhook"},{"title":"Edit a webhook","openapi":"patch /webhooks/{id}","href":"/api-docs/api-reference/webhooks/edit-a-webhook"},{"title":"List webhooks","openapi":"get /webhooks","href":"/api-docs/api-reference/webhooks/list-webhooks"},{"title":"List webhook events","openapi":"get /webhooks/events","href":"/api-docs/api-reference/webhooks/list-webhook-events"},{"title":"Create a webhook","openapi":"post /webhooks","href":"/api-docs/api-reference/webhooks/create-a-webhook"},{"title":"Trigger a webhook test delivery","openapi":"post /webhooks/trigger","href":"/api-docs/api-reference/webhooks/trigger-a-webhook"},{"title":"List webhook IPs","openapi":"get /webhooks/ips","href":"/api-docs/api-reference/webhooks/list-webhook-ips"}]},{"group":"Webhook Notifications","icon":"bell","pages":[{"title":"Get a single webhook notification","openapi":"get /webhook_notifications/{id}","href":"/api-docs/api-reference/webhook-notifications/get-a-single-webhook-notification"},{"title":"List webhook notifications","openapi":"get /webhook_notifications","href":"/api-docs/api-reference/webhook-notifications/list-webhook-notifications"},{"title":"Get webhook notification payload examples","openapi":"get /webhook_notifications/examples","href":"/api-docs/api-reference/webhook-notifications/get-webhook-notification-payload-examples"}]},{"group":"Custom Field Definitions","pages":[{"title":"List account custom field definitions","openapi":"get /accounts/{account_id}/custom_field_definitions","href":"/api-docs/api-reference/custom-fields/list-account-custom-field-definitions"},{"title":"Create an account custom field definition","openapi":"post /accounts/{account_id}/custom_field_definitions","href":"/api-docs/api-reference/custom-fields/create-account-custom-field-definition"},{"title":"List custom field definition templates","openapi":"get /custom_field_definitions","href":"/api-docs/api-reference/custom-fields/list-custom-field-definitions"},{"title":"Get a custom field definition","openapi":"get /custom_field_definitions/{id}","href":"/api-docs/api-reference/custom-fields/get-a-custom-field-definition"},{"title":"Create a custom field definition template","openapi":"post /custom_field_definitions","href":"/api-docs/api-reference/custom-fields/create-a-custom-field-definition"},{"title":"Update a custom field definition","openapi":"patch /custom_field_definitions/{id}","href":"/api-docs/api-reference/custom-fields/update-a-custom-field-definition"},{"title":"Delete a custom field definition","openapi":"delete /custom_field_definitions/{id}","href":"/api-docs/api-reference/custom-fields/delete-a-custom-field-definition"}]},{"group":"Custom Field Options","pages":[{"title":"List custom field options","openapi":"get /custom_field_definitions/{definition_id}/options","href":"/api-docs/api-reference/custom-fields/list-custom-field-options"},{"title":"Get a custom field option","openapi":"get /custom_field_definitions/{definition_id}/options/{option_id}","href":"/api-docs/api-reference/custom-fields/get-a-custom-field-option"},{"title":"Create a custom field option","openapi":"post /custom_field_definitions/{definition_id}/options","href":"/api-docs/api-reference/custom-fields/create-a-custom-field-option"},{"title":"Update a custom field option","openapi":"patch /custom_field_definitions/{definition_id}/options/{option_id}","href":"/api-docs/api-reference/custom-fields/update-a-custom-field-option"},{"title":"Delete a custom field option","openapi":"delete /custom_field_definitions/{definition_id}/options/{option_id}","href":"/api-docs/api-reference/custom-fields/delete-a-custom-field-option"}]},{"group":"Custom Fields","pages":[{"title":"List custom fields","openapi":"get /custom_fields","href":"/api-docs/api-reference/custom-fields/list-custom-fields"},{"title":"Get a custom field","openapi":"get /custom_fields/{id}","href":"/api-docs/api-reference/custom-fields/get-a-custom-field"},{"title":"Create a custom field","openapi":"post /custom_fields","href":"/api-docs/api-reference/custom-fields/create-a-custom-field"},{"title":"Update a custom field","openapi":"patch /custom_fields/{id}","href":"/api-docs/api-reference/custom-fields/update-a-custom-field"},{"title":"Delete a custom field","openapi":"delete /custom_fields/{id}","href":"/api-docs/api-reference/custom-fields/delete-a-custom-field"}]},{"group":"Account","icon":"id-badge","pages":[{"title":"Get the current credential","openapi":"get /me","href":"/api-docs/api-reference/account/get-the-current-credential"}]},{"group":"Trade Intelligence","icon":"chart-line","pages":[{"title":"Get trade intelligence coverage","openapi":"get /trade_intel/meta","href":"/api-docs/api-reference/trade-intelligence/get-trade-intelligence-coverage"},{"title":"Search importers","openapi":"post /trade_intel/companies/search","href":"/api-docs/api-reference/trade-intelligence/search-importers"},{"title":"Get an importer profile","openapi":"post /trade_intel/companies/profile","href":"/api-docs/api-reference/trade-intelligence/get-an-importer-profile"},{"title":"Search commodities","openapi":"post /trade_intel/commodities/search","href":"/api-docs/api-reference/trade-intelligence/search-commodities"},{"title":"Rank importers","openapi":"post /trade_intel/importers/top","href":"/api-docs/api-reference/trade-intelligence/rank-importers"},{"title":"Get import trends","openapi":"post /trade_intel/trends","href":"/api-docs/api-reference/trade-intelligence/get-import-trends"},{"title":"Get an import breakdown","openapi":"post /trade_intel/breakdown","href":"/api-docs/api-reference/trade-intelligence/get-an-import-breakdown"},{"title":"Look up a container's import record","openapi":"post /trade_intel/containers/lookup","href":"/api-docs/api-reference/trade-intelligence/look-up-a-containers-import-record"},{"title":"Look up a bill of lading","openapi":"post /trade_intel/bills_of_lading/lookup","href":"/api-docs/api-reference/trade-intelligence/look-up-a-bill-of-lading"}]},{"group":"Shipping Lines","icon":"ship","pages":[{"title":"List shipping lines","openapi":"get /shipping_lines","href":"/api-docs/api-reference/shipping-lines/shipping-lines"},{"title":"Get a single shipping line","openapi":"get /shipping_lines/{id}","href":"/api-docs/api-reference/shipping-lines/get-a-single-shipping-line"}]},{"group":"Metro Areas","icon":"map-pin","pages":[{"title":"Get a metro area","openapi":"get /metro_areas/{id}","href":"/api-docs/api-reference/metro-areas/get-a-metro-area-using-the-unlocode-or-the-id"}]},{"group":"Ports","icon":"anchor","pages":[{"title":"Get a port","openapi":"get /ports/{id}","href":"/api-docs/api-reference/ports/get-a-port-using-the-locode-or-the-id"}]},{"group":"Vessels","icon":"sailboat","pages":[{"title":"Get a vessel by ID","openapi":"get /vessels/{id}","href":"/api-docs/api-reference/vessels/get-a-vessel-using-the-id"},{"title":"Get a vessel by IMO","openapi":"get /vessels/{imo}","href":"/api-docs/api-reference/vessels/get-a-vessel-using-the-imo"},{"title":"Get vessel future positions","openapi":"get /vessels/{id}/future_positions","href":"/api-docs/api-reference/vessels/get-vessel-future-positions"},{"title":"Get vessel future positions from coordinates","openapi":"get /vessels/{id}/future_positions_with_coordinates","href":"/api-docs/api-reference/vessels/get-vessel-future-positions-with-coordinates"}]},{"group":"Terminals","icon":"warehouse","pages":[{"title":"Get a terminal","openapi":"get /terminals/{id}","href":"/api-docs/api-reference/terminals/get-a-terminal-using-the-id"}]},{"group":"Parties","icon":"users","pages":[{"title":"List parties","openapi":"get /parties","href":"/api-docs/api-reference/parties/list-parties"},{"title":"Create a party","openapi":"post /parties","href":"/api-docs/api-reference/parties/create-a-party"},{"title":"Get a party","openapi":"get /parties/{id}","href":"/api-docs/api-reference/parties/get-a-party"},{"title":"Edit a party","openapi":"patch /parties/{id}","href":"/api-docs/api-reference/parties/edit-a-party"}]},{"group":"Party Roles","icon":"user-tag","pages":[{"title":"List shipment party roles","openapi":"get /shipments/{shipment_id}/party_roles","href":"/api-docs/api-reference/party-roles/list-shipment-party-roles"},{"title":"Assign a shipment party role","openapi":"post /shipments/{shipment_id}/party_roles","href":"/api-docs/api-reference/party-roles/assign-a-shipment-party-role"},{"title":"Remove a shipment party role","openapi":"delete /shipments/{shipment_id}/party_roles/{id}","href":"/api-docs/api-reference/party-roles/remove-a-shipment-party-role"},{"title":"List container party roles","openapi":"get /containers/{container_id}/party_roles","href":"/api-docs/api-reference/party-roles/list-container-party-roles"},{"title":"Assign a container party role","openapi":"post /containers/{container_id}/party_roles","href":"/api-docs/api-reference/party-roles/assign-a-container-party-role"},{"title":"Remove a container party role","openapi":"delete /containers/{container_id}/party_roles/{id}","href":"/api-docs/api-reference/party-roles/remove-a-container-party-role"}]}]},{"tab":"Data Coverage","icon":"globe","groups":[{"group":" ","pages":[{"title":"Data coverage","sidebarTitle":"Overview","mode":"wide","href":"/coverage/home"}]},{"group":"Sources","icon":"database","pages":[{"title":"Ocean carriers","mode":"wide","href":"/coverage/ocean-carriers"},{"title":"Ports \u0026 terminals","mode":"wide","href":"/coverage/terminals"},{"title":"Rail carriers","mode":"wide","href":"/coverage/rail"},{"title":"Inland rail terminals","mode":"wide","href":"/coverage/inland-rail-terminals"},{"title":"Vessels","mode":"wide","href":"/coverage/vessels"}]},{"group":"Fields","icon":"table","pages":[{"title":"Field availability","mode":"wide","href":"/coverage/fields"}]},{"group":"Updates","icon":"clock-rotate-left","pages":[{"title":"Coverage changelog","mode":"wide","href":"/coverage/changelog"}]}]},{"tab":"Migrate to T49","icon":"arrow-right-arrow-left","groups":[{"group":" ","pages":[{"title":"Migrate to Terminal49","sidebarTitle":"Overview","href":"/migrate/home"}]},{"group":"Migration Guides","icon":"list-check","pages":[{"title":"Migrate from SeaRates to Terminal49 API","sidebarTitle":"SeaRates","href":"/migrate/searates"},{"title":"Migrating from Project44","sidebarTitle":"Project44","href":"/migrate/project44"},{"title":"Migrating from FourKites","sidebarTitle":"FourKites","href":"/migrate/fourkites"},{"title":"Migrating from Gnosis Freight","sidebarTitle":"Gnosis Freight","href":"/migrate/gnosisfreight"},{"title":"Migrating from Vizion","sidebarTitle":"Vizion","href":"/migrate/vizion"},{"title":"Migrating from OpenTrack","sidebarTitle":"OpenTrack","href":"/migrate/opentrack"},{"title":"Migrating from ShipsGo","sidebarTitle":"ShipsGo","href":"/migrate/shipsgo"},{"title":"Migrating from GoComet","sidebarTitle":"GoComet","href":"/migrate/gocomet"},{"title":"Migrating from Beacon","sidebarTitle":"Beacon","href":"/migrate/beacon"}]}]},{"tab":"SDK Docs","icon":"rectangle-terminal","groups":[{"group":"Getting Started","pages":[{"title":"Terminal49 TypeScript SDK","sidebarTitle":"Introduction","href":"/sdk/introduction"},{"title":"Terminal49 SDK Quickstart","sidebarTitle":"Quickstart","href":"/sdk/quickstart"}]},{"group":"Reference","pages":[{"title":"Terminal49 SDK Methods Reference","sidebarTitle":"Methods Reference","href":"/sdk/methods"},{"title":"Terminal49 SDK Filtering and Pagination","sidebarTitle":"Filtering \u0026 Pagination","href":"/sdk/filtering-pagination"},{"title":"Terminal49 SDK Error Handling","sidebarTitle":"Error Handling","href":"/sdk/error-handling"}]},{"group":"TypeScript API Reference","pages":[{"title":"Terminal49 TypeScript SDK API reference","href":"/sdk/reference/index"},{"group":"Client","pages":[{"title":"client module: Terminal49 TypeScript SDK reference","href":"/sdk/reference/client/index"},{"title":"Class: Terminal49Client","href":"/sdk/reference/client/classes/Terminal49Client"},{"title":"Interface: Terminal49ClientConfig","href":"/sdk/reference/client/interfaces/Terminal49ClientConfig"},{"title":"Interface: CustomFieldDefinitionListFilters","href":"/sdk/reference/client/interfaces/CustomFieldDefinitionListFilters"},{"title":"Interface: CustomFieldDefinitionListOptions","href":"/sdk/reference/client/interfaces/CustomFieldDefinitionListOptions"},{"title":"Interface: CustomFieldListFilters","href":"/sdk/reference/client/interfaces/CustomFieldListFilters"},{"title":"Interface: TriggerWebhookParams","href":"/sdk/reference/client/interfaces/TriggerWebhookParams"},{"title":"Interface: VesselFuturePositionsParams","href":"/sdk/reference/client/interfaces/VesselFuturePositionsParams"},{"title":"Interface: VesselFuturePositionsWithCoordsParams","href":"/sdk/reference/client/interfaces/VesselFuturePositionsWithCoordsParams"},{"title":"Interface: WebhookNotificationGetOptions","href":"/sdk/reference/client/interfaces/WebhookNotificationGetOptions"},{"title":"Interface: WebhookNotificationListOptions","href":"/sdk/reference/client/interfaces/WebhookNotificationListOptions"},{"title":"Type Alias: PartyAttributes","href":"/sdk/reference/client/type-aliases/PartyAttributes"},{"title":"Type Alias: WebhookEvent","href":"/sdk/reference/client/type-aliases/WebhookEvent"}]},{"group":"Managers","pages":[{"title":"client/managers: Terminal49 SDK resource managers","href":"/sdk/reference/client/managers/index"},{"title":"Class: BaseManager","href":"/sdk/reference/client/managers/classes/BaseManager"},{"title":"Class: ContainerManager","href":"/sdk/reference/client/managers/classes/ContainerManager"},{"title":"Class: DocumentManager","href":"/sdk/reference/client/managers/classes/DocumentManager"},{"title":"Class: DocumentSchemaManager","href":"/sdk/reference/client/managers/classes/DocumentSchemaManager"},{"title":"Class: EmailSubmissionManager","href":"/sdk/reference/client/managers/classes/EmailSubmissionManager"},{"title":"Class: ShipmentManager","href":"/sdk/reference/client/managers/classes/ShipmentManager"},{"title":"Class: ShippingLineManager","href":"/sdk/reference/client/managers/classes/ShippingLineManager"},{"title":"Class: TrackingRequestManager","href":"/sdk/reference/client/managers/classes/TrackingRequestManager"},{"title":"Class: TradeIntelManager","href":"/sdk/reference/client/managers/classes/TradeIntelManager"},{"title":"Interface: ContainerAddPartyRoleParams","href":"/sdk/reference/client/managers/interfaces/ContainerAddPartyRoleParams"},{"title":"Interface: CreateDocumentParams","href":"/sdk/reference/client/managers/interfaces/CreateDocumentParams"},{"title":"Interface: CreateTrackingRequestFromInferOptions","href":"/sdk/reference/client/managers/interfaces/CreateTrackingRequestFromInferOptions"},{"title":"Interface: DocumentListFilters","href":"/sdk/reference/client/managers/interfaces/DocumentListFilters"},{"title":"Interface: ShipmentAddPartyRoleParams","href":"/sdk/reference/client/managers/interfaces/ShipmentAddPartyRoleParams"},{"title":"Interface: TrackingRequestListFilters","href":"/sdk/reference/client/managers/interfaces/TrackingRequestListFilters"},{"title":"Interface: UpdateDocumentParams","href":"/sdk/reference/client/managers/interfaces/UpdateDocumentParams"},{"title":"Interface: TradeIntelBillOfLadingLookupOptions","href":"/sdk/reference/client/managers/interfaces/TradeIntelBillOfLadingLookupOptions"},{"title":"Type Alias: ContainerUpdateAttributes","href":"/sdk/reference/client/managers/type-aliases/ContainerUpdateAttributes"},{"title":"Type Alias: DocumentRotation","href":"/sdk/reference/client/managers/type-aliases/DocumentRotation"},{"title":"Type Alias: ShipmentUpdateAttributes","href":"/sdk/reference/client/managers/type-aliases/ShipmentUpdateAttributes"},{"title":"Type Alias: TrackingRequestType","href":"/sdk/reference/client/managers/type-aliases/TrackingRequestType"},{"title":"Type Alias: TrackingRequestUpdateAttributes","href":"/sdk/reference/client/managers/type-aliases/TrackingRequestUpdateAttributes"},{"title":"Type Alias: TradeIntelBillOfLadingLookup","href":"/sdk/reference/client/managers/type-aliases/TradeIntelBillOfLadingLookup"},{"title":"Type Alias: TradeIntelBreakdown","href":"/sdk/reference/client/managers/type-aliases/TradeIntelBreakdown"},{"title":"Type Alias: TradeIntelBreakdownRequest","href":"/sdk/reference/client/managers/type-aliases/TradeIntelBreakdownRequest"},{"title":"Type Alias: TradeIntelCommoditySearchRequest","href":"/sdk/reference/client/managers/type-aliases/TradeIntelCommoditySearchRequest"},{"title":"Type Alias: TradeIntelCommoditySearchResponse","href":"/sdk/reference/client/managers/type-aliases/TradeIntelCommoditySearchResponse"},{"title":"Type Alias: TradeIntelCompanyProfile","href":"/sdk/reference/client/managers/type-aliases/TradeIntelCompanyProfile"},{"title":"Type Alias: TradeIntelCompanyProfileRequest","href":"/sdk/reference/client/managers/type-aliases/TradeIntelCompanyProfileRequest"},{"title":"Type Alias: TradeIntelCompanySearchRequest","href":"/sdk/reference/client/managers/type-aliases/TradeIntelCompanySearchRequest"},{"title":"Type Alias: TradeIntelCompanySearchResponse","href":"/sdk/reference/client/managers/type-aliases/TradeIntelCompanySearchResponse"},{"title":"Type Alias: TradeIntelCompanySearchResult","href":"/sdk/reference/client/managers/type-aliases/TradeIntelCompanySearchResult"},{"title":"Type Alias: TradeIntelContainerLookup","href":"/sdk/reference/client/managers/type-aliases/TradeIntelContainerLookup"},{"title":"Type Alias: TradeIntelDimension","href":"/sdk/reference/client/managers/type-aliases/TradeIntelDimension"},{"title":"Type Alias: TradeIntelFilters","href":"/sdk/reference/client/managers/type-aliases/TradeIntelFilters"},{"title":"Type Alias: TradeIntelMeasure","href":"/sdk/reference/client/managers/type-aliases/TradeIntelMeasure"},{"title":"Type Alias: TradeIntelMeta","href":"/sdk/reference/client/managers/type-aliases/TradeIntelMeta"},{"title":"Type Alias: TradeIntelTopImporters","href":"/sdk/reference/client/managers/type-aliases/TradeIntelTopImporters"},{"title":"Type Alias: TradeIntelTopImportersRequest","href":"/sdk/reference/client/managers/type-aliases/TradeIntelTopImportersRequest"},{"title":"Type Alias: TradeIntelTrends","href":"/sdk/reference/client/managers/type-aliases/TradeIntelTrends"},{"title":"Type Alias: TradeIntelTrendsRequest","href":"/sdk/reference/client/managers/type-aliases/TradeIntelTrendsRequest"}]},{"group":"Errors","pages":[{"title":"Class: AuthenticationError","href":"/sdk/reference/client/classes/AuthenticationError"},{"title":"Class: AuthorizationError","href":"/sdk/reference/client/classes/AuthorizationError"},{"title":"Class: FeatureNotEnabledError","href":"/sdk/reference/client/classes/FeatureNotEnabledError"},{"title":"Class: NotFoundError","href":"/sdk/reference/client/classes/NotFoundError"},{"title":"Class: RateLimitError","href":"/sdk/reference/client/classes/RateLimitError"},{"title":"Class: Terminal49Error","href":"/sdk/reference/client/classes/Terminal49Error"},{"title":"Class: UpstreamError","href":"/sdk/reference/client/classes/UpstreamError"},{"title":"Class: ValidationError","href":"/sdk/reference/client/classes/ValidationError"}]},{"group":"Interceptors","pages":[{"title":"client/interceptors: Terminal49 SDK request interceptors","href":"/sdk/reference/client/interceptors/index"},{"title":"Class: AuthInterceptor","href":"/sdk/reference/client/interceptors/classes/AuthInterceptor"},{"title":"Class: ErrorMappingInterceptor","href":"/sdk/reference/client/interceptors/classes/ErrorMappingInterceptor"},{"title":"Class: RetryInterceptor","href":"/sdk/reference/client/interceptors/classes/RetryInterceptor"},{"title":"Type Alias: Interceptor","href":"/sdk/reference/client/interceptors/type-aliases/Interceptor"}]},{"group":"Transport","pages":[{"title":"client/transport: Terminal49 SDK HTTP transport layer","href":"/sdk/reference/client/transport/index"},{"title":"Class: Transport","href":"/sdk/reference/client/transport/classes/Transport"},{"title":"Interface: TransportConfig","href":"/sdk/reference/client/transport/interfaces/TransportConfig"},{"title":"Type Alias: ApiClient","href":"/sdk/reference/client/transport/type-aliases/ApiClient"}]},{"group":"Models","pages":[{"title":"types/models: Terminal49 SDK mapped response models","href":"/sdk/reference/types/models/index"},{"title":"Interface: Container","href":"/sdk/reference/types/models/interfaces/Container"},{"title":"Interface: ContainerRoute","href":"/sdk/reference/types/models/interfaces/ContainerRoute"},{"title":"Interface: CurrentAccount","href":"/sdk/reference/types/models/interfaces/CurrentAccount"},{"title":"Interface: CurrentCredential","href":"/sdk/reference/types/models/interfaces/CurrentCredential"},{"title":"Interface: CurrentUser","href":"/sdk/reference/types/models/interfaces/CurrentUser"},{"title":"Interface: FeatureAvailability","href":"/sdk/reference/types/models/interfaces/FeatureAvailability"},{"title":"Interface: PaginatedResult\u003cT>","href":"/sdk/reference/types/models/interfaces/PaginatedResult"},{"title":"Interface: PaginationLinks","href":"/sdk/reference/types/models/interfaces/PaginationLinks"},{"title":"Interface: RouteCoordinates","href":"/sdk/reference/types/models/interfaces/RouteCoordinates"},{"title":"Interface: RoutePort","href":"/sdk/reference/types/models/interfaces/RoutePort"},{"title":"Interface: RouteVessel","href":"/sdk/reference/types/models/interfaces/RouteVessel"},{"title":"Interface: RouteVesselPort","href":"/sdk/reference/types/models/interfaces/RouteVesselPort"},{"title":"Interface: Shipment","href":"/sdk/reference/types/models/interfaces/Shipment"},{"title":"Interface: ShippingLine","href":"/sdk/reference/types/models/interfaces/ShippingLine"},{"title":"Interface: TrackingRequest","href":"/sdk/reference/types/models/interfaces/TrackingRequest"},{"title":"Interface: TrackingSlots","href":"/sdk/reference/types/models/interfaces/TrackingSlots"},{"title":"Interface: Vessel","href":"/sdk/reference/types/models/interfaces/Vessel"},{"title":"Interface: VesselPosition","href":"/sdk/reference/types/models/interfaces/VesselPosition"},{"title":"Interface: VesselWithFuturePositions","href":"/sdk/reference/types/models/interfaces/VesselWithFuturePositions"},{"title":"Type Alias: CustomFieldValue","href":"/sdk/reference/types/models/type-aliases/CustomFieldValue"}]},{"group":"Options","pages":[{"title":"types/filters: Terminal49 SDK list filter types","href":"/sdk/reference/types/filters/index"},{"title":"types/options: Terminal49 SDK call and include options","href":"/sdk/reference/types/options/index"},{"title":"Interface: CallOptions","href":"/sdk/reference/types/options/interfaces/CallOptions"},{"title":"Interface: ListOptions","href":"/sdk/reference/types/options/interfaces/ListOptions"},{"title":"Type Alias: ContainerInclude","href":"/sdk/reference/types/options/type-aliases/ContainerInclude"},{"title":"Type Alias: IncludeParam\u003cTInclude>","href":"/sdk/reference/types/options/type-aliases/IncludeParam"},{"title":"Type Alias: ResponseFormat","href":"/sdk/reference/types/options/type-aliases/ResponseFormat"},{"title":"Type Alias: ShipmentInclude","href":"/sdk/reference/types/options/type-aliases/ShipmentInclude"},{"title":"Type Alias: TrackingRequestInclude","href":"/sdk/reference/types/options/type-aliases/TrackingRequestInclude"},{"title":"Type Alias: WebhookNotificationInclude","href":"/sdk/reference/types/options/type-aliases/WebhookNotificationInclude"}]}]}]},{"tab":"MCP","icon":"plug","groups":[{"group":"MCP","pages":[{"title":"Terminal49 MCP server","sidebarTitle":"MCP Overview","href":"/mcp/home"},{"title":"Filter shipment and container worklists with MCP","href":"/mcp/filtering-worklists"},{"title":"Terminal49 MCP server quickstart","href":"/api-docs/in-depth-guides/mcp"}]},{"group":"Setup Guides","pages":[{"title":"Connect Claude to Terminal49","sidebarTitle":"Claude","href":"/mcp/setup/claude"},{"title":"Connect Claude Code to Terminal49","sidebarTitle":"Claude Code","href":"/mcp/setup/claude-code"},{"title":"Connect ChatGPT to Terminal49","sidebarTitle":"ChatGPT","href":"/mcp/setup/chatgpt"},{"title":"Connect Cursor to Terminal49","sidebarTitle":"Cursor","href":"/mcp/setup/cursor"},{"title":"Connect Microsoft Copilot to Terminal49","sidebarTitle":"Microsoft Copilot","href":"/mcp/setup/microsoft-copilot"},{"title":"Connect VS Code to Terminal49","sidebarTitle":"VS Code","href":"/mcp/setup/vs-code"},{"title":"Connect Gemini to Terminal49","sidebarTitle":"Gemini","href":"/mcp/setup/gemini"},{"title":"Connect Antigravity to Terminal49","sidebarTitle":"Antigravity","href":"/mcp/setup/antigravity"},{"title":"Install the Terminal49 agent plugin","sidebarTitle":"Agent plugins","href":"/mcp/setup/agent-plugins"},{"title":"Connect any MCP client to Terminal49","sidebarTitle":"Other MCP clients","href":"/mcp/setup/other-clients"}]}]},{"tab":"DataSync","icon":"database","groups":[{"group":" ","pages":[{"title":"Terminal49 DataSync Documentation","sidebarTitle":"DataSync Home","href":"/datasync/home"}]},{"group":" ","pages":[{"title":"DataSync Overview","sidebarTitle":"Overview","href":"/datasync/overview"},{"title":"DataSync Supported Destinations","href":"/datasync/supported-destinations"}]},{"group":"Table Properties","icon":"table","pages":[{"title":"Containers Table","sidebarTitle":"Containers","href":"/datasync/table-properties/containers_rail"},{"title":"Shipments Table","sidebarTitle":"Shipments","href":"/datasync/table-properties/shipments"},{"title":"Tracking requests table","sidebarTitle":"Tracking Requests","href":"/datasync/table-properties/tracking-requests"},{"title":"Transport events table","sidebarTitle":"Transport Events","href":"/datasync/table-properties/transport-events"},{"title":"Transfer status table","sidebarTitle":"Transfer Status","href":"/datasync/table-properties/transfer-status"},{"title":"Deprecated DataSync Containers Table","sidebarTitle":"Containers (deprecated)","href":"/datasync/table-properties/containers"}]}]},{"tab":"Changelog","icon":"clock-rotate-left","groups":[{"group":"Updates","icon":"newspaper","pages":[{"title":"Terminal49 API and DataSync Updates","sidebarTitle":"API \u0026 DataSync Updates","href":"/updates/home"}]}]}]},"basePath":"","title":"Interface: CustomField - Terminal49","buildId":"dpl_6dVqRXFR2Go5vF5RLvAdHuv189oT","deploymentId":"dpl_6dVqRXFR2Go5vF5RLvAdHuv189oT","dynamics":[],"chunks":[]}