Skip to main content
POST
/
v1
/
seller
/
order
/
refund
Send Refund
curl --request POST \
  --url https://scx-sbx.api.jtl-software.com/v1/seller/order/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "MYBESTDEALCOMDE",
  "refundId": "<string>",
  "sellerId": "4711",
  "orderId": "43523-43432-43532",
  "orderItem": [
    {
      "orderItemId": "5437233",
      "quantity": "1.0",
      "reason": "NO_REASON",
      "refund": "19.90",
      "refundCurrency": "EUR"
    }
  ]
}
'
{
  "errorList": [
    {
      "code": "VAL100",
      "message": "Required field sellerId not found",
      "severity": "error",
      "hint": "Check the field `sellerId` — it must be a non-empty string."
    }
  ]
}

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

Refund payment to be issued to the customer for a marketplace order.

Refund payment the seller wants to issue to the customer for a marketplace order, scoped to a channel.

​
channel
string
required

This is the unique Channel name.

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

"MYBESTDEALCOMDE"

​
refundId
string
required

Seller created unique Id to identify the processing Result of a Refund processing from a Channel.

Required string length: 1 - 128
​
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"

​
orderItem
OrderItemRefund · object[]
required
Minimum array length: 1

Response

Refund send to Channel