Create a Return Shipment

Create a new return shipment from an existing shipment.

Required authorization scope: public.shipment:write

In v2024-09, qr_code_with_label is deprecated and silently falls back to qr_code.
Use qr_code — it returns both the QR code and the original label for USPS shipments.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Easyship Shipment ID

Body Params
uuid

Address ID that will be loaded as destination address. The return address of the original shipment will be used when destination_address_id is not provided.

courier_settings
object
parcels
array of objects
parcels
shipping_settings
object
Responses

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json