Skip to main content
POST
/
brand
/
{brand_domain}
/
return-portal
/
uploads
Create a file upload for the return portal
curl --request POST \
  --url https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portal/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form additionalProperties='@example-file'
[
  {
    "filename": "1dca5757ed2a47dd89ddc99ce308e6b4.webp",
    "name": "product-12345-abc",
    "path": "https://cdn.example.com/link/1dca5757ed2a47dd89ddc99ce308e6b4.webp"
  },
  {
    "filename": "ed013a200348477bb2c79fc27bb33dc8.webp",
    "name": "product-67891-cde",
    "path": "https://cdn.example.com/link/ed013a200348477bb2c79fc27bb33dc8.webp"
  }
]
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.
This endpoint allows users to upload media that may be used during the return creation purposes. The response from this endpoint contains filenames used to identify the files in later requests. Currently only images are supported. Note:
  • Files are only kept for 48 hours after upload, unless used somewhere else (for example, when creating a return).
  • The URLs returned in this response will only be available for 48 hours.
  • The endpoint allows a maximum of 10 files, so groups larger than that should be batched.
  • Files should be smaller than 10MB.
This API is currently in in beta, and may change in the near future.

Authorizations

​
Authorization
string
header
required

The JWT generated when starting the Return Portal process

Path Parameters

​
brand_domain
string
required

The brand domain, found in the brand or return portal settings

Body

multipart/form-data
​
{key}
file

The files to be uploaded, with a maximum file size of 10MB.

Response

Created

​
filename
string
required

An identifier for the file, used to reference the file in later requests.

​
name
string
required

The name sent when uploading the file.

​
path
string<uri>
required

A URL that can be used to view the uploaded file. Only valid for 48 hours.