Skip to main content

BigCommerce to iPaaS.com B2B Company and Customer Mapping Documentation

How BigCommerce B2B Edition companies, addresses, hierarchy, and company users transfer into iPaaS.com — field mappings, poll-based triggers, name- and email-based matching, and the company/user relationship model.

Summary

BigCommerce B2B Edition companies, company addresses, company hierarchy, and company users transfer into iPaaS.com. A B2B company is captured as a Company record carrying its identity and B2B attributes; its addresses, its parent/subsidiary hierarchy, and its company users are captured alongside it. The individual buyers who belong to a company — the company users — are captured as Customer records, and the tie between a company and its users is modeled as a relationship between a Company and a Customer. Transfers run from scheduled polling or subscribed triggers, or on demand from the iPaaS.com Manual Sync page.

This article is the field-level companion to BigCommerce B2B Edition Support, which covers the higher-level picture — what B2B Edition is, how to turn it on, and how automatic transfer is set up. B2B handling is off by default and only applies when B2B support is enabled on the subscription. Writing iPaaS.com companies and company users back to BigCommerce is covered by the companion iPaaS.com to BigCommerce B2B Company and Customer Mapping Documentation. Standard (non-B2B) customers are handled by a separate set of collections — see the Related Documents footer. Only one of the standard (B2C) or B2B mappings should apply to any given customer.

Contents

Data Types and Direction

This article documents the following mapping collections and the iPaaS.com data type each one operates on. Every collection here transfers BigCommerce to iPaaS.com.

Collection

iPaaS.com data type

Direction

BC B2B Company Add TO iPaaS.com

Company

BigCommerce to iPaaS.com

BC B2B Company Update TO iPaaS.com

Company

BigCommerce to iPaaS.com

BC B2B Company Address Add TO iPaaS.com (child)

Company Address

BigCommerce to iPaaS.com

BC B2B Company Address Update TO iPaaS.com (child)

Company Address

BigCommerce to iPaaS.com

BC B2B Company Relationship Add TO iPaaS.com (child)

Company Relationship

BigCommerce to iPaaS.com

BC B2B Company Relationship Update TO iPaaS.com (child)

Company Relationship

BigCommerce to iPaaS.com

BC B2B Customer Add TO iPaaS.com

Customer

BigCommerce to iPaaS.com

BC B2B Customer Update TO iPaaS.com

Customer

BigCommerce to iPaaS.com

BC B2B Customer Relationship Add TO iPaaS.com (child)

Customer Relationship

BigCommerce to iPaaS.com

BC B2B Customer Relationship Update TO iPaaS.com (child)

Customer Relationship

BigCommerce to iPaaS.com

In BigCommerce B2B Edition, a company relates to other companies as departments or subsidiaries, and to its users. In iPaaS.com those ties are modeled as relationships: company-to-company links form the hierarchy, and company-to-user links connect a company to its buyers. The company-to-user tie is a relationship between a Company and a Customer — not the Employee data type.

ID Format

Manual Sync IDs differ by collection because each collection acts on a different record. Addresses and relationships transferred as part of a company or a customer have no independent Manual Sync entry point; sync the parent and its children transfer together.

Manual Sync ID Format

  • Company: enter the BigCommerce B2B company ID — the numeric identifier BigCommerce assigns to the company. Example: 456.

  • Customer: enter the BigCommerce customer ID of the B2B company user. Example: 123.

External ID Format

After a successful transfer, iPaaS.com records the BigCommerce identifier as the external ID on a dedicated external-ID record for the transferred record:

  • For a company captured into iPaaS.com, the BigCommerce B2B company ID is saved as the external ID on the iPaaS.com Company.

  • For a company user captured into iPaaS.com, the BigCommerce customer ID is saved as the external ID on the iPaaS.com Customer, and is also written to the Customer's CustomerNumber field as a fallback match key.

The external-ID record is the primary match that routes later transfers of the same record to an update rather than creating a duplicate.

Deleted Record Support

Inbound record delete is not supported for these collections. Deleting a company, address, relationship, or company user in BigCommerce does not propagate the deletion to iPaaS.com; remove records manually in each system as needed.

Custom Field Support

