Introduction¶

Welcome to the Order Events API (OEA) documentation. Receive all order notifications related to your account with OEA. OEA enables integration with your existing IT systems, providing visibility into order state changes which happen inside the Connected Retail Tool (CRT) and Zalando warehouses. 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?¶

When an order is fulfilled by a store¶

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.

Assigned event¶

Fulfilled event¶

Cancelled event¶

Returned 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.

For ZRS+ program partners items might also be returned to a Zalando warehouse, in which case OEA will also trigger a "returned" event, see below for more details. Such ZRS+ returns are not handled in the Store tool and are handled differently.

OEA, returns to and fulfillment by Zalando¶

By default when a customer returns items, the items will be returned to a store, however Zalando also might enable a separate return option "Zalando Return Solutions Plus" (ZRS+) when items will be returned to Zalando warehouses and Zalando will take care of handling the returned items.

For items returned to Zalando warehouses Zalando might also provide another service: "Zalando Fulfillment Solutions" (ZFS) when items returned to warehouses might be sold again.

Returned event¶

OEA will initiate "returned" event for items returned to Zalando warehouses from stores, this event will have return_location attribute with the value "ZALANDO" rather than "STORE".

Zalando warehouse fulfilled event¶

For items that after being returned are fulfilled from Zalando warehouses OEA will initiate a "zalando_warehouse_fulfilled" event.

Zalando warehouse returned event¶

Items of the ZFS fulfilled order can be returned to Zalando warehouses again and OEA will then initiate a “zalando_warehouse_returned” event. Items might be returned in batches and not necessarily all items might be returned in one batch.

Please, note that the order fulfilled by ZFS is different from the original order fulfilled by the store the items of which were returned to the Zalando warehouse. Moreover items from different store orders might be grouped together/split into new ZFS orders.