README

A Veeqo provider for the Foster Commerce Shipments plugin, plus product sync between Craft Commerce and Veeqo.

What it does

• Adds Veeqo to the Shipments plugin's integration list, so shipments can be pushed to Veeqo from the control panel or queue.
• Pushes each shipment to Veeqo as an order, recording the Veeqo order id against the shipment for later lookup.
• Polls Veeqo for shipped orders on a schedule and writes the carrier and tracking number back onto the matching shipment (Veeqo has no webhooks).
• Syncs Commerce products and variants to Veeqo as products and sellables when they are saved.
• Pulls stock from Veeqo into Commerce on a schedule, keeping inventory-tracked variants in step (Veeqo is the inventory source of truth).

Requirements

• Craft CMS ^5.0
• Craft Commerce ^5.0
• Foster Commerce Shipments ^1.0
• PHP ^8.2
• A Veeqo account and API key

Install

composer require fostercommerce/shipments-veeqo
./craft plugin/install shipments-veeqo

See docs/installation.md for the full guide, including Veeqo account setup and how to add the integration.

Veeqo integration

Veeqo registers as a provider on the Shipments plugin. You add it under Shipments -> Settings -> Integrations -> New, choosing Veeqo as the provider and entering your API key, channel id, and warehouse id. From there the Shipments plugin owns the shipment lifecycle (status, history, emails); this plugin only talks to the Veeqo API.

Product sync

When a Commerce product is saved, the plugin queues a job that creates or updates the matching Veeqo product and its sellables, keyed by SKU. Variants without a SKU are skipped. You can mutate the outgoing payload from your own code before it is sent. See custom product payloads.

Polling

Veeqo does not offer webhooks, so inbound tracking arrives by polling. You run the pull command on a cron schedule. See docs/installation.md for the commands and example crontab.

Stock sync

Veeqo is built to own inventory and dictate stock to its sales channels. This plugin treats Commerce as one of those channels: shipments-veeqo/stock/pull reads Veeqo's available stock and writes it onto inventory-tracked Commerce variants. Non-tracked variants are left untouched. Turn it off with the "Let Veeqo adjust Commerce inventory" setting.

License

Proprietary.