Sendcloud

Sendcloud Shipments API

Shipments API

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /shipments/announce Create and announce a shipment synchronously · Create and announce a shipment synchronously #
Ask an LLM
“How do I create a shipment and get the label in the same response?”
“Can I announce a shipment and wait for the carrier to confirm?”
Tell an agent
Announce shipment of parcels {parcels} and wait for the label.
Create a shipment now and return the carrier response.
GET /shipments List shipments · Retrieve shipments #
Ask an LLM
“Which shipments have I created or imported recently?”
“Can I filter shipments by tracking number or order number?”
Tell an agent
List shipments with status {parcel_status}.
Find the shipment with tracking number {tracking_number}.
POST /shipments Create and announce a shipment asynchronously · Create and announce a shipment asynchronously #
Ask an LLM
“Can I submit a shipment and have it announced in the background?”
“What's the non-blocking way to announce a shipment?”
Tell an agent
Submit parcels {parcels} as a shipment announced in the background.
Queue a new shipment for asynchronous announcement.
POST /shipments/announce-with-shipping-rules Announce a shipment with shipping rules, synchronously · Create a shipment with rules and/or defaults and announce it synchronously #
Ask an LLM
“Can my shipping rules pick the method when I announce a shipment and wait for it?”
“How do I apply my shipping defaults and get the label back immediately?”
Tell an agent
Announce parcels {parcels} now applying shipping rules {apply_shipping_rules}.
Create a shipment with my shipping defaults {apply_shipping_defaults} and wait for the label.
POST /shipments/create-with-shipping-rules Announce a shipment with shipping rules, asynchronously · Create a shipment with rules and/or defaults and announce it asynchronously #
Ask an LLM
“Can shipping rules and defaults be applied to a shipment announced in the background?”
“Is there an async version of creating shipments with my shipping rules?”
Tell an agent
Queue parcels {parcels} for background announcement with shipping rules {apply_shipping_rules}.
Create an async shipment using shipping defaults {apply_shipping_defaults}.
POST /addresses/validate Validate a shipping address · Validate an address #
Ask an LLM
“Can I check that a shipping address is valid before I create a label?”
“Which carrier do I need to name when checking an address for deliverability?”
Tell an agent
Validate the address {address} for carrier {carrier_code}.
Check whether {address} is a deliverable address before shipping with {carrier_code}.
GET /shipments/{id} Get a shipment · Retrieve a shipment #
Ask an LLM
“How do I look up one shipment by its ID?”
“What parcels and status does a particular shipment have?”
Tell an agent
Show shipment {id}.
Get the details of shipment {id}.
POST /shipments/{id}/cancel Cancel an announced shipment · Cancel a shipment #
Ask an LLM
“Can I cancel a shipment that's already been announced to the carrier?”
“Does every carrier allow announced shipments to be cancelled?”
Tell an agent destructive · confirm first
Cancel shipment {id}.
Cancel announced shipment {id} with the carrier.
GET /shipments/{id}/return-portal-url Get the return portal link for a shipment · Retrieve a return portal URL #
Ask an LLM
“How do I get a return portal link to send with a shipment?”
“Which return portal URL belongs to a given shipment?”
Tell an agent
Get the return portal URL for shipment {id}.
Show the return portal link of shipment {id}.
GET /integrations/{id}/shipments List orders imported from a shop integration · Retrieve a list of shipments #
Ask an LLM
“Which orders were imported from one of my webshop integrations?”
“Can I filter a shop's imported orders by date range or order number?”
Tell an agent
List imported orders for integration {id}.
Show orders imported into integration {id} between {start_date} and {end_date}.
POST /integrations/{id}/shipments Push orders into a shop integration · Create or update a list of shipments #
Ask an LLM
“How do I insert orders from my shop system into an API integration?”
“Can I update orders I already pushed to an integration?”
Tell an agent
Insert a list of orders into integration {id}.
Create or update shop orders in integration {id}.
POST /integrations/{id}/shipments/delete Delete an order from a shop integration · Delete a shipment #
Ask an LLM
“How do I remove an order from Sendcloud after it was cancelled in my shop?”
“Can I delete an imported shop order from an integration?”
Tell an agent destructive · confirm first
Delete a shop order from integration {id}.
Remove the cancelled order from integration {id}.

Documentation

📖
Documentation
https://sendcloud.dev/api/v3/shipments/
📖
APIReference
https://sendcloud.dev/api/v3/shipments/create-and-announce-a-shipment-synchronously
📖
Documentation
https://sendcloud.dev/api/v3/orders/
📖
Documentation
https://sendcloud.dev/api/v3/ship-an-order/
📖
Documentation
https://sendcloud.dev/api/v3/returns/
📖
Documentation
https://sendcloud.dev/api/v3/service-points/
📖
Documentation
https://sendcloud.dev/api/v3/parcel-tracking/
📖
Documentation
https://sendcloud.dev/api/v3/parcel-documents/
📖
Documentation
https://sendcloud.dev/api/v3/webhooks/
📖
Documentation
https://sendcloud.dev/api/v3/event-subscriptions/
📖
Documentation
https://sendcloud.dev/api/v3/integrations/
📖
Documentation
https://sendcloud.dev/api/v3/analytics/
📖
Documentation
https://sendcloud.dev/api/v3/reporting/
📖
Documentation
https://sendcloud.dev/api/v2/parcels/
📖
Documentation
https://sendcloud.dev/api/v2/labels/
📖
Documentation
https://sendcloud.dev/api/v2/tracking/
📖
Documentation
https://sendcloud.dev/api/v2/webhooks/
📖
Documentation
https://sendcloud.dev/api/v2/integrations/
📖
Documentation
https://sendcloud.dev/api/v2/analytics/
📖
Documentation
https://sendcloud.dev/api/v2/reporting/
📖
Documentation
https://sendcloud.dev/api/v2/parcel-documents/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/openapi/sendcloud-shipments-api-openapi.yml

Schemas & Data

📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/json-structure/sendcloud-shipment-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/json-schema/sendcloud-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/json-schema/sendcloud-return-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/json-schema/sendcloud-deliveryoption-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/json-structure/sendcloud-return-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/json-schema/sendcloud-servicepoint-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/json-schema/sendcloud-servicepointdetail-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/json-schema/sendcloud-servicepointaddress-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/json-schema/sendcloud-parceltrackingresponse-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/json-schema/sendcloud-parceltrackingcreaterequest-schema.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/examples/sendcloud-announce-shipment-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/examples/sendcloud-create-return-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/examples/sendcloud-list-service-points-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sendcloud:sendcloud-shipments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sendcloud-shipments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sendcloud Shipments API
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
  description: 'Operations tagged Shipments across 2 of this provider''s published API definitions: sendcloud-shipments-openapi.yml, sendcloud-v2-integrations-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://panel.sendcloud.sc/api/v3
  description: Sendcloud Production
- url: https://panel.sendcloud.sc/api/v2
  description: Sendcloud Production
tags:


# --- truncated at 32 KB (284 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sendcloud/refs/heads/main/openapi/sendcloud-shipments-api-openapi.yml