The default configuration for a gift card product page managed by the Loopz Gift Cards app will add a button below the "Add to Cart" button, that when clicked, opens the gift card customization popup where a customer can configure their gift card. Once the gift card is configured, it's added to the cart and line item properties are added to the cart line item containing the gift card product with the details of the customer's gift card configuration. Loopz Gift Cards used those properties to issue the gift card one the order is placed.
This article details those line item properties so you can create a custom form embedded in the gift card product page to capture the details required to customize the gift card.
To add a form to the gift card product page use the Shopify Forms app or a third party form app. Configure the form the capture the recipient name and email, optionally the sender name and email and a toggle to select between instant and scheduled delivery of the gift card. The scheduled delivery option should display a date time picker component to select the date and time when the gift card should be delivered. The output of the form needs to be mapped to the line item properties described below.
The following line item properties can be added to the line item containing the gift card product. When these line item properties are present, Loopz Gift Cards will use them when issuing a new gift card. Otherwise details from the Shopify order are used.
Recipient
This line item property's value contains the name and email of the recipient of the gift card. The name and email are separated by a '|' character. If this property is not present, the name and email address of the Shopify order's customer are used.
Sender
The name and email of the sender of the gift card. This property can be omitted. When present, the order confirmation email of the gift card purchase is sent to their email address.
Delivery
Details of when to deliver the gift card. Either 'Instant' for immediate delivery of the gift card to the recipient or 'Scheduled for {date time}'. The format of the date time string is shown in the table below.
_cardDesignId
This property contains the ID of the card design created in your gift card program on the Loopz dashboard. You can get the ID's of all your card design from the API on the dashboard. You can also choose to use the "Variant Images" option in the Gift Card Product screen on the dashboard. This will create an additional variant on the gift card product for each gift amount + card design in your gift card program that a customer can select on the product page.
_message
A personal message added by the customer that is used in the gift card email sent to the gift recipient. This property is optional.
Property Name | Example |
Recipient | John Doe | [email protected] |
Sender | Jane Doe | [email protected] |
Delivery |
|
Property names that start with a '_' should not be shown to the customer in the cart or checkout page. Shopify's default themes will hide properties that start with a '_' in the cart and checkout page. If you're using a custom theme, you might need to add code to your theme to exclude those properties from being shown.
For non-english stores, we also support the following languages for the publicly visible property names that you can use.
English | French |
Recipient | Destinataire |
Sender | Expéditeur |
Delivery | Livraison |
Instant | Instant |
Scheduled for | Prévu pour |
English | German |
Recipient | Empfänger |
Sender | Absender |
Delivery | Lieferung |
Instant | Sofortig |
Scheduled for | Eingetragen für |
English | Italian |
Recipient | Destinatario |
Sender | Mittente |
Delivery | Consegna |
Instant | Immediato |
Scheduled for | Pianificato per |
English | Spanish |
Recipient | Destinatario |
Sender | Remitente |
Delivery | Entrega |
Instant | Instantáneo |
Scheduled for | Programado para |