Instructions for ms_webasyst_api_integration

The add-on connects CS-Cart with Webasyst through the API. It sends products and orders from CS-Cart to Webasyst, receives updated data from Webasyst, and helps map local and remote order statuses.

What it does

• sends products and product changes to Webasyst by SKU;
• creates and updates orders in Webasyst;
• receives updated products and orders from Webasyst through cron;
• maps CS-Cart order statuses to Webasyst statuses;
• logs requests and responses;
• stores internal mappings for users and statuses.

Where it is located

• Add-ons → API integration with webasyst → General — account URL, token, product updates, update intervals, order discounts, default category, default company, logging, and log file size;
• Add-ons → API integration with webasyst → Additional information — cron notes;
• Add-ons → API integration with webasyst → Statuses compare — local and remote status mapping;
• the Get token button is shown in the add-on settings when the add-on is active.

How to configure

1. Enter the Webasyst Account URL, that is the root URL of the store on the Webasyst side.
2. Click Get token and complete authorization. After the redirect, the token is saved in the add-on settings.
3. If needed, enable Product update enable.
4. Set Update time and Orders update time. The value is specified in seconds and is used to pick recently changed records.
5. If needed, enable Discount enable so discounts are sent when orders are created or updated.
6. Select the Default category and Default company. New products will be created with the selected category, and orders will be synchronized only for the selected company.
7. If needed, enable Logging and set the Logging file size in bytes.

Status mapping

In the Statuses compare section, set a remote Webasyst status for each local order status. Supported values are shipped, processed, and completed. When an order status changes in CS-Cart, the add-on sends the change to Webasyst using the selected mapping.

What is synchronized

• Products — they are updated by SKU. If a product with that SKU does not exist, the add-on can create a new product with name, description, SEO fields, price, quantity, images, and default values from the settings;
• Orders — when an order is created or updated in CS-Cart, the add-on sends order items, customer data, shipping address, shipping method, comment, and shipping cost to Webasyst;
• Order statuses — when an order status changes in CS-Cart, the add-on can move the Webasyst order to shipped, processed, or completed.

Additional notes

• Use the cron jobs from the Additional information section for data exchange:

To update products: php path_to_site_folder/example.ru/index.php?dispatch=ms_webasyst_api_integration.update_products

To update orders: php path_to_site_folder/example.ru/index.php?dispatch=ms_webasyst_api_integration.update_orders

• If the account URL or token is missing, synchronization will not run;
• Logging helps track requests and exchange errors.

How to check

1. Save the add-on settings and make sure the token is filled in.
2. Change a product in Webasyst and run the product update cron, then check the result in CS-Cart.
3. Create or update an order in CS-Cart and check that it appears or updates in Webasyst.
4. Change an order status in CS-Cart and make sure the status mapping is applied in Webasyst.