BigCommerce does not expose custom fields for the company, company address, or customer data types. The integration populates several iPaaS.com custom fields inbound to carry B2B-specific values and to route records; none require manual creation for the default templates, and the ones that route records add no mapped data.

Values written to the iPaaS.com Company and its relationships:

  • B2B Company Status: the company's B2B status, resolved through a lookup translation.

  • B2B Group Name, B2B Catalog Id, B2B Catalog Name: the company's customer group and assigned catalog.

  • B2B BC Company Payment Terms Enabled, B2B BC Company Payment Terms: the company's BigCommerce payment-terms configuration.

  • B2B User First Name, B2B User Last Name, B2B User Phone Number, B2B User Email, B2B Company Name: recorded on the company/user relationship for visibility.

Values written to the iPaaS.com Customer to identify and route a B2B user:

  • B2B_UserIdFromB2B: the BigCommerce B2B user identifier. Its presence marks a Customer as a B2B user and routes it to the B2B collections; its absence routes a customer to the standard collections.

  • B2B_SendToB2B: set to true when a B2B user identifier is present; used by the outbound customer path.

  • B2B_PhoneNumber: the B2B user's phone number.

Mapping Collection Status

All collections in this article ship Enabled. Trigger events:

  • Company, Company Address, Company Relationship: BigCommerce B2B Edition does not send its own webhook notifications, so companies transfer through scheduled polling using the store/company/poll scope with the filter B2B_Company.

  • Customer, Customer Relationship: the standard BigCommerce customer created and customer updated events are shared with the B2B path and are sufficient in most cases; a store/customer/poll scope with the filter B2B_User is also available.

Whether a given event drives an Add or an Update depends on whether the record is already linked to iPaaS.com by an external ID. Automatic transfers do not run until the corresponding poll events or triggers are configured — see Setup Requirements.

Duplicate or Conflicting Mappings

Several collections operate on the same underlying records. Review their filters and Add/Update settings before enabling them, and decide which collection is the source of truth for each record.

  • Standard vs. B2B customers. The inbound customer filter splits customers between the standard collections and the B2B collections documented here. Only one of the standard or B2B mappings should apply to any given customer. Enabling both without coordinated filters can create duplicate or conflicting customers.

  • Add vs. Update. The Company and Customer paths are split into Add and Update collections. The external-ID link decides which one applies to a given event; coordinate the two so a given transfer is handled by exactly one of them.

Collision Handling

The integration decides whether an incoming B2B record is new or one it already knows about so updates land on the right record instead of creating duplicates:

  • Companies are matched by name.

  • Customers (company users) are matched by email address.

When a match is found, the record is treated as the same record and the configured collision method for that data type decides the outcome. The selectable methods are:

  • Remap and Link: link the incoming record to the matched record and remap it.

  • Update and Link: update the matched record and keep the link.

  • Update and No Link: update the matched record without establishing a persistent link.

  • Error: stop and raise an error instead of resolving the match automatically.

Review the collision method for the Company and Customer data types so records merge with, or stay separate from, existing records as your workflow expects. A company without a name, or a company user without an email, cannot be matched reliably.

Supported Child Collections

The Company and Customer collections drive their related records through child collections that transfer as part of the parent:

  • BC B2B Company Add TO iPaaS.comBC B2B Company Address Add TO iPaaS.com, BC B2B Company Relationship Add TO iPaaS.com

  • BC B2B Company Update TO iPaaS.comBC B2B Company Address Update TO iPaaS.com, BC B2B Company Relationship Update TO iPaaS.com

  • BC B2B Customer Add TO iPaaS.comBC B2B Customer Relationship Add TO iPaaS.com

  • BC B2B Customer Update TO iPaaS.comBC B2B Customer Relationship Update TO iPaaS.com

The company-to-user relationship is carried through the Company Relationship and Customer Relationship child collections. The company-to-company hierarchy (parent/subsidiary) is carried on the Company record itself.

System Caveats

BigCommerce Caveats

  • B2B Edition required. These collections apply only to BigCommerce B2B Edition. An active B2B Edition app must be installed and configured, and B2B support enabled on the iPaaS.com subscription, before B2B records transfer. See BigCommerce B2B Edition Support.

  • No B2B webhooks. BigCommerce B2B Edition does not send its own webhook notifications to iPaaS.com. Automatic company transfers rely on scheduled polling; company users are shared with the standard customer events or can be polled.

  • Rate limiting. When BigCommerce rate-limits requests, the transfer is automatically rescheduled to resume after the limit window resets. No subscriber action is required.

