Webasyst API Integration

Instructions for API integration with Webasyst

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 the add-on 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 the module 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 updates.
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 discounts in orders 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 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 are sent to Webasyst when they are created or updated in CS-Cart, including order items, customer data, shipping address, shipping method, comment, and shipping cost;
• Order statuses can be moved to shipped, processed, or completed in Webasyst when the status changes in CS-Cart.

How to check the add-on

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.