Skip to main content
GET
/
shipments
/
{id}
/
return-portal-url
Retrieve a return portal URL
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/shipments/{id}/return-portal-url \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": {
    "url": "http://mybrand.returns-portal.com/initiate/"
  }
}
The URL which is retrieved will link directly to the shipment 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 shipment, 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 shipment

Response

OK

​
data
object
required