Skip to main content
GET
/
brand
/
{brand_domain}
/
return-portal
/
label
/
polling
Retrieve the status of a return
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portal/label/polling \
  --header 'Authorization: Bearer <token>'
{
  "download_url": "https://panel.sendcloud.sc/api/v2/brand/my-brand/return-portal/label/download?token=xxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxx",
  "return": 123456,
  "parcels": [
    7654321
  ],
  "tracking_numbers": [
    "3SYZXG123456789"
  ]
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

The JWT generated when starting the Return Portal process

Path Parameters

​
brand_domain
string
required

The domain of the brand configured for your return portal.

Query Parameters

​
token
string

Polling token, used to find the return

Response

OK

​
download_url
string<uri>
required

A URL pointing to the downloadable label

​
return
integer
required

ID of the created return

​
parcels
integer[]
required

ID(s) of the created parcels of the return

​
tracking_numbers
string[]
required

Tracking number(s) of the created parcels

​
customs_declaration_url
string<uri>

If available the customs-declaration can be downloaded here