How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Sendcloud

Sendcloud Shipments API

Shipments API

Documentation Provider Profile APIs.io OpenAPI GitHub

Sendcloud Shipments API is one of 26 APIs that Sendcloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 10 JSON Schema definitions.

Tagged areas include Shipments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 10 JSON Schemas.

This API exposes 12 operations across 10 paths, and defines 63 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://panel.sendcloud.sc/api/v3, https://panel.sendcloud.sc/api/v2.

12 operations 10 paths 63 schemas 4 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://panel.sendcloud.sc/api/v3
Authentication
HTTP Basic, OAuth 2.0
License
Apache 2.0
Resource Areas
1

Authentication & Security 2

Sendcloud Shipments API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (HTTPBasicAuth). It supports OAuth 2.0 (OAuth2ClientCreds) using the clientCredentials flow, exposing 1 scope.

  • HTTPBasicAuth — Basic Authentication using API key and secrets is currently the main authentication mechanism.
  • OAuth2ClientCreds — OAuth2 is a standardized protocol for authorization that allows users to share their private resources stored on one site with another site without having to p…

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 4 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Shipments 12

Shipments API

POST
/shipments/announce
Create and announce a shipment synchronously
sc-public-v3-scp-post-announce_shipment 1 param body → 201400404
GET
/shipments
Retrieve shipments
sc-public-v3-scp-get-all_shipments 13 params → 200400404
POST
/shipments
Create and announce a shipment asynchronously
sc-public-v3-scp-post-create_shipment 1 param body → 201400404
POST
/shipments/announce-with-shipping-rules
Create a shipment with rules and/or defaults and announce it synchronously
sc-public-v3-scp-post-announce_shipment_with_rules 1 param body → 201400404
POST
/shipments/create-with-shipping-rules
Create a shipment with rules and/or defaults and announce it asynchronously
sc-public-v3-scp-post-create_shipment_with_rules 1 param body → 201400404
POST
/addresses/validate
Validate an address
sc-public-v3-scp-post-validate_address 1 param body → 200400
GET
/shipments/{id}
Retrieve a shipment
sc-public-v3-scp-get-shipment_by_id 1 param → 200404
POST
/shipments/{id}/cancel
Cancel a shipment
sc-public-v3-scp-post-cancel_shipment 1 param → 200202404409
GET
/shipments/{id}/return-portal-url
Retrieve a return portal URL
sc-public-v3-scp-get-return_portal_url 1 param → 200404
GET
/integrations/{id}/shipments
Retrieve a list of shipments
sc-public-v2-orders-get-retrieve_a_list_of_shipments 9 params → 200404
POST
/integrations/{id}/shipments
Create or update a list of shipments
sc-public-v2-orders-post-create_a_list_of_shipments 1 param body → 200400404
POST
/integrations/{id}/shipments/delete
Delete a shipment
sc-public-v2-orders-post-delete_a_shipment 1 param body → 204400404

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are ShipmentBlobOrder (40 properties), ShipmentBlobOrderCreate (33 properties), dangerous-goods (19 properties), parcel-item-with-optional-fields (18 properties). Each schema is shown below with its type and property counts.

