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

Sendcloud Ship an Order API

OrderLabelAPI

Sendcloud Ship an Order 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 Ship an Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 10 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

Requests are made against a single base URL, https://panel.sendcloud.sc/api/v3.

2 operations 2 paths 21 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Sendcloud Ship an Order 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 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Ship an Order 2

OrderLabelAPI

POST
/orders/create-labels-async
Request a label for one or more orders asynchronously
sc-public-v3-orders_labels-post-create_labels_async 1 param body → 202400404
POST
/orders/create-label-sync
Request a label for a single order synchronously
sc-public-v3-orders_labels-post-create_labels_sync 1 param body → 201400404

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are ErrorObject (8 properties), documents (4 properties), create-labels-base (4 properties), label-base (4 properties). Each schema is shown below with its type and property counts.

OrderSelectorOrderNumberRequired
object
3 properties 1 required
create-labels-async
object
Payload for creating labels for orders. Note that if the senderaddressid is not specified, the API will use the default [sender address](/docs/getting-started/…
str-dimensions
object
Dimensions in the specified unit
4 properties 4 required
label-base
object
4 properties
create-labels-base
object
4 properties 1 required
OrderItem
object
2 properties 2 required
parcel-common-with-optional-fields
object
Parcel common with optional fields model
2 properties
dimension-units
string
ErrorObject
object
Error in a JSON:API error format
8 properties
create-labels-parcels
object
Multicollo parcels array model used for splitting shipped object into multiple parcels
1 property
CreateLabelParcel
object
1 required
label-async
object
Holds the reference to created label.
create-labels-sync
object
Payload for creating labels for orders. Note that if the senderaddressid is not specified, the API will use the default [sender address](/docs/getting-started/…
OrderSelectorOrderIdRequired
object
3 properties 1 required
errors
object
A standardized format for errors in JSON:API responses.
1 property
label-sync
object
Holds the reference to created label.
str-weight
object
Weight in the specified unit
2 properties 2 required
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
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
documents
object
Documents object for a parcel
4 properties
weight-units
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendcloud-ship-an-order-api-openapi.yml Raw ↑

Other APIs Sendcloud publishes across the network.

Sendcloud Address API
Sendcloud Analytics API
Sendcloud Broadcast API
Sendcloud Connections API
Sendcloud Customs Documents Download API
Sendcloud Exception logs API
Sendcloud Integrations API
Sendcloud Label Download API
Sendcloud Labels API
Sendcloud OAuth2 API
Sendcloud Orders API
Sendcloud Parcel Documents API
Where this information came from

This is an independent, third-party profile of Sendcloud Ship an Order 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.