Release Notes

Current Version

Version: 2.6.7

2.6.7 Improvements

Publication Date: Sep 09, 2021

  • Update stock api

2.6.6 Improvements

Publication Date: Sep 08, 2021

  • Update to stock and offers api

2.6.5 Improvements

Publication Date: Sep 1, 2021

  • Update price validation rules
  • Update mStock rate limiting docs

2.6.4 Improvements

Publication Date: Aug 25, 2021

  • Add price currency code table
  • Add collapsable JSON
  • Add more context to stock location ID field

2.6.3 Improvements

Publication Date: Aug 19, 2021

  • Highlight the 403 "Access Forbidden"
  • Add new step in switching Sandbox
  • Add 429 Too Many Requests in Developer Docs API Spec
  • Warning update and portal specify
  • Restructure offers docs
  • Update glossary.md

2.6.2 Improvements

Publication Date: Jul 28, 2021

  • Update Ratelimits for Stock APIs.

2.6.1 Improvements

Publication Date: Jul 28, 2021

  • Enhance price update API documentation.
  • Remove references of Offers APIs.

2.6.0 Improvements

Publication Date: Jul 14, 2021

  • Deprecate Refresh Token from Authentication API.
  • Remove manual refund details from Orders API.
  • Add references to the deprecated Offers API.
  • Fix broken link in Glossary.

2.5.9 Improvements

Publication Date: Jul 7, 2021

  • Fix link

2.5.8 Improvements

Publication Date: Jul 1, 2021

  • Update information on duplicated price updates.
  • Add information on stock APIs.

2.5.7 Improvements

Publication Date: Jun 24, 2021

  • Explanation about the relationship between sales order and fulfillment order

2.5.6 Improvements

Publication Date: Jun 16, 2021

  • Update orders manual refund description

2.5.5 Improvements

Publication Date: Jun 9, 2021

  • Fix order with pending updates

2.5.4 Improvements

Publication Date: May 19, 2021

  • Add new markets to sales channel docs
  • Update zfs icm documentation

2.5.3 Improvements

Publication Date: May 6, 2021

  • Orders Shipment Address explanation
  • Orders possible locales

2.5.2 Improvements

Publication Date: April 28, 2021

  • Copyright update
  • Order tracking update - Added warnings
  • User management user interface and add user flow update

2.5.1 Improvements

Publication Date: April 14, 2021

  • Provide truncated exponential back-off as best-practices on handling errors
  • Provide best practices with steps for the order export process

2.5.0 Improvements

Publication Date: March 31, 2021

  • httpie link changes
  • Product onboard warning and formatting changes
  • Update rate-limit documentation for Orders API

2.4.9 Improvements

Publication Date: March 17, 2021

  • Fix conflict

2.4.8 Improvements

Publication Date: March 17, 2021

  • Change link to httpie
  • Render warnings correctly

2.4.7 Improvements

Publication Date: March 17, 2021

  • Add Notice for Access Token Only Migration

2.4.6 Improvements

Publication Date: March 10, 2021

  • Update orders documentation regarding stock location.
  • Update on Price Reporting API.

2.4.5 Improvements

Publication Date: March 3, 2021

  • Update order export documentation
  • Update order API documentation for temporal filters
  • Include rate limit information for Price Reporting API

2.4.4 Improvements

Publication Date: February 24, 2021

  • Add return reason in order line attributes
  • Improve refund price field description
  • Remove documentation about not yet released Stocks API

2.4.3 Improvements

Publication Date: February 17, 2021

  • Update Product Attributes API.
  • Design improvements on Contact Support button.

2.4.1 Improvements

Publication Date: February 11, 2021

  • Update Price Reporting APIs.

2.4.0 Improvements

Publication Date: February 10, 2021

  • Update Price Reporting APIs.
  • Update ZFS APIs regarding scopes and rate-limits.

2.3.9 Improvements

Publication Date: February 3, 2021

  • Update on time format for Price Reporting APIs.
  • Overall update to have consistent naming and branding by renaming "Merchant Platform" to "zDirect Platform".

2.3.8 Improvements

Publication Date: January 28, 2021

  • Update on zDirect FAQ.

2.3.7 Improvements

Publication Date: January 27, 2021

  • Add clarification on Products APIs.
  • Fix hyperlink to Application Management.

2.3.6 Improvements

Publication Date: December 13, 2020

  • Update zDirect Portal Overview.
  • Update zDirect Portal Technical Integration.
  • Add Information about User Management.
  • Add zDirect FAQ section.
  • Update Offers API rate limit.
  • Improvements on Orders Overview.

