Webhook/winkelstraat/push api/v2/rma item

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

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

POST https://webhook.example.com

What it does. Notifies you about the state of an individual returned item within a return.

When it is sent. When items are received by the merchant or the return (RMA) is closed.

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

rma_item object Required

The RMA item this update relates to.
Hide rma_item attributes Show rma_item 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.
- qty_returned string | null
  
  The quantity returned only has a value when the items have been returned at the merchant.
- retailer_resolution string | null
  
  Resolution decided by the merchant, as a human-readable label localized to the order. Only set once the merchant has decided. Possible values: No refund (Niet terugbetalen), Refund (Terugbetalen) or Exchange (Ruilen).
- 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).
- condition string | null
  
  Condition of the returned item as assessed by the merchant, as a human-readable label localized to the order. Possible values: Unworn, Worn, Damaged, Counterfeit, Wrong item, Missing.
- 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.
- updated_at string(date-time) Required
  
  Date/time the record was last updated.
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).
- shipment_id string Required
  
  Winkelstraat shipment increment ID (e.g. 000000284).
- date string(date-time) Required
  
  Order creation date/time.
- shipping_address object Required
  
  Shipping address of the order.
  Hide shipping_address attributes Show shipping_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.
rma object Required

The RMA this update relates to.
Hide rma attributes Show rma attributes object
- 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 Required
  
  Carrier tracking number.
- carrier_code string Required
  
  Code of the shipping carrier (e.g. ups, dhlparcel, tig_postnl).

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-item

Request examples

# Headers
x-version: V2
x-api-key: string

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

Response examples (200)

{}