Setup with API Token

View as MarkdownOpen in Claude

This page shows how to connect using an API token that you generate from your ShipBob dashboard. If your AI app supports sign-in with your browser (most modern versions do), the standard Setup is easier - you just paste a URL and sign in. No token needed.

When to Use This Method

Use this setup if:

  • Your AI app doesn’t offer a “sign in with browser” option when you add the ShipBob server
  • Your workplace requires you to use an API token instead of signing in through the browser
  • You prefer to generate and manage a token yourself

If you’re not sure, try the standard setup first. You can always come back here if it doesn’t work with your app.

Step 1 - Generate a ShipBob API Token

  1. Log in to your ShipBob dashboard:
  2. In the left sidebar, click Integrations
  3. Click API Tokens, then Generate New Token
  4. Give the token a name (e.g., Claude Desktop) and click Generate
  5. Copy the token immediately - it is only shown once

PAT Screen

Treat this token like a password. Do not share it or commit it to source control.

For more detail on token generation, see Authentication.

Step 2 - Configure Your AI Client

Pick your app below and follow the instructions.

Claude Desktop needs a helper tool called mcp-remote to send your token to ShipBob. This requires Node.js to be installed on your computer.

Before you start: Download and install Node.js (LTS). After installing, open a terminal (Command Prompt on Windows, Terminal on Mac) and type node --version to confirm it’s working. You should see a version number like v24.15.0.

Node Version

If you see 'node' is not recognized or command not found, restart your computer and try again.
  1. Open Claude Desktop

  2. Open the configuration file:

    • Windows: Click FileSettingsDeveloperEdit Config
    • Mac: Click Claude in the menu bar → SettingsDeveloperEdit Config

    Local MCP Servers

  3. A file called claude_desktop_config.json opens in your text editor (Notepad on Windows)

    Claude Desktop Config File Claude Desktop Config File Content

  4. Add the ShipBob connection:

    If the file is empty or contains only {}, delete everything and paste this:

    1{
    2 "mcpServers": {
    3 "shipbob-developer-api": {
    4 "command": "npx",
    5 "args": [
    6 "mcp-remote",
    7 "https://api.shipbob.com/developer-api/mcp",
    8 "--header",
    9 "Authorization:${AUTH_HEADER}"
    10 ],
    11 "env": {
    12 "AUTH_HEADER": "Bearer PASTE_YOUR_TOKEN_HERE"
    13 }
    14 }
    15 }
    16}

    Claude Config

    For sandbox, swap the URL to https://sandbox-api.shipbob.com/developer-api/mcp.

  5. Find the line that says PASTE_YOUR_TOKEN_HERE and replace it with the token you copied in Step 1.

    Keep the word Bearer and the space before your token. The line should look like: "AUTH_HEADER": "Bearer D4AC36BF5C5...4-1"

    Claude Config with Masked Token

  6. Save the file (Ctrl+S on Windows, Cmd+S on Mac)

  7. Fully close Claude Desktop - don’t just minimize it:

    • Windows: Open Task Manager (Ctrl+Shift+Esc) → find Claude → right-click → End Task
    • Mac: Right-click Claude in the Dock → Quit

    Claude Force Stop

  8. Reopen Claude Desktop

    Connectors list in Claude chat

    Open a new chat and you should see the ShipBob connector listed. Ask Claude, What ShipBob tools are available?, to verify the connection. MCP Server tools list

VS Code can connect to ShipBob directly with your token - no extra tools needed.

Add the following to .vscode/mcp.json or your user MCP config:

1{
2 "servers": {
3 "shipbob-developer-api": {
4 "type": "http",
5 "url": "https://api.shipbob.com/developer-api/mcp",
6 "headers": {
7 "Authorization": "Bearer ${input:shipbob_token}"
8 }
9 }
10 },
11 "inputs": [
12 {
13 "type": "promptString",
14 "id": "shipbob_token",
15 "description": "ShipBob API Token",
16 "password": true
17 }
18 ]
19}

When you start the server for the first time, VS Code asks you to enter your token. Paste the token you copied in Step 1 (without Bearer - VS Code adds that automatically).

For sandbox, swap the URL to https://sandbox-api.shipbob.com/developer-api/mcp.

If your app lets you add a remote server with custom headers, configure it with:

SettingValue
Server URLhttps://api.shipbob.com/developer-api/mcp (or https://sandbox-api.shipbob.com/developer-api/mcp for sandbox)
Authorization headerBearer <your-token>

If your app uses a JSON config file, the entry typically looks like:

1{
2 "type": "http",
3 "url": "https://api.shipbob.com/developer-api/mcp",
4 "headers": {
5 "Authorization": "Bearer PASTE_YOUR_TOKEN_HERE"
6 }
7}

If your app only supports running a local command (not a URL), you can use mcp-remote as a bridge. This requires Node.js:

$npx mcp-remote https://api.shipbob.com/developer-api/mcp --header "Authorization:Bearer PASTE_YOUR_TOKEN_HERE"

Step 3 - Verify the Connection

Start a new chat and type:

"What ShipBob tools are available?"

If set up correctly, your AI client lists the available ShipBob tools.

Common Errors

ErrorWhat to do
npx: command not foundNode.js is not installed (only needed for Claude Desktop). Download from nodejs.org/en/download and restart your computer.
”Unauthorized” or 401 errorYour token may be incorrect. Go back to your ShipBob dashboard, generate a new token, and paste it again carefully. Make sure there’s a space between Bearer and the token.
ShipBob tools don’t appear after restartMake sure you fully closed your AI app - not just minimized it. On Windows, use Task Manager; on Mac, right-click in the Dock and click Quit.
Config file shows a red errorThe JSON formatting may be broken. Paste the entire file contents into jsonlint.com - it will highlight exactly where the problem is.

Need Help?