2.3.5 Improvements

Publication Date: December 23, 2020

  • Fix hyperlink in Products API.
  • Update Rate-limits for Orders API.
  • Update on field validation for Orders API.

2.3.4 Improvements

Publication Date: December 17, 2020

  • Update Price Reporting API rate limits quotas

2.3.3 Improvements

Publication Date: December 2, 2020

  • Add information about price retention time.

2.3.2 Improvements

Publication Date: November 18, 2020

  • Add page_size to the price reporting API
  • Rephrase product submission problem description and price update reports.
  • Add page_size to the price reporting API

2.3.1 Improvements

Publication Date: November 6, 2020

  • Add movement_type to the ICM API Response
  • Negative quantities when the movement type is "Customer Order Relocation Corrections"
  • Adds entries to Order API to warn API users about data retention

2.3.0 Improvements

Publication Date: October 28, 2020

  • Product Status Report API is out of beta phase and now generally available to all partners
  • Increase Rate Limits for Offers API and Products Attributes API to 1000 req/sec
  • Add missing live attribute in Sales Channel API response specification

2.2.5 Improvements

Publication Date: October 20, 2020

  • Products API guide, improve image hosting documentation
  • Add Shipping Notice Q&A session

2.2.4 Improvements

Publication Date: October 13, 2020

  • introducing customer account deletion API
  • update on FAQ
  • update on ZFS APIs

2.2.2 Improvements

Publication Date: September 22, 2020

  • update api overview for mStock
  • replace footprint of developer portal with zdirect
  • renamed items to order_items and transitions to order_transitions
  • fix wrong price update value

2.2.1 Improvements

Publication Date: September 9, 2020

  • Fix indentation problem on pricing reporting Open API spec

2.2.0 Improvements

Publication Date: September 4, 2020

  • Update for Orders processing flow:

    1. Add return reason code and description accepted by the orders API
    2. Add supported locale values
    3. Update the address type enum with correct values
    4. Add note on the difference between price and discounted_price for the ordered item
  • Update for Price Reporting & Stocks APIs:

    1. The Price Reporting API was missing the message severities. They are now being properly propagated to the response.
    2. The Stocks API is being used by merchants who are not part of our pool of pilots, which causes them to submit stock updates for stock locations, despite having no stock locations created for them. Added a warning in the top to point out that this API is only for chosen pilots & a link to the regular stock API which is to be used until we push for the rollout of the new stock API
  • Add warnings for PSR API to help the partner to understand why certain products will not show up in the response

2.1.10 Improvements

Publication Date: August 20, 2020

  • General Adjustments
  • Update Price Reporting API

2.1.9 Improvements

Publication Date: August 12, 2020

  • Update in Products API
  • Update in Shipping Notice API
  • Update in Price and Stock Pages

2.1.8 Improvements

Publication Date: August 10, 2020

  • Update in Price Reporting API

2.1.7 Improvements

Publication Date: July 24, 2020

  • Update in Price Reporting API

2.1.6 Improvements

Publication Date: July 22, 2020

  • Add recommendation in Product Asscociation API

2.1.4 Improvements

Publication Date: July 14, 2020

  • Fix typo in Product Status Report API

2.1.3 Improvements

Publication Date: July 10, 2020

  • Updated documentation to make return tracking number mandatory
  • Update Price Update Docs for Scheduling + Ignore Warnings
  • Add missing value in the POST request for token endpoint

2.1.2 Improvements

Publication Date: June 25, 2020

  • Minor updates on boarding new products documentation

2.1.1 Improvements

Publication Date: June 12, 2020

  • Minor updates to zfs-tracking-inventory documentation
  • Update order processing documentation
  • Update mPrice and mStock API Specs

2.1.0 Improvements

Publication Date: June 5, 2020

  • Add new Stock API endpoints (currently available just for for articles in the German sales channel)
  • Remove Articles API get stock endpoint
  • Document PSR API pagination behavior
  • Update Products API required fields

2.0.4 Improvements

Publication Date: May 13, 2020

  • Update Product Status Report API
  • Update Product Status Report API Tutorials

2.0.3 Improvements

Publication Date: April 27, 2020

  • Update some API deifnitions

2.0.2 Improvements

Publication Date: April 17, 2020

  • Session Limits for Tokens
  • Issuing Access Tokens without Refresh Tokens

2.0.1 Improvements

Publication Date: April 7, 2020

  • Revise Glossary.
  • Add info on non-EU currency to Updating Prices.
  • Add offerability definitions to ZFS Inventory Tracking.
  • Remove get CSV operation from PSR API guide.

