Introduction¶

Welcome to the Order Events API (OEA) documentation. Receive all order notifications related to your account with OEA. OEA provides visibility into order state changes which happen inside the Connected Retail Tool (CRT) and enables integration with your existing IT systems. Visibility is provided by means of issuing events to which an IT systems can subscribe. You acknowledge the notification and then apply your business logic. Read here about the suggested best practices with OEA.

How OEA works?¶

A Customer places an order on the Zalando website. OEA initiates an “assigned” event as soon as the order is made visible to the store via Connected Retail Tool (CRT). Each order contains items which stores might pick or cancel. When items are picked, packed and completed in the tool then OEA initiates a “fulfilled” event. Please note that fulfilled is triggered when the store personnel clicks on the complete button in the tool. If all the items are unavailable, the store cancels the order which initiates the “cancelled” event.

Items of the fulfilled order can be returned by the customer. When the store personnel processes a return and clicks on confirm return in tool then OEA initiates the “returned” event. Items might be returned in batches and not necessarily all items might be returned in one batch.

Connected Retail offers a feature called routing. Routing allows another store in your network to fulfil an order if it is cancelled by the store. A cancelled order will be routed to another store in your account if the store has stock for all the items in the order. Hence, orders are not split during routing. They are routed as a whole. There is no limit to how many stores an order can be routed to as long as there are stores which have the stock to fulfill the order, if a store cancels the order the same order will no longer be routed to this store again. When a cancelled order is routed to another store then OEA initiates a “routed” event.