Webhook/winkelstraat/push api/v1/order item

POST https://webhook.example.com

The order-item webhook executes a POST in JSON format to a designated endpoint of the merchant. The order-item webhook event is send when key attributes of an order item change value. Currently, we only send these update events when items are items are refunded to a customer.

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

order object
Hide order attributes Show order attributes object
- order_id string
- id string Deprecated
  
  Use order_id instead
- main_order_id string Deprecated
  
  Use order_id instead
order_item object
Hide order_item attributes Show order_item attributes object
- sku string
- name string
- price number(float)
- updated_at string(date-time)
- 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
- size string
- color string
- item_id string Deprecated
  
  Use to order_item_id instead.
- uid string Deprecated
  
  Deprecate. Migrate to order_item_id instead.
- order_item_id string
update object

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
  
  Value is CREDITMEMO.
- id string Deprecated
  
  Use creditmemo_id instead
- creditmemo_id string
- status string
  
  Values are NONE, DEFICIENT, CANCELLED, or FUNDED_BY_PLATFORM.
- quantity integer
- creditmemo_item_id string

Responses

200

Ok
202

Accepted
406

Not accepted

POST winkelstraat/push-api/v1/order-item

Request example

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