Skip to content

Latest commit

 

History

History
156 lines (112 loc) · 5.51 KB

CHANGELOG.adoc

File metadata and controls

156 lines (112 loc) · 5.51 KB
Raw

Zettle API changelog

The changelog lists all changes that are made for APIs and API documentation.

Each log entry uses the following tags:

  • For API changes and the corresponding documentation changes, the log is tagged with the name of the changes API. For example, OAuth API.

  • For documentation changes that are editorial and are not introduced by any API change, the log is tagged with Editorial changes.

March 31, 2022 Finance API

Finance API V1 replaced by V2

A new version V2 of the Finance API is released, which replaces the former version V1. V1 is now deprecated but will remain available until 2022-12-31.

For information about how to migrate from V1 to V2 and changes between the versions, see Finance API migration guide.

February 24, 2022 Inventory API

Added support for read/write of low stock alert

  • Added configuration for low stock alerts. If the number of products available is less than the threshold level, the product is added to the low stock view.

  • API documentation updated accordingly.

February 3, 2022 Inventory API OAuth API Get started

Extended Inventory API documentation with these additions:

  • Overview of Inventory API.

  • Concept description - how inventories work.

  • User guides for managing locations, tracking, inventory balances, and low stock levels.

Added how to get started with Zettle APIs:

  • A user guide for signing up for a developer account.

  • User guides for setting up authorisation flows.

January 18, 2022 OAuth API Editorial changes

Replaced the deprecated endpoint users/me with users/self

The following updates were done for the deprecation:

  • The OAuth API endpoint users/me is deprecated and replaced by users/self.

  • Until users/me is removed, all API requests to it will be redirected to users/self.

  • The API documentation is updated to include users/self instead of users/me.

Note: The support for the deprecated users/me will continue until further notice. It is recommended to replace users/me with users/self in your integration as soon as possible.

November 24, 2021 Editorial changes

Improved documentation accessibility

The improvements include the following:

  • Improved image alternative text.

  • Improved link text.

  • Improved readability.

  • Changed some markups.

  • Removed directional words, such as above and below.

September 15, 2021 OAuth API

Password grant is deprecated

The Password grant OAuth flow has been deprecated and will be removed on 31st January 2022. Please update your Zettle integration to another authentication flow to keep it running. For information about how to update the authentication flow, see Zettle Password grant migration guide.

July 20, 2021 Finance API

Finance API documentation improvements

The improvements include the following:

  • Improved the API reference document.

  • Added a concept description about how payments work at Zettle.

  • Added user guides.

May 3, 2021 Pusher API

Pusher API documentation improvements

The improvements include the following:

  • Improved API reference document.

  • Added the list of currently supported events in the API reference document.

  • Added the user guides and troubleshooting documents.

October 28, 2020 Editorial changes

Applied a Beta label on any mention of API documentation

The current state of the API documentation leaves plenty of room for improvement.

To be transparent and set expectations right, we’ve applied a Beta label on any mention of the API documentation.

We are currently working to improve the Zettle Developer Platform, including the API documentation.

September 21, 2020 Finance API Purchase API Product library API Image API

Updated documentation for Finance, Purchase, Product Library, and Image APIs.

Finance API

  • Removed transaction type SUBSCRIPTION_CHARGE, since it was incorrectly added to the documentation.

  • Clarified that VOUCHER_ACTIVATION does not appear on the LIQUID account.

  • Marked the TELL_FRIEND transaction type as deprecated. This transaction type was removed in late 2018, but may show up in transactions prior to that.

Purchase API

  • Removed the CUSTOM payment type. This payment type does not exist anymore and has not been in use.

Product Library API

  • Updated the example request under the "Create product" section to reflect the new category and variantOptionDefinitions fields.

The category field replaces the old categories field. Now, a product may only have one category assigned to it. To create a new product category, provide a new version 1 UUID for the category.uuid field when creating or updating a product. For example:

{
    "category": {
        "uuid": "1ee20a82-fb8a-11ea-adc1-0242ac120002",
        "name": "New Category"
    }
}

  • The imageLookupKeys field has been deprecated in favour of presentation.imageUrl.

  • Added an example request under the "Update product" section.

  • Added descriptions about Product Categories.

Image API

  • Replaced usage of imageLookupKey with imageUrls. The imageLookupKey has been deprecated. Instead, the fully qualified URLs should be used.