{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/elements/account-settings/manage-carriers","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/elements/account-settings/manage-carriers","default":false,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/elements/account-settings/manage-carriers","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Manage Carriers Element","keywords":"shipping, labels, shipstation, documentation, api","siteUrl":"https://docs.shipstation.com","lang":"en-US","llmstxt":{"hide":false,"title":"ShipStation API LLM Docs","description":"Find links and references to all markdown documentation for use with LLMs","excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"manage-carriers-element","__idx":0},"children":["Manage Carriers Element"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Manage Carriers Element allows users to view a list of their existing ShipEngine carrier connections or connect additional ShipEngine carriers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This can be used as a stand-alone Element and/or utilized within the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/elements/account-settings/carrier-services"},"children":["Carrier Services Element"]}," via the ShipEngine Carriers section."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configuring-carriers","__idx":1},"children":["Configuring Carriers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Manage Carriers Element is designed to integrate with the leading global shipping carriers. Check out the complete ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/carriers/setup"},"children":["carriers documentation"]}," to learn more about ShipEngine carriers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you wish to view and manage ShipEngine carrier accounts in the Manage Carriers Element, you must explicitly list them by carrier code in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["globalFeatures.enabledShipEngineCarriers"]}," array, which is nested within the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["features"]}," prop of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ElementsProvider"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ElementsSDK"]}," class constructor."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For an in depth overview of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["features"]}," object, please review the Configuring Elements Features step in either the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/elements/elements-react#configuring-elements-features"},"children":["ElementsProvider"]}," or the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/elements/elements-sdk#configuring-elements-features"},"children":["Elements SDK"]}," guides."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["DANGER:"]}," ","If you exclude the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["globalFeatures.enabledShipEngineCarriers"]}," property in your global features, or set the value to an empty array without including any supported carrier codes, you will not be able to view and manage ShipEngine Carriers."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"supported-shipengine-carriers-in-elements","__idx":2},"children":["Supported ShipEngine Carriers in Elements"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"us-carrier-codes","__idx":3},"children":["US Carrier Codes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["USPS: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["stamps_com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["DHL Express: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dhl_express_worldwide"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"gb-carrier-codes","__idx":4},"children":["GB Carrier Codes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Yodel: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yodel_walleted"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Evri: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hermes"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["DPD: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dpdwallet"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ca-carrier-codes","__idx":5},"children":["CA Carrier Codes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["GlobalPost: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["globalpost"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"au-carrier-codes","__idx":6},"children":["AU Carrier Codes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Aramex Australia: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["aramex_au_walleted"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sendle: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sendle_walleted"]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["DANGER:"]}," ","If you exclude the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["globalFeatures.enabledShipEngineCarriers"]}," property in your global features, or set the value to an empty array without including any supported carrier codes, you will not be able to view and manage carriers in this Element."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"react-component","__idx":7},"children":["React Component"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"jsx","header":{"controls":{"copy":{}}},"source":"import { ManageCarriers, ElementsProvider } from '@shipengine/elements';\nimport { themeConfig } from '../themeConfig';\n\nconst tokenPath = '/path/to/token/endpoint';\n\nconst Foo = () => {\n  const getToken = useCallback(() => {\n    return fetch(tokenPath).then((res) => res.text());\n  }, []);\n\n  return (\n    <ElementsProvider\n      getToken={getToken}\n      themeConfig={themeConfig}\n      onError={handleError}\n      features={{\n        globalFeatures: {\n          enabledShipEngineCarriers: ['ups', 'stamps_com', 'yodel_walleted'],\n        },\n      }}\n    >\n      <ManageCarriers.Element />\n    </ElementsProvider>\n  );\n};\n","lang":"jsx"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sdk","__idx":8},"children":["SDK"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"// Creates a new instance of the Elements SDK.\nconst elements = new ElementsSDK(getToken, {\n  onError: (err: Error) => console.error(err),\n  themeConfig: themeConfig,\n  locale: 'en-US',\n  features: {\n    globalFeatures: {\n      // The list of available ShipEngine carriers\n      enabledShipEngineCarriers: ['stamps_com', 'yodel_walleted'],\n    },\n  },\n});\n\nconst manageCarriers = elements.create('manageCarriers');\n","lang":"js"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["NOTE:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To access this Element, a seller must be onboarded with ShipEngine carrier account(s) and a valid payment method. These steps can be completed in the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/elements/onboarding/onboarding"},"children":["Onboarding Element"]},"."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Args/Props"},"children":["Args/Props"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onRedirectToOnboarding"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["function"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["optional"]}," An optional callback that is triggered when the \"Complete Onboarding\" button is clicked. This button appears when a user who hasn't completed onboarding tries to access the Manage Carriers Element, which requires an onboarded seller. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"We recommend using this callback to display the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/elements/onboarding/onboarding"},"children":["Onboarding Element"]},"."]}]}]}]}]}]},"headings":[{"value":"Manage Carriers Element","id":"manage-carriers-element","depth":1},{"value":"Configuring Carriers","id":"configuring-carriers","depth":2},{"value":"Supported ShipEngine Carriers in Elements","id":"supported-shipengine-carriers-in-elements","depth":3},{"value":"US Carrier Codes","id":"us-carrier-codes","depth":4},{"value":"GB Carrier Codes","id":"gb-carrier-codes","depth":4},{"value":"CA Carrier Codes","id":"ca-carrier-codes","depth":4},{"value":"AU Carrier Codes","id":"au-carrier-codes","depth":4},{"value":"React Component","id":"react-component","depth":2},{"value":"SDK","id":"sdk","depth":2}],"frontmatter":{"seo":{"title":"Manage Carriers Element"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipengine/docs/elements/account-settings/manage-carriers","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}