Skip to main content

WooCommerce Customer TO iPaaS.com Mapping Documentation

How the WooCommerce integration brings shoppers who register or change their details TO iPaaS.com with their billing and shipping addresses, matched by email so no customer is duplicated.

Contents

  • Summary

  • ID Format

  • Deleted Record Support

  • Custom Field Support

  • Mapping Collection Status

  • Duplicate or Conflicting Mappings

  • Supported Child Collections

  • System Caveats

  • Setup Requirements

  • Integration Flow

  • Mappings

  • Error Handling

  • Testing and Validation

  • Additional Notes

  • Related Documents

Summary

This documentation covers WooCommerce customers TO iPaaS.com. A shopper who registers, or changes their details, becomes or updates an iPaaS.com customer with their billing and shipping addresses:

  • a customer not linked yet whose email matches exactly one iPaaS.com customer is linked to it, not duplicated;

  • a new customer is numbered with their email address; an existing one keeps its number;

  • store staff (administrators and shop managers) are never sent;

  • the WooCommerce Sync Baseline custom field records what iPaaS.com last received, so a later update FROM iPaaS.com doesn't overwrite edits made in the store.

ID Format

Manual Sync ID Format: Enter the WooCommerce customer id (the user id in WordPress).

External ID Format (saved after sync): the WooCommerce customer id (96); addresses {customer id}|billing and {customer id}|shipping.

Deleted Record Support

Deleting a user in WordPress is not sent; the iPaaS.com customer stays.

Custom Field Support

Yes: a customer's public meta entries are offered as custom fields on the WooCommerce Customer table. Create one named exactly as the meta key, and the iPaaS.com customer custom field to hold it, and map one to the other (Custom to Custom). The extension or developer that adds the value knows its key.

Mapping Collection Status

The template is active. Its filter leaves out the administrator and shop manager roles; to leave out another role add a condition, for example && Role != "subscriber". Keep the WooCommerce Sync Baseline mapping.

Duplicate or Conflicting Mappings

An update replaces the whole customer: change a mapping to a keep-formula rather than deleting it (Known Limitations 26). Two Customer TO collections must not overlap (Known Limitations 28).

This collection has no Collision Handling Method setting. Matching is automatic: a WooCommerce customer not linked yet whose email matches exactly one iPaaS.com customer is linked to it (WOOC-BIZL-1011 when several match).

Supported Child Collections

  • WooCommerce Customer Address TO iPaaS.com: the billing and the shipping address (Known Limitations 11).

System Caveats

  • Changes to existing customers arrive by the customer.updated webhook only; the customer poll finds new registrations (Known Limitations 5).

  • Two or more iPaaS.com customers with the email stop the transfer (WOOC-BIZL-1011).

  • Edits made in both systems: an update FROM iPaaS.com keeps a field changed only in WooCommerce, and writes iPaaS.com's value when both changed (Known Limitations 21).

  • A customer written FROM iPaaS.com comes back once through this collection as an ordinary update, carrying the values just written (Known Limitations 32).

Setup Requirements

The webhook scopes customer.created and customer.updated turned on, and a Webhook Poll Request event for customer/poll every 15 minutes, with Customer Poll Initial Days set before its first run.

Integration Flow

  1. A shopper registers or changes their details; WooCommerce sends its webhook (the poll finds new registrations).

  2. The integration reads the customer and their addresses, and links them by email when they are new to this subscription.

  3. iPaaS.com runs this collection; the filter leaves out staff.

Mappings

Add/Update WooCommerce Customer TO iPaaS.com

iPaaS.com data type: Customer. Sync type: Add/Update. Mappings: 7.

Description: WooCommerce shoppers become iPaaS.com customers, with their billing and shipping addresses. Store staff (the administrator and shop manager roles) are not sent. New customers arrive by webhook and by the customer poll; changes arrive by the customer update webhook. A customer whose email matches exactly one iPaaS.com customer is linked to it instead of creating a second one. The WooCommerce Sync Baseline custom field records what iPaaS.com last received, so later updates FROM iPaaS.com don't overwrite edits made in WooCommerce. Fields WooCommerce doesn't own are kept on update. To stop WooCommerce changing a field in iPaaS.com, change its mapping to keep the iPaaS.com value instead of deleting it: a deleted mapping sends the field empty and clears it in iPaaS.com.

Mapping Filter:

// Shoppers only: store staff accounts (administrator, shop manager) are not customers.
// To send other roles too, remove their condition; to leave out another role, add a condition for it, for example one that excludes the subscriber role.
return Role != "administrator" && Role != "shop_manager";

Mapping Type

Source Field (WooCommerce)

Destination Field (iPaaS.com)

Description

Dynamic Formula

formula 1 (below)

CustomerNumber

(Required.) Kept when the iPaaS.com customer already has one; a new customer is numbered with their email address. Change it if your other systems expect their own numbering.

Field

FirstName

FirstName

(Recommended.) First name.

Field

LastName

LastName

(Recommended.) Last name.

Field

Email

EmailAddress

(Required.) Email. It also links a WooCommerce customer to an iPaaS.com customer with the same email.

Dynamic Formula

formula 2 (below)

Company

(Optional. To stop sending it, change it to a keep-formula: deleting it clears the field in iPaaS.com on the next update.) The billing company. When the WooCommerce customer has none, the company iPaaS.com already has is kept.

Dynamic Formula

formula 3 (below)

Comment

(Keep it.) Kept: WooCommerce doesn't own the iPaaS.com comment.

Field

SyncBaseline

WooCommerce Sync Baseline (Custom Field)

(Recommended. Keep it.) A short fingerprint of the WooCommerce values iPaaS.com last received (no personal data). Customer FROM iPaaS.com reads it back so edits made in WooCommerce aren't overwritten; without it every mapped field is written.

Dynamic Formulas (verbatim)

Formula 1, CustomerNumber:

// Keep the number iPaaS.com already has; a new customer is numbered with their email address.
return DestinationValue != null && !string.IsNullOrWhiteSpace(DestinationValue.CustomerNumber) ? DestinationValue.CustomerNumber : Email;

Formula 2, Company:

// The billing company; kept when the WooCommerce customer has none.
return !string.IsNullOrWhiteSpace(Company) ? Company : (DestinationValue != null ? DestinationValue.Company : null);

Formula 3, Comment:

return DestinationValue != null ? DestinationValue.Comment : null;

WooCommerce Customer Address TO iPaaS.com

iPaaS.com data type: Customer Address. Child of: Add/Update WooCommerce Customer TO iPaaS.com. Sync type: Add/Update. Mappings: 14.

Description: The customer's billing and shipping addresses. An empty address isn't sent. An address iPaaS.com already has keeps its third street line.

Mapping Type

Source Field (WooCommerce)

Destination Field (iPaaS.com)

Description

Field

Type

Type

(Recommended.) billing or shipping.

Dynamic Formula

formula 4 (below)

IsPrimaryBilling

(Recommended.) The billing address is the primary billing address.

Dynamic Formula

formula 5 (below)

IsPrimaryShipping

(Recommended.) The shipping address is the primary shipping address.

Field

FirstName

FirstName

(Recommended.) First name on the address.

Field

LastName

LastName

(Recommended.) Last name on the address.

Field

Company

Company

(Optional. To stop sending it, change it to a keep-formula: deleting it clears the field in iPaaS.com on the next update.) Company.

Field

Address1

Address1

(Recommended.) Street 1.

Field

Address2

Address2

(Optional. To stop sending it, change it to a keep-formula: deleting it clears the field in iPaaS.com on the next update.) Street 2.

Dynamic Formula

formula 6 (below)

Address3

(Keep it.) Kept: WooCommerce addresses have no third street line.

Field

City

City

(Recommended.) City.

Field

State

Region

(Recommended.) State or county code.

Field

Postcode

PostalCode

(Recommended.) Postal code.

Field

Country

Country

(Recommended.) Two-letter country code.

Field

Phone

PhoneNumber

(Optional. To stop sending it, change it to a keep-formula: deleting it clears the field in iPaaS.com on the next update.) The phone on the address.

Dynamic Formulas (verbatim)

Formula 4, IsPrimaryBilling:

return Type == "billing";

Formula 5, IsPrimaryShipping:

return Type == "shipping";

Formula 6, Address3:

return DestinationValue != null ? DestinationValue.Address3 : null;

Error Handling

Every error the integration raises carries a WOOC- code; WooCommerce Error Messages has the full text, cause and what to do for each. iPaaS.com's own refusals have no WOOC- prefix. Connection errors (Store URL, key, host) can stop any transfer and are listed there under "Connection and settings".

Code

When

What to do

Retried by iPaaS.com

WOOC-BIZL-1011

The email is shared by several iPaaS.com customers.

Merge the duplicate customers in iPaaS.com, then transfer the WooCommerce customer again.

Yes, until fixed or dismissed; it fails the same way until the cause is fixed

Testing and Validation

Follow the WooCommerce Installation Instructions, "Before you test: test safely": test on a staging copy of the store with its own subscription, if your host offers one; on your live store, test before your back-office systems are connected, with a Private test product and your own name and email address.

  1. Register a test customer in a private browser window with an email you own, then add a billing and shipping address under My account > Addresses: a customer with that email and those addresses appears in iPaaS.com.

  2. Change their last name or city in the store: the same customer is updated.

Additional Notes

Guest orders don't create customers: they arrive with the billing name and email on the order.

Related Documents

Related Mapping Documentation

  • WooCommerce Customer FROM iPaaS.com Mapping Documentation

Did this answer your question?