{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/partners/set-carrier-countries","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/partners/set-carrier-countries","default":false,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/partners/set-carrier-countries","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Set Available Carriers by Country","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":"set-available-carriers-by-country","__idx":0},"children":["Set Available Carriers by Country"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["ShipStation API integrates with 100+ carriers from all over the world. However, most shippers use a limited selection of carriers that service specific countries. If you'd like to set which country's carriers your customers can connect in the carrier connection screen, you can do so by using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["themes"]}," endpoint."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["themes"]}," endpoint allows you to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/partners/customize-theme"},"children":["customize your customer's onboarding experience"]}," and determine which country's carriers will be available for your customers to connect to."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/connectcountrycodescreen.bb4e6f6965207baea2e5ccf6b67f9c33669681a809a322cbc0dbd97695349455.78ec57cc.png","alt":"Carrier connect screen with country and carrier selection"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"set-carriers-by-country-for-your-customers","__idx":1},"children":["Set Carriers by Country for Your Customers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you haven't created a theme yet, you'll need to do so. If you want to edit a theme you've already created, you'll use the method to edit a theme instead."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carriers"]}," object to your request with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connect_country_codes"]}," property. The values for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["connect_country_codes"]}," property will be the two-letter ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1"},"children":["ISO 3166-1 country code"]}," starting with the country code of the account, and then adding any other country codes you wish to include."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the examples below, 'ACCOUNT_ORIGIN_COUNTRY_CODE' means the country code of the account. For example, if the account is based in the United States, the first country code in the value list will be \"US\"."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TIP:"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"include-with-onboarding-customization","__idx":2},"children":["Include with Onboarding Customization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carriers.connect_country_codes"]}," property when creating or editing a theme to customize your customer onboarding experience!"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Go to our ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/partners/theme-reference"},"children":["Theme Endpoint Reference page"]}," for a full list of properties available for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["themes"]}," endpoint and their descriptions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-theme-example-request","__idx":3},"children":["Create Theme Example Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST /v1/partners/themes"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/partners/themes HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __PARTNER_API_KEY_HERE__\nContent-Type: application/json\n\n{\n  \"name\": \"My theme\",\n  \"brand\": \"Auctane brand\",\n  \"carriers\": {\n    \"connect_country_codes\": [\"ACCOUNT_ORIGIN_COUNTRY_CODE\", \"GB\",\"ES\"]\n  }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Theme Example Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"theme_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My theme\",\n  \"brand\": \"Auctane brand\",\n  \"carriers\": {\n    \"connect_country_codes\": [\"ACCOUNT_ORIGIN_COUNTRY_CODE\", \"GB\",\"ES\"]\n  },\n  \"created_at\": \"2024-01-25T03:06:20.933Z\",\n  \"modified_at\": \"2024-01-25T03:06:20.933Z\",\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"edit-theme-example-request","__idx":4},"children":["Edit Theme Example Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you create a theme, the response will include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["theme_id"]},". You can then use the ID to make edits to your existing theme(s)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PATCH /v1/partners/themes/{themeID}"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"PATCH /v1/partners/themes/550e8400-e29b-41d4-a716-446655440000 HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __PARTNER_API_KEY_HERE__\nContent-Type: application/json\n\n{\n  \"carriers\": {\n    \"connect_country_codes\": [\"ACCOUNT_ORIGIN_COUNTRY_CODE\", \"GB\",\"ES\"]\n  },\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response will return your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["theme_id"]}," and the current values for each property in that theme."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using the above examples, the carriers available to your customer in the carrier connection screen will be countries available for that account's home country, Great Britain, and Spain. Carriers that service only other countries will be hidden."]}]},"headings":[{"value":"Set Available Carriers by Country","id":"set-available-carriers-by-country","depth":1},{"value":"Set Carriers by Country for Your Customers","id":"set-carriers-by-country-for-your-customers","depth":2},{"value":"Include with Onboarding Customization","id":"include-with-onboarding-customization","depth":3},{"value":"Create Theme Example Request","id":"create-theme-example-request","depth":3},{"value":"Edit Theme Example Request","id":"edit-theme-example-request","depth":3}],"frontmatter":{"seo":{"title":"Set Available Carriers by Country"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipengine/docs/partners/set-carrier-countries","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}