Skip to main content
POST
/
v1
/
channel
/
order
/
return
Return Announcement 
curl --request POST \
  --url https://scx-sbx.api.jtl-software.com/v1/channel/order/return \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sellerId": "4711",
  "orderId": "43523-43432-43532",
  "channelReturnId": "R12343",
  "orderItem": [
    {
      "orderItemId": "5437233",
      "quantity": "1.0",
      "returnReason": "NO_REASON",
      "note": "<string>"
    }
  ]
}
'
{
  "errorList": [
    {
      "code": "GEN500",
      "message": "Internal Server Error",
      "severity": "error",
      "hint": null
    }
  ]
}

Authorizations

​
Authorization
string
header
required

As a Channel Integrator you will receive a API Refresh Token. With such a Refresh Token you need to request an Access Token with a limited Lifetime (see POST /v1/auth). This Access Token must be provided as a Bearer Token in the Authorization Header with every request.

Body

application/json

Announcement of a return shipment that the customer is sending back for a marketplace order.

​
sellerId
string
required

A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process.

Pattern: ^\w{1,50}$
Example:

"4711"

​
orderId
string
required
Required string length: 1 - 150
Example:

"43523-43432-43532"

​
channelReturnId
string
required

Id used to identify an order return on Marketplace.

Example:

"R12343"

​
orderItem
object[]

Details about what will be to returned to Seller. If the orderItem list is empty as Seller must expect that the whole order is returned.

​
returnTracking
object

Optional information about return tracking.

Response

Return announcement received