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

The Integrations API from Sendcloud — 6 operation(s) for integrations.

Sendcloud Integrations 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 Integration. 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 6 paths, and defines 9 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.

12 operations 6 paths 9 schemas 1 DELETE6 GET1 PATCH3 POST1 PUT

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 Integrations 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 6 paths, the API surfaces 12 operations — 1 DELETE, 6 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Integrations 12
GET
/integrations
Retrieve a list of integrations
sc-public-v2-orders-get-retrieve_a_list_of_integrations 1 param → 200
GET
/integrations/{id}
Retrieve an integration
sc-public-v2-orders-get-retrieve_an_integration 1 param → 200404
PUT
/integrations/{id}
Update an integration
sc-public-v2-orders-put-update_an_integration 1 param body → 200400404
PATCH
/integrations/{id}
Partially update an integration
sc-public-v2-orders-patch-partial_update_an_integration 1 param body → 200400404
DELETE
/integrations/{id}
Delete an integration
sc-public-v2-orders-delete-delete_an_integration 1 param → 204404
GET
/integrations/logs
Retrieve all integration exception logs
sc-public-v2-orders-get-retrieve_integrations_logs → 200
GET
/integrations/{id}/logs
Retrieve exception logs for a specific integration
sc-public-v2-orders-get-retrieve_integration_logs 1 param → 200404
POST
/integrations/{id}/logs
Create integration exceptions logs
sc-public-v2-orders-post-create_integration_logs 1 param body → 201400404
GET
/shop-order-statuses
Retrieve shop order statuses for an integration
sc-public-v3-integrations-get-shop_order_statuses 3 params → 200400
POST
/shop-order-statuses
Create or overwrite shop order statuses
sc-public-v3-integrations-post-shop_order_statuses body → 200400
GET
/shop-order-statuses/mapping
Retrieve custom status mapping for an integration
sc-public-v3-integrations-get-shop_order_statuses_mapping 1 param → 200400
POST
/shop-order-statuses/mapping
Create or update custom status mapping for an integration
sc-public-v3-integrations-post-shop_order_statuses_mapping body → 200400

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are IntegrationLog (13 properties), Integration (11 properties), ErrorObject (8 properties), IntegrationUpdate (7 properties). Each schema is shown below with its type and property counts.

IntegrationUpdate
object
An updated integration response object
7 properties
errors
object
A standardized format for errors in JSON:API responses.
1 property
Integration
object
11 properties 3 required
IntegrationLog
object
13 properties 1 required
get-custom-status-mapping
object
Retrieve available shop order statuses mapped onto Sendcloud's internal status category for the given integration.
1 property
post-shop-order-statuses
object
POST request with shop order statuses with translations.
2 properties 2 required
get-shop-order-statuses
object
Available shop order statuses with translations.
1 property
create-custom-status-mapping
object
Create or update the mapping of available shop order statuses onto Sendcloud's internal status category.
2 properties 2 required
ErrorObject
object
Error in a JSON:API error format
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendcloud-integrations-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 Label Download API
Sendcloud Labels API
Sendcloud OAuth2 API
Sendcloud Orders API
Sendcloud Parcel Documents API
Sendcloud Parcel Tracking API
Where this information came from

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