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 Returns API

The Returns API from Sendcloud — 6 operation(s) for returns.

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

This API exposes 7 operations across 6 paths, and defines 32 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

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

7 operations 6 paths 32 schemas 2 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.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 Returns 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 7

Across 6 paths, the API surfaces 7 operations — 2 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Returns 7
POST
/addresses/validate
Validate an address
sc-public-v3-scp-post-validate_address 1 param body → 200400
POST
/returns
Create a return
sc-public-v3-scp-post-returns_create_new_return 1 param body → 201400
GET
/returns
Retrieve a list of returns
sc-public-v3-scp-get-returns_get_returns 5 params → 200
GET
/returns/{id}
Retrieve a return
sc-public-v3-scp-get-returns_get_details 1 param → 200404
PATCH
/returns/{id}/cancel
Request cancellation of a return
sc-public-v3-scp-patch-returns_cancel 2 params body → 202404409
POST
/returns/validate
Validate a return
sc-public-v3-scp-post-returns_validate 1 param body → 200400
POST
/returns/announce-synchronously
Create a return synchronously
sc-public-v3-scp-post-returns_create_new_return_synchronously 1 param body → 201400

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are carrier-shipping-functionalities (44 properties), Return (33 properties), parcel-item-returns-create (22 properties), dangerous-goods (19 properties). Each schema is shown below with its type and property counts.

address-with-required-fields
object
Sendcloud Address object
5 required
address-washer-request
object
Address Washer Request object model
3 properties 2 required
errors
array
A standardized format for errors in [JSON:API](https://jsonapi.org/format/error-objects) responses.
weight
object
Weight in the specified unit
2 properties 2 required
shipping-products-ref
object
Sendcloud shipping product code
1 property
Return
object
A Sendcloud return object
33 properties 9 required
Price
object
2 properties
ReturnValidation
object
A Sendcloud return validation object
15 properties 4 required
return-refund
object
Information about the compensation chosen by the customer for the returned items
2 properties
optional-price
required-price
Price, consisting of a value and currency.
address-validation-method-enum
string
price
object
Price in the specified currency
2 properties
parcel-item-returns-details
A single item in a shipment
address
object
Sendcloud Address object
12 properties
price-with-any-currency
object
Price in the specified currency
2 properties 2 required
dangerous-goods
object
Hazardous materials information for items.
19 properties
parcel-customs-information
objectnull
Optional customs information that should be provided for international parcels. This information is used for generating customs documents.
13 properties 2 required
return-reason
object
The reason this Return was created. This could be on the item level or the whole Return.
2 properties
ShipWith
object
Shipping specifications chosen for return
5 properties
detailed-tracking-blob-status
object
5 properties
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
DeliveryOption
stringnull
The options the customer has for returning this parcel: - dropoffpoint: At a drop-off point - Print at home - dropofflabelless: At a drop-off point - No printe…
errors_2
object
1 property
ErrorObject
object
Error in a JSON:API error format
8 properties
address-washer-response
object
Address Washer Response object model
2 properties
raw-address
object
Raw address object
8 properties
dimension-units
string
carrier-shipping-functionalities
object
Shipping functionalities
44 properties
dimension
object
Dimension in the specified unit
4 properties 4 required
parcel-item-returns-create
object
A single item in a shipment
22 properties
weight-units
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendcloud-returns-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 Returns 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.