Push API Sales Webhooks

2.1.0

Introduction

Winkelstraat.nl has created a set of webhooks, that developers can use to integrate with their e-commerce systems. These webhooks serve merchants to stay updated throughout the fulfilment journey. The webhooks provide real-time insights for:

• shipment creation,
• tracking label requests,
• RMA processing, and
• changes in order item statuses like refunds,

Activation

To activate the Winkelstraat.nl Sales Webhooks please send the URL of the endpoint(s) to partnersupport@winkelstraat.nl.

Security

To prevent unauthorised updates to the endpoints, we can add an additional x-api-key header. The value of this header acts as a shared secret between sender and receiver. The value can be any list of characters. To check the value’s validity must be checked by the receiving server.

Terminology

This document uses the following concepts:

• Order: An order represents a purchase request initiated by a user, comprising various order items with differing quantities. Throughout its entire life cycle, an order may transition through multiple statuses.
• Shipment: A shipment is a package that consolidates a selection of order items that have to be shipped together.
• Track: A (shipment) track is used to to monitor and tracing the movement of a shipment.
• RMA: An RMA or a return is a package that consolidates a selection of ordered items (RMA items) that need to be shipped from a customer to a merchant.
• RMA item: An RMA item specifies a.o. the reason for return, the desired resolution by a customer, and the merchant resolution.
• Credit memo: A credit memo is a correctional specification issued by a seller to a buyer to denote the amount returned.

Deliverability

Webhooks events are fired in real-time; when the system registers a change, the corresponding webhook event is triggered immediately after. If a webhook is not accepted by the receiving server (e.g., the HTTP response code is not successful or the delivery fails), the retry-mechanism tries to deliver the message several times during the next 24 hours.