status
object
Status object for a parcel
2 properties
shipment-with-rules-response
object
Shipment response object model including applied shipping rules.
documents
object
Documents object for a parcel
4 properties
sync-parcels-array-response
object
Sync parcel common object model
address-validation-method-enum
string
str-dimensions
object
Dimensions in the specified unit
4 properties 4 required
customs-information-with-optional-fields
objectnull
Optional customs information that should be provided for international shipments. This information is used for generating customs documents.
13 properties 1 required
shipment-response
object
Shipment response object model
cancellation-status
object
2 properties 2 required
delivery-dates
object
Defined delivery dates
2 properties
multicollo-parcels-array-request-with-optional-fields
object
Parcels array request with optional fields object model
1 property
base-shipment-response
object
Base shipment response object model
address-with-sender-address-id
object
A sender address referenced by ID.
1 property 1 required
parcel-common-with-optional-fields
object
Parcel common with optional fields model
6 properties
shipment-request-sync-announce
object
Synchronous Announcement Shipment request object model
dimension-units
string
ErrorObject
object
Error in a JSON:API error format
8 properties
address-washer-response
object
Address Washer Response object model
2 properties
customs-information
object
applied-shipping-rule
object
Represents a shipping rule that was applied to the shipment and the result of the changes it made.
2 properties 2 required
Price
object
2 properties
parcel-common
object
Parcel common object model
shipment-request
object
Shipment request object model
service-point-response
object
Service point information returned in responses.
2 properties 2 required
weight
object
Weight in the specified unit
2 properties 2 required
service-point-request
object
Node for service point information. Use the [Retrieve a list of service points](/api/v2/service-points/retrieve-a-list-of-service-points) endpoint to find serv…
shipment-common-with-optional-fields
object
Shipment common with optional fields object model
8 properties 1 required
sync-shipment-with-rules-response
object
Sync shipment response object model including applied shipping rules.
parcel-item-with-optional-fields
object
A single item (with optional fields) in a shipment. Note that parcel item object is required for shipments that require customs documents.
18 properties 1 required
cancel-shipment-status
object
1 property 1 required
errors
array
A standardized format for errors in [JSON:API](https://jsonapi.org/format/error-objects) responses.
parcel-item
object
A single item in a shipment. Note that parcel item object is required for shipments that require customs documents.
dangerous-goods
object
Hazardous materials information for items.
19 properties
optional-price
address-washer-request
object
Address Washer Request object model
3 properties 2 required
label-details
object
Describes the format and resolution of the label. Note: If you request a label in ZPL format and the carrier supports native ZPL, then it won't be possible to…
2 properties
parcels-array-response
object
Parcel common object model
address-with-required-fields
object
Sendcloud Address object
TaxNumber
object
Identification numbers and codes used in different contexts. These identifiers are used for taxation, customs, business registration, and other purposes, depen…
3 properties 3 required
str-weight
object
Weight in the specified unit
2 properties 2 required
required-price
Price, consisting of a value and currency.
shipment-request-async
object
Asynchronous Shipment request object model
raw-address
object
Raw address object
8 properties
multicollo-parcels-array-request
object
Multicollo parcels array model
1 property
shipping-option-code-properties
object
Contains the required properties to be sent when API client informs the shipping method and carrier to be used
2 properties
shipment-request-with-optional-fields
object
Shipment request with optional fields object model
ship-with
object
The ship with object can be used to define how you would like to send your shipment. You can use a shippingoptioncode. This is a unique identifier that display…
2 properties 2 required
shipment-common
object
Shipment common object model
sync-shipment-response
object
Sync shipment response object model
address
object
Sendcloud Address object
12 properties
shipment-request-with-rules
object
Asynchronous Shipment with Rules request object model
weight-units
string
ShipmentBlobOrder
object
40 properties 27 required
ParcelItems
object
12 properties 3 required
ShipmentBlobOrderCreate
object
33 properties 25 required
CustomsInformation
objectnull
Customs information related to this shipment
5 properties
ShipmentErrorLog
object
4 properties
CostsObject
object
2 properties
ShipmentCreateUpdateLog
object
4 properties
country-codes
string
A country represented by its ISO 3166-1 alpha-2 code
ShipmentBlobStatus
objectnull
2 properties 2 required
CheckoutPayload
object
4 properties 3 required
TaxNumber_2
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendcloud-shipments-api-openapi.yml Raw ↑

Other APIs Sendcloud publishes across the network.

Sendcloud Address API
AE Profile APIs.io
Sendcloud Analytics API
AE Profile APIs.io
Sendcloud Broadcast API
AE Profile APIs.io
Sendcloud Connections API
AE Profile APIs.io
Sendcloud Customs Documents Download API
AE Profile APIs.io
Sendcloud Exception logs API
AE Profile APIs.io
Sendcloud Integrations API
AE Profile APIs.io
Sendcloud Label Download API
AE Profile APIs.io
Sendcloud Labels API
AE Profile APIs.io
Sendcloud OAuth2 API
AE Profile APIs.io
Sendcloud Orders API
AE Profile APIs.io
Sendcloud Parcel Documents API
AE Profile APIs.io
#Shipments
← Back to S APIs
API Details
ID
sendcloud:sendcloud-shipments-api
Base URL
https://panel.sendcloud.sc/api/v3
Docs
https://sendcloud.dev/api/v3/shipments/
Provider
Sendcloud
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=sendcloud-shipments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/sendcloud-shipments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Sendcloud Shipments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.