Webhook/winkelstraat/push api/v1/rma item

POST https://webhook.example.com

The RMA item webhook performs a post in JSON format to a designated endpoint of the merchant. The events are send when items are received by the merchant or the RMA request is closed.

The use of this webhook has been deprecated. Please use a new webhook for the new version of the API. The new webhook is called winkelstraat/push-api/v2/rma-item.

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 Deprecated

  • rma_item object
    Hide rma_item attributes Show rma_item 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
    • qty_returned string | null

      The quantity returned only has a value when the items have been returned at the merchant.

    • retailer_resolution string | null

      The retailer resolution only has a value when a merchant as specified a resolution.

    • resolution string | null
    • condition string | null
    • reason string | null
    • price number(float)
    • uid string Deprecated

      The uid is deprecated, migrate to 'rma_item_id' instead

    • rma_item_id string

      The rma_item_id is a unique identifier for an RMA item.

    • updated_at string(date-time)
  • order object
    Hide order attributes Show order attributes object
    • order_id string
    • shipment_id string
    • date string(date-time)
    • discount number(float)
    • grand_total number(float)
    • shipping_address object
      Hide shipping_address attributes Show shipping_address attributes object
      • name string
      • street string
      • housenumber string
      • postcode string
      • city string
      • province string | null
      • country string
      • email string
    • main_order_id string Deprecated

      Use order_id instead

    • id string Deprecated

      Use shipment_id instead

  • rma object
    Hide rma attributes Show rma attributes object
    • id string Deprecated

      Use rma_id instead

    • 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
    • carrier_code string

Responses

  • 200

    Ok

  • 202

    Accepted

  • 406

    Not accepted

POST winkelstraat/push-api/v1/rma-item
Request example
{
  "rma": {
    "id": "000000078",
    "rma_id": "000000078",
    "carrier_code": "ups",
    "track_number": "1Z97W1439114675551",
    "date_received": null,
    "date_requested": "2024-02-01T11:44:03.000+00:00"
  },
  "order": {
    "id": "000000284",
    "date": "2024-01-26T21:45:30.000+00:00",
    "discount": 0,
    "order_id": "000000549",
    "grand_total": 271,
    "shipment_id": "000000284",
    "main_order_id": "000000549",
    "shipping_address": {
      "city": "Zonnewijk",
      "name": "Jan Jansen",
      "email": "jan.jansen@gwinkelstraat.nl",
      "street": "Edsger Dijkstraat",
      "country": "NL",
      "postcode": "9012DE",
      "province": null,
      "housenumber": "12"
    }
  },
  "rma_item": {
    "sku": "wsnl199-wsnl199-5c9de5ad4681ed3eb551e7ee",
    "uid": "0:3:jkkPWmdPM0Wb+6/gHWPWX1hIONZJw+t1XJEF5tRf",
    "name": "t-shirts",
    "size": "L",
    "color": "Blauw",
    "price": 271,
    "reason": "Meer bezorgd dan besteld",
    "condition": "",
    "reference": "3G1MXE1MXVZF982",
    "resolution": "Terugbetalen",
    "updated_at": "2024-02-08T22:07:46.236+00:00",
    "rma_item_id": "YEK",
    "manufacturer": "Emporio Armani",
    "qty_returned": null,
    "article_number": "3G1MXE1MXVZF982 L",
    "retailer_resolution": null
  }
}