omnitrade / woocommerce

1.x-dev 2026-10-17 13:53 UTC

Requires

• php: >=8.2
• omniscient/omnitrade: ^1.0@dev
• symfony/http-client: ^6.4|^7.0|^8.0

Requires (Dev)

• phpunit/phpunit: ^11.0

MIT

• Marco Meyer

• wordpress
• commerce
• woocommerce
• omnitrade

Published on Packagist.org on 2026-10-17 14:09 UTC

README

WooCommerce for omniscient/omnitrade: a sale paid on the shop's own checkout (an order created unpaid, with its payment URL), the shop's orders and their payment state, refunds, the payment gateways switched on, the catalogue, and webhooks - the REST API v3.

$gateway = (new WooCommerceGatewayFactory($http))->create(['url' => 'https://shop.example/', 'consumer_key' => '...', 'consumer_secret' => '...']);   // $http: the application's HTTP client; none given, the factory makes its own

No framework needed: the package requires omniscient/omnitrade and symfony/http-client. In a Symfony application, the same through the bundle's configuration:

omnitrade:
    gateways:
        woo:
            factory: woocommerce
            options:
                url: '%env(WOOCOMMERCE_URL)%'                       # https://shop.example
                consumer_key: '%env(WOOCOMMERCE_KEY)%'               # ck_...
                consumer_secret: '%env(WOOCOMMERCE_SECRET)%'         # cs_...
                webhook_secret: '%env(WOOCOMMERCE_WEBHOOK_SECRET)%'  # for notify()
                currency: EUR                                        # the store's, for the catalogue

purchase() creates a pending order and answers PENDING with its payment URL; the shop's own gateways take the money there, and fetch() or the order.updated webhook say when they did (processing/completed is PAID, failed REFUSED, cancelled CANCELLED). refund() refunds through the shop's gateway; fetchOrder() reads any order; paymentMethods() lists the gateways enabled.

Catalogue

fetchProducts() pages through /products (modified_after, search), a variable product's variations as its variants; fetchProduct() finds one by id, slug or page URL; fetchInventory() reads stock_quantity of products and variations; notify() reads product.created|updated|deleted into a Notification carrying the Product. Brands (9.6+, or a Brand attribute), categories, tags, the attributes (the variations' ones as options), images, regular and sale prices are mapped: see docs/catalogue.md.

Credentials: a REST API key with Read/Write (WooCommerce → Settings → Advanced → REST API) over HTTPS, and a webhook (same screen → Webhooks) for order.updated with a secret of your own.

Responsibility

This package is an independent, unofficial client: it is not affiliated with, endorsed by or sponsored by Automattic Inc. (WooCommerce). It reaches the WooCommerce shop it is pointed to on behalf of whoever runs it, and it does not redistribute their data beyond the short excerpts recorded as test fixtures. Its MIT licence covers this package's code only and grants no right to the service or to its data.

Whoever installs and runs this package is responsible for complying with the terms of the shop it reaches and WooCommerce's (woocommerce.com/terms-conditions), for obtaining whatever they require (an account, a key, a licence or subscription, an attribution or a citation, a rate limit to respect), and for any use made of what it returns. The authors publish it free of charge, make no commercial use of it, and accept no liability for how it is used (see LICENSE).

License: MIT since 2026-10-09; earlier versions remain published under LGPL-3.0-or-later.