Skip to main content

Square to iPaaS.com Customer Mapping Documentation

How Square customer and customer address records transfer to iPaaS.com — ID formats, field mappings, prerequisite email linking, caveats, and testing.

Summary

Square customers can be transferred to iPaaS.com so that each Square customer is recorded as an iPaaS.com Customer, carrying the customer's name, email address, company, note, phone number, and the Square created and updated timestamps. The customer's address is imported by the child collection as part of the same transfer. A customer is recorded on demand from the Manual Sync page, or automatically as a prerequisite when a Square order that references the customer is transferred.

ID Format

  • Manual Sync ID: the Square customer identifier — the id Square assigns to the customer profile, an uppercase alphanumeric string (for example, JDKYHBWT1D4F8MFH63DBMEN8Y4) — entered on the iPaaS.com Manual Sync page.

  • External ID saved after sync: on the first successful transfer, iPaaS.com saves the Square customer identifier as the external ID on a dedicated external-ID record. That external-ID record is the primary match used to route later updates to the same iPaaS.com Customer. The Square identifier is also written into the iPaaS.com CustomerNumber field, which provides visibility on the record and serves as a fallback match key when no external-ID record exists yet. Remapping CustomerNumber to a different source disables the fallback match for any customers already created.

Deleted Record Support

Outbound customer deletion is not supported. The Square Customer model's Delete operation is not implemented, delete mappings are not included in the default templates, and deleting a customer in Square does not remove or deactivate the corresponding iPaaS.com Customer.

Mapping Collection Status

  • Status: Enabled. The parent Customer collection carries no mapping filter, so every customer presented to it is processed. The child Customer Address collection carries a filter that limits it to the customer's own address (see Mappings).

  • Trigger Events: this collection has no standalone Square webhook of its own. A Square customer is recorded automatically as a prerequisite when a Square order that references that customer is transferred to iPaaS.com, and on demand from the iPaaS.com Manual Sync page.

Duplicate or Conflicting Mappings

Duplicate Matching

To prevent duplicate customers, the integration links each Square customer to its iPaaS.com counterpart in two ways: by the external-ID record described under ID Format, and — when a customer has not yet been linked — by matching on email address. When a Square customer that has both an id and an email address is transferred and no external-ID record yet exists, the integration searches iPaaS.com for a customer with the same email address and links the two records instead of creating a new customer. After the first successful transfer, the external-ID record takes over as the primary match.

Unmapped Field Overwrite Risk

iPaaS.com applies a full-record update when it revises an existing record.

  • Customer: every standard customer field that Square can populate — CustomerNumber, EmailAddress, FirstName, LastName, Company, and Comment — is mapped in this collection, so no standard customer field is at risk of being cleared on update. Square remains the source of truth for the mapped fields.

  • Customer Address: the iPaaS.com address fields Address3, Company, FirstName, LastName, PhoneNumber, Type, IsPrimaryBilling, and IsPrimaryShipping are not mapped and will be cleared on each transfer unless mapped to preserve them. Square's customer address does not supply these values, so if subscribers or their MiSP set any of them on the iPaaS.com address by other means, add a Dynamic Formula mapping using the DestinationValue function to carry the existing value forward (for example, map DestinationValue.Type to the Type field).

Supported Child Collections

Parent Collection: Add/Update Square Customer TO iPaaS.com.

  • Add/Update Square Customer Address TO iPaaS.com: records the customer's address (street lines, city, region, postal code, country) in iPaaS.com. It is transferred as part of the parent customer and is linked to the same iPaaS.com Customer. The PreventDuplicate flag is set so repeated transfers update the existing address rather than adding a second one.

System Caveats

Square Caveats

  • Email address is required by iPaaS.com but optional in Square. Square allows a customer profile with no email address; iPaaS.com does not. A Square customer without an email address cannot be recorded, so confirm your Square customers carry an email address before relying on automatic transfers.

  • Phone number and company are optional and are carried across only when present on the Square customer.

  • Country is a two-letter country code as recorded by Square, and is stored as-is.

  • Only the customer's own address is captured. Square records a single address on the customer profile; that is the address transferred by the child collection.

  • Rate limiting: if Square temporarily limits the number of requests, the transfer is automatically rescheduled to resume after the limit resets. No subscriber action is required.

iPaaS.com Caveats

  • The customer is matched by its external-ID record first. After the first successful transfer, later changes to the same Square customer update the existing iPaaS.com Customer rather than creating a new one.

  • Updates overwrite mapped fields from the current Square values on every transfer, so Square is the source of truth for the mapped fields.

  • The parent customer is recorded before or together with its address. The address is attached to the iPaaS.com Customer created or updated by the parent collection.

Setup Requirements

iPaaS.com Configuration

