Shipping Tracking

Instructions for Shipping Tracking

The add-on obtains parcel information through the gdeposylka.ru API. Using a tracking number and the selected shipping service, it displays the latest tracking events and can automatically update shipment and order statuses for completed or inactive deliveries.

What the add-on does

• adds parcel checking to the shipment card and the order card;
• displays up to three latest tracking events with their date and time;
• saves the entered tracking number to the shipment after a successful request;
• moves a delivered or no-longer-active shipment to the selected final status;
• can change the order status, but only after every shipment in that order has reached the final status;
• updates eligible shipments in bulk or on a cron schedule.

Where to find the add-on

Open the Shipping Tracking settings page and its General section. The add-on is used on the Shipments list, the individual shipment card, and the order card, where the MS: Shipping Tracking block is displayed. The Shipments list has the Update all shipment statuses action in its actions menu.

Configuration

1. API key for the gdeposylka.ru service. Obtain a key from gdeposylka.ru and enter it here. Without a valid key, the add-on cannot send tracking requests.
2. Lock tracking number field. Enable this option if staff must not edit the tracking number from the add-on block in an order or shipment card. Checking an already saved number remains available.
3. Final shipment status. Select the status assigned when the service reports delivery or that tracking is no longer active. If the default value is left in place, the standard Shipped shipment status is used.
4. Order status when all shipments reach the final status. Select an order status or leave Do not change. The selected status is applied only after every shipment in the order has the final shipment status.
5. Pass for Cron. Set a non-guessable value. It protects scheduled runs and must match the value used in the cron command.
6. Changes in the last n days. Enter a number of days to limit cron and bulk updates to shipments created in that period. Leave it blank to check all shipments whose status is not yet final.

Checking one parcel

1. Make sure that the shipment has a shipping service selected and a valid tracking number.
2. Open the order card or shipment card. In the add-on block, enter the tracking number if the field is not locked, then click Find.
3. Check the result: the add-on displays up to three latest checkpoints with status, date, and time. After a successful request, the entered number is saved to the shipment.
4. If the service returns a waiting status, try again in 3–5 minutes. An invalid number produces the corresponding message.

The add-on passes identifiers to the API for Russian Post, CDEK, and Boxberry. For another service, or if no service is selected, it reports that the delivery service is not supported.

Bulk update and cron

To update manually, open the Shipments list, choose Update all shipment statuses, and confirm the action. The add-on processes only shipments that have a tracking number and a supported shipping service and have not yet received the final status.

For scheduled runs, use the generated command from the Cron block on the settings page. Copy it to the server scheduler without changing the --dispatch and --pass parameters. If a day limit is configured, the command automatically includes --days. By default, the command template is scheduled for 09:55 daily; if needed, change the crontab schedule without changing the command itself.

After a bulk update, the add-on reports how many shipment statuses were updated. If no eligible changes are found, it displays a notice that there are no statuses to update.

How to check the result

1. Configure the API key and select the final shipment status.
2. Create or use a shipment with a supported shipping service and a valid tracking number.
3. Run a search from the order or shipment card and confirm that tracking checkpoints appear.
4. For a parcel that the service considers delivered or inactive, run the bulk update or wait for cron.
5. Check the new shipment status. If an order status is configured, verify that it changes only after all shipments in the order are complete.

If no result is returned

• Check the API key and the availability of the gdeposylka.ru API.
• Verify the tracking number and shipping service selected in the shipment.
• If the service has not prepared data for a new parcel yet, retry in 3–5 minutes.
• For cron, check the password in the settings and command, as well as the scheduler execution log.