Webhook/winkelstraat/push api/v2/rma

POST https://webhook.example.com

The RMA webhook performs a post in JSON format to a designated endpoint of the merchant. The events are send when an RMA is created, a track is added, or the status changes.

Headers

x-version string Required

Version of the webhook.
x-api-key string

The API-key is a shared secret that can be used to authenticate the incomming request.

application/json

Body

status string
rma_id string
date_received string | null

The data received only has a date-time value if we have registered a delivery at the merchant.
date_requested string(date-time)
track_number string | null
carrier_code string | null
track_url string | null
items array[object]
Hide items attributes Show items attributes object
- sku string
- reference string
  
  The reference value specifies the product reference given by a merchant.
- article_number string
  
  The article number value specifies the manufacturer product number (MPN).
- manufacturer string
- name string
- size string
- color string
- resolution string | null
- reason string | null
- price number(float)
- rma_item_id string
  
  The rma_item_id is a unique identifier for an RMA item.
order object

Additional properties are allowed.
Hide order attributes Show order attributes object
- order_id string
- date string(date-time)
- address object
  
  Additional properties are allowed.
  Hide address attributes Show address attributes object
  
  name string
  
  street string
  
  housenumber string
  
  postcode string
  
  city string
  
  province string | null
  
  country string
  
  email string
shipment object

Additional properties are allowed.
Hide shipment attributes Show shipment attributes object
- shipment_id string
- shipment_token string

Responses

200

Ok
202

Accepted
406

Not accepted

POST winkelstraat/push-api/v2/rma

Request example

{
  "items": [
    {
      "sku": "wsnl199-wsnl199-5c9de5ad4681ed3eb551e7ee",
      "name": "t-shirts",
      "size": "S",
      "color": "Blauw",
      "price": 271,
      "reason": "Meer bezorgd dan besteld",
      "reference": "3G1MXE1MXVZF982",
      "resolution": "Terugbetalen",
      "rma_item_id": "YEK",
      "manufacturer": "Emporio Armani",
      "article_number": "3G1MXE1MXVZF982 L"
    }
  ],
  "order": {
    "date": "2024-01-26T21:45:30.000+00:00",
    "address": {
      "city": "Zonnewijk",
      "name": "Jan Jansen",
      "email": "jan.jansen@gwinkelstraat.nl",
      "street": "Edsger Dijkstraat",
      "country": "NL",
      "postcode": "9012DE",
      "province": null,
      "housenumber": "12"
    },
    "order_id": "000000549"
  },
  "rma_id": "000000078",
  "status": "authorized",
  "shipment": {
    "shipment_id": "000000284",
    "shipment_token": "0:3:CS70ed/6GtDiRsvfuF2Q/5iArqmSr7mYy832e5xZTQ=="
  },
  "track_url": "https://wwwapps.ups.com/WebTracking/processInputRequest?loc=nl_NL&tracknum=1Z97W1439114675551",
  "carrier_code": "ups",
  "track_number": "1Z97W1439114675551",
  "date_received": null,
  "date_requested": "2024-02-01T11:44:03.000+00:00"
}