Instant Update

Owned by Dana Negrescu
Last updated: Apr 19, 2021
2 min read

The Instant Update feature is part of a new data integration strategy, which is documented in https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/252280881.

The purpose is to instant update essential product information (ex: stock, availability, title, category, variants, etc).

The Instant Update can not be used to add new products to an existing data index.

Use a full or delta data index update in order to add new products.

Before continuing with the setup, decide at the project level which properties must be part of the Instant Update request. Product properties that are not updated frequently (ex: brand, description) should not be part of it, these will be part of the delta or daily full data sync.

Setup

  1. Add the plugin to your project via composer 

    1. composer require boxalino/data-integration-shopware6

  2. Activate the plugin (Shopware 6 default): 

    1. ./bin/console plugin:refresh 

    2. ./bin/console plugin:install --activate --clearCache BoxalinoDataIntegration

  3. Log in to your Shopware admin and configure the plugin with the configurations provided for your setup

    1. Shopware Admin >> Settings >> System >> Plugins >> Boxalino Data Integration for Shopware v6

      1. If the plugin configurations are not displayed, they can be accessed via direct link: admin#/sw/plugin/settings/BoxalinoDataIntegration

    2. Use the ? icon to get information on the configurations options or check https://github.com/boxalino/data-integration-shopware6/wiki/Configurations#instant-update-configuration

  4. Create the service configuration XML (as described in the Instant Update Integration steps https://github.com/boxalino/rtux-integration-shopware/wiki/Instant-Update)

  5. Check the configuration requirements as described https://github.com/boxalino/rtux-integration-shopware/wiki/Instant-Update#requirements

Endpoint

Set the Instant Update Endpoint configuration to https://boxalino-di-instant-update-krceabfwya-ew.a.run.app

 

Review

The sensitive properties that would directly impact the API response must be identified at the project level.

Stock Information

Official Shopware 6 documentation on Products Deliverability https://docs.shopware.com/en/shopware-6-en/catalogues/products#deliverability

The boxalino/data-integration-shopware6 plugin is providing a base for the stock attribute handler which uses the stock_availability as the value for stock.

Delivery Centers

The Data Integration stock information is represented by a list of Stock data schema (Referenced Schema Types | STOCK ) which fits the scenario of handling stock information per delivery center.

If your project is handling the stock information in some other way than the default Shopware 6 - create a custom handler and update the declared service

Price Information

The boxalino/data-integration-shopware6 plugin provides a base for the price property handler. It will export the product price and list price.

The default property handlers are provided with the boxalino/data-integration-shopware6 repository.

The ones available for instant mode (ex: price) have the “allowInstantMode” method set to “true” (as seen here)