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"
  ]
}
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.
Once a return parcel has been successfully created, a polling URL is included in the response. Creating a label depends on the response time of the carrier, so you need to make a request to this endpoint to see the status of the label. The URL you received contains a token with the id, so you don’t need to provide any additional lookup details or authentication.
  • A 200 response will indicate that the label is ready and can be downloaded.
  • A 202 response will indicate that the label is not ready to be downloaded but the return data has been accepted. If you have paid returns enabled this status is used to indicate we are waiting for payment. For more information take a look at this help center article.
  • A 500 response means that the label announcement failed.

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