The Customer collection has no separate inbound event to enable. Customers are recorded automatically as a prerequisite of the Square order transfer — see the Square Order Mapping Documentation — and on demand from the Manual Sync page using the Square customer identifier. No customer-specific Inbound Data Flows step is required.

Square Configuration

The Square connection must be authorized for the integration. The Square-side webhook registration used to drive automatic order (and therefore customer) transfers is covered in the Square Installation Instructions.

Integration Flow

  1. A Square customer is presented to the integration — entered on the iPaaS.com Manual Sync page as the Square customer identifier, or retrieved automatically when a Square order that references the customer is transferred.

  2. When the customer has both an id and an email address and is not yet linked to iPaaS.com, the integration searches iPaaS.com for a customer with the same email address. If one is found, it links the two records so the transfer updates that customer instead of creating a duplicate; if the link cannot be completed, the transfer records a warning in the error log (see Error Handling).

  3. The customer is created or updated in iPaaS.com from the mapped fields, and the Square customer identifier is saved as the external-ID link.

  4. The child address collection writes the customer's address when the parent Square customer has an address.

Mappings

Add/Update Square Customer TO iPaaS.com (Parent)

iPaaS.com data type: Customer

Mapping Type

Source (Square)

Destination (iPaaS.com)

Description

Field

Id

CustomerNumber

Required. Carries the Square customer identifier; anchors the record and enables the fallback match (see ID Format).

Field

EmailAddress

EmailAddress

Required. iPaaS.com will not record a customer without an email address, and the value is used for duplicate matching.

Field

GivenName

FirstName

Recommended so records are complete and searchable.

Field

FamilyName

LastName

Recommended so records are complete and searchable.

Field

CompanyName

Company

Optional. Carried across when present on the Square customer.

Field

Note

Comment

Optional. The free-text note on the Square customer profile.

Field

PhoneNumber

Phone Number

Optional. Stored exactly as it appears on the Square profile.

Field

CreatedAt

CreatedAt

Optional. The timestamp the customer was created in Square; set by Square and unchanged on later updates.

Field

UpdatedAt

UpdatedAt

Optional. The timestamp of the customer's most recent change in Square; maintained by Square.

Add/Update Square Customer Address TO iPaaS.com (Child)

iPaaS.com data type: Customer Address

Mapping Filter

Parent.Address != null && SourceTypeName == "ParentOnly"

Filter Description. The address is written only when the parent Square customer has an address (Parent.Address != null) and only for the customer-level address (SourceTypeName == "ParentOnly"). If the parent customer has no address, or the record is not the parent-level address, the collection is skipped without raising an error, so exactly one address is recorded per customer.

Mapping Type

Source (Square)

Destination (iPaaS.com)

Description

Dynamic Formula

Parent.CustomerAddress_AddressLine1

Address1

Recommended. The first address line from the parent Square customer's address.

Dynamic Formula

Parent.CustomerAddress_AddressLine2

Address2

Optional. The second address line, when present.

Dynamic Formula

Parent.CustomerAddress_Locality

City

Recommended. The locality (city) from the parent Square customer's address.

Dynamic Formula

Parent.CustomerAddress_AdministrativeDistrictLevel1

Region

Recommended. The administrative district (state or province).

Dynamic Formula

Parent.CustomerAddress_PostalCode

PostalCode

Recommended. The postal code from the parent Square customer's address.

Dynamic Formula

Parent.CustomerAddress_Country

Country

Recommended. The country, recorded by Square as a two-letter country code and stored as-is.

Static

true

PreventDuplicate

Control setting. Set to true so repeated transfers update the existing address instead of adding a duplicate.

Error Handling

  • Duplicate-link warning (Customer): when the integration finds an existing iPaaS.com customer by email address but cannot complete the external-ID link, it records a warning in the error log noting that duplicate customer records may result. Verify that the Square customer's email address is not shared by more than one iPaaS.com customer. See the Square Error Messages article for the full message text and resolution steps.

Testing & Validation

  • Record a Square customer that has an email address and confirm it appears in iPaaS.com with the correct CustomerNumber, name, email address, and note.

  • Confirm the Square customer identifier is saved as the external ID, and that re-syncing the same customer updates the existing iPaaS.com Customer rather than creating a duplicate.

  • Attempt to record a Square customer that has no email address and confirm the transfer does not create a customer.

  • Record a customer from the Manual Sync page using the Square customer identifier and confirm success.

  • Confirm the child address imports with the correct region, postal code, and two-letter country code, and that re-imports do not create a duplicate address.

Additional Notes

  • Deletion is out of scope. Deleting a customer or removing an address in Square does not remove the corresponding iPaaS.com Customer or address.

Related Documents

Did this answer your question?