Zeros for the quantity of goods when exchanging with Commerceml

Instructions for “Zero product quantities during CommerceML exchange”

What the add-on does

The add-on extends product quantity data during a CommerceML exchange. If a warehouse exists in the store but the current upload provides no quantity for that warehouse, the add-on supplies a value of 0. Warehouses that do not exist in the store are excluded from processing.

The add-on can also reset all warehouse and overall stock once through a cron command.

Where to find the add-on

Go to Add-ons → Manage add-ons → Zero product quantities during CommerceML exchange.

The CommerceML and Warehouses add-ons must be installed and enabled for automatic processing. The exchange must use valid HTTP Basic authentication.

Add-on settings

Secret key (secret_key) protects the full-reset action. The command URL contains the MD5 hash of the current key. The default value is ms_cml_fill_empty_amount; replace it with a unique value before enabling the cron job.

Cron link displays a ready-to-use command after the secret key is filled in. Copy the command from the add-on settings.

Automatic zeroing during exchange

1. Start an authenticated CommerceML catalog import.
2. The add-on obtains the mapping between external warehouse identifiers and store warehouses.
3. When a product is processed, the add-on adds a quantity of 0 for each existing warehouse that has no data in the current upload.

Full reset through cron

The add-on generates a command in the following form:

0 4 * * * php<version> <store root>/<storefront script> --dispatch=ms_cml_fill_empty_amount.reset --hash=<MD5 of the secret key>

Copy the command from the settings and add it to the cron scheduler. The operation runs only if the supplied hash matches the MD5 hash of the current secret key.

Important: the command zeroes every value in the warehouse stock tables and the overall product quantity. The operation has no built-in rollback. Back up the database first and make sure a full exchange can run immediately afterward to restore current stock.

How to check the result

Automatic mode: run a test exchange where one existing warehouse is omitted for a selected product. After import, check the product quantities by warehouse: the omitted warehouse must contain 0, while submitted warehouse values must match the upload.

Full reset: test only on a staging copy or after creating a backup. Run the command from the settings and confirm that warehouse and overall quantities are 0. A command with a modified hash must not perform the reset.