Skip to main content

🤖 Integrate with AI

Use your AI coding assistant to integrate the Ship24 Tracking API faster. There are two entry points:

  1. A guided prompt that points your assistant at a hosted integration guide.
  2. The Tracking MCP server, which lets an assistant call the Tracking API directly as tools.

Guided prompt​

Paste the prompt below into your AI coding assistant (Claude, Cursor, Copilot, etc.). It tells the assistant to read our hosted SKILL.md and walk you through a full integration.

Read https://docs.ship24.com/assets/ai/skills/ship24-tracking-api-integration/SKILL.md and follow the instructions to integrate the Ship24 Tracking API into my project.

How it works​

SKILL.md is a hosted instruction file the assistant reads first. It guides the assistant through four phases:

  1. Detect your existing setup (language, framework, how you call HTTP APIs).
  2. Clarify your plan and preferences (e.g. trackers vs. per-call, webhooks vs. polling).
  3. Implement the integration against the Tracking API.
  4. Verify the result with real calls.

You still need a Ship24 API key. See Getting started.

Tracking MCP server​

The Ship24 Tracking MCP server exposes the Tracking API as Model Context Protocol tools, so an AI assistant can create trackers, fetch tracking results and list couriers for you without writing any HTTP code.

Ship24 hosts the server, and it uses the Streamable HTTP transport:

https://api.ship24.com/mcp

Prerequisites​

You authenticate with your normal Ship24 API key (apik_...). Create one in your Dashboard; see Getting started.

The API key is passed on every request via the Authorization header:

Authorization: Bearer apik_your_key_here

Connect your client​

For Claude Code, run:

claude mcp add --transport http ship24-tracking https://api.ship24.com/mcp -H "Authorization: Bearer apik_your_key_here"

For Claude Desktop, Cursor and other clients that use a JSON config, add the server to your MCP configuration:

{
"mcpServers": {
"ship24-tracking": {
"type": "http",
"url": "https://api.ship24.com/mcp",
"headers": {
"Authorization": "Bearer apik_your_key_here"
}
}
}
}

Replace apik_your_key_here with your own key and restart the client.

Available tools​

ToolWhat it does
create_trackerCreate a tracker for a tracking number. Idempotent; subscribes to webhook updates when configured.
bulk_create_trackersCreate up to 100 trackers in a single request.
trackCreate a tracker and return full tracking results in one call.
list_trackersReturn a paginated list of your trackers.
get_trackerFetch a single tracker's metadata by trackerId (or clientTrackerId).
update_trackerPartially update a tracker (e.g. subscribe/unsubscribe, correct destination).
get_tracking_resultsFull tracking results for a tracker: status, all events and delivery statistics.
search_tracking_by_numberFind all tracking results for a raw tracking number, without a trackerId.
get_couriersList every supported courier with its courier code and requirements.
search_trackingOn-demand per-call lookup (per-call plans). Does not create a persistent tracker.
resend_webhooksResend all webhook messages of an existing tracker.

Limitations​

  • Calls made through the MCP server use your API key and count against your Ship24 plan's quota, the same as direct API calls.
  • get_couriers returns the full courier list, which is large. Prefer letting Ship24 auto-detect the courier from the tracking number, and omit courierCode unless you need to force a specific one. When you do need codes, fetch the list once and cache it in your application rather than requesting it on every call.
  • Webhook endpoint configuration, account and plan management, and API-key generation are not available as tools. Manage those in your Dashboard.

For the full request/response schema of every endpoint, see the API Reference.