2.0.0 Improvements

This version includes the final revisions to a complete reorganization and refactor of the zDirect Developer Documentation. Major changes include:

  • Rewrite Developer Guide content for all ZFS APIs, including:
    • Item Quantities API
    • Shipping Notices API
    • Stock Movements API
  • Add API Reference pages for all ZFS APIs.
  • Add Sales Channels API to Developer Guide and API Reference.

1.10.13 Improvements

  • Minor corrections.

1.10.12 Improvements

  • Add ICT partner instructions to Orders in Developer Guide.

1.10.11 Improvements

  • Minor corrections and updates.

1.10.10 Improvements

  • Rewrite guide to Orders and Updating Stock
  • Add API Reference pages for Orders API and Stock API
  • Add new examples to PSR API Overview.

1.10.9 Improvements

  • Minor corrections.

1.10.8 Improvements

  • Add /tours endpoint to Shipping Notices API Reference.

1.10.7 Improvements

  • Add Product Status Report API to Developer Guide and API Reference.

1.10.6 Improvements

  • Fix styling issue.

1.10.5 Improvements

  • Fix version history

1.10.4 Improvements

  • Rewrite guide to products and product onboarding.
  • Add Products Onboarding Cheatsheet
  • Rewrite Prices API developer guide.
  • Add standardized Overview pages to API Reference with information on scopes, sandbox, and rate limiting.

1.10.3 Improvements

  • Add Multi-Factor Authentication to zDirect Portal guide.

1.10.2 Improvements

  • Update URL for zDirect.

1.10.1 Improvements

  • Explain how to submit images for new products

1.10.0 Improvements

  • Reorganized docs into three main sections: GSG, Developer Guide, API Reference (Swagger)
  • Added API Overview page to GSG
  • Added Stages of Integration page to GSG
  • Combined sandbox content into single Sandbox Testing page
  • Separated Authentication content into two sections:
  • Quick Start Guide tutorial in the GSG
  • Authentication API section in the Developer Guide
  • Added intro pages to the Developer Guide and API Reference
  • Added zDirect Portal section to Developer Guide
  • Removed tutorial section and You Fulfill/We Fulfill

1.9.9 Improvements

  • Introduced mPrice Validation in Price API
  • Updated ZFS Inventory Service API
  • Updated ZFS Items Quantities API

1.9.8 Improvements

  • Add address type format changes

1.9.7 Improvements

  • Change used Sales Channel ID in documentation to Germany

1.9.6 Improvements

  • Add Support documentation

1.9.5 Improvements

  • Fix broken link in Offers - Updating Prices
  • Minor updates

1.9.4 Improvements

  • Add ratelimiting documentation for Orders API Endpoints
  • Add ratelimiting documentation for Price Update API

Publication Date: November 20, 2019

1.9.3 Improvements

  • Enhancing FAQ

Publication Date: November 11, 2019

1.9.2 Improvements

  • Removing deprecated Products API Endpoints

1.9.1 Improvements

  • Introducing Validations on Price API

1.9.0 Improvements

  • Improvement on Products API

1.8.9 Improvements

  • Improvement on Products API
  • Introducing Rate limiting on Products API

1.8.8 Improvements

  • Improvement on Products API

1.8.7 Improvements

  • New Section under Authentication for using refresh token

1.8.6 Improvements

  • Price API Enhancement

1.8.5 Improvements

  • Fix Broken Links in Zalando Partner University Documentation

1.8.4 Improvements

  • Introducing Merchant Platform Technical Support form in Support section

1.8.3 Improvements

  • Price API Updates

1.8.2 Improvements

  • Price API Updates

1.8.1 Improvements

  • Improvement on Products API
  • Remove Team Curry Email

1.8.0 Improvements

  • Documentation site went public

1.7.4 Improvements

  • Improvement on rate limiting content

1.7.3 Improvements

  • Introducing Rate Limiting
  • Introducing Best Practices to avoid getting rate limited.

1.7.2 Improvements

  • Glossary cross links has been updated

1.7.1 Improvements

1.7 Improvements

1.6.6 Improvements

  • Authorization API:
    • Added Create App section. This is a new feature that developers can create and manage their apps by their own.
    • Updated "Obtain your Credentials"
    • Updated "Generate Access Token"
    • Updated "Use the Access Token"
    • Updated "Sandbox Mode"

1.6.5 Improvements

  • Orders API: add stock_location_id attribute when fetching an order

1.6.4 Improvements

  • Orders API: Removed the not used number_of_pages field from meta object. Made copyright the only required field.

1.6.3 Improvements