iPaaS.com Caveats

  • Company name required. A company must have a name. The name is required and is the key iPaaS.com uses to match companies.

  • Email required for customer matching. The email address is the key iPaaS.com uses to match and de-duplicate company users. A company user without an email cannot be matched reliably.

  • Company status translation. The inbound B2B Company Status mapping uses a lookup translation. Review and customize the translation values so BigCommerce company statuses map to the iPaaS.com company statuses your workflow expects.

  • Company relationship model. The company-to-user tie is a relationship between a Company and a Customer, carrying the user's B2B role (Super Admin, Admin, Senior Buyer, or Junior Buyer) — not the Employee data type.

Integration-Specific Caveats

  • Update field preservation. The inbound Company Update and Customer Update collections carry several fields forward from the existing iPaaS.com record rather than overwriting them (for the company: name, email, phone, description, department, fax, URL, account number, tax ID number, and the parent-company link; for the customer: customer number, company, and comment), so an update from BigCommerce does not blank iPaaS.com-owned values.

  • Prerequisite auto-transfer. A company and its B2B users are transferred together: transferring a company auto-transfers its related users, and transferring a user auto-transfers its related company. Subscribers do not pre-sync either side. A failed prerequisite blocks the dependent transfer.

Setup Requirements

Automatic transfers do not run until the corresponding poll events or triggers are configured. All of the setup below is done on the Subscriber Dashboard; see the BigCommerce Installation Instructions for the step-by-step screens.

  • B2B companies. Under Inbound Data Flows, add a poll event that uses the store/company/poll scope with the filter B2B_Company. Choose a polling interval that suits how often your companies change. Company addresses and company relationships transfer as children of the company poll.

  • B2B company users. In most cases the standard BigCommerce customer created and customer updated events are sufficient — enable those under Inbound Data Flows. If you prefer polling, add a poll event that uses the store/customer/poll scope with the filter B2B_User. Either path works; you do not need both.

Integration Flow

Company and its children:

  1. A B2B company poll event fires, or a company is manually synced by its BigCommerce B2B company ID.

  2. The company is matched to an existing iPaaS.com Company on name (see Collision Handling). A match updates the existing Company; no match creates a new one.

  3. The company's addresses are captured through the address child collection and labeled with the company.

  4. The company's relationships to its B2B users are captured through the relationship child collection, each carrying the user's B2B role, and each user is transferred as a prerequisite Customer.

Company user:

  1. A BigCommerce customer created or updated event fires (or a B2B_User poll event), or a user is manually synced by its BigCommerce customer ID.

  2. The inbound filter routes the customer to the B2B path only when it carries a B2B user identifier.

  3. iPaaS.com matches the user to an existing Customer on email address. A match updates the existing Customer; no match creates a new one.

  4. The user's relationship to its company is captured through the customer relationship child collection.

Mappings

Each collection below lists its Mapping Filter (when the collection has one), the iPaaS.com data type it operates on, and its field mapping table. Source and destination field names are shown as they appear in each system. Where an Add and an Update collection are near-identical, they are presented together with any differences noted.

BC B2B Company Add TO iPaaS.com / BC B2B Company Update TO iPaaS.com

iPaaS.com data type: Company

Both collections capture a BigCommerce B2B company into an iPaaS.com Company: Add handles new companies; Update handles changes to a company that already exists in iPaaS.com. Neither collection has a mapping filter, so all companies passed to them are processed.

The Add collection maps the company's core identity and B2B attributes directly from BigCommerce. The Update collection maps the same B2B attributes, and for the core identity fields (name, email, phone, and several others) it carries the existing iPaaS.com value forward rather than overwriting it — so an inbound update does not blank iPaaS.com-owned values. The tables below show the shared B2B-attribute fields, then the direction-specific identity fields.

Shared fields (Add and Update):

Mapping Type

Source Field (BigCommerce)

Destination Field (iPaaS.com Company)

Description

Field

BCGroupName

B2B Group Name

Recommended. The BigCommerce customer group name associated with the company.

