Skip to main content
POST
/
brand
/
{brand_domain}
/
return-portal
/
incoming
Create a return
curl --request POST \
  --url https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portal/incoming \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": 0,
  "message": "string",
  "outgoing_parcel": 0,
  "service_point": {
    "id": 10875349
  },
  "refund": {
    "refund_type": {
      "code": "money"
    },
    "message": "string"
  },
  "delivery_option": "drop_off_point",
  "products": [
    {
      "product_id": "1234",
      "quantity": 1,
      "description": "golden pen",
      "value": 1,
      "return_reason": 1
    }
  ],
  "incoming_parcel": {
    "collo_count": 1,
    "from_address_1": "string",
    "from_address_2": "string",
    "from_city": "string",
    "from_company_name": "string",
    "from_country": "IT",
    "from_email": "string",
    "from_house_number": "string",
    "from_country_state": "IT-AN",
    "from_name": "string",
    "from_postal_code": "string",
    "from_telephone": "string"
  },
  "selected_functionalities": {
    "first_mile": "dropoff"
  },
  "selected_carrier_code": "string",
  "pickup_date": "string"
}
'
{
  "poller_url": "https://panel.sendcloud.sc/api/v2/brand/sendcloud-development/return-portal/label/polling?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MzQyMjA3MDgsImlkIjoxMTg1MDgyfQ.vSkcEU2wChq5Tq5_lGSRLtC03S4ZG_HgRk5JU7i3ZH4",
  "return": 1185082,
  "incoming_parcels": [
    133726727
  ],
  "payment_url": "https://mollie.com/paymen-url/pm_213123123"
}
The outgoing parcel and related data needed to make a request to this endpoint can be retrieved from the Retrieve an outgoing parcel endpoint. This endpoint also returns the JWT Token needed for authentication with this endpoint.

Authorizations

​
Authorization
string
header
required

The JWT generated when starting the Return Portal process

Path Parameters

​
brand_domain
string
required

The domain you defined in the brand settings.

Body

application/json

OK

​
reason
integer
required

The return reason identifier matching the ones provided from Sendcloud.

​
message
string
required

A message relating to the return.

​
outgoing_parcel
integer
required

The ID of the outgoing parcel for this return.

​
refund
object
required

Details about the refund the customer is requesting

​
delivery_option
enum<string>
required

The options the customer has for returning this parcel:

  • drop_off_point: At a drop-off point - Print at home
  • drop_off_labelless: At a drop-off point - No printer needed
  • in_store: Return in store
  • pickup: Arrange a pick-up
Available options:
drop_off_point,
in_store,
pickup
Minimum string length: 1
​
products
object[]
required

The products or items being returned

​
incoming_parcel
object
required
​
service_point
object

The service point that the customer has selected for returning the parcel

​
selected_functionalities
object

Shipping functionalities that need to be used for this return.

​
selected_carrier_code
string

The identifier of the carrier that needs to be used for this return. Available carriers are listed in the response from the /brand/{brand_domain}/return-portal/outgoing endpoint

Minimum string length: 1
​
pickup_date
string

The chosen date for the return parcel to be picked up

​
images
object[]

A list of images to attach to the return

Maximum array length: 10
​
customs_information
object

Optional customs information that should be provided for international returns. This information is used for generating customs documents.

Example:
{
  "customs_invoice_nr": "INV-123",
  "export_type": "private",
  "invoice_date": "2023-08-24",
  "discount_granted": "14.99",
  "freight_costs": "4.65",
  "insurance_costs": "3.60",
  "other_costs": "1.20",
  "general_notes": "Compliance: Goods comply with international safety standards (CE certified).",
  "additional_declaration_statements": [
    "With reference to the above shipment, I understate that the content is not made of leather parts of animal species protected by the Washington Convention.",
    "I solemnly declare that the contents of this document represent a true and accurate account of the events as they occurred. I acknowledge my responsibility for the information presented herein and understand that any misrepresentation or falsification may result in legal consequences or other penalties as applicable."
  ],
  "importer_of_record": {
    "name": "John Doe",
    "company_name": "ImporterCo",
    "address_1": "Maple Avenue",
    "house_number": "123",
    "postal_code": "90210",
    "city": "Springfield",
    "country_code": "US",
    "country_state": "US-MA",
    "telephone": "+15551234567",
    "email": "info@importer-of-record-example.com"
  },
  "tax_numbers": {
    "sender": [
      {
        "name": "VAT",
        "country_code": "NL",
        "value": "NL123456789B01"
      },
      {
        "name": "EORI",
        "country_code": "NL",
        "value": "NL123456789"
      }
    ],
    "receiver": [
      {
        "name": "EIN",
        "country_code": "US",
        "value": "123456789"
      }
    ],
    "importer_of_record": [
      {
        "name": "EIN",
        "country_code": "US",
        "value": "987654321"
      }
    ]
  },
  "return_data": {
    "return_postal_code": "1111 AA",
    "outbound_tracking_number": "JT1234567890",
    "outbound_shipment_date": "2023-08-14",
    "outbound_carrier_name": "UPS"
  }
}

Response

OK

​
poller_url
string
required
Minimum string length: 1
​
return
integer
required
​
incoming_parcels
integer[]
required
​
payment_url
string

The payment URL will be available when paid returns is enabled and a payment provider is connected. For more info on how it works please take a look at at our help center article.