Webhook/winkelstraat/push api/v1/order 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 when key details of an order item change — currently, when an item is refunded to the customer (a credit memo).

When it is sent. When an order item is refunded to the customer.

Version. ⚠️ Deprecated. Use the V2 winkelstraat/push-api/v2/order-item webhook instead.

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 Deprecated

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).
- id string Deprecated
  
  Use order_id instead
- main_order_id string Deprecated
  
  Use order_id instead
order_item object Required

The order item this update relates to.
Hide order_item attributes Show order_item attributes object
- sku string Required
  
  Marketplace SKU of the product.
- name string Required
  
  Product name.
- price number(float) Required
  
  Unit price of the item including VAT, in the order currency.
- updated_at string(date-time) Required
  
  Date/time the record was last updated.
- reference string | null
  
  The reference value specifies the product reference given by a merchant.
- article_number string | null
  
  The article number value specifies the manufacturer product number (MPN).
- manufacturer string | null
  
  Brand / manufacturer name.
- size string Required
  
  Product size.
- color string Required
  
  Product colour.
- item_id string Deprecated
  
  Use to order_item_id instead.
- uid string Deprecated
  
  Deprecate. Migrate to order_item_id instead.
- order_item_id string Required
  
  Opaque identifier of the order item.
update object Required

The update describes the change relative to the order item. Currently, we have only specified a creditmemo item update.
Hide update attributes Show update attributes object
- order_type_event string Required
  
  Type of the order-item change. Currently always creditmemo (a refund).
  
  Value is creditmemo.
- id string Deprecated
  
  Use creditmemo_id instead
- creditmemo_id string Required
  
  Winkelstraat credit-memo increment ID.
- status string Required
  
  Status of the credit-memo item. Possible values: none (no special status), deficient, cancelled, funded_by_platform (the refund was funded by Winkelstraat).
  
  Values are none, deficient, cancelled, or funded_by_platform.
- quantity integer Required
  
  Number of units of this item.
- creditmemo_item_id string Required
  
  Opaque identifier of the credit-memo item.

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/v1/order-item

Request examples

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

# Payload
{
  "order": {
    "id": "000000549",
    "order_id": "000000549",
    "main_order_id": "000000549"
  },
  "order_item": {
    "sku": "wsnl199-wsnl199-5c9de5ad4681ed3eb551e7ee",
    "name": "t-shirt",
    "price": 271,
    "updated_at": "2024-02-12T08:40:35.000+00:00",
    "reference": "3G1MXE1MXVZF982",
    "article_number": "3G1MXE1MXVZF982 L",
    "manufacturer": "Emporio Armani",
    "size": "L",
    "color": "Blauw",
    "uid": "0:3:bIrcd5YMqzVb+W+utk+eR+4nSTDVc8hcb6pmLaAQKA==",
    "item_id": "r06",
    "order_item_id": "r06"
  },
  "update": {
    "order_type_event": "creditmemo",
    "id": "000000060",
    "status": "none",
    "quantity": 1,
    "creditmemo_item_id": "6xO="
  }
}

Response examples (200)

{}