Field

CatalogId

B2B Catalog Id

Recommended. The identifier of the catalog assigned to the company.

Field

CatalogName

B2B Catalog Name

Recommended. The name of the catalog assigned to the company.

Lookup Translation

Lookup Translation: BC B2B Company Status To iPaaS

B2B Company Status

Recommended. The company's status, resolved from the BigCommerce status through a lookup translation. Review and customize the translation values for your workflow.

Field

PaymentTermIsEnabled

B2B BC Company Payment Terms Enabled

Recommended. Whether BigCommerce payment terms are enabled for the company.

Field

PaymentTerms

B2B BC Company Payment Terms

Recommended. The BigCommerce payment terms configured for the company.

Lookup Translation Tables

The B2B Company Status mapping resolves the BigCommerce status through the BC B2B Company Status To iPaaS lookup translation. These are subscriber-configurable defaults — review and customize them so BigCommerce company statuses map to the iPaaS.com statuses your workflow expects.

Source Value (BigCommerce)

Destination Value (iPaaS.com)

0

PENDING

1

APPROVED

2

REJECTED

Add — identity fields:

Mapping Type

Source Field (BigCommerce)

Destination Field (iPaaS.com Company)

Description

Field

CompanyName

Name

Required. The company name; iPaaS.com rejects the Company record if it is missing, and the name is the key used to match companies.

Field

CompanyEmail

EmailAddress

Recommended. The company email.

Field

CompanyPhone

PhoneNumber

Recommended. The company phone number.

Update — identity fields (each carries the existing iPaaS.com value forward):

Mapping Type

Source Field (BigCommerce)

Destination Field (iPaaS.com Company)

Description

Dynamic Formula

DestinationValue.Name

Name

Required. Preserves the company's existing iPaaS.com name; a company must have a name.

Dynamic Formula

DestinationValue.EmailAddress

EmailAddress

Recommended. Preserves the existing iPaaS.com email so the company match stays intact.

Dynamic Formula

DestinationValue.PhoneNumber

PhoneNumber

Optional. Preserves the existing iPaaS.com phone number.

Dynamic Formula

DestinationValue.Description

Description

Optional. Preserves the existing iPaaS.com description.

Dynamic Formula

DestinationValue.Department

Department

Optional. Preserves the existing iPaaS.com department.

Dynamic Formula

DestinationValue.FaxNumber

FaxNumber

Optional. Preserves the existing iPaaS.com fax number.

Dynamic Formula

DestinationValue.Url

Url

Optional. Preserves the existing iPaaS.com URL.

Dynamic Formula

DestinationValue.AccountNumber

AccountNumber

Optional. Preserves the existing iPaaS.com account number.

Dynamic Formula

DestinationValue.TaxIdNumber

TaxIdNumber

Optional. Preserves the existing iPaaS.com tax ID number.

Dynamic Formula

DestinationValue.ParentCompanyId

ParentCompanyId

Optional. Preserves the existing iPaaS.com parent-company link, keeping the company hierarchy intact.

BC B2B Company Address Add TO iPaaS.com (child) / BC B2B Company Address Update TO iPaaS.com (child)

iPaaS.com data type: Company Address

These are child collections of the company transfer. Each address is linked to the parent Company and transferred as part of the company; there is no independent sync. Neither collection has a mapping filter, so every address on a transferred company is processed. The Add and Update field tables are identical.

Mapping Type

Source Field (BigCommerce)

Destination Field (iPaaS.com Company Address)

Description

Field

AddressLine1

Address1

Recommended. The primary street line of the company address.

Field

AddressLine2

Address2

Recommended. The secondary street line where present.

Field

City

City

Recommended. The city of the company address.

Dynamic Formula

Parent.CompanyName

Company

Recommended. The company-name label for the address, carried from the parent company record.

Field

CountryName

Country

Recommended. The country name of the company address.

Field

FirstName

FirstName

Recommended. The address contact's first name.

Field

IsBilling

IsPrimaryBilling

Recommended. Whether this is the company's primary billing address.

Field

IsShipping

IsPrimaryShipping

Recommended. Whether this is the company's primary shipping address.

Field

LastName

LastName

Recommended. The address contact's last name.

Field

PhoneNumber

PhoneNumber

