Skip to main content
GET
/
integrations
/
{id}
Retrieve an integration
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/integrations/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": 123,
  "shop_name": "Integration #1",
  "shop_url": "https://example.com",
  "system": "api / amazon / magento",
  "failing_since": "2019-08-24T14:15:22Z",
  "last_fetch": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "service_point_enabled": true,
  "service_point_carriers": [
    "ups"
  ],
  "webhook_active": true,
  "webhook_url": "https://example.com"
}

Documentation Index

Fetch the complete documentation index at: https://sendcloud.dev/llms.txt

Use this file to discover all available pages before exploring further.

API v2 is entering maintenance mode. New users should start with API v3 to access our latest features and improved performance. Already using v2? Don’t worry, your current integration remains fully functional. Read more about maintenance mode, or check out the migration guide for API v3.
The information returned includes the shop name and URL, the date and the time of the last order fetch. The response will also indicate whether service point delivery is enabled for this integration, and for which carriers.

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Path Parameters

​
id
integer
required

The id of the integration

Response

OK

​
shop_name
string
required
read-only

Name of the shop

Required string length: 1 - 250
Example:

"Integration #1"

​
system
string
required
read-only

Type of shop/system the integration connects to

Required string length: 1 - 50
Example:

"api / amazon / magento"

​
last_updated_at
string<date-time>
required
read-only

Timestamp when the integration was last updated

​
id
integer
read-only

ID of an integration

Required range: x >= 1
Example:

123

​
shop_url
string<uri> | null

URL of the shop the integration connects to

Minimum string length: 1
​
failing_since
string<date-time> | null
read-only

Timestamp from when the integration is failing to fetch orders or to send feedback

​
last_fetch
string<date-time> | null
read-only

The last time we managed to fetch data from this integration, used for rate limiting purposes

​
service_point_enabled
boolean

Flag for denoting if delivery to service points is enabled

​
service_point_carriers
string[]
read-only

A list of carriers available for the service point picker

​
webhook_active
boolean

Flag indicating if updates for parcels should be send via the webhook

​
webhook_url
string<uri> | null

A URL to which Sendcloud communicates updates to a parcel

Minimum string length: 1