Skip to main content

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 Sendcloud Return portal is a convenient and easy to use feature which allows customers to create a return shipment for an order. The customer can enter both the tracking number for the original order and their postcode directly into the Return portal to perform an outgoing parcel lookup. Upon a successful lookup, they are prompted to select their return items and the reason for the return, select a refund or exchange method and choose how they want to make the return. The return parcel is then announced with the selected carrier, and a downloadable return label is provided to the customer.

​
What can you do with this API?

The Return portal API provides several endpoints which cover the entire return process:
  • Perform a lookup of your Return portal settings
  • Lookup an outgoing parcel and acquire JWT authentication tokens
  • Create a return parcel
  • Download the label for the return parcel

​
Getting started

Before you can begin using the Return portal API, you first need to have configured some settings related to the Return portal in your Sendcloud account.

Return portal setup

Read a step-by-step guide on how to set up your Return Portal in the Sendcloud help center.

​
Authentication

The Return portal API uses JWT authentication. Since this is a public facing API, the JWT token is generated upon a successful outgoing parcel lookup.
  1. Look up the original shipment via the Outgoing parcel lookup endpoint
  2. Two JWT authentication tokens will be provided - one for creating a new return parcel, and one for looking up service point locations
  3. In order to create the return parcel, include an Authorization header with a Bearer schema in your request and enter the access_token you obtained by performing the Outgoing parcel lookup.