Recommended. The address contact's phone number.

Field

ZipCode

PostalCode

Recommended. The postal or ZIP code.

Field

StateName

Region

Recommended. The state or region name.

BC B2B Company Relationship Add TO iPaaS.com (child) / BC B2B Company Relationship Update TO iPaaS.com (child)

iPaaS.com data type: Company Relationship

These are child collections of the company transfer. They link the company to its B2B users — one relationship per user — and carry the user's B2B role. There is no independent sync, and neither collection has a mapping filter. The Add and Update field tables are identical. Each related user is transferred as a prerequisite Customer.

Mapping Type

Source Field (BigCommerce)

Destination Field (iPaaS.com Company Relationship)

Description

Dynamic Formula

return await GetSpaceportIdAsync(Id, "Customer", SpaceportSystemId);

RelatedToId

Required. Resolves and links the iPaaS.com Customer (the B2B user) the company is related to. The user is transferred automatically as a prerequisite; if it cannot be resolved, the user link does not complete.

Dynamic Formula

(see formula below)

Type

Recommended. Records the user's B2B role on the relationship — B2B Super Admin, B2B Admin, B2B Senior Buyer, or B2B Junior Buyer. Any other value leaves the type unset.

Static

"false"

IsPrimary

Recommended. Whether this is the primary relationship; ships as false from the company side.

Field

B2B_FirstName

B2B User First Name

Recommended. The related B2B user's first name, recorded on the relationship for visibility.

Field

B2B_LastName

B2B User Last Name

Recommended. The related B2B user's last name, recorded on the relationship for visibility.

Field

B2B_PhoneNumber

B2B User Phone Number

Recommended. The related B2B user's phone number, recorded on the relationship for visibility.

Field

B2B_Email

B2B User Email

Recommended. The related B2B user's email, recorded on the relationship for visibility.

Type formula (maps the BigCommerce B2B role to the relationship type):

if (B2B_Role == -1)  return "B2B Super Admin";if (B2B_Role == 0)  return "B2B Admin";if (B2B_Role == 1)  return "B2B Senior Buyer";if (B2B_Role == 2)  return "B2B Junior Buyer";return null;

BC B2B Customer Add TO iPaaS.com / BC B2B Customer Update TO iPaaS.com

iPaaS.com data type: Customer

Both collections capture a BigCommerce B2B company user into an iPaaS.com Customer: Add handles new users; Update handles changes to a user that already exists in iPaaS.com. The two share the same filter and the same core fields; the Update collection additionally preserves the customer number, company, and comment from the existing iPaaS.com record.

Mapping Filter

if(B2B_UserIdFromB2B != null)  return true;return false;

Filter Description. A customer is processed here only when it carries a BigCommerce B2B user identifier (B2B_UserIdFromB2B is not null) — that is, only when it is a B2B company user. This is the exact inverse of the standard (non-B2B) Customer collections, which process customers whose B2B user identifier is null. The two filters route each customer to exactly one path. This filter references a custom-field value rather than an environment-specific value, so no placeholder substitution is required.

Shared fields (Add and Update):

Mapping Type

Source Field (BigCommerce)

Destination Field (iPaaS.com Customer)

Description

Field

B2B_Email

EmailAddress

Required. The B2B user's email; the key iPaaS.com matches on to de-duplicate customers (see Collision Handling).

Field

B2B_UserIdFromB2B

B2B_UserIdFromB2B (custom)

Required. The BigCommerce B2B user identifier; marks the Customer as a B2B user and routes it to the B2B path.

Dynamic Formula

B2B_UserIdFromB2B != null ? "true" : "false"

B2B_SendToB2B (custom)

Recommended. Set to true when a B2B user identifier is present; flags the Customer for the outbound B2B path.

Field

B2B_PhoneNumber

B2B_PhoneNumber (custom)

Recommended. The B2B user's phone number, stored as a custom field on the Customer.

Field

B2B_FirstName

FirstName

Recommended. The B2B user's first name.

Field

B2B_LastName

LastName

Recommended. The B2B user's last name.

Add — customer number:

Mapping Type

Source Field (BigCommerce)

Destination Field (iPaaS.com Customer)

Description

Field

Id

CustomerNumber

