Installation and Update

1. Open Add-ons → Manage add-ons or Add-ons → Downloaded add-ons.
2. Find Extended Store API and install or update it.
3. Open the add-on page and make sure it is enabled for the required storefront.
4. Clear the CS-Cart cache after installation or update so the store can register the settings and API resources again.
5. If you use reward points, warehouses, pickup points, extended wishlists, or external payments, make sure the corresponding add-ons are enabled as well.

Main Settings

1. Open the Extended Store API add-on page.
2. In Banner block ID, select the block to provide to external clients.
3. In Brand feature ID, select the feature used for the brand list.
4. In Main category ID, select the root category of the provided catalog. Keep the default value for the entire catalog.
5. In Warehouse filter ID, select the filter used for warehouse availability.
6. If required, enable checkout blocking in apps when a product is unavailable in the selected city.
7. Choose separately whether the same availability rule should block checkout on the website.
8. Save the settings.

Preparing Catalog Data and Payment Methods

• Under Marketing → Banners, make sure the required banners belong to the selected block. Mobile-specific banner options remain on the Mobile App tab.
• Set a category color when an external interface needs it.
• In the brand feature, mark the variants that should be available to external clients.
• If product blocks are used, mark the blocks that should be provided to the app.
• Under Administration → Payment methods, enable Display in app for every payment method that should be available to an external client.
• Check the status of shipping methods, store locations, pickup points, and warehouses used during checkout.

Connecting an API Client

The technical add-on identifier remains ms_mobile. Existing resource paths do not need to change when upgrading to version 1.3.0.

1. For a server-side integration, create a dedicated CS-Cart API user and grant only the required view or manage permissions for the add-on resources.
2. Use a customer token for personal customer data. Do not submit another customer's identifier in place of the authenticated account.
3. For a store with multiple storefronts, send the required storefront context and make sure the add-on is enabled for that storefront.
4. Do not expose administrator keys or customer tokens in public website or app code.

Main resource groups:

• catalog — ms_products, ms_categories, ms_brands, ms_banners, ms_blocks, ms_promotions;
• customer and purchases — ms_users, ms_cart, ms_orders, ms_favorite, ms_cart_points;
• fulfillment — ms_store_locations, ms_sdek_offices;
• collections — ms_wishlists, ms_wishlist_items, ms_shared_wishlists.

Available operations depend on the authentication type and user permissions. Without authentication, only a published collection can be read by its public key.

Product Collections

1. Install and enable a compatible extended wishlist add-on.
2. Authenticate the customer in the external portal or app.
3. Create a collection as a draft, then add products and optional notes.
4. Reorder the products and check the collection contents.
5. Publish a non-empty collection. The add-on returns a sharing link after publication.
6. Return the collection to draft status to stop public access. Only its owner can update or delete it.

Post-connection Check

1. Request categories and products and make sure the data belongs to the required storefront.
2. Authenticate a test customer, add an available product to the cart, and recalculate it.
3. If reward points are enabled, apply a test amount and check the resulting total.
4. Select a city, warehouse, or pickup point and make sure an unavailable product blocks checkout only when the corresponding option is enabled.
5. Place a test order and check its products, customer details, shipping, payment, discounts, and reward points in the administration panel.
6. If collections are used, create a draft, add a product, publish it, and open the returned sharing link without authentication.

If the API Does Not Respond

• 401 or 403: check the key or token, user type, and granted permissions.
• 404 after installation or update: make sure the add-on is enabled for the required storefront, then clear the CS-Cart cache.
• Collections are unavailable: check the extended wishlist add-on status and make sure the database update has completed.
• No payment methods: enable Display in app for the required methods.
• Incorrect warehouse availability: check the selected warehouse filter, city, stock levels, and checkout blocking options.
• External payment fails: check the status and settings of the payment add-on in use, then repeat the test order.