What it does. Notifies you about a customer return (RMA) — its status, the returned items, and the return shipment details.
When it is sent. When an RMA is created, a track is added, or its status changes.
Version. Recommended (V2).
Headers
-
Version of the webhook.
-
The API-key is a shared secret that can be used to authenticate the incoming request.
Body
-
Current status of the return (RMA).
Values are
pending,authorized,partially_authorized,received,received_on_item,approved,approved_on_item,rejected,rejected_on_item,denied,closed, orprocessed_closed. -
Winkelstraat RMA (return) increment ID.
-
The data received only has a date-time value if we have registered a delivery at the merchant.
-
Date/time the return was requested.
-
Carrier tracking number.
-
Code of the shipping carrier (e.g.
ups,dhlparcel,tig_postnl). -
Public carrier tracking URL for the return shipment.
-
The items included in this shipment or return.
-
Summary of the order this record belongs to.
-
The shipment this return relates to.
Responses
-
Delivered. Return any 2xx status to acknowledge receipt; the response body may be empty or contain anything, as Winkelstraat does not read it. Any 2xx response is treated as a successful delivery and the webhook is not retried.
No response body is expected; Winkelstraat does not read it. Returning a 2xx with an empty body is sufficient.
-
Accepted for asynchronous processing. Treated the same as 200 — the webhook is not retried.
-
Not accepted. Any non-2xx response — or a connection/timeout failure — is treated as a failed delivery, and the webhook is retried several times over the next 24 hours.
# Headers
x-version: V2
x-api-key: string
# Payload
{
"status": "authorized",
"rma_id": "000000078",
"date_received": null,
"date_requested": "2024-02-01T11:44:03.000+00:00",
"track_number": "1Z97W1439114675551",
"carrier_code": "ups",
"track_url": "https://wwwapps.ups.com/WebTracking/processInputRequest?loc=nl_NL&tracknum=1Z97W1439114675551",
"items": [
{
"sku": "wsnl199-wsnl199-5c9de5ad4681ed3eb551e7ee",
"reference": "3G1MXE1MXVZF982",
"article_number": "3G1MXE1MXVZF982 L",
"manufacturer": "Emporio Armani",
"name": "t-shirts",
"size": "S",
"color": "Blauw",
"resolution": "Terugbetalen",
"reason": "Meer bezorgd dan besteld",
"price": 271,
"rma_item_id": "YEK"
}
],
"order": {
"date": "2024-01-26T21:45:30.000+00:00",
"order_id": "000000549",
"address": {
"name": "Jan Jansen",
"street": "Edsger Dijkstraat",
"housenumber": "12",
"postcode": "9012DE",
"city": "Zonnewijk",
"province": null,
"country": "NL",
"email": "jan.jansen@gwinkelstraat.nl"
}
},
"shipment": {
"shipment_id": "000000284",
"shipment_token": "0:3:CS70ed/6GtDiRsvfuF2Q/5iArqmSr7mYy832e5xZTQ=="
}
}
{}