Instructions for Mobile App

The add-on provides data for a mobile app and helps connect the store with the mobile interface: catalog, banners, cart, orders, brands, favorites, promotions, and payments.

What it does

- sends products, categories, banners, cart, orders, users, brands, and promotions to the app;
- takes the main category and a separate banners block into account;
- supports the data needed for the mobile flow;
- works with warehouse filtering when that scenario is used in the store;
- supports reward points in the cart and orders;
- supports Paygine payments, including card and SBP;
- supports shipping data, including SDEK;
- works with related add-ons when they are enabled.

Where it is located

The main settings are in Administration → Add-ons → Manage add-ons → Mobile App.

The add-on card contains these fields:
- banners block id;
- brand feature id;
- main category id;
- warehouses filter id for the ms_filter_warehouses add-on.

When editing a banner, there is a Mobile App tab. It is used to set the banner data for the mobile flow.

When editing a payment method, there is a Show in app checkbox. It controls whether the method is available in the mobile interface.

How to configure

1. Set the banners block ID if you want banners to be returned in the app.
2. Set the brand feature ID if the app should show brands.
3. Set the main category ID if the catalog is built from a separate root category.
4. Set the warehouses filter ID if the ms_filter_warehouses add-on is used.
5. Enable Show in app for the payment methods that should be available in the app.
6. Fill in the banner data on the Mobile App tab in the banner card when needed.

How to use it

1. Connect the mobile app to the add-on API.
2. Check that catalog, banners, cart, and orders open correctly in the app.
3. For products and categories, check that they appear in the mobile flow as intended by the store setup.
4. For banners, make sure the correct block and banner card data are used.
5. For payments, make sure only the methods marked as visible are available in the app.
6. For shipping, check that the required shipping method and pickup point data are passed in orders.

How to check it

- the API should return products, categories, banners, and cart data without errors;
- the selected add-on settings should affect catalog and banner output;
- orders should include shipping and payment data;
- reward points should work correctly when the related add-on is enabled;
- Paygine card or SBP flow should work when payment support is enabled.

If something does not work

- check the ID values in the add-on card;
- check that dependent add-ons are enabled if you rely on them;
- check the banner and payment method settings if the required data does not appear in the app;
- check that the store has the required entities: products, categories, banners, brands, and payment methods.