WooCommerce client
What it does
The opotopo-seller-api WordPress plugin uploads the catalog of a WooCommerce store to the platform: it creates and updates listings from products, variations and stock, withdraws products that dropped out of the catalog, brings platform orders into store orders and fulfills them from the order admin. No code is needed.
The plugin is built on the PHP client and is open source under the MIT license: code and releases — github.com/AdzerKI/seller-api-woocommerce.
Installation
- Download the latest release archive.
- In the WordPress admin: "Plugins" → "Add New Plugin" → "Upload Plugin", choose the archive and click "Activate".
WordPress does not activate the plugin without WooCommerce or on WordPress, WooCommerce and PHP versions below the plugin requirements.
Settings
"WooCommerce" → "Settings" → the "OPOTOPO" tab:
- "API key" — a key of the "API" section with the write listings, remove listings, file upload, read orders and fulfill orders permissions
- "Organization ID" — the seller organization; without it products are created on behalf of the key organization, for a personal key — on behalf of its owner
- "Publication" — unchecked keeps new products as drafts
- "Webhook signing secret" — the secret of the order receiving address
- "Platform address" — the platform API address
Catalog
Published simple and variable products go to the platform, except hidden ones:
- SKU — the product SKU, without it —
wc-and the product ID - price — the active price, for a variable product — the lowest variation price
- barcode — the GTIN, brand — the product brand, characteristics — the visible product attributes
- images — the cover and the gallery
- weight and dimensions — in the store units, for a variable product — the largest among variations
- quantity — the product stock or the sum of variation stock; without stock management — no quantity
- variants — variations in stock with a price: the name is the variation attribute values, the photo is the variation image, the files are the variation downloads; a simple downloadable product is one variant with its files
Categories
The store category of a product is the path of its deepest category from the root. The platform category for it is chosen in the "Store categories" card of the "API" section: paths appear in the card with the first synchronization, a product of an unmapped category is rejected with its path, and the next synchronization after the choice creates it.
Synchronization
- Changing or deleting a product or variation and a stock change queue a synchronization; a full run goes every hour; runs never overlap
- The queue is run by WP-Cron; with WP-Cron disabled, the server scheduler has to run it
- The "OPOTOPO" tab shows the last run summary, product rejections with details and the "Synchronize now" button; rejection codes — the PHP client
Orders
- The order receiving address is shown under the "Webhook signing secret" field. In the "Webhooks" block of the "API" section add this address with the "New order", "Purchase revoked" and "Order status changed" events, and put its signing secret into the "Webhook signing secret" field.
- A platform purchase becomes a WooCommerce order paid by the platform in the "Processing" status with the stock reduced: lines are the store products of the listings, delivery is an order line, the recipient, address and pickup point go to the shipping address and the order note.
- The platform order status goes to the order notes; received by the buyer — "Completed", cancelled — "Cancelled" with the stock restored
- A purchase revocation is a WooCommerce refund of its amount with the stock restored, without a payment gateway
Order fulfillment
The "OPOTOPO" panel of the order screen shows the status and receiving method of the platform order and the actions its status allows; an action goes with saving the order:
- "Hand over to delivery" — own delivery: the delivery service, tracking number and tracking address
- "Ship with the carrier" — a drop-off point or "Carrier courier pickup" and places with weight and dimensions in the store units; without places every unit ships as its own place with the product package
- "Ready for pickup" — pickup
- "Cancel the order on OPOTOPO" — with a reason
- "Label" and "Waybill" — shipment documents
A platform refusal is shown as an order screen error with its text.
Removal
Deleting the plugin in "Plugins" removes its tables, settings and tasks; the listings on the platform stay.
Did not find the answer to your question?
Create a request