API: Refund Order
POST /api/marketplace/v2/orders/{kogan_order_ref}/refund/
Marks the specified shipped items of the specified order as cancelled.
NOTE
When refunding an order, the customer will receive a refund for the item(s) amount + shipping (if any) and a notification containing the reason.
URL Parameters
Parameter | Required | Description |
|---|---|---|
kogan_order_ref | Yes | The Id of the order to refund |
Request Format
See below a list of the fields and description for the order’s cancellation
Parameter | Required | Description |
|---|---|---|
ID | Yes | Order Id |
Quantity | Yes | The number of units to refund. |
Reason | Yes | The reason the item is being refunded. |
SellerSku | Yes | The SKU of the ordered line item. |
Reasons
This is a list with all the refund reason allowed (refer to the field Reason)
- Change of Mind
- Dead Arrival
- Failed Cancel
- Listing Error
- Part Problem
- Return Sender
- Wrong Goods
- Faulty Item
- Damage In Transit
- Faulty Part
Request Body Example
{
"OrderID": "123456",
"Items": [
{
"ID": "0",
"SellerSku": "XX-Valyrian-steel-SWORD-1",
"Quantity": 1,
"Reason":"Dead Arrival"
},
{
"ID": "1",
"SellerSku": "XX-DRAGON-STONE",
"Quantity": 4,
"Reason": "Return Sender"
}
]
}Updated 20 days ago