Sendcloud Shipments API

Shipments API

Documentation GitHub OpenAPI

Business capability

Logistics Operations Management BC-520.50

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}.

Sendcloud Shipments API

Operations 12

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification