This article walks you through installing the WooCommerce integration on iPaaS.com. You will check your store, create a WooCommerce REST API key, subscribe, fill in the settings, review the default templates, turn on the webhooks and polls, and check the first transfers. You don't need to write code for the default setup; the few optional steps that change a filter or a mapping formula give you the text to use.
How long it takes. As an estimate, plan about an hour in WordPress and iPaaS.com, plus your web host's response time if HTTPS or a firewall must change first. Reviewing the filters, translations and stand-in SKUs with your MiSP can add to that.
Where things are in iPaaS.com. This article gives paths such as Subscriptions > your WooCommerce subscription > Mappings. Screen and button names can differ slightly between iPaaS.com versions. If something doesn't look the way it is described here, your iPaaS.com partner (MiSP) or iPaaS.com support can show you where it is.
Before You Begin
What your store needs
Item | Why | How to check |
WooCommerce is installed and active | The integration talks to WooCommerce's REST API. | In WordPress, open Plugins. WooCommerce is listed and says Deactivate under its name (which means it is active). |
The store opens with | The integration only connects over HTTPS (the secure, encrypted form of a web address), so your key is never sent unencrypted. | Open your store in a browser. The address starts with |
Permalinks are not set to Plain | With Plain permalinks, WooCommerce's REST API addresses don't work. | In WordPress, open Settings > Permalinks. Any choice except Plain works (for example Post name). If you change it, click Save Changes. |
You can sign in as an administrator | Only an administrator can create the REST API key the integration needs. | In WordPress, open Users. Your user's Role is Administrator. |
The store lets the integration's requests through | Some hosts, firewalls and security plugins block requests that come from another system. | See Let the integration's requests through below. |
You may need your web host. Setting up HTTPS, or changing a firewall your host runs, can take a support ticket and a day or two. If you aren't sure whether your store has a firewall or security plugin, send the Let the integration's requests through section to your web host now, so their answer is ready before you go live.
What the first transfers change in your store
The integration links to records your store already has. It doesn't create duplicates, but it does change the records it links to:
Products. Before creating a product, the integration looks for a WooCommerce product with the same SKU. If it finds one, it links to it and updates it: every field the mapping fills (in the default template: name, description, prices, status, backorders, weight and dimensions) is overwritten with iPaaS.com's values. Fields the mapping doesn't fill are left as they are, with one exception: when a product's regular price is sent without a sale price, a sale running in WooCommerce ends (see Review the filters to keep WooCommerce's sales). The default template doesn't map categories, tags or images; they are written only if your MiSP maps them. A product without a SKU is not written to the store (
WOOC-VALD-1005).Stock. Every stock update turns on Manage stock for the product or variation and sets the stock number.
Customers. Before creating a customer, the integration looks for a WooCommerce customer with the same email address (email only). If it finds one, it links to it and overwrites the fields the mapping fills. If that customer's WooCommerce username differs from the username iPaaS.com sends, nothing is written and the customer is not linked (
WOOC-BIZL-1017). A mapped password is sent only when a new account is created, never to an account the integration links to or updates. A store administrator's or shop manager's account is never linked or overwritten (WOOC-BIZL-1015). Later updates FROM iPaaS.com hold back a field changed in WooCommerce only when iPaaS.com's value hasn't changed since; when both changed, iPaaS.com's value is written. This needs the two WooCommerce Sync Baseline mappings in the customer collections; without them, every mapped field is written.
Before the first transfer, back up your store (most hosts offer a one-click backup) or export your products and customers from WordPress. Then start with one product, check it, and only then let the rest of the catalogue flow.
What iPaaS.com needs: your products
iPaaS.com accepts an order line only when its SKU is a product in iPaaS.com. A line with a blank SKU, or with a SKU iPaaS.com doesn't know, is refused, and so is its order. So before orders can come TO iPaaS.com, the store's products must be in iPaaS.com.
Usually this is already true. The products come from the system that sends your catalogue to WooCommerce through iPaaS.com, such as an ERP, a point-of-sale system or a product information system. Set up that system's product flow first.
If your other systems only take orders (for example a CRM, a shipping system or a marketing system), you also need a system connected to iPaaS.com that sends products TO iPaaS.com. This integration sends products FROM iPaaS.com to WooCommerce, not the other way.
Give every product a SKU in WooCommerce. The default template has a stand-in SKU for lines without one, and one for fee lines; you set both in Set the stand-in SKUs below.
Let the integration's requests through
The integration reads and changes your store through addresses that start with /wp-json/wc/v3/ (WooCommerce's REST API). Many hosts, firewalls and WordPress security plugins block these requests, or block changes only. If they are blocked, products and stock can't be sent and orders can't be read, and transfers fail with WOOC-EXTN-1001.
WooCommerce itself has no list of approved addresses, so there is nothing to set up in WooCommerce. What matters is anything in front of it:
A WordPress security plugin (for example a plugin that adds a firewall or login protection): open its settings and allow requests to
/wp-json/wc/v3/, for both reading and changing data. Some plugins call this "REST API access"; don't turn the REST API off.A firewall run by your host (sometimes called a web application firewall): ask your host to make an exception for requests to
/wp-json/wc/v3/(reading and changing data). If your host only accepts requests from approved IP addresses, ask them to add iPaaS.com's addresses,20.98.221.25and69.61.66.130(the current list is kept in Whitelisting iPaaS.com IP Addresses). You can forward them the paragraph below.Turn off maintenance mode or "coming soon" pages before the first transfer.
Text you can forward to your web host:
We are connecting our WooCommerce store to iPaaS.com, an integration platform. iPaaS.com will call our store's WooCommerce REST API at https://[our store address]/wp-json/wc/v3/, both to read data (GET) and to create and update products, stock, customers and webhooks (POST, PUT and DELETE). Each request carries a WooCommerce REST API key we created, over HTTPS. Please make sure no firewall, security rule or rate limit blocks or challenges these requests (for example with a CAPTCHA or a "checking your browser" page). If you only allow requests from approved IP addresses, please add iPaaS.com's addresses 20.98.221.25 and 69.61.66.130; every request still needs our REST API key.
How you know it works: after setup, the first transfer doesn't fail with WOOC-EXTN-1001.
To create the WooCommerce REST API key
Sign in to WordPress as an administrator.
In the left menu, click WooCommerce, then Settings.
Click the Advanced tab, then the REST API keys link under the tabs.
Click Add key (on a store with no keys yet, the button may say Create an API key).
Fill in the form:
Description: type
iPaaS.com integrationUser: choose an administrator. Choose a user who will stay with the business, because the key stops working if that user is removed or loses the administrator role.
Permissions: choose Read/Write. Read alone is not enough: the integration writes products, stock, customers and webhooks.
Click Generate API key.
WooCommerce shows two values. Copy both and keep them somewhere safe, such as a password manager:
Consumer key (it starts with
ck_)Consumer secret (it starts with
cs_)
WooCommerce shows the Consumer secret only once. If you lose it, revoke the key and create a new one.
Treat the key like a password. Anyone with it can read and change your store's products, orders and customers.
Emails WooCommerce sends to new customers
When a customer is created FROM iPaaS.com (for example, an account added in your ERP), WooCommerce creates a real store account. If WooCommerce's New account email is turned on, WooCommerce emails that customer a welcome message, and a link to set their password when Send password setup link is ticked under WooCommerce > Settings > Accounts & Privacy (WooCommerce recommends it). Updates to an existing customer never send it.
Decide before you go live:
In WordPress, open WooCommerce > Settings > Emails.
Find New account and click Manage.
Leave Enable this email notification ticked if new customers created FROM iPaaS.com should be welcomed. Untick it, then click Save changes, if they should not, for example while many existing customers first reach the store from your ERP; tick it again afterwards. Customers created while it is off get no email; they can set a password with Lost your password? on the store's My account page.
Installation Instructions for Integration Setup
In iPaaS.com, go to Subscriptions and click Search Certified Integration Marketplace & Subscribe.
Click the WooCommerce integration tile.
Click Subscribe.
Enter a name for the subscription. It must be unique within the company.
Format: WooCommerce - [Store or Purpose]
Example: WooCommerce - Main Store
Select Create Default Mappings (recommended). This applies the default templates listed under Default Mapping Collections below.
Enter the Store URL: your store's home address.
Example:
https://shop.example.comType it exactly as it appears in your browser when you open your store's home page. It must start with
https://.Use the home page's address. If you paste an address from the WordPress admin (containing
/wp-adminor/wp-login.php), that part is removed and the store's own address is used.If your store's address changes when you open it (for example
shop.example.combecomeswww.shop.example.com), enter the address the browser ends on. Otherwise the connection fails withWOOC-EXTN-1003, which names the address the store sent the request to.One subscription connects one store. The first store it connects to is recorded; to connect another store, add a new subscription (changing the Store URL to another store stops every transfer with
WOOC-BIZL-1014).
Enter the Consumer Key: paste the Consumer key you copied (it starts with
ck_).Enter the Consumer Secret: paste the Consumer secret you copied (it starts with
cs_).Set Stock Locations.
Default value: blank (every iPaaS.com location counts toward WooCommerce stock).
To count only some locations, type their iPaaS.com location names or ids, separated by commas, for example
Main Warehouse, Downtown Store. Names are matched without regard to capital letters.Where to find them: your company's locations are listed in iPaaS.com's location settings, with each location's name and id. Copy the names exactly as they appear there. If you can't find the list, your MiSP or iPaaS.com support can give you the names.
Each entry is checked against iPaaS.com's locations, and an entry iPaaS.com doesn't have stops stock updates with
WOOC-NFND-1006. If your company has 100 or more locations, use location ids: a misspelt name can't be caught there.
Set Stock Quantity Field.
Default value:
QtyAvailable(each location's available quantity).Choose
QtyOnHandto count each location's on-hand quantity instead.Every stock update, with the product or stock-only, reads every listed location's quantity from iPaaS.com with this setting, so its total is always one measure.
In the stock collections, map StockQuantity to the same quantity as this setting:
QtyAvailablewith the default,QtyOnHandwhen you chooseQtyOnHand. The mapped quantity never changes the total. The integration compares it with that location's available and on-hand quantities in iPaaS.com to confirm that iPaaS.com already shows the change, so the check only covers the quantity you map, and the total counts the quantity this setting names.When you change this setting, change the mapping too. The totals stay right either way (each one is read with this setting), but the check that iPaaS.com already shows the change only covers the quantity you map. StockQuantity is mapped in five collections: the two stock-only collections (Add/Update WooCommerce Product Inventory FROM iPaaS.com and Add/Update WooCommerce Product Variant Inventory FROM iPaaS.com), the two inventory child collections of Add/Update WooCommerce Product FROM iPaaS.com (one for the product, one for its variants), and the inventory child collection of Add/Update WooCommerce Product Variant FROM iPaaS.com.
Keep StockQuantity a plain field, never a formula. With a formula, stock-only updates stop with
WOOC-BIZL-1008.
Set Order Page Size.
Default value:
50. Leave it as it is. The highest value is 100; a larger value is treated as 100.
Set Order Poll Initial Days.
Default value:
7. This is how far back the first order poll looks. A blank, 0 or invalid value uses 7; use1for the shortest look-back.If your store's recent orders already reached your back-office system another way (entered by hand, or sent by another plugin or connection you are replacing), set it low, for example
1, and turn the old connection off first, so the first poll doesn't send them again and nothing ships twice.Raise it before the first poll if you want older orders brought TO iPaaS.com. The integration has no first load: orders older than this reach iPaaS.com only if they change in WooCommerce.
Set Customer Page Size.
Default value:
50. Leave it as it is. The highest value is 100; a larger value is treated as 100.
The settings you fill in at steps 6 to 14 appear together on the subscription page:
Set Customer Poll Initial Days.
Default value:
7(a blank, 0 or invalid value also uses 7). On the first customer poll, only customers who registered in the last this-many days are brought TO iPaaS.com. Customers who registered earlier reach iPaaS.com only when they change in WooCommerce. Raise it before the first poll to bring in more existing customers.
Leave the platform presets (API Throttle Limit, API Throttle Seconds, Concurrent Connections, Concurrent Batch Executions) at their defaults. They are filled in for you; see Subscription Configuration – Edit for what each one does. If you later see
WOOC-EXTN-1005often (your host is asking iPaaS.com to slow down), lower Concurrent Batch Executions by 1 (never below 1) and watch for a day before lowering it again.Click Apply to save the settings. Saving does not test the connection. The integration checks the store on its first transfer. A wrong address or key makes that transfer fail with Unable to connect to subscription with id N; the reason, with its code (for example
WOOC-AUTH-1001), is written to the subscription's log page at the same time (see Where to see transfers and errors below).
See WooCommerce Connections and Settings for every setting in detail.
Authentication Configuration
The integration uses a WooCommerce REST API key, sent with every call over HTTPS. There is no separate sign-in and nothing to refresh. The key works until you revoke it, or until its WordPress user is removed or loses the administrator role.
To rotate the key:
Create a new key in WooCommerce > Settings > Advanced > REST API keys, as in To create the WooCommerce REST API key above.
Paste the new Consumer Key and Consumer Secret into the subscription and click Apply.
In WooCommerce, click Revoke on the old key.
Default Mapping Collections
The default templates create these collections, with child collections for order lines, addresses, payments, taxes and coupons, and for customer addresses. You find them under Subscriptions > your WooCommerce subscription > Mappings.
Collection | Type | Direction |
Add/Update WooCommerce Product FROM iPaaS.com | Product | FROM iPaaS.com |
Add/Update WooCommerce Product Variant FROM iPaaS.com | Product Variant | FROM iPaaS.com |
Add/Update WooCommerce Product Inventory FROM iPaaS.com | Product Inventory | FROM iPaaS.com |
Add/Update WooCommerce Product Variant Inventory FROM iPaaS.com | Product Variant Inventory | FROM iPaaS.com |
Add WooCommerce Order TO iPaaS.com | Transaction | TO iPaaS.com |
Update WooCommerce Order TO iPaaS.com | Transaction | TO iPaaS.com |
Add WooCommerce Refund TO iPaaS.com | Transaction (Return) | TO iPaaS.com |
Add/Update WooCommerce Customer TO iPaaS.com | Customer | TO iPaaS.com |
Add/Update WooCommerce Customer FROM iPaaS.com | Customer | FROM iPaaS.com |
Check the custom fields. After subscribing, check two custom fields in iPaaS.com: the customer custom field WooCommerce Sync Baseline (used by the customer collections) and the transaction custom field WooCommerce Refund Ids (used by the order collections). If either is missing, create it with exactly that name and type (a customer custom field for the first, a transaction custom field for the second), or ask your MiSP. Without the first, every mapped customer field is written to WooCommerce on each update FROM iPaaS.com. Without the second, the order in iPaaS.com doesn't show a refund that was deleted in WooCommerce.
Review the filters
A collection's filter decides which records it sends. Each one is yours to change. Review them before you go live:
Add/Update WooCommerce Product FROM iPaaS.com has no filter: every product iPaaS.com sends is created or updated in the store, with the status the mapping sends (a new product with no status is published). If iPaaS.com holds items the web shouldn't sell, such as a large ERP item master with discontinued or trade-only items, add a filter to this collection before you turn on its events. For example: send only products in your web category, or only products whose "publish to web" field (or similar flag in your source system) is set. Add the same condition to Add/Update WooCommerce Product Variant FROM iPaaS.com, Add/Update WooCommerce Product Inventory FROM iPaaS.com and Add/Update WooCommerce Product Variant Inventory FROM iPaaS.com: a filter on the Product collection alone doesn't stop them, and stock and variant changes for the excluded products then fail with
WOOC-NFND-1004,WOOC-NFND-1005orWOOC-NFND-1003. Your MiSP can write the filter with you.If you run sales in WooCommerce, add a static mapping KeepStoreSalePrice =
trueto Add/Update WooCommerce Product FROM iPaaS.com, its product variant child collection and Add/Update WooCommerce Product Variant FROM iPaaS.com before the first product transfer. Without it, iPaaS.com owns the sale price: when a regular price is sent and the iPaaS.com sale price is empty or zero, the sale running in WooCommerce ends. Removing the SalePrice mapping doesn't keep WooCommerce's sales; only KeepStoreSalePrice does.To load a catalogue hidden, you can map Status to
draft, so new products arrive as drafts shoppers can't see. While the mapping saysdraft, every update writesdraft: a product you publish by hand in WooCommerce goes back to draft at its next update. When you change the mapping back to the Status translation, each active product is published at its next update.Add WooCommerce Order TO iPaaS.com creates committed orders: status processing, completed, on-hold or refunded. On-hold orders are included because WooCommerce has already reduced their stock; refunded ones so that a sale refunded before it first reached iPaaS.com still arrives, followed by its return. Orders that never reached one of these statuses (pending payment, failed, cancelled) are not created in iPaaS.com. A pending order is created when it later moves to one of these statuses. If your business ships before payment, add pending to the filter.
Update WooCommerce Order TO iPaaS.com updates any order already in iPaaS.com: later status changes, cancellations and payment. It writes WooCommerce's order status on every change, so the order's status in iPaaS.com follows WooCommerce. If another system (for example your ERP) sets the status in iPaaS.com and that status should stay, change the Status mapping in this collection to a keep-formula (a formula that keeps the transaction's current value). Your MiSP can set it up. A line removed from an order in WooCommerce after the order reached iPaaS.com stays on the transaction: see WooCommerce Integration Known Limitations §25. To stop sending a field TO iPaaS.com, change its mapping to a keep-formula rather than deleting it: a deleted mapping clears that field on the next update (Known Limitations §26).
Add WooCommerce Refund TO iPaaS.com creates each refund as a Return transaction linked to its order.
Add/Update WooCommerce Customer TO iPaaS.com sends shoppers only. Store staff accounts (the administrator and shop manager roles) are not sent.
Add/Update WooCommerce Customer FROM iPaaS.com sends only customers with an email address, because WooCommerce needs one. Each customer it creates gets a WooCommerce account; a customer whose email belongs to a store administrator or shop manager is refused (
WOOC-BIZL-1015). WooCommerce may email them; see Emails WooCommerce sends to new customers above.
Guest orders
A shopper who checks out without an account places a guest order. A guest order reaches iPaaS.com with the billing name and email address, but with no link to an iPaaS.com customer. An order from a registered customer is linked only once that customer is in iPaaS.com.
Check what the systems that receive your orders (for example an ERP or accounting system) need. Many need a customer on every order. Common choices are a "cash sale" or "web guest" customer in that system that guest orders are posted to, or matching the order to a customer by its billing email. Set this up in the receiving system's integration, or ask your MiSP.
Review the translations
The default templates use translations to turn one system's values into the other's:
Order status (order collections): WooCommerce statuses to iPaaS.com transaction statuses. Every row already has a working value:
pendingandfailedto Awaiting Payment,processingto Processing,on-holdto On Hold,completedto Complete,cancelledto Cancelled,refundedto Refunded (refunds use it too) andcheckout-draftto Draft. Change a row only if your other systems expect a different status. If a WooCommerce extension adds its own order status, add a row for it before the first order with that status arrives: iPaaS.com refuses an order whose status has no row (errorVALD-1024, "Required property 'status' not found"), and nothing is created.Payment method (order collections): your WooCommerce payment methods to your iPaaS.com payment methods. The template has rows for
bacs(bank transfer),cheque,cod(cash on delivery) andwoocommerce_payments(WooCommerce's own card payments). For each other payment method your store offers, add a row whose source is the method's id: in WooCommerce > Settings > Payments, click Manage on the method and copy the last part of the browser's address: the text aftersection=, or for the offline methods the text after/offline/(for examplecod). WooCommerce's own methods arebacs,chequeandcod. If the address shows neither (some payment plugins have their own settings page), ask the plugin's provider for its payment gateway id. iPaaS.com refuses a paid order whose payment method has no row (errorVALD-1024, "Required property 'method' not found"), and nothing is created.Shipping method (order collections): your WooCommerce shipping methods (for example
flat_rate,free_shipping,local_pickup) to your iPaaS.com shipping methods. Add a row for every shipping method your store offers.Product status (Add/Update WooCommerce Product FROM iPaaS.com): iPaaS.com's
ActiveandPreorderto WooCommerce'spublish(shoppers can see and buy it), andDisabledandDiscontinuedtodraft(hidden, order history kept). These are the four statuses an iPaaS.com product can have. You can change adraftrow's WooCommerce value toprivateif you prefer.
In the payment method and shipping method translations, every target starts as text that begins with REPLACE with (for example REPLACE with your iPaaS.com Payment Method for check payments). Replace each one with the matching method your iPaaS.com company uses, and add a row for every payment and shipping method your store offers. iPaaS.com refuses an order whose payment method is still REPLACE with …, or has no row at all, and nothing is created. So replace every target and add every method before the first order arrives. If an order was refused this way, add the missing row, then resend the order from iPaaS.com or make a change to it in WooCommerce. The translations are kept with the subscription's mappings; if you can't find them, ask your MiSP or iPaaS.com support.
Set the stand-in SKUs
Every order line needs a SKU that exists in iPaaS.com. The line SKU mapping in the order line child collection is a formula: it uses the SKU of the iPaaS.com product the WooCommerce product is linked to, else the WooCommerce SKU, else one of two stand-in SKUs. The formula holds both stand-ins as quoted text:
REPLACE with your SKU for products without one: used for a line whose WooCommerce product has no SKU.REPLACE with your fee item SKU: used for a fee line (for example a payment surcharge), which has no product.
Both are placeholder values: you replace them with the SKUs of two products that exist in iPaaS.com, for example FEE and NOSKU. This is a hard prerequisite. iPaaS.com refuses an order with a fee line or a line without a SKU while the stand-in names no iPaaS.com product, and nothing is created; the error names the value to replace, for example NFND-1003 - Product Id: REPLACE with your fee item SKU does not exist or can not be found. Create the two products in iPaaS.com (or in the system that sends your catalogue to iPaaS.com) first.
The same formula is in three child collections: WooCommerce Order Line TO iPaaS.com (Add Order) under Add WooCommerce Order TO iPaaS.com, WooCommerce Order Line TO iPaaS.com (Update Order) under Update WooCommerce Order TO iPaaS.com, and WooCommerce Refund Line TO iPaaS.com under Add WooCommerce Refund TO iPaaS.com. Set the stand-ins in all three before the first order arrives:
Go to Subscriptions > your WooCommerce subscription > Mappings.
Open Add WooCommerce Order TO iPaaS.com, then its child collection WooCommerce Order Line TO iPaaS.com (Add Order).
Open the mapping for the line SKU.
In the formula, replace only the words inside the quotes: change
REPLACE with your SKU for products without oneto the SKU of an iPaaS.com product for lines without a SKU (for exampleNOSKU), andREPLACE with your fee item SKUto the SKU of an iPaaS.com product that stands for fees (for exampleFEE, a "Fee" item in your back office). Keep the quotation marks and leave the rest of the formula exactly as it is: if you replace the whole formula with a SKU, every line gets that SKU.Save the mapping, then the collection.
Repeat steps 2 to 5 for WooCommerce Order Line TO iPaaS.com (Update Order) under Update WooCommerce Order TO iPaaS.com and WooCommerce Refund Line TO iPaaS.com under Add WooCommerce Refund TO iPaaS.com.
Keep the two stand-in products out of your store. The product collection sends iPaaS.com products to WooCommerce, so without a filter the fee item and the no-SKU item would appear in your shop as products shoppers can buy. Open Add/Update WooCommerce Product FROM iPaaS.com, and add a filter that leaves out both SKUs, for example
return Sku != "FEE" && Sku != "NOSKU";with your two SKUs in place of FEE and NOSKU. If the collection already has a filter, add the two conditions to it with&&.Leave the stand-in products out of the other product collections too, as for any filter on the Product collection (see Review the filters). A stock change on a stand-in product otherwise reaches Add/Update WooCommerce Product Inventory FROM iPaaS.com and fails with
WOOC-NFND-1004, because the product isn't in your store.Add/Update WooCommerce Product Inventory FROM iPaaS.com and Add/Update WooCommerce Product Variant Inventory FROM iPaaS.com: a stock record carries no SKU, so leave the stand-ins out by their iPaaS.com product ids (shown on each product in iPaaS.com), for example
return Convert.ToInt64(ParentId) != 12345 && Convert.ToInt64(ParentId) != 12346;with your two ids. In the Product Variant Inventory collection this matters only if a stand-in product has variants; there, use the variants' ids.Add/Update WooCommerce Product Variant FROM iPaaS.com: this matters only if a stand-in product has variants. Leave them out by the same two product ids, with the same condition as in the Product Inventory collection.
If the stand-in products already appear in your shop, set them to Draft in WooCommerce.
How you know it's done: no mapping or translation in the three order collections still shows REPLACE. If you work with a MiSP, they can do this for you; otherwise iPaaS.com support can walk you through it.
Turn On the Webhooks and Polls
A scope is one kind of data the integration brings TO iPaaS.com. A webhook scope is WooCommerce telling iPaaS.com about a change by sending a webhook. A poll scope asks WooCommerce for changes on a schedule. Turn the scopes on in the subscription's Inbound Data Flows (Subscriptions > your WooCommerce subscription, then Inbound Data Flows). The two poll scopes are listed only when the All switch above the list is on.
Scope | Turn on | What it does |
| Yes (webhook) | New orders come TO iPaaS.com when WooCommerce sends the order's |
| Yes (webhook) | Status changes, payments, edits and refunds come TO iPaaS.com when WooCommerce sends the order's |
| Yes | Brings in every order changed since the last poll, so it catches any order a webhook missed. It does not resend an order whose transfer failed: fix the cause, then resend the order from iPaaS.com. |
| Yes (webhook) | New customers come TO iPaaS.com when WooCommerce sends the |
| Yes (webhook) | Changes to customers come TO iPaaS.com when WooCommerce sends the |
| Yes | Brings in customers created since the last poll. Catches new customers a webhook missed. |
You don't create webhooks in WooCommerce yourself. The integration creates them when you turn a webhook scope on, and removes them when you turn it off. WooCommerce turns a webhook off after more than five failed deliveries in a row. With a poll scheduled, the integration turns it back on at the start of the next poll. The order poll catches up the orders that were missed; the customer poll finds new customers only, so a change to an existing customer made while the webhook was off reaches iPaaS.com with that customer's next change (or resend the customer from iPaaS.com). Turning the scope off and on again also turns the webhook back on. To stop a webhook, turn its scope off in iPaaS.com, not in WooCommerce.
WooCommerce queues each webhook and sends it from its background scheduler, which WordPress runs when someone visits the store (or from a server task, if your host has set one up). An order or customer usually reaches iPaaS.com within a few minutes; on a store with few visitors it can take longer. See WooCommerce Integration Known Limitations §24.
Products, variants, stock and customers sent FROM iPaaS.com run on iPaaS.com's own events. In the subscription's Outbound Data Flows, turn on the created and updated events for Product, Product Variant, Product Inventory, Product Variant Inventory and Customer (the scopes product/created, product/updated, product/inventory/updated, product/variant/created, product/variant/updated, product/variant/inventory/updated, customer/created and customer/updated). Without them, nothing is sent to your store.
Decide on WooCommerce's New account email (see Emails WooCommerce sends to new customers) before you turn on the Customer events. Review the Add/Update WooCommerce Product FROM iPaaS.com filter (see Review the filters) before you turn on the Product events.
Schedule the Polls
A /poll scope runs only on a schedule. Turning a poll scope on doesn't start it, and subscribing doesn't create the schedule.
For each poll scope, create an event in iPaaS.com's Events (Integration Monitoring and Diagnostics > Events, then Add Event; see Events):
Enter a Name and a Description, and set Event Type to Webhook (Poll Request).
Under Event Rules, click Add and add three rules, in this order (SystemId must come before Scope):
SystemId: in Expression, choose your WooCommerce subscription.
Scope:
order/poll(orcustomer/pollfor the customer event).Interval: the schedule: type Manual, expression
0 0/15 * * * ?(see below).
Click Apply.
Production schedules run in UTC.
Event name (your choice) | Subscription | Scope | Schedule |
WooCommerce orders | your WooCommerce subscription |
| every 15 minutes |
WooCommerce customers | your WooCommerce subscription |
| every 15 minutes |
For the Interval rule, set the expression type to Manual and enter 0 0/15 * * * ? (every 15 minutes, on the quarter hour). The other types (Hourly, Daily, Weekly, Monthly) have no 15-minute option.
The polls catch missed orders and new customers (a change to an existing customer arrives with its next change (or resend the customer from iPaaS.com)): we recommend both, every 15 minutes, even when the webhooks are on. The first order/poll looks back Order Poll Initial Days; after that, each poll starts where the last one ended.
Post-Installation Verification
Where to see transfers and errors
Each transfer, and each error with its code, is shown on the subscription's error and log pages in iPaaS.com (open Subscriptions > your WooCommerce subscription, then its errors or logs). Every error the integration records carries a code such as WOOC-AUTH-1001. When a message says iPaaS.com tries the transfer again automatically, no action is needed unless the error keeps coming back. Look the code up in WooCommerce Error Messages. If you can't find these pages, ask your MiSP or iPaaS.com support.
Before you test: test safely
Test records travel like real ones. An order you place in the store reaches every system connected to iPaaS.com, such as your ERP, warehouse, shipping and accounting systems, where it may be picked, shipped or invoiced.
Best: test on a staging or test copy of your store, with its own subscription, if your host offers one.
On your live store:
Do the tests before you connect your ERP, warehouse or accounting system to iPaaS.com, or tell the people who pick, ship and invoice orders to ignore the test order.
Pay with an offline payment method that charges nothing, such as Check payments or Cash on delivery. Turn one on for the test in WooCommerce > Settings > Payments, under Take offline payments (older WooCommerce versions list the methods directly on the Payments tab), and turn it off again afterwards if you don't normally offer it.
Use your own name, address and email address.
Use a clearly named test product (for example "TEST - do not ship") whose status is Private, so shoppers can't see or buy it. To order it yourself, sign in to the store as an administrator first: administrators can see and buy private products.
Afterwards, cancel or delete the test order, customer and product in WooCommerce and in each connected system.
Checks
Connection check. Saving does not test the connection. The first transfer does. If it fails with Unable to connect to subscription with id N, open the subscription's log page at that time, read the code (
WOOC-VALD-1001toWOOC-VALD-1004,WOOC-AUTH-1001,WOOC-AUTZ-1001,WOOC-NFND-1001,WOOC-BIZL-1014, orWOOC-EXTN-1001toWOOC-EXTN-1005), and look it up in WooCommerce Error Messages.Webhooks. In WordPress, open WooCommerce > Settings > Advanced > Webhooks. Each webhook scope you turned on has one webhook named like
iPaaS.com (Production, 12345) order.created, with status Active. If one is missing or not active, turn its scope off and on again.Product test. In the system that sends your catalogue to iPaaS.com (or in iPaaS.com itself), create or change one test product with a SKU, and set it to inactive (or draft) in that system, so it reaches WooCommerce as a draft that shoppers can't see. When the test is done, delete the test product in both places (or leave it inactive). Check that it appears in Products in WordPress with the right name, price and stock (and categories or images, if your MiSP mapped them). Send it again (change it once more) and check that no second copy appears.
Stock test. Change that product's stock in iPaaS.com. Check that only the stock changed in WooCommerce, and that the number matches the total of the locations in Stock Locations (each location's available quantity, or its on-hand quantity with
QtyOnHand).Order test. Following Before you test: test safely, place an order for the test product with an offline payment method. If WooCommerce shows it as On hold (as Check payments does), open the order, change its status to Processing and save, as if the payment had arrived. Check that it appears in iPaaS.com as a transaction with its lines, addresses and payment (allow a few minutes for the webhook). Then refund part of it in WooCommerce and check that a Return transaction linked to the order appears in iPaaS.com. Remember that the order and the return also reach your connected systems.
Customer test. In a private browser window, register a test customer in the store with your own email address (if your store doesn't let shoppers create accounts, create the customer in WordPress under Users > Add User with the role Customer) and check that they appear in iPaaS.com with their addresses. Then create a test customer in iPaaS.com (or in the system that sends customers to iPaaS.com), also with an email address you own, and check that they appear in WooCommerce under Users. If New account is on, that address receives WooCommerce's welcome email.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
iPaaS.com Documentation: https://support.ipaas.com/en/articles/10280417-api-introduction
iPaaS.com Support Portal: https://support.ipaas.com/en/
iPaaS.com Contact Information: https://ipaas.com/contact-us/
WooCommerce REST API documentation, for REST API keys and permalinks.
Related Documents
iPaaS.com <> WooCommerce: Background








