{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Trackstar","colors":{"primary":"#7691DA","light":"#D3D665","dark":"#2E3B72"},"logo":{"light":"https://mintcdn.com/trackstar/e_R8AMY4ayyVfYRU/logo/light.svg?fit=max\u0026auto=format\u0026n=e_R8AMY4ayyVfYRU\u0026q=85\u0026s=eb832f4ffc768291fd95c4939b2ac6c2","dark":"https://mintcdn.com/trackstar/e_R8AMY4ayyVfYRU/logo/dark.svg?fit=max\u0026auto=format\u0026n=e_R8AMY4ayyVfYRU\u0026q=85\u0026s=1a2845225060cfe1d75c91a7240341a0"},"favicon":"https://mintcdn.com/trackstar/ronaGfFeKtERpohJ/favicon.png?fit=max\u0026auto=format\u0026n=ronaGfFeKtERpohJ\u0026q=85\u0026s=b3a24a0d7d7c7acc8e7394c0640eb8c6","api":{"openapi":"https://production.trackstarhq.com/openapi.json","mdx":{"server":"https://production.trackstarhq.com"}},"navbar":{"primary":{"type":"button","label":"Get an API Key","href":"https://www.trackstarhq.com/#"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/trackstarhq","website":"https://www.trackstarhq.com/"}},"integrations":{"clearbit":{"publicApiKey":"pk_1c5d72a7b03149b504c277cee5b4032a"}},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode","mcp","add-mcp","download-spec"],"display":"header"},"markdown":{"instructions":["Trackstar is a unified REST API for WMS, cart, and carrier systems. Base URL: https://production.trackstarhq.com. There is no SDK; call the API with plain HTTP.","Send x-trackstar-api-key on every request. Endpoints scoped to one connection also need x-trackstar-access-token. Read both from environment variables and never print them.","Reads return data Trackstar has already synced from the connected system. Writes (POST, PUT, PATCH, DELETE) are forwarded to the connected system immediately.","A new connection has no data until its initial sync finishes. Wait for the connection.historical-sync-completed webhook, or poll GET /connections/{connection_id} and check historical_sync_completed.","List endpoints page with page_token and next_token (limit is capped at 1000). Repeat every filter on every page. Filters use field[operator]=value, for example created_date[gte]=2026-01-01T00:00:00Z.","Write bodies must not contain null or empty strings; omit the field instead. Call GET /integrations/{integration_type}/{integration_name}/write-info first to learn the exact fields an integration accepts.","To test without real credentials, POST /sandbox/generate-sandbox/{wms|cart|carrier} with the API key returns a sandbox access token. Start at https://docs.trackstarhq.com/how-to-guides/build-with-ai.md and install the skills with: npx skills add https://docs.trackstarhq.com"]},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Request an API Key","icon":"key","href":"https://trackstarhq.com/get-started"},{"anchor":"Login to Dashboard","icon":"browser","href":"https://dashboard.trackstarhq.com"},{"anchor":"WMS Integrations","icon":"warehouse","href":"https://trackstarhq.com/integrations/wms"},{"anchor":"Cart Integrations","icon":"cart-shopping","href":"https://trackstarhq.com/integrations/cart"},{"anchor":"Carrier Integrations","icon":"truck","href":"https://trackstarhq.com/integrations/carrier"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"trackstar","hasAudioNarration":false,"actualSubdomain":"trackstar","customDomains":["docs.trackstarhq.com"],"gitSource":{"type":"github","owner":"trackstarhq","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af54531ae6a71ac899659da","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Guides","count":67},{"language":"default","tag":"How-To Guides","count":58},{"language":"default","tag":"WMS API","count":55},{"language":"default","tag":"WMS API Reference","count":55},{"language":"default","tag":"Webhooks","count":48},{"language":"default","tag":"WMS","count":29},{"language":"default","tag":"Admin API","count":21},{"language":"default","tag":"Admin API Reference","count":20},{"language":"default","tag":"Orders","count":17},{"language":"default","tag":"Cart API","count":16}]},"assistantConfig":{"enableStarterQuestions":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/mgmt/get-connection","slug":"/api-reference/mgmt/get-connection","pageMetadata":{"openapi":"get /connections/{connection_id}","title":"Get Connection","description":"Returns the specified connection.","href":"/api-reference/mgmt/get-connection"},"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: \"Returns the specified connection.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /connections/{connection_id}","title":"Get Connection","description":"Returns the specified connection.","href":"/api-reference/mgmt/get-connection"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/trackstar/30b448b1cb413b03/required.js","/_mintlify/custom/trackstar/a23a6fd668fcabff/tab-dropdown.js","/_mintlify/custom/trackstar/bf284930523528a1/write-fields.js"],"openApiReferenceData":{"operation":{"parameters":["c766c392-ae0a-4a21-8e7d-6dd2386c7b9d","3b629e01-a321-44ef-b0db-d0aba4f2d5b9"],"responses":{"200":"45399bba-ad3e-4957-a094-b7daa296d5b3","404":"d505a9af-c909-4c38-a1ca-10dc7e4c7b6f","422":"bf92f9c9-6fd6-4268-be90-8af02f54b7f2"},"tags":["Auth"],"summary":"Get Connection","description":"Returns the specified connection.","operationId":"get_GET__connections_path_connection_id","method":"get","type":"path","servers":["730f9537-e78e-4d7f-9c09-dc5df01bc354"],"security":[],"path":"/connections/{connection_id}","baseUrlOptions":["https://production.trackstarhq.com"],"title":"Get Connection","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c766c392-ae0a-4a21-8e7d-6dd2386c7b9d":{"in":"path","name":"connection_id","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"3b629e01-a321-44ef-b0db-d0aba4f2d5b9":{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":"\u003cx-trackstar-api-key>","isRequired":true,"description":"Your organization-level Trackstar API key.","uniqueKey":"","typeLabel":"string"},"required":true}},"responses":{"45399bba-ad3e-4957-a094-b7daa296d5b3":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"A list of connections for your organization.","example":[{"connection_id":"07b344db-0304-4866-9ae1-ac8af5292a28","integration_name":"integration_name","integration_display_name":"ShipBob","customer_id":"customer_id","created_at":"2023-01-01T00:00:00Z","last_used":"2023-01-01T00:00:00Z","times_used":1,"sync_schedules":[{"function_name":"get_inventory","last_crawl_start":"2023-01-01T00:00:00Z","last_crawl_end":"2023-01-01T00:00:00Z","latest_data":"2023-01-01T00:00:00Z","sync_frequency":3600,"sync_status":"enabled"}],"errors":[{"error_message":"error_message","affected_endpoints":[{"endpoint":"GET /connection","preventing_sync":false}],"first_seen":"2023-01-01T00:00:00Z","last_seen":"2023-01-01T00:00:00Z"}],"available_actions":["get_inventory","get_products"],"integration_type":"wms","webhooks_disabled":false,"historical_sync_completed":{"get_bills":true,"get_inbound_shipments":true,"get_inventory":true,"get_orders":true,"get_products":true,"get_returns":true,"get_warehouse_customers":true,"get_warehouse_locations":true,"get_warehouses":true},"me":{"account_id":"account_12345","account_name":"My WMS Account"}}],"items":{"type":"object","properties":{"connection_id":{"type":"string","description":"The unique ID of the connection.","example":"connection_id","isRequired":true,"uniqueKey":"data.items.[INDEX].connection_id","typeLabel":"string"},"integration_name":{"type":"string","description":"The name of the integration associated with the connection.","example":"integration_name","isRequired":true,"uniqueKey":"data.items.[INDEX].integration_name","typeLabel":"string"},"integration_display_name":{"type":"string","description":"The human-readable display name of the integration associated with the connection.","example":"ShipBob","isRequired":true,"uniqueKey":"data.items.[INDEX].integration_display_name","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","description":"An identifier for your end customer.","example":"customer_id","isRequired":true,"uniqueKey":"data.items.[INDEX].customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"An identifier for your end customer.","example":"customer_id","isRequired":true,"uniqueKey":"data.items.[INDEX].customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].customer_id","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","description":"The date the connection was created.","example":"2022-01-01T00:00:00Z","isRequired":true,"uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"last_used":{"oneOf":[{"type":"string","format":"date-time","description":"The date the connection was last updated.","example":"2022-01-02T05:05:05Z","isRequired":true,"uniqueKey":"data.items.[INDEX].last_used.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date the connection was last updated.","example":"2022-01-02T05:05:05Z","isRequired":true,"uniqueKey":"data.items.[INDEX].last_used.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].last_used","typeLabel":"string\u003cdate-time> | null"},"times_used":{"oneOf":[{"type":"integer","description":"The number of times the connection has been used in a request to the Trackstar API. Equal to the number of API calls made with this connection.","example":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].times_used.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of times the connection has been used in a request to the Trackstar API. Equal to the number of API calls made with this connection.","example":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].times_used.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].times_used","typeLabel":"integer | null"},"sync_schedules":{"type":"array","description":"A list of sync schedules for the connection.","items":{"type":"object","properties":{"function_name":{"type":"string","description":"The function that is being synced.","example":"function_name","isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].function_name","typeLabel":"string"},"last_crawl_start":{"oneOf":[{"type":"string","format":"date-time","description":"The date when Trackstar last started a crawl for this function.","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].last_crawl_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date when Trackstar last started a crawl for this function.","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].last_crawl_start.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].last_crawl_start","typeLabel":"string\u003cdate-time> | null"},"last_crawl_end":{"oneOf":[{"type":"string","format":"date-time","description":"The date when Trackstar last completed a crawl for this function.","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].last_crawl_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date when Trackstar last completed a crawl for this function.","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].last_crawl_end.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].last_crawl_end","typeLabel":"string\u003cdate-time> | null"},"latest_data":{"oneOf":[{"type":"string","format":"date-time","description":"The date of the most recent data successfully fetched for this function.","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].latest_data.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date of the most recent data successfully fetched for this function.","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].latest_data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].latest_data","typeLabel":"string\u003cdate-time> | null"},"sync_frequency":{"type":"integer","description":"The frequency of the sync in seconds.","example":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].sync_frequency","typeLabel":"integer"},"sync_status":{"oneOf":[{"type":"string","enum":["enabled","disabled","sync_in_progress","first_sync_in_progress","error","stuck"],"description":"The status of the sync.","example":"sync_in_progress","isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].sync_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["enabled","disabled","sync_in_progress","first_sync_in_progress","error","stuck"],"description":"The status of the sync.","example":"sync_in_progress","isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].sync_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX].sync_status","typeLabel":"enum\u003cstring> | null"}},"required":["function_name","last_crawl_end","last_crawl_start","latest_data","sync_frequency","sync_status"],"additionalProperties":false,"title":"SyncSchedule","uniqueKey":"data.items.[INDEX].sync_schedules.items.[INDEX]","typeLabel":"SyncSchedule · object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].sync_schedules","typeLabel":"SyncSchedule · object[]"},"errors":{"type":"array","description":"A list of errors for the connection. e.g. missing permissions, invalid credentials, etc.","items":{"type":"object","properties":{"error_message":{"type":"string","description":"The error message.","example":"error_message","isRequired":true,"uniqueKey":"data.items.[INDEX].errors.items.[INDEX].error_message","typeLabel":"string"},"affected_endpoints":{"type":"array","description":"A list of endpoints that were affected by the error and whether the error is preventing the sync from completing.","example":[{"endpoint":"GET /wms/inventory","preventing_sync":true},{"endpoint":"GET /wms/orders","preventing_sync":false}],"items":{"type":"object","properties":{"endpoint":{"type":"string","description":"The endpoint that was affected.","example":"GET /wms/inventory","isRequired":true,"uniqueKey":"data.items.[INDEX].errors.items.[INDEX].affected_endpoints.items.[INDEX].endpoint","typeLabel":"string"},"preventing_sync":{"type":"boolean","description":"If True, the error is preventing the sync from completing. If False, we are able to sync but there may be data or fields that we are unable to fetch.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].errors.items.[INDEX].affected_endpoints.items.[INDEX].preventing_sync","typeLabel":"boolean"}},"required":["endpoint","preventing_sync"],"additionalProperties":false,"title":"AffectedEndpoints","uniqueKey":"data.items.[INDEX].errors.items.[INDEX].affected_endpoints.items.[INDEX]","typeLabel":"AffectedEndpoints · object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].errors.items.[INDEX].affected_endpoints","typeLabel":"AffectedEndpoints · object[]"},"first_seen":{"type":"string","format":"date-time","description":"The date the error was first seen.","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.items.[INDEX].errors.items.[INDEX].first_seen","typeLabel":"string\u003cdate-time>"},"last_seen":{"type":"string","format":"date-time","description":"The date the error was last seen.","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.items.[INDEX].errors.items.[INDEX].last_seen","typeLabel":"string\u003cdate-time>"}},"required":["affected_endpoints","error_message","first_seen","last_seen"],"additionalProperties":false,"title":"ConnectionError","uniqueKey":"data.items.[INDEX].errors.items.[INDEX]","typeLabel":"ConnectionError · object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].errors","typeLabel":"ConnectionError · object[]"},"available_actions":{"type":"array","description":"A list of actions that the integration supports.","items":{"type":"string","description":"Action supported by the integration","example":"available_actions","uniqueKey":"data.items.[INDEX].available_actions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.items.[INDEX].available_actions","typeLabel":"string[]"},"integration_type":{"type":"string","enum":["wms","freight","cart","carrier","erp"],"description":"The type of the integration.","example":"wms","isRequired":true,"uniqueKey":"data.items.[INDEX].integration_type","typeLabel":"enum\u003cstring>"},"webhooks_disabled":{"oneOf":[{"type":"boolean","description":"If True, create \u0026 update webhooks for Trackstar objects (e.g. order.created) will not be sent for this connection. Connection specific webhooks (e.g. connection.deleted) will still be sent.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].webhooks_disabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If True, create \u0026 update webhooks for Trackstar objects (e.g. order.created) will not be sent for this connection. Connection specific webhooks (e.g. connection.deleted) will still be sent.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].webhooks_disabled.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].webhooks_disabled","typeLabel":"boolean | null"},"paused":{"type":"boolean","description":"If True, every sync schedule for this connection is paused and no data will sync until at least one schedule is resumed.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].paused","typeLabel":"boolean"},"paused_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date every sync schedule for this connection was paused. Null if the connection is not currently paused.","example":"2022-01-02T05:05:05Z","isRequired":true,"uniqueKey":"data.items.[INDEX].paused_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date every sync schedule for this connection was paused. Null if the connection is not currently paused.","example":"2022-01-02T05:05:05Z","isRequired":true,"uniqueKey":"data.items.[INDEX].paused_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].paused_at","typeLabel":"string\u003cdate-time> | null"},"historical_sync_completed":{"type":"object","description":"Indicates whether the initial historical sync has been completed for each function. If a key is not present or empty, assume the historical sync has not been completed for that function.","example":{"get_bills":true,"get_inbound_shipments":true,"get_inventory":true,"get_orders":true,"get_products":true,"get_returns":true,"get_warehouse_customers":true,"get_warehouse_locations":true,"get_warehouses":true},"additionalProperties":{"type":"boolean","description":"Whether the historical sync has been completed for the function.","example":true,"uniqueKey":"data.items.[INDEX].historical_sync_completed.additionalProperties","typeLabel":"boolean"},"isRequired":true,"uniqueKey":"data.items.[INDEX].historical_sync_completed","typeLabel":"object"},"me":{"description":"Information that helps identify the connected account. If null, the integration does not provide this information.","example":{"account_id":"account_12345","account_name":"My WMS Account"},"isRequired":true,"uniqueKey":"data.items.[INDEX].me","typeLabel":"any"}},"required":["available_actions","connection_id","created_at","customer_id","errors","historical_sync_completed","integration_display_name","integration_name","integration_type","last_used","me","paused","paused_at","sync_schedules","times_used","webhooks_disabled"],"additionalProperties":false,"title":"Connection","uniqueKey":"data.items.[INDEX]","typeLabel":"Connection · object"},"uniqueKey":"data","typeLabel":"Connection · object[]"}},"additionalProperties":false,"title":"GetConnectionsResponseonlydata","uniqueKey":"","typeLabel":"GetConnectionsResponseonlydata · object"},"examples":{"Example":{"title":"Example","value":{"data":[{"connection_id":"07b344db-0304-4866-9ae1-ac8af5292a28","integration_name":"integration_name","integration_display_name":"ShipBob","customer_id":"customer_id","created_at":"2023-01-01T00:00:00Z","last_used":"2023-01-01T00:00:00Z","times_used":1,"sync_schedules":[{"function_name":"get_inventory","last_crawl_start":"2023-01-01T00:00:00Z","last_crawl_end":"2023-01-01T00:00:00Z","latest_data":"2023-01-01T00:00:00Z","sync_frequency":3600,"sync_status":"enabled"}],"errors":[{"error_message":"error_message","affected_endpoints":[{"endpoint":"GET /connection","preventing_sync":false}],"first_seen":"2023-01-01T00:00:00Z","last_seen":"2023-01-01T00:00:00Z"}],"available_actions":["get_inventory","get_products"],"integration_type":"wms","webhooks_disabled":false,"historical_sync_completed":{"get_bills":true,"get_inbound_shipments":true,"get_inventory":true,"get_orders":true,"get_products":true,"get_returns":true,"get_warehouse_customers":true,"get_warehouse_locations":true,"get_warehouses":true},"me":{"account_id":"account_12345","account_name":"My WMS Account"}}]}}},"exampleType":"generated"}},"description":"Successful response","exampleType":"generated"},"d505a9af-c909-4c38-a1ca-10dc7e4c7b6f":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"id":{"type":"string","description":"The ID of the item that wasn't found.","uniqueKey":"id","typeLabel":"string"}},"required":["error"],"type":"object","title":"HTTPError","uniqueKey":"","typeLabel":"HTTPError · object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","id":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Not found","exampleType":"generated"},"bf92f9c9-6fd6-4268-be90-8af02f54b7f2":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"object","properties":{"\u003clocation>":{"type":"object","properties":{"\u003cfield_name>":{"type":"array","items":{"type":"string","uniqueKey":"detail.\u003clocation>.\u003cfield_name>.items.[INDEX]","typeLabel":"string"},"uniqueKey":"detail.\u003clocation>.\u003cfield_name>","typeLabel":"string[]"}},"uniqueKey":"detail.\u003clocation>","typeLabel":"object"}},"uniqueKey":"detail","typeLabel":"object"}},"required":["error"],"type":"object","title":"ValidationError","uniqueKey":"","typeLabel":"ValidationError · object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","detail":{"\u003clocation>":{"\u003cfield_name>":["\u003cstring>"]}}}}},"exampleType":"generated"}},"description":"Validation error","exampleType":"generated"}},"security":{},"servers":{"730f9537-e78e-4d7f-9c09-dc5df01bc354":{"description":"Trackstar API","url":"https://production.trackstarhq.com"}}},"originalFileLocation":"https://production.trackstarhq.com/openapi.json"},"subdomain":"trackstar","siteName":"Trackstar","title":"Get Connection - Trackstar","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T22:40:27.743Z","originalFileLocation":"api-reference/mgmt/get-connection.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=\"system\"}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=\"Returns the specified connection.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Trackstar\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_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=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Connection - Trackstar\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the specified connection.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Trackstar\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.trackstarhq.com/api-reference/mgmt/get-connection\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://trackstar.mintlify.site/_mintlify/api/og/v2?division=Admin+API+Reference\u0026amp;title=Get+Connection\u0026amp;description=Returns+the+specified+connection.\u0026amp;theme=e80604f17ac1c49831a5e6d2\u0026amp;signature=bc32c8b4832012fb8d411bfb2615d37ab3b1f747ab8dce7af2e940418a9d7536\">\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=\"Get Connection - Trackstar\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the specified connection.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://trackstar.mintlify.site/_mintlify/api/og/v2?division=Admin+API+Reference\u0026amp;title=Get+Connection\u0026amp;description=Returns+the+specified+connection.\u0026amp;theme=e80604f17ac1c49831a5e6d2\u0026amp;signature=bc32c8b4832012fb8d411bfb2615d37ab3b1f747ab8dce7af2e940418a9d7536\">\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=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Trackstar\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7691DA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.trackstarhq.com/api-reference/mgmt/get-connection\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/mgmt/get-connection.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.trackstarhq.com/#organization\",\"name\":\"Trackstar\",\"url\":\"https://docs.trackstarhq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/trackstar/e_R8AMY4ayyVfYRU/logo/light.svg?fit=max\u0026auto=format\u0026n=e_R8AMY4ayyVfYRU\u0026q=85\u0026s=eb832f4ffc768291fd95c4939b2ac6c2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.trackstarhq.com#website\",\"name\":\"Trackstar\",\"url\":\"https://docs.trackstarhq.com\",\"publisher\":{\"@id\":\"https://docs.trackstarhq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.trackstarhq.com/api-reference/mgmt/get-connection#webpage\",\"url\":\"https://docs.trackstarhq.com/api-reference/mgmt/get-connection\",\"name\":\"Get Connection\",\"description\":\"Returns the specified connection.\",\"dateModified\":\"2026-01-28T22:40:27.743Z\",\"isPartOf\":{\"@id\":\"https://docs.trackstarhq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.trackstarhq.com/api-reference/mgmt/get-connection#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.trackstarhq.com/api-reference/mgmt/get-connection#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Admin API Reference\",\"item\":\"https://docs.trackstarhq.com/api-reference/mgmt/create-link-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Connection\",\"item\":\"https://docs.trackstarhq.com/api-reference/mgmt/get-connection\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.trackstarhq.com/api-reference/mgmt/get-connection#apireference\",\"headline\":\"Get Connection\",\"name\":\"Get Connection\",\"description\":\"Returns the specified connection.\",\"url\":\"https://docs.trackstarhq.com/api-reference/mgmt/get-connection\",\"mainEntityOfPage\":{\"@id\":\"https://docs.trackstarhq.com/api-reference/mgmt/get-connection#webpage\"},\"dateModified\":\"2026-01-28T22:40:27.743Z\",\"publisher\":{\"@id\":\"https://docs.trackstarhq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.trackstarhq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Trackstar\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Trackstar\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/mgmt/get-connection.md","siteName":"Trackstar","nav":{"global":{"anchors":[{"anchor":"Request an API Key","icon":"key","href":"https://trackstarhq.com/get-started"},{"anchor":"Login to Dashboard","icon":"browser","href":"https://dashboard.trackstarhq.com"},{"anchor":"WMS Integrations","icon":"warehouse","href":"https://trackstarhq.com/integrations/wms"},{"anchor":"Cart Integrations","icon":"cart-shopping","href":"https://trackstarhq.com/integrations/cart"},{"anchor":"Carrier Integrations","icon":"truck","href":"https://trackstarhq.com/integrations/carrier"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Admin API","groups":[{"group":"Admin API Reference","pages":[{"openapi":"post /link/token","title":"Create Link Token","href":"/api-reference/mgmt/create-link-token"},{"openapi":"post /link/exchange","title":"Exchange Auth Code","href":"/api-reference/mgmt/exchange-auth-code"},{"openapi":"get /connections","title":"Get Connections","description":"Returns connected integrations for your organization.","href":"/api-reference/mgmt/get-connections"},{"openapi":"get /connections/{connection_id}","title":"Get Connection","href":"/api-reference/mgmt/get-connection"},{"openapi":"patch /connections","title":"Update Connection","description":"Manually update properties of the connection associated with your access token.","href":"/api-reference/mgmt/update-connection"},{"openapi":"post /connections/sync","title":"Sync Connection","href":"/api-reference/mgmt/sync-connection"},{"openapi":"delete /connections","title":"Delete Connection","href":"/api-reference/mgmt/delete-connection"},{"openapi":"patch /schedules/{function_name}/toggle","title":"Toggle Schedule","href":"/api-reference/mgmt/toggle-connection-schedule"},{"openapi":"patch /schedules/toggle-all","title":"Toggle All Schedules","href":"/api-reference/mgmt/toggle-all-schedules"},{"openapi":"get /integrations/{integration_type}","title":"Integration Info","href":"/api-reference/mgmt/integrations"},{"openapi":"get /integrations/{integration_type}/{integration_name}","title":"Integration Info for Single Integration","href":"/api-reference/mgmt/get-integration"},{"openapi":"get /integrations/{integration_type}/{integration_name}/write-info","title":"Integration Write Info","href":"/api-reference/mgmt/integration-write-info"},{"openapi":"post /integration-requests","title":"Request an Integration","href":"/api-reference/mgmt/create-integration-request"},{"openapi":"get /integration-requests/flows","title":"Integration Request Flows","href":"/api-reference/mgmt/integration-request-flows"},{"openapi":"get /magic-links","title":"Get Magic Links","href":"/api-reference/mgmt/get-magic-links"},{"openapi":"get /magic-links/{magic_link_id}","title":"Get Magic Link","href":"/api-reference/mgmt/get-magic-link"},{"openapi":"post /magic-links","title":"Create Magic Link","href":"/api-reference/mgmt/create-magic-link"},{"openapi":"delete /magic-links/{magic_link_id}","title":"Delete Magic Link","href":"/api-reference/mgmt/delete-magic-link"},{"openapi":"get /api-logs","title":"Get API Logs","href":"/api-reference/mgmt/search-api-logs"},{"openapi":"get /api-logs/facets","title":"Get API Log Facets","href":"/api-reference/mgmt/api-log-facets"}]},{"group":"Sandbox","pages":[{"openapi":"post /sandbox/generate-sandbox/{integration_type}","title":"Generate Sandbox","href":"/api-reference/sandbox/generate-sandbox"}]}]},{"tab":"WMS API","pages":[{"title":"WMS API","href":"/api-reference/wms-api/inventory/info"}]},{"tab":"Cart API","pages":[{"title":"Cart API","href":"/api-reference/cart-api/products/info"}]},{"tab":"Carrier API","pages":[{"title":"Carrier API","href":"/api-reference/carrier-api/invoice-line-items/info"}]},{"tab":"ERP API","hidden":true,"pages":[{"title":"ERP API","href":"/api-reference/erp-api/sales-orders/info"}]}]},"basePath":"","title":"Get Connection - Trackstar","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}