Release notes

Version 1.8.0

Customer API

IMPORTANT!
In this version the shop offers aka deals got an upgrade.
This upgrade doesn't change existing behavior.
If you're interested to learn more about this upgrade, please check the documentation.
If you have further questions, please contact api-support@localtomorrow.be

• global_discount_percentage has been added to shop
• invoice_cost_obsolete_price, invoice_cost_obsolete_price_enable added to checkout.cart_config struct
• note_from_customer added to checkout.cart_config struct
• shop offers have been upgraded (recurring, multiple active, ...)

Company API

• user_id has been added to order.consumer struct
• external_order_nr, shop_uses_external_order_nrs has been added to order struct
• code has been added to category struct
• shop offers aka deals endpoints have been added
• shop offers have been upgraded (recurring, multiple active, ...)

Version 1.7.0

Customer API

IMPORTANT!: please note that this version contains breaking changes for options and optionsets, you need to test your whole integration before switching to this version.

• multiple_choice, choose_amount, min_different_options, max_different_options, min_amount_options and max_amount_options are added to option sets
• amount has been added and is required for cart item options
• messages endpoints have been added for sending/receiving messages on an order.
• plu_code has been added to products
• soldout_until has been added to products

Company API

• multiple_choice, choose_amount, min_different_options, max_different_options, min_amount_options and max_amount_options are added to option sets. Please notify us if you implemented (/ want to implement) this change, since we've disabled this setting for some shops in their management UI.
• amount has been added for cart item options
• note_to_self has been added to orders
• warranty information has been added to orders
• tin_nr has been added to orders
• preparation_status has been added to orders
• invoice has been added to orders

Version 1.6.0

IMPORTANT!: please note that this version contains breaking changes regarding stock management (min_max in products), you need to test your whole integration before switching to this version.

Customer API

• price_calculation has been added to options
• allow_order_messages, category_overview and fold_category_groups has been added to shops
• image has been added to categories
• only_order_in_store has been added to products and categories (only used for shop owners)

Company API

• price_calculation option has been added to options. Now you can choose whether you need to apply the price change of an option per kg, per person, per item or per piece. Please notify us if you implemented (/ want to implement) this change, since we've disabled this setting for some shops in their management UI.
• allow_order_messages has been added to shops. Before this settings was part of allow_order_comments, but now it has been split up in to 2 separate settings. This setting defines whether the user can add extra comments/messages to an order after the order has been placed.

Version 1.5.2

Customer API

• New endpoint: Get a shop by url
• New endpoint: Get photos of a shop
• New endpoint: Get all shops of a platform
• status fields (open, takeout, delivery) added to shops
• has_specialties property for shops extended
• category_groups_overview and display_mode for detailed shops
• url property for all shops
• Added category property to all products for consumers
• joyn_enabled property for all shops
• end_time for takeout orders (required when takeout_use_intervals is enabled)

Company API

• Added soldout & stock.amount to products
• Added allow_order_comment & allow_product_comments to shop settings
• Added takeout_use_intervals to shop settings

Version 1.5.1

Customer API

• allow_invoices property for shops
• currency property for shops
• tin_nr property for users

Version 1.5.0

Customer API

It is no longer possible to upload before API v1.5.0.

• CartItem.options field added, this replaces the CartItem.option_ids and CartItem.uploads field and makes it possible to match options with uploaded files.
• CartItem.uploads has been made optional in all previous versions because it isn't supported any longer.
• allow_comments field moved to Shop.simple
• Added code to option sets and options. This property is used to associate options and option sets by third parties when they read orders.

Company API

• The way options are returned in orders is changed. You can now receive an upload for each option, and no longer for optionsets.
• Uploads property is removed from CartItem.company
• Added code to option sets and options. This property is optional when creating or editing options and option sets. You can now also read this property when fetching orders.
• We added UUID's to category groups. These UUID's should not be unique across shops, only within a shop. This allows you to keep the pictures of category groups when you want to change the category groups in a shop.

Version 1.4.0

Customer API

• Add CartItems to a Cart via the validate endpoint to prevent logic in the frontend
• Suggestions when using the validate endpoint to add items to the cart! 🥳
• Validating an empty cart will return a 400 status code
• Added allow_discount_codes field to the CartConfig struct
• Added offer field to Product.detailed
• Added ProductPrice.detailed (ProductPrice is now called ProductPrice.simple), which adds the offer field
• Removed items field from Offer
• Added amount_free to CartItem.order and CartItem.cart. This is the amount that the consumer gets for free (due to an offer) on top of the amount.
• Added type field to OfferItem, with value x-plus-y or percentage.
• Added image property to Option.simple and Option.detailed

Company API

Safe update from 1.3.0 without code changes

