Skip to main content
WEBHOOK
ReturnCreated
{
  "action": "return_created",
  "timestamp": 123,
  "data": {
    "id": 42,
    "brand_id": 123,
    "order_number": "<string>",
    "return_reason_id": 123,
    "return_address_id": 123,
    "paid_return": true,
    "delivery_choice": "<string>",
    "refund_type": "<string>",
    "items": [
      {
        "quantity": 123,
        "item_id": "<string>",
        "description": "<string>",
        "sku": "<string>",
        "hs_code": "<string>",
        "return_reason_id": 123
      }
    ]
  }
}
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.

Authorizations

​
Sendcloud-Signature
string
header
required

Body

application/json

Webhook data you will receive

The webhook payload when a return is created. This is emitted when a return is created either via the API or the Return Portal.

Creating a return manually via Return Form does NOT trigger the webhook.

​
action
enum<string>
required

Describes webhook action

Available options:
return_created
Example:

"return_created"

​
timestamp
number
required

Unix timestamp

​
data
object
required

Information about the return

Response

200

Return a 200 status to indicate that the data was processed successfully. The response body may contain the extended line item.