API Changelog

All notable changes to the Snabble API will be documented in this file.

This file will be updated weekly, if there are notable changes.

2023-05-11

• Make Product Object v2 the default response

2023-05-05

• ADDED priceEntryRequired to Product Object v2

2021-04-16

• ADDED isDiscountable to Product Object v2
• Clearified the usage of Price Modifiers in VPoS API

2021-03-29

• ADDED Specification for Discounts and Modifiers in VPoS API
• ADDED Specification for Coupons in VPoS API

2020-12-02

• Clearified the errors list in the VPoS API

2020-10-14

• ADDED links.receipt Documentation to Order
• ADDED FiscalReference to Order

2020-08-28

• ADDED isPrimary to Code Object v2
• ADDED specifiedQuantity to Code Object v2

2020-08-20

• ADDED maximal batch size of 20000 to Products Batch Import
• ADDED maximal batch size of 20000 to Batch Update Pricing
• ADDED maximal batch size of 20000 to Batch Update Prices

2020-07-29

• ADDED priorityto Pricing Category Object

2020-07-20

• ADDED notForSale to Product Object v2
• ADDED DELETE /{project}/pricing/products
• ADDED DELETE /{project}/pricing/products/sku/{sku}/category/{categoryID}

2020-07-17

• REMOVED documentation of Product Object v1 representation

2020-06-15

• REMOVED checkoutProcess property from order example

2020-03-18

• ADDED clientID and appUserID to cart, checkoutInfo and checkoutProcess

2020-03-05

• ADDED mode to createClosingSchedule

2020-01-23

• ADDED BASIC authentication scheme to the list of supported schemes for vPoS calls

2020-01-09

• ADDED externalShopId to vPoS data model

2019-12-10

• REMOVED closed field from CheckoutProcess and Close Request from Modify Checkout Process Endpoint

2019-12-04

• ADDED Closing and Create Closing Schedule endpoints

2019-09-09

• REMOVED GET /{project}/orders/statistics

2019-08-22

• REMOVED GET /{project}/products/code/{code}
• REMOVED GET /{project}/products/weighItemId/{code}
• REMOVED GET /{project}/products/search/bySkus
• REMOVED GET /{project}/products/bundlesForSku/{bundledSku}
• DEPRECATED Get order statistics: GET /{project}/orders/statistics

2019-07-30

• ADDED customer.loyaltyCard field to order
• ADDED session field to order

2019-07-25

• ADDED endpoint to delete all products of a project
• ADDED endpoint to delete a pricing
• ADDED batch endpoint for batch update pricings and clearified documentation

2019-05-29

• ADDED customerCardPrice to price and scanMessage to product v2 object

2019-02-04

• ADDED Support for units cl, m2e-1, dm2, m2e-3, dm, dag and hg in product API

2019-01-28

• ADDED Product Object v2 representation
• DEPRECATED Product Object v1 representation
• DEPRECATED GET /{project}/products/code/{code}
• DEPRECATED GET /{project}/products/weighItemId/{code}
• DEPRECATED GET /{project}/products/search/bySkus
• DEPRECATED GET /{project}/products/bundlesForSku/{bundledSku}

2019-01-10

• ADDED support for additional units

2018-12-07

• DEPRECATED eans field in products. It will be removed on February 1st 2019.
• REMOVED boost field in products

2018-11-20

• ADDED new PoS Integration API
• ADDED currency to Checkout Info and Order
• ADDED paymentResult to Checkout Process

2018-10-12

• ADDED new Pricing API

2018-10-11

• DEPRECATED boost field in products. It will be removed after December 1st, 2018.
• FIXED documentation of the default values in products. The now documented values conform to the behavior of the API.

2018-09-18

• ADDED priceOrigin to line items

2018-09-04

• ADDED code object to products
• ADDED clientID to orders in retailer portal

2018-07-23

• ADDED fsk sale restriction

2018-07-20

• ADDED barcodes to product detail view (retailer portal)
• CHANGED supervisor layout
• ADDED rescan to supervisor

2018-07-13

• ADDED customersInShop indicator to supervisor
• ADDED localization to supervisor

2018-07-06

Product

• ADDED bundledProduct to model product bundles

2018-06-25

Checkout

• ADDED transferred Payment State
• ADDED createdAt date to Checkout Info
• FIXED adding Line Items for deposits referenced by other Line Items

Products

• REMOVED Deprecated decimalDigits and currency in Product
• FIXED several bugs in the appdb creation, which could lead to missing products.

2018-06-11

Highlights:

• ADDED New Orders API
• ADDED support for arbitrary sku strings

Deprecation:

• DEPRECATED decimalDigits and currency in Product These will not be available anymore starting 22.06.2018

Orders

• New Orders API
• Show Orders in Retailer Portal

Products

• ADDED support for arbitrary sku strings
• ADDED controlIndication and forceControl to the product. These parameters are used to parametrization the control indication algorithm
• ADDED saleRestriction to the product
• ADDED saleStop to the product
• FIXED: The type of the sku property of the Result Message now matches the documented one (string).
• FIXED: send the status code 404 Not Found for a request to the appdb, if no products for the project are known.

Checkout

• ADDED support for scannable codes that encode the number of units and the price. For this the Line Item was extended with the field units and weight
• ADDED the scannedCode to the Line Item
• Refuse to create a Checkout Info from Carts that contain a product with a sale stop