Summary
Shopify Plus Gift Card records can be created in Shopify from iPaaS Gift Card data through API-based synchronization. This integration supports Add Only sync type, ensuring that new gift cards are created in Shopify. Card balances cannot be updated after they are created. This mapping should only be used for one-time transfers when introducing existing gift cards into Shopify Plus.
Field Constraints
Code: Must be unique in Shopify. Once created, it cannot be changed.
Balance: Cannot be updated after card creation (initial balance is fixed).
ExpirationDate: Optional; must be in a valid ISO date format if provided.
Mapping Collection Status
Status: Enabled
Trigger Events: Gift Card Add in iPaaS
Id Format
Gift cards are uniquely identified by their Code in Shopify. Ensure each card code in iPaaS is unique before transfer.
Duplication or Conflicting Collections
This is the only active mapping collection for Gift Card sync. No other overlapping Gift Card-to-Gift Card collections exist.
System Caveats
iPaaS Caveats
Requires valid OriginalAmount and Code.
Gift card balance cannot be updated once synced.
Shopify Caveats
Only available on Shopify Plus plans.
Balances cannot be updated; only initial value is supported.
Gift cards cannot be transferred across stores.
Setup Requirements
iPaaS Configuration
Enable Shopify Plus Gift Card Add Only From iPaaS mapping collection.
Ensure mapping filter is set to 1 == 1.
Shopify Plus Configuration
In the integration settings, enter the following correctly:
OAuth URL Template:
https://{API Store}.myshopify.com/admin/oauth/authorize?client_id={SystemTypeVersion:Client_Id}&scope={SystemTypeVersion:Scope}&redirect_uri={SystemTypeVersion:RedirectUrl}&state={iPaaSState}
OAuth Identifier Field: timestamp
OAuth Success Callback Field: code
Shopify Store Credentials
Client_Secret: Secret saved when creating your Shopify store
Scope: write_gift_cards Cards
RedirectUrl:
https://portal.ipaas.com/Gift Card/subscription-mgmt/subscriptions/authorization/app
Authentication & Security
OAuth 2.0 Token: Used for Shopify API authentication.
Integration Flow
iPaaS initiates the process to send Gift Card data.
Mapping transforms iPaaS fields into the Shopify Plus Gift Card schema.
A Gift Card is created in Shopify with a specified code, initial value, and optional expiration.
Gift Card cannot be updated after creation—only redeemed.
Mappings
Mapping filter
1==1
Description
Disable this mapping if you are not using Shopify Plus. Card balances cannot be updated! This should only be used for one-time transfers.
Shopify Gift Card From iPaaS (Parent)
Mapping Type | Source Field (iPaaS) | Destination Field (Shopify) | Description |
Field | Description | Note | Required |
Field | OriginalAmount | InitialValue | Required |
Dynamic Formula |
| CustomerId | This conversion function retrieves the Shopify Customer ID using the iPaaS.com Customer ID. |
Field | ExpirationDate | ExpiresOn | Recommended |
Field | PurchaseDate | CreatedAt | Recommended |
Field | Number | Code | Required |
Field | Balance | Balance | Required |
Error Handling
Duplicate Code: Shopify rejects card creation if the code already exists.
Invalid Expiration Date: Date must be a valid ISO format.
Non-Shopify Plus Store: API rejects calls if the store is not on the Plus plan.
Testing & Validation
Test Scenarios
Gift Card Add: New iPaaS Gift Card creates a Shopify Gift Card successfully.
Gift Card Update: Existing Shopify Gift Card updates correctly by Email match.
Address Add/Update: Address from iPaaS maps to Shopify with province code transformation.
Validation Rules
Code: Must be unique per store.
OriginalAmount: Required and must be a positive number.
Balance: Must equal OriginalAmount at creation.
Validation Checklist
Gift card created in Shopify Plus with the correct initial value.
Gift card linked to the customer if CustomerId is provided.
The gift card code is unique and can be used in Shopify checkout.
Additional Notes
This flow is Add Only; no updates or deletes are supported.
Use this mapping strictly for initial data transfer when onboarding to Shopify Plus.
Once migrated, all gift card management must be handled within Shopify Plus.