Skip to main content
POST
/
v1
/
seller
/
order
/
return
Return
curl --request POST \
  --url https://scx-sbx.api.jtl-software.com/v1/seller/order/return \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "MYBESTDEALCOMDE",
  "sellerId": "4711",
  "orderId": "43523-43432-43532",
  "sellerReturnId": "123",
  "orderItem": [
    {
      "orderItemId": "5437233",
      "quantity": "1.0",
      "returnReason": "NO_REASON",
      "condition": "ORIGINAL_PACKAGING",
      "acceptReturn": true,
      "requireReturnShipping": true,
      "note": "<string>"
    }
  ],
  "channelReturnId": "R12343"
}
'
{
  "errorList": [
    {
      "code": "GEN404",
      "message": "Not found",
      "severity": "error",
      "hint": null
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer JWT issued to a seller after they sign up for a JTL-Scx subscription via the JTL Customer Center. Usage format: Bearer <JWT>.

Body

application/json

Notification that a return shipment has been received and inspected by the seller.

Seller notification that a return shipment has been received and inspected, scoped to a channel.

​
channel
string
required

This is the unique Channel name.

Pattern: ^\w{5,15}$
Example:

"MYBESTDEALCOMDE"

​
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"

​
sellerReturnId
string
required

Id used to identify an order return on Seller side.

Example:

"123"

​
orderItem
object[]
required
Minimum array length: 1
​
channelReturnId
string

Id used to identify an order return on Marketplace.

Example:

"R12343"

Response

Return information received