Skip to main content

iPaaS.com to Shopify Gift Card Mapping Documentation

Create Shopify gift cards from iPaaS gift card data

iPaaS.com to Shopify Gift Card Mapping Documentation

Shopify Plus gift cards can be created in Shopify from iPaaS.com gift card data through API-based synchronization. The relevant collection is Add Shopify Plus Gift Card FROM iPaaS.com, which supports the Add sync type only. It is intended strictly for one-time data transfers — for example, seeding existing gift cards into a new Shopify Plus store. Card balances cannot be updated after a gift card is created, so this collection never updates gift cards; it only adds them.

ID Format

Gift cards are uniquely identified by their Code in Shopify. Ensure each gift card Code (sourced from the iPaaS.com gift card Number) is unique before the transfer. Once created, a gift card Code cannot be changed.

Deleted Record Support

This collection does not delete gift cards. It is add-only; once a gift card is created in Shopify, manage or remove it within Shopify Plus.

Mapping Collection Status

  • Status: Disabled by default. The mapping filter 1 == 0 blocks all records.

  • Trigger: Outbound. For a one-time migration, change the filter to 1 == 1, run the transfer (or run via Manual Sync), then disable the collection again.

Duplicate or Conflicting Mappings

The opposite-direction collection Add/Update Shopify Plus Gift Card TO iPaaS.com reads Shopify gift cards into iPaaS.com. This FROM-iPaaS.com collection writes new gift cards to Shopify. Balances cannot round-trip because Shopify gift-card balances are immutable after creation. No other overlapping gift-card-to-gift-card collections exist.

Supported Child Collections

None. Add Shopify Plus Gift Card FROM iPaaS.com is a standalone collection with no child collections.

System Caveats

iPaaS.com Caveats

  • Requires a valid OriginalAmount and Code.

  • The gift card balance cannot be updated once the card is created in Shopify.

Shopify Caveats

  • Gift cards are available on all Shopify plans, but non-Plus plans support more limited gift card functionality than Shopify Plus; this collection targets the Shopify Plus gift card experience (and ships disabled by default — see Mapping Collection Status). The Gift Card API also requires the write_gift_cards access scope, which Shopify grants on request.

  • Balances cannot be updated; only the initial value is supported.

  • Gift cards cannot be transferred across stores.

  • Shopify rejects creation if the Code already exists.

Setup Requirements

iPaaS.com Configuration

  • Enable the Add Shopify Plus Gift Card FROM iPaaS.com mapping collection by changing its filter from 1 == 0 to 1 == 1 for the duration of the migration.

Shopify Plus Configuration

  • The Shopify connection must be authorized with gift-card write access (write_gift_cards).

Integration Flow

  1. iPaaS.com initiates the transfer of gift card data (via Manual Sync or an enabled outbound Create trigger).

  2. The mapping transforms iPaaS.com fields into the Shopify Plus gift card schema.

  3. A gift card is created in Shopify with the specified code, initial value, and optional expiration.

  4. The gift card cannot be updated after creation — only redeemed.

Mappings

Add Shopify Plus Gift Card FROM iPaaS.com (284598)

Mapping Type

Source Field (iPaaS.com)

Destination Field (Shopify)

Requirement / Note

Field

Description

Note

Recommended.

Field

OriginalAmount

InitialValue

Required. Fixed initial balance.

Dynamic Formula

GetExternalId(CustomerId, "customer", SpaceportSystemId)

CustomerId

Recommended. Resolves the Shopify customer id from the iPaaS.com customer id.

Field

ExpirationDate

ExpiresOn

Recommended. Must be a valid date if provided.

Field

PurchaseDate

CreatedAt

Recommended.

Field

Number

Code

Required. Must be unique per Shopify store; immutable after creation.

Field

Balance

Balance

Required. Should equal OriginalAmount at creation.

Error Handling

  • Duplicate code: Shopify rejects creation if the Code already exists.

  • Invalid expiration date: the date must be a valid date.

  • Missing gift-card scope: the Gift Card API rejects calls if the connection lacks write_gift_cards (request the scope from Shopify Support).

Testing & Validation

  • Gift card add: a new iPaaS.com gift card creates a Shopify gift card successfully.

  • Customer linkage: the gift card links to the Shopify customer when CustomerId is provided.

  • Validation rules: Code unique per store; OriginalAmount required and positive; Balance equals OriginalAmount at creation.

  • Validation checklist: gift card created in Shopify Plus with the correct initial value; linked to the customer if provided; code unique and usable at 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. After migration, manage all gift cards within Shopify Plus.

Related Documents

Did this answer your question?