Skip to main content
The Return portal API supports multicollo returns. This allows you to create a return shipment which contains multiple parcels, so long as the outgoing shipment was also multicollo.

​
How to create a multicollo return

The process for creating a multicollo return is the same as described in the Return portal documentation. The only difference is that you can state the number of collos to include in the return shipment.
  1. Use the identifier of any of the parcels (tracking number or order number) included in the original shipment with the Retrieve an outgoing parcel endpoint. This will always return the main parcel in the shipment, so don’t worry if the identifiers don’t match.
  2. In the parcel object in the response, you can find the number of parcels which were included in the original shipment under collo_count. You can choose to return, at most, a number of parcels equal to this number.
  3. When sending your request to the Create a return endpoint, add the number of parcels you want to include in the shipment under the collo_count field, in the incoming_parcel object.
Each parcel inside the multicollo return is treated as an individual shipment, and will receive its own tracking number.
Example request method and URL
POST https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portal/incoming
Example request body snippet
{
  "outgoing_parcel": 123, // ID of the original outgoing parcel
  "incoming_parcel": {
    "collo_count": 3
    // ... other incoming_parcel fields
  }
  // ... other fields
}