Sendcloud

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Experimental (how to enable).
  • Authentication: Basic auth.
  • Connection: HTTP Basic auth with SENDCLOUD_PUBLIC_KEY as the username and SENDCLOUD_SECRET_KEY as the password.
  • Provider documentation: Authentication reference.

Credentials

Set these per environment. See Connect an integration.

VariableRequiredDescription
SENDCLOUD_PUBLIC_KEYYesSendcloud API public key, used as the HTTP Basic username Docs.
SENDCLOUD_SECRET_KEYYesSendcloud API secret key, used as the HTTP Basic password Docs.

Setup

  1. Create a Sendcloud account: Sign up at https://app.sendcloud.com - a free plan is available and is enough to test the API against your own account.
  2. Create API keys: In the Sendcloud panel open Settings → Integrations (https://app.sendcloud.com/v2/settings/integrations/manage), find 'Sendcloud API' in the list, click Connect, and give the integration a name. You receive a public key and a secret key.
  3. Store the keys: Add SENDCLOUD_PUBLIC_KEY and SENDCLOUD_SECRET_KEY to your .env file. The API uses HTTP Basic auth with the public key as username and the secret key as password.
  4. Verify access: Run the List Shipments tool. An empty data array is a valid response for a new account.

Provider notes

  • Always use API v3 (https://panel.sendcloud.sc/api/v3/...) for new integrations - Sendcloud is migrating integrations from v2 to v3
  • Creating a shipment announces it to the carrier and may incur label costs; configure a sender address in the panel first
  • List Shipping Options is a POST request but is read-only - it only calculates available options and quotes

Provider API reference.

Tools

ToolAccessDescription
List Shipments<br /><code className="reference-identifier">sendcloud__list_shipments</code>ReadList shipments
Get Shipment<br /><code className="reference-identifier">sendcloud__get_shipment</code>ReadGet shipment
Create Shipment<br /><code className="reference-identifier">sendcloud__create_shipment</code>WriteCreate shipment
List Shipping Options<br /><code className="reference-identifier">sendcloud__list_shipping_options</code>ReadList shipping options
Get Tracking<br /><code className="reference-identifier">sendcloud__get_tracking</code>ReadGet tracking
Cancel Shipment<br /><code className="reference-identifier">sendcloud__cancel_shipment</code>WriteCancel shipment before carrier collection

Verify the connection

Call a read tool such as sendcloud__list_shipments with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.