• price_look_up_code and code are not required anymore when creating products and product prices (but we always return them, even if null)
• price_look_up_code and code are returned in order CartItems

Version 1.3.0

Customer API

• Ability to filter shops (search & recent) and orders by company ID.

Company API

Review order fetching before upgrading from 1.2.0

• Requesting orders sorting is fixed (for all versions)
• future property when requesting orders
• Get printable HTML of an order
• before_id and after_id should be the id of a valid order (was not enforced in previous versions)

Version 1.2.0

• Price has been transformed into a structure so the currency is easier to access everywhere.
• The Shop opening, takeout, delivery hours structure has changed to allow opening hours per vending machine

Changed endpoints

• The output data is changed in the 'GET /company/shops/@id/orders' endpoint
• The data data is changed in the 'PATCH /company/orders/@id' endpoint
• The output data is changed in the 'PATCH /company/orders/@id' endpoint
• The output data is changed in the 'GET /shops/@id' endpoint
• The output data is changed in the 'GET /shops/recent' endpoint
• The output data is changed in the 'GET /company/@id/shops' endpoint
• The output data is changed in the 'GET /shops/@shop/products/search' endpoint
• The output data is changed in the 'GET /shops/@shop/products/@id' endpoint
• The output data is changed in the 'PATCH /shops/@shop/products/@id' endpoint
• The output data is changed in the 'GET /shops/@shop/specialties' endpoint
• The output data is changed in the 'GET /shops/@shop/offers/@offer/products' endpoint
• The output data is changed in the 'GET /shops/@shop/favourites' endpoint
• The output data is changed in the 'GET /shops/@shop/categories/@id' endpoint
• The output data is changed in the 'GET /orders/group/@id' endpoint
• The output data is changed in the 'GET /orders/@id' endpoint
• The output data is changed in the 'GET /orders' endpoint
• The output data is changed in the 'POST /orders/@id/exchange' endpoint
• The output data is changed in the 'POST /checkout' endpoint
• The output data is changed in the 'POST /checkout/order' endpoint

Version 1.1.0

Add functionalitities for the customer API to filter on a company in shops and orders (not yet in shop search).

Also added the 'credomatic' payment method.

List of changed endpoints (customer API only)

• The output data is changed in the 'GET /company/shops/@id/orders' endpoint
• The data data is changed in the 'PATCH /company/orders/@id' endpoint
• The output data is changed in the 'PATCH /company/orders/@id' endpoint
• The output data is changed in the 'GET /orders/group/@id' endpoint
• The output data is changed in the 'GET /orders/@id' endpoint
• The query data is changed in the 'GET /orders' endpoint
• The output data is changed in the 'GET /orders' endpoint
• The output data is changed in the 'POST /orders/@id/exchange' endpoint
• The data data is changed in the 'POST /checkout' endpoint
• The output data is changed in the 'POST /checkout' endpoint
• The data data is changed in the 'POST /checkout/order' endpoint
• The output data is changed in the 'POST /checkout/order' endpoint
• Endpoint GET /company/@id/shops has been added

Version 1.0.1

The payment method carte_bleue is renamed to cartes_bancaires.

Version 1.0.0 (timezones and currencies)

We bumped up our version to 1.0.0 to indicate that the API is now mature.

Company API

• We removed DateTime fields where possible and replaced them with the timezone safe unix timestamp
• To modify the currency or timezone of a shop, please use the website interface
• Added price_look_up_code and code to product prices
• Code of a product is nullable

Customer API

• We removed DateTime fields where possible and replaced them with the timezone safe unix timestamp.
• Pagination of orders has been improved and now matches the Company api
• Currencies have been added to Orders and Shops

List of changed endpoints

