API (v1.1)

Versions

Like any other software, this API is always being updated and improved. Minor changes are implemented without impact your use of it. But, there are times when we need to push forward new features or protocols. When this happens, we use versioning to basically launch a new API, while supporting an old one.

Default Version

Current default version is: 1.1

There will always be a default version, which is assumed whenever you don't specify one. The default version maybe the latest or not - it all depends on our roadmap implementation. Nevertheless, we will notify you before changing the default version and we'll give enough time to migrate your code, if needed.

Specifying a version

You may specify which version you intend to use by including it on the enpoint url like so:

$ curl ... https://www.vendus.pt/ws/v1.3/account

API Versions

1.2 - 2018-07-31

• Products
  • New structure for params
  • Ability to update price groups for a product
  • Ability to manage stock per store and/or variant
• Stores
  • New structure for rooms and tables

1.1 - 2017-03-16

• Core
  • We now have edges, which are endpoints inside an endpoint, facilitating grouping and future developments
  • General documentation improvements
• Account
  • New endpoint that allows access to account configuration
  • New edge users that gives access to users list
• Clients
  • New param q - allows searching for a string
  • New action PATCH - allows client updates
• Documents
  • It's now possible to create a document of type RG
  • Param type now supports multiple types
  • New param tx_id - uniquely identifies a document creation
  • New param external_reference - identifies a document outside Vendus
  • New param invoices - for documents of type RG
  • New param q allows searching for a string
  • New egde types - Allows access to a list of document types
  • New egde paymentmethods - Replaces old endpoint payments
• Products
  • New param q - allows searching for a string
  • New egde brands - replaces old endpoint brands
  • New egde categories - replaces old endpoint categories
  • New egde units - replaces old endpoint units
• Registers
  • New edge movements - allows access to register's movements
• Taxes
  • New endpoint that allows access to a list of available taxes
  • New edge exemptions - allows access to a list of available tax exemptions
• Backwards compatibility breaks
  • Endpoint payments is now available at documents > paymentmethods
  • Endpoint brands is now available at products > brands
  • Endpoint categories is now available at products > categories
  • Endpoint units is now available at products > units

1.0 - 2016-07-01

0.9 - 2016-01-01

Deprecated Versions

While we try to maintain active all versions of our API, sometimes it is necessary to discontinue a version. When and if we feel that need, we will notify you in advance and with time.