MCP Server

To use the ShipBob MCP server with Claude Desktop:

1. Open Claude Desktop’s configuration file:
   • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: %APPDATA%\Claude\claude_desktop_config.json
2. Add the ShipBob MCP server configuration:

Configuration:

1
{
2
  "mcpServers": {
3
    "shipbob-developer-api": {
4
      "url": "https://api.shipbob.com/developer-api/mcp",
5
      "transportType": "http",
6
      "headers": {
7
        "Authorization": "Bearer YOUR_API_TOKEN"
8
      }
9
    }
10
  }
11
}

3. Replace YOUR_API_TOKEN with your actual ShipBob API token
4. Restart Claude Desktop
5. Verify the connection by asking Claude: “What ShipBob tools are available?”

To integrate with VS Code, you’ll need to configure an MCP server in your mcp.json file:

Prerequisites:

• Install the latest version of Visual Studio Code
• Have access to GitHub Copilot

1. Create Configuration File:
   • Workspace: Create .vscode/mcp.json in your workspace folder
   • User Profile: Use the command MCP: Open User Configuration from the Command Palette (Ctrl+Shift+P)
2. Add ShipBob MCP Server Configuration:

Configuration:

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-api-token}"
8
      }
9
    }
10
  },
11
  "inputs": [
12
    {
13
      "type": "promptString",
14
      "id": "shipbob-api-token",
15
      "description": "ShipBob API Token",
16
      "password": true
17
    }
18
  ]
19
}

Alternative: Using Environment Variables:

1
{
2
  "servers": {
3
    "shipbob-developer-api": {
4
      "type": "http",
5
      "url": "https://api.shipbob.com/developer-api/mcp",
6
      "headers": {
7
        "Authorization": "Bearer ${env:SHIPBOB_API_TOKEN}"
8
      }
9
    }
10
  }
11
}

3. When you start using the MCP server, VS Code will prompt you for your API token (if using ${input:}), or ensure the SHIPBOB_API_TOKEN environment variable is set (if using ${env:})
4. Trust the Server: When VS Code prompts you to trust the MCP server configuration, review the details and confirm
5. Start the Server: Run MCP: List Servers from the Command Palette and start the ShipBob Developer API server
6. Verify the connection by opening Copilot Chat and asking: “What ShipBob tools are available?”

For other MCP-compatible AI assistants:

1. Use the appropriate ShipBob MCP endpoint:

   • Sandbox: https://sandbox-api.shipbob.com/developer-api/mcp
   • Production: https://api.shipbob.com/developer-api/mcp

2. Configure authentication using your ShipBob API token in the Authorization header:

   Authorization: Bearer YOUR_API_TOKEN

3. Follow your client’s specific MCP configuration instructions

4. Verify the connection by listing available tools

• Get Orders
• Get Order by Order ID
• Get Order Store JSON
• Get All Merchants Shipping Methods
• Get All Shipments for Order
• Get One Shipment by Shipment ID
• Get Logs for One Shipment by Shipment ID
• Get One Shipment by Order ID and Shipment ID
• Get Logs for One Shipment by Order ID and Shipment ID
• Get One Shipment’s Status Timeline by Shipment ID
• Get One Shipment’s Status Timeline by Order ID and Shipment ID

• Gets Taxonomy
• Gets Product by ID
• Gets Taxonomy by ID
• Gets Taxonomy Parent
• Gets Packaging Requirement
• Gets Multiple Product Variants
• Retrieves List of Products Based on Filters Provided

• Get Inventory
• Get All Inventories
• Get Inventory Levels
• Get All Inventory Levels
• Get Inventory Levels Grouped by Lot
• Get All Inventory Levels Grouped by Lot
• Get Inventory Levels Grouped by Fulfillment Center
• Get All Inventory Levels Grouped by Fulfillment Center

• Get Channels

Problem: AI assistant cannot connect to ShipBob MCP Server

Solutions:

1. Verify you’re using the correct endpoint URL:
   • Sandbox: https://sandbox-api.shipbob.com/developer-api/mcp
   • Production: https://api.shipbob.com/developer-api/mcp
2. Check your internet connection
3. Ensure your AI assistant supports MCP protocol
4. Verify your configuration file syntax is correct

Problem: Requests fail with “401 Unauthorized” or “403 Forbidden”

Solutions:

1. Verify your ShipBob API token is valid
2. Check token hasn’t expired (regenerate if needed)
3. Ensure the Authorization header is properly formatted: Bearer YOUR_TOKEN
4. Confirm you’re using the right token for the environment (sandbox vs production)

Problem: AI assistant reports no ShipBob tools are available

Solutions:

1. Verify the MCP server configuration in your AI assistant
2. Restart your AI assistant after configuration changes
3. Check that your API token has the necessary permissions
4. Try asking: “What ShipBob tools are available?”

Problem: Tools execute but return errors

Solutions:

1. Check that required parameters are provided
2. Verify parameter formats match API requirements (e.g., dates, IDs)
3. Review error message for specific guidance
4. Consult ShipBob API documentation for parameter details
5. Ensure you have permissions for the operation

Problem: Requests are being throttled

Solutions:

1. Check ShipBob API rate limits
2. Reduce the frequency of requests
3. Use batch operations when available

Problem: Data returned doesn’t match expectations

Solutions:

1. Verify you’re using the correct environment (sandbox vs production)
2. Check that data exists in your ShipBob account
3. Ensure you have the right permissions to view the data
4. Try the same query directly in the ShipBob dashboard

Any MCP-compatible AI assistant that supports Streamable HTTP transport.

The MCP Server is free to use for ShipBob customers.

Yes! Use the production endpoint (https://api.shipbob.com/developer-api/mcp) with your production API credentials.

Simply update your AI assistant’s configuration to use the appropriate endpoint URL and API token:

• Sandbox: https://sandbox-api.shipbob.com/developer-api/mcp + sandbox token
• Production: https://api.shipbob.com/developer-api/mcp + production token

Yes. All communication is encrypted via HTTPS, your API token is securely validated, and no data is stored or shared by the MCP server.

Follow the ShipBob Authentication Guide to set up API access for your ShipBob account. The guide covers both sandbox and production environment setup.

The AI assistant will only perform actions you explicitly request. Your ShipBob API token’s permissions also control what actions are possible.