> For the complete documentation index, see [llms.txt](https://claimlane-docs.gitbook.io/claimlane-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://claimlane-docs.gitbook.io/claimlane-docs/troubleshooting-and-faqs/shipstation-integration-setup-guide.md).

# ShipStation Integration Setup Guide

### Prerequisites

Before starting, make sure that:

* You are logged in to **ShipStation as the account owner**
* Your **ShipStation plan includes API access**

If API access is not included in your plan, you will not be able to generate the required credentials.

***

### Step 1 — Log in to ShipStation

Log in to your ShipStation account using the **account owner** credentials.

***

### Step 2 — Open API Settings

In ShipStation, go to:

`Settings → Account → API Settings`

This is where you can generate the API credentials needed for the Claimlane integration.

***

### Step 3 — Generate API Credentials

1. Click **Generate API Key**
2. ShipStation will send a **verification email**
3. Open the email and complete the verification
4. Once verified, the **Generate** button will become active

***

### Step 4 — Select Expiration Period

Before finalizing the API credentials:

* Select the **longest expiration period available**

This helps reduce the risk of the integration stopping due to an expired key.

***

### Step 5 — Copy the API Key and API Secret

After clicking **Generate**, ShipStation will show:

* **API Key**
* **API Secret**

Important:

* These credentials are shown **only once**
* Copy them immediately
* Store them securely until they have been added to Claimlane

***

### Step 6 — Share the Credentials with Claimlane

Provide the following credentials to Claimlane:

* **API Key**
* **API Secret**

Claimlane will use these to connect to your ShipStation account.

***

### Step 7 — Configure the Shipping Agreement in Claimlane

In **Claimlane Shipping Agreements**, the integration must be configured using the following mapping:

* **Shipping identifier** = `Carrier:::ServiceCode`
* **Client ID** = `API Key`
* **Client Secret** = `API Secret`

#### Field mapping example

| Claimlane field     | Value                   |
| ------------------- | ----------------------- |
| Shipping identifier | `Carrier:::ServiceCode` |
| Client ID           | ShipStation API Key     |
| Client Secret       | ShipStation API Secret  |

***

### Shipping Identifier Format

The **Shipping identifier** must follow this format:

`Carrier:::ServiceCode`

Example structure:

`carrier_name:::service_code`

Make sure the value matches the carrier and service that should be used for outbound shipments.

***

### Result

Once the setup is completed, Claimlane will be able to use your ShipStation account to book **outbound shipping labels** for repair shipments.

***

### Troubleshooting

#### API Settings are not available in ShipStation

Your ShipStation plan may not include API access. Check your subscription or contact ShipStation support.

#### API Key or API Secret was not copied

ShipStation only shows these credentials once. If they were lost, you will need to generate a new set.

#### Integration does not work in Claimlane

Double-check that:

* the **API Key** is entered as **Client ID**
* the **API Secret** is entered as **Client Secret**
* the **Shipping identifier** uses the exact format `Carrier:::ServiceCode`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://claimlane-docs.gitbook.io/claimlane-docs/troubleshooting-and-faqs/shipstation-integration-setup-guide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.