Skip to content

Version

Current version: [1.0.9] - 19.08.2022

Backward compatibility

Breaking changes will be avoided in the API, however API can evolve in a backward compatible way in the future.

Examples of breaking changes which will be avoided

  • Renaming an attribute
  • Changing an attribute's type
  • Removing an attribute
  • Removing event type (for example, ‘zalando_warehouse_returned’)

Examples of backward compatible changes which might happen

  • Adding new event type with a new set of attributes
  • Adding new attributes to existing event types

The client systems consuming the API should be prepared for the listed backward compatible changes and handle adding new attributes and event types gracefully: a sensible implementation might be to ignore such additional attributes and event types and not be too strict about asserting which exact set of attributes is included into an event.

Filtering events

Filtering out certain event types is the responsibility of the client system which connects to Order Events API.

ChangeLog

  • [2.0.0] - 23.09.2024 - routed events have been replaced by a pair of canceled and assigned. routed events might still be produced for some existing older integrations.
  • [1.0.9] - 19.08.2022 - extended "state" attribute with new values "zalando_warehouse_fulfilled" and "zalando_warehouse_returned"
  • [1.0.8] - 11.07.2022 - added "cancelled_items" attribute in "fullfilled" events for cancelled items
  • [1.0.7] - 07.01.2022 - added "return_location" attribute in "item" object only for "returned" events
  • [1.0.6] - 27.10.2021 - added "cancellation_reason" attribute in "item" object only for "cancelled" events
  • [1.0.5] - 14.06.2021 - added "customer_billing_address" attribute for "fulfilled" and "returned" events
  • [1.0.4] - 11.02.2021 - fix "article_number" bug when it contained "zalando_article_number" rather than the value of the "article_number" column provided in the FCI feed, add a new "zalando_article_number" attribute
  • [1.0.3] - 04.01.2021 - added "Delivery failed" return reason for "returned" events as return code 10
  • [1.0.2] - 07.10.2020 - added "return_reason_code" attribute in "item" object for "returned" events
  • [1.0.1] - 05.10.2020 - added "delivery_details" attribute for "fulfilled" and "returned" events
  • [1.0.0] - 10.06.2020