Recommended. Stores the BigCommerce customer ID on the Customer for visibility and as a fallback match key when no external-ID link yet exists.

Update — preserved fields (carried forward from the existing iPaaS.com record):

Mapping Type

Source Field (BigCommerce)

Destination Field (iPaaS.com Customer)

Description

Dynamic Formula

DestinationValue.CustomerNumber

CustomerNumber

Recommended. Preserves the customer's existing iPaaS.com customer number rather than overwriting it.

Dynamic Formula

DestinationValue.Company

Company

Recommended. Preserves the existing iPaaS.com company value.

Dynamic Formula

DestinationValue.Comment

Comment

Recommended. Preserves the existing iPaaS.com comment value.

BC B2B Customer Relationship Add TO iPaaS.com (child) / BC B2B Customer Relationship Update TO iPaaS.com (child)

iPaaS.com data type: Customer Relationship

These are child collections of the company user transfer. They link the B2B user (a Customer) to the company it belongs to, and carry the user's B2B role. The link is modeled as a relationship between a Customer and a Company — not the Employee data type. There is no independent sync, and neither collection has a mapping filter. The Add and Update field tables are identical.

Mapping Type

Source Field (BigCommerce)

Destination Field (iPaaS.com Customer Relationship)

Description

Dynamic Formula

return await GetSpaceportIdAsync(CompanyId.Split("\|")[0], "Company", SpaceportSystemId);

RelatedToId

Required. Resolves and links the iPaaS.com Company the user belongs to, from the BigCommerce company identifier.

Dynamic Formula

(see formula below)

Type

Recommended. Records the user's B2B role on the relationship — B2B Super Admin, B2B Admin, B2B Senior Buyer, or B2B Junior Buyer.

Static

"True"

IsPrimary

Recommended. Marks this as the user's primary company relationship.

Field

CompanyName

B2B Company Name (custom)

Recommended. The related company's name, recorded on the relationship for visibility.

Type formula (maps the parent user's BigCommerce B2B role to the relationship type):

if (Parent.B2B_Role == -1)  return "B2B Super Admin";if (Parent.B2B_Role == 0)  return "B2B Admin";if (Parent.B2B_Role == 1)  return "B2B Senior Buyer";if (Parent.B2B_Role == 2)  return "B2B Junior Buyer";return null;

Testing and Validation

Test Scenarios

  1. Company create. Create a new B2B company in BigCommerce, run the company poll (or manually sync by its BigCommerce B2B company ID), and verify a Company appears in iPaaS.com with the mapped name, email, phone, status, group, catalog, and payment-terms values, and that its addresses and user relationships are captured.

  2. Company update. Change a field on an existing BigCommerce B2B company and verify the change propagates to the matched iPaaS.com Company, and that iPaaS.com-owned identity fields are preserved.

  3. Company name matching. Transfer a company whose name matches an existing iPaaS.com Company and confirm the existing record is updated rather than a duplicate created, per the configured collision-handling method.

  4. Company user. Create a B2B company user in BigCommerce and verify a Customer appears in iPaaS.com routed to the B2B path (carrying its B2B user identifier), matched on email, and linked to its company through a relationship carrying the correct B2B role.

  5. Company hierarchy. Confirm a company that is a department or subsidiary of another company carries its parent-company link, and that its user relationships reflect the expected roles.

Validation Checklist

  • B2B support is enabled on the subscription, and the required poll events and triggers are configured before expecting automatic transfers.

  • Only one of the standard or B2B customer mappings applies to any given customer.

  • The BC B2B Company Status To iPaaS lookup translation has been reviewed so BigCommerce statuses map to the intended iPaaS.com statuses.

  • The correct collision-handling method is selected for the Company and Customer data types.

Additional Notes

  • Delete these collections if you are not using B2B Edition. The B2B company, company address, company relationship, and B2B customer collections apply only to BigCommerce B2B Edition and can be removed on a standard store.

  • Outbound direction. Writing iPaaS.com companies and company users back to BigCommerce B2B Edition is documented separately in the companion iPaaS.com to BigCommerce B2B Company and Customer Mapping Documentation.

  • B2B quotes. B2B quotes transfer to iPaaS.com through their own collections and are out of scope for this article; see BigCommerce B2B Edition Support.

Related Documents

Did this answer your question?