Webhook/winkelstraat/push api/v2/rma

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://push-api.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Push API Sales MCP server": {
    "url": "https://push-api.doc.winkelstraat.nl/mcp"
  }
}

Close
POST https://webhook.example.com

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

  • 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 incoming request.

application/json

Body

  • status string Required

    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, or processed_closed.

  • rma_id string Required

    Winkelstraat RMA (return) increment ID.

  • 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) Required

    Date/time the return was requested.

  • track_number string | null

    Carrier tracking number.

  • carrier_code string | null

    Code of the shipping carrier (e.g. ups, dhlparcel, tig_postnl).

  • track_url string | null

    Public carrier tracking URL for the return shipment.

  • items array[object] Required

    The items included in this shipment or return.

    Hide items attributes Show items attributes object
    • sku string Required

      Marketplace SKU of the product.

    • reference string Required

      The reference value specifies the product reference given by a merchant.

    • article_number string Required

      The article number value specifies the manufacturer product number (MPN).

    • manufacturer string Required

      Brand / manufacturer name.

    • name string Required

      Product name.

    • size string Required

      Product size.

    • color string Required

      Product colour.

    • resolution string | null

      Resolution requested by the customer, as a human-readable label localized to the order (e.g. Terugbetalen). Possible values: Refund (Terugbetalen) or Exchange (Ruilen).

    • reason string | null

      Reason the customer gave for the return, as a human-readable label localized to the order (e.g. Meer bezorgd dan besteld). Possible reasons: Too big, Too small, Not as expected, Fabric not as expected, Damaged, Poor quality, Item faulty, Product description not accurate, Product photo not accurate, Ordered accidentally, Lower price available, Delivered too late, Missing accessories, More delivered than ordered, No longer needed, No reason.

    • price number(float) Required

      Unit price of the item including VAT, in the order currency.

    • rma_item_id string Required

      The rma_item_id is a unique identifier for an RMA item.

  • order object Required

    Summary of the order this record belongs to.

    Hide order attributes Show order attributes object
    • order_id string Required

      Winkelstraat order increment ID (e.g. 000000549).

    • date string(date-time) Required

      Order creation date/time.

    • address object Required

      Billing address of the order.

      Hide address attributes Show address attributes object
      • name string Required

        Full name of the recipient at this address.

      • street string Required

        Street name.

      • housenumber string Required

        House number, including any suffix (e.g. 12A).

      • postcode string Required

        Postal code.

      • city string Required

        City.

      • province string | null

        Province or region; null when not applicable.

      • country string Required

        Two-letter ISO 3166-1 alpha-2 country code (e.g. NL).

      • email string Required

        Customer e-mail address.

  • shipment object Required

    The shipment this return relates to.

    Hide shipment attributes Show shipment attributes object
    • shipment_id string Required

      Winkelstraat shipment increment ID (e.g. 000000284).

    • shipment_token string Required

      Opaque, signed token identifying the shipment; used in follow-up API calls.

Responses

  • 200 application/json

    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.

  • 202

    Accepted for asynchronous processing. Treated the same as 200 — the webhook is not retried.

  • 406

    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.

POST winkelstraat/push-api/v2/rma
Request examples
# 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=="
  }
}
Response examples (200)
{}