{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/partners/accounts/create","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/partners/accounts/create","default":false,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/partners/accounts/create","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Create an Account","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":"create-an-account","__idx":0},"children":["Create an Account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["ShipStation's Partner API allows you to programmatically create ShipStation API accounts for your customers. You can then make ShipStation API calls on behalf of your customers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When creating a ShipStation API account, you can optionally include a unique ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["external_account_id"]},", which can be your own ID for that customer. This will allow you to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/partners/accounts/get-account-by-external-id"},"children":["retrieve the account using the external ID"]}," later."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"shipstation-api-login","__idx":1},"children":["ShipStation API Login"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["ShipStation API accounts that are created via the Partner API cannot log into the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://dashboard.shipengine.com/"},"children":["ShipStation API dashboard"]}," by default. Instead, everything that a user might normally do in the dashboard is instead done via the API. The most obvious example of this is ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/carriers/connect"},"children":["connecting a carrier account"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"email-and-password","__idx":2},"children":["Email and Password"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can specify an email and password that will allow direct login access to this account."," ","The password must be at least 7 characters long. The email must be unique and not in use by any other accounts associated with ShipStation API - if the email is already in use by another account, you will receive an error."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request-body-properties","__idx":3},"children":["Request Body Properties"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following table lists the properties required for this endpoint. To see a sample of a full request, see the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#example-request"},"children":["Example Request"]}," section below."]},{"$$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":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Max Length"},"children":["Max Length"]},{"$$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":["first_name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["24"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First name of account owner. This will always be null in the response. (Optional)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["last_name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["24"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last name of account owner. This will always be null in the response. (Optional)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["company_name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["50"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Company name of account owner. This will always be null in the response. (Optional)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["external_account_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["128"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A unique ID that can be used to list the account. (Optional)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["origin_country_code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be capitalized. Valid values for this field can be found on our ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/partners/accounts/supported-countries"},"children":["supported countries page"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["50"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A unique email that can be used to log into the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://dashboard.shipengine.com/"},"children":["ShipStation API dashboard"]},". This will always be null in the response. (Optional)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["password"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["128"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Minimum 7 characters. A password that can be used to log into the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://dashboard.shipengine.com/"},"children":["ShipStation API dashboard"]},". This is not in the response. (Optional)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-request--response","__idx":4},"children":["Example Request & Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create a ShipStation API account, you'll send a POST request to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/partners/accounts"]}," endpoint containing information about your customer's account."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/partners/accounts HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __PARTNER_API_KEY_HERE__\nContent-Type: application/json\n\n{\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"company_name\": \"Acme Corp.\",\n  \"external_account_id\": \"819748723192\",\n  \"origin_country_code\": \"US\",\n  \"email\": \"Must be Unique\",\n  \"password\": \"Must be at least 7 characters\"\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example response:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"api_key\": {\n    \"encrypted_api_key\": \"ie3IlOJ01tTirwbezeOsiC6aYMy5AxpaWtEGbmWGX3E\",\n    \"created_at\": \"2023-12-04T23:06:39.197Z\",\n    \"description\": \"Account API Key\",\n    \"account_id\": 12345,\n    \"api_key_id\": 4069\n  },\n  \"account_id\": 12345,\n  \"external_account_id\": \"Very Real ID\",\n  \"created_at\": \"2023-12-04T23:06:39.197Z\",\n  \"modified_at\": \"2023-12-04T23:06:39.197Z\",\n  \"active\": true,\n  \"email\": null,\n  \"company_name\": null,\n  \"first_name\": null,\n  \"last_name\": null,\n  \"origin_country_code\": \"US\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["NOTE:"]}," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["encrypted_api_key"]}," contains the account API key. The name may imply that this value needs to be decrypted before it can be used, but that is not the case. In your API requests, you should send this value as-is. Please treat the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["encrypted_api_key"]}," value as a sensitive piece of information and ensure it is stored securely in your system."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each account is created with an API key you can begin using immediately. If this key is ever compromised you can always ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/partners/disable-api-key"},"children":["delete it"]}," and then ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/partners/create-shipengine-api-key"},"children":["create a new one"]},"."]}]},"headings":[{"value":"Create an Account","id":"create-an-account","depth":1},{"value":"ShipStation API Login","id":"shipstation-api-login","depth":2},{"value":"Email and Password","id":"email-and-password","depth":3},{"value":"Request Body Properties","id":"request-body-properties","depth":2},{"value":"Example Request & Response","id":"example-request--response","depth":2}],"frontmatter":{"seo":{"title":"Create an Account"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipengine/docs/partners/accounts/create","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}