Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

shipcloud (BYOK) — connector documentation

  • MCP endpoint: https://byok-shipcloud.connectorbay.com/mcp
  • REST API: POST https://byok-shipcloud.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-shipcloud.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own shipcloud shipcloud API key (sent as the basic-auth user name), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-shipcloud.connectorbay.com/health · Tool schemas: https://byok-shipcloud.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-shipcloud · agent@connectorbay.com

What shipcloud (BYOK) is for

shipcloud (BYOK) lets an AI assistant read your own shipcloud data through the shipcloud API with a key you supply (shipcloud API key (sent as the basic-auth user name)). Read-only: 10 tools (get_account, list_carriers, list_shipments, get_shipment, list_trackers, get_tracker, list_orders, list_webhooks, list_pickup_requests, find_pickup_dropoff_locations). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.shipcloud.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by shipcloud. shipcloud and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which shipcloud account and plan does my key belong to?"
  • "Which carriers and services can I use in shipcloud?"
  • "Which shipments did I create with DHL recently?"
  • "Show the details and tracking events of a shipcloud shipment"
  • "Which of my tracked parcels are still in transit?"
  • "What are the tracking events of a shipcloud tracker?"

What it does

  • get_account: Show the shipcloud account behind the key: user id, customer number, environment (production or sandbox) and subscription plan.
  • list_carriers: List the carriers available to the account with their services, package types, additional services and label formats.
  • list_shipments: List shipments, newest first, with carrier, service, tracking number, price and reference. Filters narrow by carrier, tracking number, reference, service, type, source, tracking status or creation time. Up to 100 per page. Recipient addresses are not returned.
  • get_shipment: Get one shipment by id: carrier, service, tracking number, price, reference, tracking link and its packages with sizes, weights and tracking events.
  • list_trackers: List trackers (shipments tracked by carrier tracking number) with carrier, tracking number, status and last status update. Recipient addresses are not returned.
  • get_tracker: Get one tracker by id with its current status and the list of tracking events (time, location, status, details).
  • list_orders: List orders sent to shipcloud (for the returns portal) with order ids, totals and weight. Filter by external order id, external customer id or creation date. Delivery addresses and items are not returned.
  • list_webhooks: List the webhooks registered on the account with their URL, subscribed event types and whether they are deactivated.
  • list_pickup_requests: List the carrier pickups that were requested: carrier, pickup number, time window and the shipments included.
  • find_pickup_dropoff_locations: Find carrier pickup and drop-off points (parcel shops, lockers) near an address or coordinates, with name, address, distance and opening hours.

BYOK key

You bring your own shipcloud shipcloud API key (sent as the basic-auth user name) (https://app.shipcloud.io/de/users/api_key). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.shipcloud.io over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the shipcloud API (api.shipcloud.io) with a BYOK key; documentation: https://developers.shipcloud.io/reference/. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by shipcloud. shipcloud and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your shipcloud account.

Built for: Worldwide. Languages: English.