Skip to content

ShipEngine

Updated View as Markdown

Inspect connected parcel carriers and their service codes in ShipEngine, now branded ShipStation API. Select your account’s US or EU API region and supply its API key. These three reads do not buy labels, quote rates, create shipments, connect carriers or expose carrier account numbers. This is separate from the ShipStation application integration.

What you can do (3)

What you can do

Available commands: 3 (3 read, 0 write). Enable only the commands your application needs.

Command Effect
List connected ShipEngine carriers — shipengine.carriers.list Read
Read a connected ShipEngine carrier — shipengine.carriers.get Read
List a ShipEngine carrier’s services — shipengine.services.list Read

Connect and use

Connect and use

Open the integration's connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.

Get your provider credentials

Follow these steps for ShipEngine, then enter the issued values in the connection form below.

  1. Sign in to the ShipEngine / ShipStation API dashboard, choose Sandbox or Production in the environment selector, open API Keys and choose Create new key. Name and copy the key. Sandbox keys begin with TEST and work with the provided sandbox carriers. Enter the key in ShipEngine API key and select the matching account’s us or eu API region here; keys are not transferred between regions. Select carriers.list and save, then create an Tooluse.net API key scoped to the reads you need. Use a returned carrier_id with carriers.get or services.list. No labels or paid rate requests are made by these commands. Revoke/replace the key in the provider dashboard and update this connection; no managed OAuth is provided.

Official credential setup

Where to enter credentials

In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.

Connection field Requirement
ShipEngine API key Required
ShipEngine API region Required

Open API keys and create a Tooluse.net key for the enabled commands.

Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.

Configure Claude Code, Codex or Cursor once

Permissions and results

If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.

Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.

Call from your client

Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.

Configure Claude Code, Codex or Cursor once

Discover your enabled tools

List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.

curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.

HTTP call

curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {}
}'

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Commands

List connected ShipEngine carriers — shipengine.carriers.list

Read connected parcel-carrier account IDs, codes, display names, nicknames and primary status. Account numbers, billing and nested settings are excluded. The provider returns one collection; no automatic pagination, rate quote, label purchase or carrier connection is performed.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Read a connected ShipEngine carrier — shipengine.carriers.get

Read the identity, display name and primary status of one connected parcel carrier. Obtain carrier_id from carriers.list. Account numbers and connection secrets are excluded. LTL endpoints and connection changes are outside this subset.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.carrier_id string Required A carrier ID returned by carriers.list. This is a connected parcel-carrier ID, not an LTL SCAC. minLength: 1; maxLength: 25; pattern: "^se(-[a-z0-9]+)+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "carrier_id": "se-123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a ShipEngine carrier’s services — shipengine.services.list

Read service codes, names and domestic/international/multi-package/return capability flags for one connected parcel carrier. Obtain carrier_id from carriers.list. This does not quote rates, check transit estimates or create shipments.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.carrier_id string Required A carrier ID returned by carriers.list. This is a connected parcel-carrier ID, not an LTL SCAC. minLength: 1; maxLength: 25; pattern: "^se(-[a-z0-9]+)+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "carrier_id": "se-123"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Errors

Check the key's expiry, revocation, workspace and allowed operations.

Reuse the same idempotency key only for the same request.

The connection or provider limit has been reached. Check the receipt before retrying.

Test the connection

Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.

Official provider documentation

Type to search…

↑↓ navigate↵ selectEsc close