Skip to main content
GET
/
parcels
/
{id}
/
return_portal_url
Retrieve a return portal URL
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/parcels/{id}/return_portal_url \
  --header 'Authorization: Basic <encoded-value>'
{
  "url": "http://mybrand.returns-portal.com/initiate/"
}
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 URL which is retrieved will link directly to the parcel in the Sendcloud Return portal, so a return parcel can be created immediately based on the outgoing shipment. If no Return portal is configured, or if no brand is connected to the parcel, this endpoint will return an error response with a 404 status code.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

ID of the parcel

Response

OK

​
url
string
required
Minimum string length: 1