• The query data is changed in the 'GET /company/companies/@id/products' endpoint
• The output data is changed in the 'GET /company/companies/@id/products' endpoint
• The query data is changed in the 'GET /company/shops/@id/products' endpoint
• The output data is changed in the 'GET /company/shops/@id/products' endpoint
• The query data is changed in the 'GET /company/categories/@id/products' endpoint
• The output data is changed in the 'GET /company/categories/@id/products' endpoint
• The output data is changed in the 'GET /company/products/@id' endpoint
• The body data is changed in the 'POST /company/companies/@id/products' endpoint
• The output data is changed in the 'POST /company/companies/@id/products' endpoint
• The body data is changed in the 'PATCH /company/products/@id' endpoint
• The output data is changed in the 'PATCH /company/products/@id' endpoint
• The body data is changed in the 'POST /company/companies/@id/products/bulk' endpoint
• The output data is changed in the 'POST /company/companies/@id/products/bulk' endpoint
• The body data is changed in the 'PATCH /company/products/bulk' endpoint
• The output data is changed in the 'PATCH /company/products/bulk' endpoint
• The output data is changed in the 'GET /company/categories/@id' endpoint
• The output data is changed in the 'POST /company/companies/@id/categories' endpoint
• The output data is changed in the 'PATCH /company/categories/@id' endpoint
• The output data is changed in the 'GET /company/products/@id/prices' endpoint
• The output data is changed in the 'GET /company/prices/@id' endpoint
• The body data is changed in the 'POST /company/products/@id/prices' endpoint
• The output data is changed in the 'POST /company/products/@id/prices' endpoint
• The data data is changed in the 'PATCH /company/prices/@id' endpoint
• The output data is changed in the 'PATCH /company/prices/@id' endpoint
• The query data is changed in the 'GET /company/shops/@id/orders' endpoint
• The output data is changed in the 'GET /company/shops/@id/orders' endpoint
• The body data is changed in the 'PATCH /company/orders/@id' endpoint
• The output data is changed in the 'PATCH /company/orders/@id' endpoint
• The output data is changed in the 'GET /shops/@id' endpoint
• The output data is changed in the 'GET /shops/search' endpoint
• The output data is changed in the 'GET /shops/recent' endpoint
• The output data is changed in the 'GET /orders/group/@id' endpoint
• The output data is changed in the 'GET /orders/@id' endpoint
• The query data is changed in the 'GET /orders' endpoint
• The output data is changed in the 'GET /orders' endpoint
• The output data is changed in the 'POST /orders/@id/exchange' endpoint
• The output data is changed in the 'POST /checkout' endpoint
• The output data is changed in the 'POST /checkout/order' endpoint

Version 0.3.0

Company API:

• It is now possible to associate a list of shops when creating or updating a category. Categories can move between shops and can be shared between shops of the same company.
• Category groups can now be created when updating or creating a Shop.
• Added code field to Product, here you can store a custom ID that you might use in your own system to help you link the products in the webshop with your own.
• Products can now be ordered when updating a Category. The products will be shown in the order received in the products field.
• Products can now be created and updated in bulk via PATCH /company/products/bulk and POST /company/companies/@id/products/bulk
• Products can now move between categories (in existing PATCH endpoint, or in the new product patch bulk endpoint)
• The product create endpoint has changed to POST /company/companies/@id/products, and the category_id should be defined in the body now.
• Endpoint added to upload a product's image POST /company/products/@id/photo and to delete a product photo DELETE /company/products/@id/photo
• It is now possible to upload and delete a shop's avatar and banner POST/DELETE /company/shops/@id/avatar POST/DELETE /company/shops/@id/banner
• A category banner image can now be uploaded and deleted via POST /company/categories/@id/banner and DELETE /company/categories/@id/banner
• Updating an order status is now possible via PATCH /company/orders/@id
• You can request all the categories of a company (it already was possible to request all the categories of a shop)
• The Shop.detailed struct now includes the list of categories that are assigned to that shop
• Returns more information for orders in latches (vending machines) - OrderCheckout struct

Customer API:

• Returns more information for orders in latches (vending machines) - OrderCheckout struct

Version 0.2.2

Customer API:

• Added latch implementations

Version 0.2.1

Customer API:

• Added Joyn

Version 0.2.0

Company API:

• Added SEO metatags field to product

Version 0.1.5

Customer API:

• Payment methods don't support the success and failure url anymore. Now you only can pass one return URL. In return, you receive a payment status for every order.
• Orders now have a payment status to allow polling on payment status
• You can now force an exchange update (payment status update) for an order. Use this wisely.
• Invoice messages have been added to CartConfig

Version 0.1.4

We changed all the customer endpoints that return products to require a shop ID. This is needed to provide information in the products details that is related to the shop. We will use this information later on to also provide discount related information per product.

Warning : if you store or cache any product information, please always include the shop ID. Product ID is not unique anymore, the combination between product ID and shop ID is unique. If you reuse the same product ID from your database, but use it for a different shop, it will contain slightly different information.

• GET /products/@id -> GET /shops/@shop/products/@id
• PATCH /products/@id -> PATCH /shops/@shop/products/@id
• GET /categories/@id -> GET /shops/@shop/categories/@id
• The OrderCheckout struct now contains the notes field for the delivery method

Version 0.1.3

• optionsets property has been renamed to option_sets to be more consistent
• You can now set the option sets of a product by setting the option_set_ids property of a product
• You can now set the order of product prices by setting the order property of a product price
• You can now set the order of the options in an option set by setting the order property of an option

Version 0.1.2

• payment methods are now string enumeration values
• added endpoints to request orders of a shop and company (company api)

Version 0.1.1

• The X-VERSION header is now required.
• Version 0.1.0 has been removed.
• New endpoints to request favourites, specialties and offers
• Product endpoints now return the favourite property if authenticated (else nil)