Summary
Gift Card records can be transferred from Shopify Plus to iPaaS through API-based synchronization. This collection supports the Add/Update sync type, ensuring that Shopify-issued gift cards are represented within iPaaS for reporting and downstream business processes.
Field Constraints
Number: Derived from Shopify Id, not the gift card code.
Balance: Numeric, cannot be modified by iPaaS.
Mapping Collection Status
Status: Enabled
Trigger Events: Gift Card Add/Update in Shopify
Id Format
Gift cards are identified in iPaaS by the Shopify Gift Card Id. The actual Gift Card Code is never exposed and cannot be retrieved.
System Caveats
iPaaS Caveats
Gift card data is read-only, representing Shopify state.
Cannot be used for issuing or adjusting balances.
Shopify Caveats
Gift Card Codes are private and never exposed via API.
Adjustments (balance changes) cannot be pushed from iPaaS into Shopify.
Setup Requirements
iPaaS Configuration
Enable Shopify Plus Gift Card Add/ Update To iPaaS mapping collection.
Shopify Plus Configuration
In the integration settings, enterthe 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: read_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
Shopify Plus gift card data is retrieved via the Gift Cards API.
Mapping transforms Shopify fields into the iPaaS Gift Card schema.
Gift cards are created/updated in iPaaS for reporting and downstream use
Mappings
Decription
Disable this mapping collection if you are not using Shopify PLUS. Gift cards transferred from Shopify will only represent Shopify activity. Adjustments CANNOT be transferred to Shopify from iPaaS due to Shopify API limitations. Shopify Gift Card Codes cannot be accessed outside of Shopify.
Shopify Gift Card To iPaaS (Parent)
Mapping Type | Source Field (Shopify) | Destination Field (iPaaS) | Description |
Field | Id | Number | Required |
Field | Description | Note | Recommended |
Field | Balance | Balance | Required |
Lookup Translation | Status | This lookup translation calculate Expire Date or Disable Date of Gift Cards and convert to iPaaS Gift Card Status. | |
Dynamic Formula |
| CustomerId | The GetSpaceportId method returns the iPaaS.com Customer ID based on the Shopify Customer ID linked to the current subscription. |
Dynamic Formula |
| Originating_SystemId |
|
Field | ExpiresOn | ExpirationDate | Optional |
Field | InitialValue | OriginalAmount | Optional |
Static | Gift Card | Type | Static field to identify record type. |
Lookup Translation
Shopify Gift Card Status To iPaaS
Source Field (Shopify) | Destination Field (iPaaS) |
| Void |
| Expired |
| Active |
| Active |
Error Handling
Invalid Expiration Date: Sync fails if the date is invalid.
Missing Balance: Required field cannot be null.
Testing & Validation
Test Scenarios
Gift Card Sync: Shopify gift card appears in iPaaS with balance and metadata.
Status Mapping: Status values translate correctly from Shopify to iPaaS.
Customer Linkage: Gift card associates with the correct customer in iPaaS.
Validation Rules
Number: Must be mapped from Shopify Id.
Balance: Must be numeric.
Status: Must map correctly via lookup translation.
Validation Checklist
Gift card records are visible in iPaaS.
Balance values match Shopify.
Status translation works as expected.
Expiration and original amount are captured correctly.
Additional Notes
Adjustments and issuance must always occur in Shopify Plus.