The Stock Movement service which is part of Zalando Fulfillment Solutions (ZFS) is now live.

The service offers a Rest API that makes ZFS business to business goods movement processes more transparent for partners. The API provides data for the following movements/use cases:

  • Inbound goods receive process
  • Outbound return process

1.6.2 Improvements

Update Products API specification: add possible errors for stock and price endpoints

1.6.1 Improvements

Finalized renaming Article to Product for Products API

1.6 Improvements

New look and feel for Technical documentation.

1.5 Improvements

We have achieved a significant jump in quality with this release by overhauling the structure to make it more convenient for partners to access information. First and foremost, there are now two different paths for using the Merchant Platform based on whether you are a non-ZFS partners or a ZFS partner. This is now reflected in the basic structure of the site, which you can see by looking at the navigation menu on the left. The "You Fulfill" section of this site covers the path that non-ZFS partners follow. The "We Fulfill" section of this site covers the path that ZFS partners follow.

In addition, the following improvements have been made:

  • The home page has been completely revised to reflect the structural changes, as well as to include more general information about the ZDI solution as a whole. The page itself has been renamed the Readme page to reflect the fact that developers are the primary audience for this site.
  • A short "Integration" chapter has been added to further explain ZDI as a whole, and specifically the integration process.
  • The "Welcome to You Fulfill" and "Welcome to We Fulfill" chapters have been added to further clarify the two distinct methods, or paths, for using ZDI. New pictures on these pages illustrate the APIs used in each method.

1.4 Improvements

Version 1.5 involved a major overhaul so version 1.4 was included in it.

1.3 Improvements

1.2 Improvements

The OpenAPI specifications have all been improved and updated to match the wording and other standards in the Guides. Some of the contextual and background information has been moved from the OpenAPI specifications into the Guides so that all of the essential information you need is in the Guides, and this is supported by the Reference information in the OpenAPI specifications.

1.1 Improvements

The following improvements have been made:

  • The Shipping Notices Guide has been signficantly enhanced and now describes the latest improvements to the Shipping Notices API.

  • The "Authentication" section has been revised and expanded with more detailed information and more specific examples.

  • All code samples have been made fully functional with the addition of backslashes at the end of each line, so you can now copy and paste the code into httpie, substitute in your Merchant Id and your Access Token, and then run the code. The formatting has also been improved.

  • The Glossary has been enhanced, in particular with new entries related to ZFS and the Shipping Notices API, such as colli, hanging goods, pallet, announced item set, dispatch item set and more.

  • Most chapters that describe API calls have been updated with more detailed information about response codes that you receive when you make API calls, in sections entitled Understanding Response Codes. While this information is available in the OpenAPI specification, we've highlighted the most important response codes in the API call chapters so that you need not always look in the OpenAPI specification.

1.0 Improvements

The Merchant Platform for Developers Documentation has been completely overhauled and improved with this 1.0 release:

  • Restructured the information to segment ZDI from ZFS.
  • Included enhanced coverage of ZDI and complete coverage of ZFS.
  • Standardized terminology and acronyms throughout with a brand new Glossary of Terms and Acronyms.
  • Divided the information up into Guides and References. Guides have step-by-step instructions and References have comprehensive information.
  • Segmented the information by service so key information is more readily available.
  • Created completely new introductory material describing the various solutions and the platform.
  • Developed a series of diagrams to illustrate the solutions, the platform, the API and its services.
  • Developed a series of architectural diagrams clearly showing the process steps, both programmatic and non-programmatic.
  • Introduced Quick Starts for advanced developers and as reminders of key concepts for everyone.
  • Introduced PDF printable versions of the Quick Starts so they can be printed and posted for easy access to key information.
  • Created endpoint diagrams to highlight key functionality of each service.
  • Standardized the use of Notes and Tips. Tips have information for more advanced developers.
  • Introduced the use of Caution callouts to clearly highlight actions that are detrimental.
  • Simplified and smoothed out some of the English. Fixed some minor typos and grammatical errors.
  • Presented code samples inline so a click is not required to see it.
  • Presented code samples with color-coding for easier reading. Also added line breaks for easier reading of different segments of the URLs.
  • Introduced Feedback buttons on every page to collect detailed information that can be used to enhance and improve the documentation over time.
  • Improved the colors and readability of some of the existing diagrams.
  • Restructured the presentation of API reference information to make it more easily accessible.

Copyright © 2021 by Zalando SE. All rights reserved. This material is proprietary and confidential. Do not duplicate, distribute or reproduce in any form without express written permission from Zalando SE.

Contact Support