Skip to content

WooCommerce

Connect a WooCommerce shop to BIRP under CRM > E-commerce, without code: catalogue, prices, stock, orders and their statuses.

Version v1.3, updated

On this page

BIRP connects to a WooCommerce shop with the shop's own REST API keys, so no BIRP API key is needed. A connection imports the catalogue, sends prices and stock, receives the paid orders and sends their status back. Each of these is turned on per connection.

Before you start

  • WooCommerce 5.8 or later, at an address that starts with https.

  • WordPress permalinks other than Plain: in WordPress, Settings, then Permalinks.

  • A user of the shop with the Shop manager role, kept for BIRP only.

  • REST API keys of that user with Read/Write access. In WooCommerce: Settings, then Advanced, then REST API, then Add key.

  • The e-commerce module of your company. If E-commerce is missing under CRM in BIRP, ask BIRP to turn it on.

Connect the shop

  1. In BIRP, open CRM, then E-commerce, then Connect a store.

  2. Enter a name, the shop's address and the two keys, then Test. BIRP checks the shop and the keys, and shows the WooCommerce version, the currency and whether the shop manages stock.

  3. Choose Connect. BIRP adds its webhooks to the shop. Every action of the connection starts off, so no product, price, stock or order moves yet.

  4. On the connection's Settings tab, choose the warehouse, then turn on what the connection does.

The company admin connects a shop and changes its settings. The other people who work in CRM open its Orders, Catalogue and Log tabs. With write access to E-commerce, they also link products and start a sync.

What the connection does

Action

Direction

What happens

Import the catalogue

Shop to BIRP

On request. The shop's products are imported as resale goods or finished products, as chosen on the Settings tab. Each one is linked to the BIRP product of that kind with the same SKU, or created in BIRP. A product with variations becomes one BIRP product per variation.

Send prices

BIRP to shop

BIRP's sale price of each linked product, written as the shop's regular price. A price is sent when its product is linked or the price changes in BIRP; turning the action on and an import send each price not sent yet or changed since. To send them all again: on the Log tab, Run now, then Prices sent. A price in another currency than the shop's is not sent.

Send stock

BIRP to shop

The stock of a linked product, from the connection's warehouse or from all warehouses. Sending it turns on stock management for each linked product in the shop. Stock management must also be on for the whole shop: in WooCommerce, Settings, then Products, then Inventory. If you turn it on later, send the stock again: on the Log tab, Run now, then Stock sent.

Receive orders

Shop to BIRP

Paid orders arrive as confirmed customer orders, with the shop's order number. Orders on hold arrive as drafts and are confirmed once paid, and pending orders wait until they are paid. Only orders placed or changed after the action is first turned on arrive.

Send order statuses

BIRP to shop

When an order changes status in BIRP, the shop's order takes the status chosen for it on the Settings tab.

Sync customers

Shop to BIRP

The customer of each received order becomes a BIRP customer. With Match customers by e-mail, a customer with the email of exactly one BIRP customer is linked to that one instead. With the action off, every order goes to one customer named after the connection.

Orders from the shop

A shop order appears in CRM, then Orders, with its connection and the shop's order number. It shows two amounts: the total of its lines, before taxes, and what the customer paid in the shop, with taxes, shipping and fees.

An order of resale goods is never produced: once it is confirmed, Prepare from stock on the order takes its goods from the connection's warehouse. For finished products, the production policy chosen on the Settings tab decides.

  • Automatic starts production once the order is paid, when the recipe and the materials allow. If it cannot start, the Log tab says why.

  • Manual waits for someone to start it.

  • Never does not produce: the order leaves from finished stock.

If your company has Retail, Online orders in Retail lists the shop orders at what the customer paid. Once invoiced, they count in the retail reports under the channel of the connection.

An order BIRP cannot take as the shop sent it waits on the connection's Orders tab, with the reason and what to do. Linking the missing products, on the Catalogue tab or by an import, applies the order.

Limits

  • Images and descriptions are not imported.

  • Only simple products and the variations of variable products are imported. Grouped, external and other product types are not.

  • A shop product whose SKU belongs to a BIRP product of the other kind is not imported. Link it by hand on the Catalogue tab.

  • Stock is sent in whole units, rounded down.

  • Shipping and fees are not order lines, and coupons are already taken off the line prices. Taxes, shipping and fees stay with the order, as the difference between its two amounts.

  • An order that mixes resale goods and finished products is not created. Split it in the shop into one order of each kind: WooCommerce lets you change the items of an order only while it is Pending payment or On hold.

  • A change the shop makes to the lines of an order BIRP already has is not applied: it waits on the Orders tab.

  • Connect a shop with this connector or with your own code, not both: each would bring the same orders.

When something goes wrong

  • The connection's Log tab lists the latest syncs, newest first, with what each did and why it failed. A failed import counts the products it could not link or create, and gives the shop id of those among the first 50 it read.

  • When the shop refuses the keys, the connection stops and says why. The company admin enters new keys on the Danger tab; the links and the history stay.

  • If the shop's server removes the Authorization header, ask your host to keep it, then enter the keys again.

  • BIRP verifies the shop's signature.

  • custom-integration
  • receive-orders
  • stock-levels
  • references-and-external-ids