Skip to main content

BigCommerce to iPaaS.com Gift Card Mapping Documentation

How BigCommerce gift cards and their issuance activity transfer into iPaaS.com — field mappings, status lookup translation, recipient tracking, and auto-creation of gift cards during order preprocessing.

Summary

BigCommerce gift cards and their issuance activity transfer to iPaaS.com. Inbound transfers capture BigCommerce gift cards, and the issuance activity on them, into iPaaS.com Gift Card and Gift Card Activity records. Transfers run automatically from subscribed webhook events or on demand from the iPaaS.com Manual Sync page. These flows let iPaaS.com merchants accept gift cards in an omnichannel fashion, so a balance issued in BigCommerce becomes visible in iPaaS.com.

Writing iPaaS.com gift cards out to BigCommerce is covered by the companion iPaaS.com to BigCommerce Gift Card Mapping Documentation.

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

Add/Update BigCommerce Gift Card TO iPaaS.com

Gift Card

BigCommerce to iPaaS.com

Add/Update BigCommerce Gift Card Activity TO iPaaS.com (child)

Gift Card Activity

BigCommerce to iPaaS.com

Gift cards are matched on their code (ID) only — there is no additional pre-processing to reconcile them.

ID Format

Manual Sync ID Format

  • Gift Card: enter the BigCommerce gift-card ID — the numeric identifier BigCommerce assigns to the gift card. Example: 88.

The gift card's issuance activity has no independent Manual Sync entry point. Sync the parent gift card by its BigCommerce gift-card ID and the activity transfers together.

External ID Format

After a successful transfer, iPaaS.com records the BigCommerce gift-card ID as the external ID on the iPaaS.com Gift Card. Because gift cards are matched on their code, the Gift Card's Number field also provides a stable identifier. The external-ID record is the primary match that routes later transfers of the same card to an update rather than creating a duplicate.

Deleted Record Support

Inbound gift-card delete is supported. BigCommerce publishes a gift-card deleted event that iPaaS.com can act on to remove the linked Gift Card. Confirm the delete behavior against your business rules in a staging environment before relying on it in production. Gift Card Activity has no independent delete; it is tied to the lifecycle of its parent card.

Custom Field Support

BigCommerce does not expose custom fields for the gift-card data type, and no iPaaS.com custom fields are created by default for gift cards or gift-card activity. No custom-field configuration is required to run these collections.

Mapping Collection Status

All collections in this article ship Enabled. Trigger events:

  • Gift Card and Gift Card Activity: BigCommerce gift card created and gift card updated events. The activity child has no separate trigger — it transfers as part of the parent gift card.

The parent Gift Card collection has no mapping filter, so every gift card selected by Manual Sync or a subscribed event is processed. The Gift Card Activity child collection has a filter that records issuance activity only once per card (see the Mappings section). Automatic transfers do not run until the corresponding events are subscribed — see Setup Requirements.

Duplicate or Conflicting Mappings

Gift cards do not use email-based collision handling. The inbound Gift Card collection matches on the gift-card code through the external-ID link, and the Gift Card Activity child is controlled by its own filter (one issuance activity per card), so a card is captured once and its issuance recorded once.

Supported Child Collections

The inbound Gift Card collection drives the card's issuance activity through a child collection that transfers as part of the card:

  • Add/Update BigCommerce Gift Card TO iPaaS.comAdd/Update BigCommerce Gift Card Activity TO iPaaS.com

Gift Card Activity is a leaf collection with no children of its own.

System Caveats

BigCommerce Caveats

  • Matched by code. Gift cards are matched on their code (ID) only, with no additional pre-processing to reconcile them.

  • 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

  • Status translation. The Status mapping uses a lookup translation. Review and customize the translation values so each BigCommerce gift-card status maps to the iPaaS.com status your workflow expects.

  • Optional links resolve when present. The originating customer and originating order links are populated only when those records are already linked in iPaaS.com; otherwise they are left unset and the gift card still transfers.

  • Recipient tracking for purchase-for-another. These collections support the scenario where one person purchases a gift card for someone else. The purchasing customer is tracked through the linked originating customer; the recipient is tracked through the recipient name and email. Both sides of the gift are carried through the transfer.

  • Parent required (activity). The activity is created only as part of its parent Gift Card. If the parent card does not transfer, the activity is not created.

Integration-Specific Caveats

  • Gift-card auto-creation during order preprocessing. Gift cards can be created automatically during order preprocessing. When a BigCommerce order contains gift-certificate line items, the corresponding gift cards are created as a prerequisite of the order transfer, so subscribers do not need to pre-sync them. This behavior can be turned off with the Disable Gift Card Auto-Creation During Order To iPaaS Preprocessing subscription setting.

  • Issuance activity only. The activity collection records the initial issuance of a gift card. Later balance movements (redemptions, adjustments) are not recorded by this collection.

Setup Requirements

Automatic transfers do not run until the corresponding events are subscribed. Configure the BigCommerce gift-card webhooks and enable the corresponding events (gift card created and gift card updated) under Inbound Data Flows in the subscription configuration. The gift-card activity child transfers with the parent card and needs no separate subscription. See the Installation Instructions for the webhook setup steps.

Integration Flow

Gift card and its activity:

  1. A BigCommerce gift card created or updated event fires, or a gift card is manually synced by its BigCommerce gift-card ID.

  2. The integration reads the full BigCommerce gift card and maps the header fields to the iPaaS.com Gift Card, matching on the gift-card code through the external-ID link. A match updates the existing Gift Card; no match creates a new one.

  3. The card's issuance activity is captured through the child activity collection and linked to the Gift Card — but only when the card does not already have activity recorded.

  4. Gift cards may also be auto-created ahead of an order transfer: when a BigCommerce order contains gift-certificate line items, the corresponding gift cards are created during order preprocessing unless the Disable Gift Card Auto-Creation During Order To iPaaS Preprocessing setting is turned on.

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.

Add/Update BigCommerce Gift Card TO iPaaS.com

iPaaS.com data type: Gift Card

Captures a BigCommerce gift card into an iPaaS.com Gift Card, creating the record when it does not yet exist and updating it when it does. It maps the card number, type, balance, status, purchase date, original amount, expiry date, the recipient, the originating system, and links to the originating customer and order, and it drives the transfer of the card's activity through its child collection. This collection has no mapping filter, so every gift card selected by Manual Sync or a subscribed event is processed.

Mapping Type

Source Field (BigCommerce)

Destination Field (iPaaS.com Gift Card)

Description

Field

Code

Number

Required. Stores the BigCommerce gift-card code on the iPaaS.com Gift Card. It identifies the card, and gift cards are matched on this code.

Static

"Gift Card"

Type

Required. A fixed value that sets how the card is handled downstream. Allowed values are Gift Card and Store Credit; the value chosen affects how the card is presented to other systems, so confirm it is correct for your business before enabling this collection.

Field

Balance

Balance

Recommended. The card's current spendable balance.

Lookup

Lookup Translation: BC Gift Card Status To iPaaS

Status

Recommended. Translates the BigCommerce gift-card status into the iPaaS.com gift-card status. Review and customize the translation values so each BigCommerce status maps to the status your workflow expects.

Dynamic Formula

DateOnly(PurchaseDate)

PurchaseDate

Recommended. Records the card's purchase date, normalized to a date-only value.

Dynamic Formula

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

CustomerId

Recommended. Links the gift card to its originating iPaaS.com Customer when that customer is already linked; otherwise it is left unset.

Dynamic Formula

return await GetSpaceportIdAsync(OrderId, "Transaction", SpaceportSystemId);

TransactionId

Recommended. Links the gift card to its originating iPaaS.com order (Transaction) when that order is already linked; otherwise it is left unset.

Field

ToName

ReceivingCustomer

Recommended. Records the recipient customer's name. For reference only; it is not linked to any existing customer.

Field

ToEmail

ReceivingCustomerEmail

Recommended. Records the recipient customer's email address.

Dynamic Formula

SpaceportSystemId

Originating_SystemId

Required. Records which system the gift card originated in — the BigCommerce system this subscription is connected to.

Dynamic Formula

DateOnly(ExpiryDate)

ExpirationDate

Recommended. Records the card's expiry date, normalized to a date-only value.

Field

Amount

OriginalAmount

Recommended. Records the card's original (starting) amount; the BigCommerce Amount field is the card's original amount.

Status Lookup Translation

The Status mapping uses the BC Gift Card Status To iPaaS lookup translation. Review and customize the translation values so each BigCommerce gift-card status maps to the iPaaS.com status your workflow expects.

Source Value (BigCommerce)

Destination Value (iPaaS.com)

Notes

active

Active

disabled

Void

pending

Pending

(expired, past expiry date)

Expired

condition-based entry

(zero balance or expired)

Redeemed

condition-based entry

Add/Update BigCommerce Gift Card Activity TO iPaaS.com

iPaaS.com data type: Gift Card Activity

Captures the issuance activity for a BigCommerce gift card into an iPaaS.com Gift Card Activity record, linked to its parent Gift Card. This is a child collection of Add/Update BigCommerce Gift Card TO iPaaS.com and transfers as part of the card; it is not synced on its own.

Mapping Filter

int parent = Parent.Id;var result = await GiftCardHasActivityAsync(parent);if (result == true){return false;} else {return true;}

Filter Description. The filter records an issuance activity only when the parent gift card has no existing activity. It checks whether the parent card (Parent.Id) already has activity: when it does (result == true), the record is skipped (return false); when it does not, a new activity record is created (return true). This ensures each card records its issuance once and is not duplicated on later updates of the parent card. This filter contains no environment-specific value, so no placeholder substitution is required.

Mapping Type

Source Field (BigCommerce)

Destination Field (iPaaS.com Gift Card Activity)

Description

Dynamic Formula

DateOnly(Parent.PurchaseDate)

Timestamp

Recommended. Records the activity date from the parent gift card's purchase date, normalized to a date-only value.

Dynamic Formula

Parent.OrderId

TransactionReferenceId

Recommended. References the parent gift card's originating order, providing a link back to the transaction that issued the card.

Dynamic Formula

Parent.Amount

Amount

Required. Records the activity amount from the parent gift card's amount.

Static

"Issue"

ActivityType

Required. A fixed value of Issue. Every record created here records the issuance of the gift card.

Testing and Validation

Test Scenarios

  1. Gift card create. Create a new gift card in BigCommerce and verify a Gift Card record appears in iPaaS.com with the mapped number, type, balance, status, purchase date, original amount, expiry date, and recipient, and that an issuance activity record is created against it.

  2. Gift card update. Change a field on an existing BigCommerce gift card and verify the change propagates to the matched iPaaS.com Gift Card, and confirm a second issuance activity is not created (the activity filter records issuance once per card).

  3. Recipient tracking. Purchase a gift card in BigCommerce for a different recipient and verify the recipient name and email are captured on the iPaaS.com Gift Card, distinct from the originating (purchasing) customer link.

  4. Status translation. Confirm each BigCommerce gift-card status resolves to the intended iPaaS.com status, adjusting the lookup translation values as needed.

  5. Auto-creation during order preprocessing. Transfer a BigCommerce order containing gift-certificate line items and confirm the corresponding gift cards are auto-created; then enable Disable Gift Card Auto-Creation During Order To iPaaS Preprocessing and confirm they are no longer auto-created.

  6. Delete. Delete a gift card in BigCommerce and confirm the delete behaves as your business rules expect on the linked iPaaS.com Gift Card.

Validation Checklist

  • The Type static value (Gift Card or Store Credit) is correct for your business before enabling the inbound collection.

  • The status lookup translation has been reviewed so each status maps to the intended value.

  • The Disable Gift Card Auto-Creation During Order To iPaaS Preprocessing setting reflects whether you want gift cards auto-created during order preprocessing.

  • Delete behavior has been confirmed against your business rules in a staging environment.

Additional Notes

  • Matching. Gift cards are matched on their code (ID) only, with no additional pre-processing to reconcile them.

  • Issuance activity only. The activity collection records the initial issuance of a gift card. Later balance movements (redemptions, adjustments) are not recorded by this collection.

  • Purchase-for-another. The inbound flow records the originating (purchasing) customer link and the recipient separately, so a gift card bought by one person for another carries both sets of details.

  • Outbound direction. Writing iPaaS.com gift cards out to BigCommerce is documented separately in the companion iPaaS.com to BigCommerce Gift Card Mapping Documentation.

Related Documents

Did this answer your question?