Getting Started

Welcome to the Gift Registry Documentation.

Here you will find everything you need to set up Gift Registry service, and start creating a buyer community at your store.

Gift Registry will surely help your customers to build one, by simple actions:

• сreate a gift registry
• choose the desirable gifts and put them into the gift list
• share the list with their friends!

It is the perfect decision for every shopper, who wants to give a polite tip about their own wishes to their friends.

Go ahead, dive in!

Firstly, please, find our extension in My Downloadable Products section of our store. Learn how to install extension, and proceed with Quick Start, which will guide you to setup your return policy.

How to install extension

1. Backup your store database and web directory.
2. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
3. Copy the installation instructions from page My Downloadable Products to the SSH console and press ENTER.
4. Run command php -f bin/magento module:enable Mirasvit_Core Mirasvit_Giftr to enable the extension.
5. Run command php -f bin/magento setup:upgrade to install the extension.
6. Run command php -f bin/magento cache:clean to clean the cache.

7. Deploy static view files

   rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

Quick Start

Gift Registry comes with a bundle of useful building bricks, that allow you to embrace its full functionality out-of-box.

However, sometimes it is not enough, and you need to build up specific policy for you store.

1. Firstly, check out default Form Fields, which our extension provides by default, and ensure, that they collect all info you need. Create additional fields, if you need to collect additional data from customers.

2. Organize and reorganize form fields into Form Sections. They consist of fields, defined above, and will turn into separate sections of Gift Registry creation page. Properly combined fields will make Gift Registry creation quick and logical.

3. Create events, on which you wish your customer make more orders and exchange with gifts. Typically it is holidays, actions and even promotional campaigns. Collect specific data from customers by assigning to that events additional form sections.

4. Allow customers to show importance of items, added to their Gift Registries - by creating Priority levels.

5. Maintain customer's registries connected to your policy, and adjust them just in time.

6. Customize email notifications, which will be sent to customers.

7. Tune-up our extensions by adjusting its Settings to your needs.

This should be a good beginning.

Refer to appropriate sections of our manual to have more info.

Gift Registry Settings

This section describes most of settings, that you can use for configuring your gift policy. It breaks into two main sections:

• General Settings
• Notifications

General Settings

Notifications

Managing Form Fields

Form Fields are the most basic component of Gift Registries. Each field defines a parameter, that customer should fill in order to create Gift Registry.

Once fields are defined, they should be combined into larger bricks - sections, and they - in turn - define a Registry creation page.

For example, standard General Information section consists of the following fields:

• Gift Registry Name
• Description
• Location
• Date
• Active
• Visibility
• Image

Their definitions are located at Customer -> Gift Registry -> Registry Form Fields. There you can also define your own fields.

How to create a Form Field

Go to Customer -> Gift Registry -> Registry Form Fields, and press Add New button. You will be taken to the creation page, which contains the following fields:

• Title - a title of field. It is store-dependent, so you can have different names (for example, translated) for different storeviews. To create such a store field, use store switcher.
• Code - an internal code, which will be used in database. Therefore, it should contain only letters, digits and underscore, and it shall be unique.
• Type - widget type, that will be used for entering and displaying a value of this field. There's five standard types available:
  • Text - regular one-line text field
  • Multi-line text - a text area for entering large texts
  • Date - a date field, with date chooser
  • Checkbox - a checkbox
  • Drop-down list - a combobox drop-down selection menu.
• Description - a description of this field, which will be shown as hint below the field on creation page
• Active - whether this field is active and should be displayed.
• Sort Order - a priority, that field should have within its section.

   red | Rot
   blue | Blau
   black | Schwarz

Managing Form Sections

Form sections are the building block for Registry creation page, and backend Registry edit page.

Each form section consists of one or more Fields, which are defined in separate grid.

There's four standard form sections, that can be combined to a creation/edition form depending on Event Types:

• General Information
• Registrant
• Co-Registrant
• Shipping Address

They all are located at Customers -> Gift Registry -> Registry Form Sections grid. You can also create there your own sections.

How to create a Form Section

Go to Customers -> Gift Registry -> Registry Form Sections. You will be taken to the creation dialog page, which consists of the following fiedls:

• Title - a title of section. It is store-dependent, so you can have different names (for example, translated) for different storeviews. To create such a store field, use store switcher.
• Sort Order - a priority of this section within the registry creation form.
• Section Fields - a list of fields, which should consist this section. These fields should not be assigned to other sections.

  Note

  If you see this field empty, go to Customers -> Gift Registry -> Registry Form Fields, and either create new, or unassign existing ones.
• Active - whether this section is active and should be displayed at creation and edition forms.

Managing Event Types

Event types are the one of the most basic parts of Gift Registry. They define special events, on which customer can receive a gift from other customers.

By default there's three basic events, which you can find at Customers -> Gift Registry -> Events Types grid:

• Birthday
• Wedding
• Baby Shower

These are the most common events, that every customer can have. But you can also define your own event type from the their grid.

How to create an Event Type

Go to Customers -> Gift Registry -> Events Types, and press Add New. You will ne taken to the creation dialog page, which consists of the following fields:

• Title - a title, which will be shown on event selection drop-down menu at customer's account.
• Sort Order - priority, that this event should have. It affects order, in which drop-down menu items are sorted.
• Form Sections - a list of sections - e. q. separately defined set of fields, that should be shown to customer at Registry creation stage, when this event type is selected.
• Active - defines, whether Event Type is active and available for Registry creation.

Managing Gift Registries

Gift Registry is the only entity in our extension, which can be created only by customer.

Backend provides only means of viewing and editing of already created registries in order to maintain store's policy.

All registries are located at their respective grid at Customers -> Gift Registry -> Registries.

It provides you with two useful mass actions:

• Change status - allows you to disable registries, that should not be used any longer, or enable them back.
• Delete - allows you to remove unnecessary registries.

Also, using Guest View link you can preview customer's Gift Registry in frontend.

How to edit and manage Gift Registry

Pick up a registry and enter its edition page. It divided to three separate tabs: General, Products and Orders - each contains respective information.

General tab is totally built from sections, defined for given type of Event.

For reference on fields, displayed here, check respective record of Event Type at Customers -> Gift Registry -> Events Types. Then pick up sections, defined there, and proceed to Form Registry Sections grid - where you can see fields, assigned to that sections.

Products tab contains product list, that customer had added to his registry. You can forcibly add there additional products, using Add Product button above products grid. There's also a mass Delete actions, that allows you to remove unnecessary products from Gift Registry.

Product records here also are editable - you need just to click on respective product. It will bring you to the Item editing dialog, which consists of following fields:

• Qty - is the quantity of this product, that customer wishes to have.
• Ordered Qty - is the quantity of actually ordered products from this Gift Registry.
• Received Qty - is the actually received products by customer.
• Priority - defines importance of this product for a customer.
• Note - additional note on this product.

Orders contains just a list of Orders, made from current Gift Registry, with a filter for quick searching.

Managing Item Priorities

Each item, that customer has put to his Gift Registry, can have priority, which defines its importance for a customer and its place in Gift Registry. It can be also set from backend.

There's three basic priorities, which our extension provide: High, Medium and Low.

They are located at Customers -> Gift Registry -> Item Priorities grid. There you can also create your priority.

How to create an Item Priority

Go to Customers -> Gift Registry -> Item Priorities, and press Add New button. You will be taken to the simple creation page with only two fields:

• Title - a title of priority. It is store-dependent, so you can have different names (for example, translated) for different storeviews. To create such a store field, use store switcher.
• Sort Order - a constant, which defines place of this priority in drop-down menu, and respective Items in Gift Registry.

Configuring Email Notifications

All Gift Registries Email notification templates are regular transactional emails - e. q. they can be customized using default Magento 2 means.

There's three templates, used by our extension:

• Owner Notification Template - sent to customer on ordering an item from his registry.
• Gift Registry Sharing Notification Template - sent to customer, when his Gift Registry is shared.
• Out Of Stock Item Notification Template - sent to customer, when item from his Gift Registry became out of stock.

To customize any of these templates you need to perform following steps:

• Go to Marketing > Communications > Email Templates
• Press the button Add New Template
• Pick up template in the dropdown that you would like to customize. They are located under category Mirasvit_Giftr.
• Press the button Load Template
• Enter the new Template Name (e.g. My Gift Registry Share Template)
• Change Temlate Subject and Template Content if you need
• Press the button Save Template
• Go to Stores -> Configuration -> Mirasvit Extensions -> Gift Registry and select your newly created template in proper option of Notifications section.

Migration from Magento 1 to Magento 2

Below are examples of scripts, which may be used for transferring data from Mirasvit Gift Registry for Magento 1 to Mirasvit Gift Registry for Magento 2.

To use scripts you need a help of PHP developer. Scripts may contain bugs and may not transfer all necessary data. So you may need to fit them for your needs. Migration service is not a part of our support service. If you need a help of our team, you'll need to buy a migration service.

Click on the names of scripts below to download:

• mirasvit_giftr_m1_export.php - script for exporting Gift Registry data to XML file.
• mirasvit_giftr_m2_import.php - script for importing Gift Registry data from XML file.

How to perform Migration

Follow these steps to correctly perform migration:

1. Run standard Magento 2 migration, and make sure, that customers and orders were transferred from your M1 store to M2;
2. Make sure, that Gift Registry MX for Magento 2 is installed on your M2 store.
3. Place mirasvit_giftr_m1_export.php to the root of your M1 store, and run it either:
   • From browser by opening URL http://store_m1.com/mirasvit_giftr_m1_export.php, or
   • From SSH/Console: navigate to your store's root and run command php -f mirasvit_giftr_m1_export.php
4. If script returned success, file giftr_export.xml will be created at the root of the store, with all your data. Transfer it to the root of your M2 store;
5. Place mirasvit_giftr_m2_import.php to the root of your M2 store, and run it either:
   • From browser by opening URL http://store_m1.com/mirasvit_giftr_m2_import.php, or
   • From SSH/Console: navigate to your store's root and run command php -f mirasvit_giftr_m2_import.php
6. Check migrated data.
7. When migration is completed, remove both migration scripts.

Troubleshooting

In some cases import script can crush on timeout or memory overloading error (due to large quantities of data). In this case just restart import script by reloading browser page. It will skip previously uploaded data, and proceed from the last unprocessed record.

How to upgrade extension

To upgrade the extension follow these steps:

1. Backup your store's database and web directory.
2. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
3. Run command composer require mirasvit/module-gift-registry:* --update-with-dependencies to update current extension with all dependencies.

   Note

   In some cases the command above is not applicable, it's not possible to update just current module, or you just need to upgrade all Mirasvit modules in a bundle. In this case command above will have no effect.
   
   Run instead composer update mirasvit/* command. It will update all Mirasvit modules, installed on your store.
   
   
4. Run command php -f bin/magento setup:upgrade to install the updates.
5. Run command php -f bin/magento cache:clean to clean the cache.

6. Deploy static view files

   rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

Disabling Extension

Temporarily Disable

To temporarily disable the extension please follow these steps:

1. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
2. Run command php -f bin/magento module:disable Mirasvit_Giftr to disable the extension.
3. Login in to the Magento back-end and refresh the store cache (if enabled).

Extension Removal

To uninstall the extension please follow these steps:

1. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
2. Run command composer remove mirasvit/module-giftr to remove the extension.
3. Login in to the Magento back-end and refresh the store cache (if enabled).

Change Log

1.2.45

(2023-05-04)

Improvements

• Added variable "gifterName" to the "Owner Notification Template email"

1.2.44

(2022-11-02)

Fixed

• Customer address validation

1.2.43

(2022-08-25)

Fixed

• Image loading issue in registry edit page

1.2.42

(2022-03-25)

• Support of PHP 8.1

1.2.41

(2021-04-20)

Fixed

• Remove unexisted plugin CustomerAddressValidatorPlugin

1.2.40

(2021-04-12)

Fixed

• m242 compatibility
• search by event date issue

1.2.39

(2020-12-16)

Fixed

• Error "Uncaught ReferenceError: addressConverter is not defined in shipping-rates-validator.js:16

1.2.38

(2020-12-15)

Fixed

• change json encoder

1.2.37

(2020-10-23)

Fixed

• Share email subject display issue

1.2.36

(2020-09-07)

Fixed

• Unable to purchase gift item with guest user (switched JS overrides to mixins)

1.2.35

(2020-06-15)

Fixed

• Support of Magento 2.4.0
• add guest add to cart notification about log in
• set registrant address selected

1.2.34

(2020-03-26)

Fixed

• Update customer data after Gift registry delete

1.2.33

(2020-03-16)

Fixed

• Share with friends issue

1.2.32

(2020-03-13)

Fixed

• Unable to save gift registry

1.2.31

(2020-03-13)

Fixed

• Unable to create gift registry

1.2.30

(2020-03-04)

Fixed

• Incorrect Gift Registry sales order data
• Error when deleted product listed in Gift Registry items
• Set registrant shiping address as default
• Rift Registry dropdown doesn't close after add to registry

1.2.29

(2020-02-11)

Fixed

• Notice on checkout page

1.2.28

(2020-02-10)

Fixed

• Missing helper call

1.2.27

(2020-02-04)

Fixed

• Magento 2.3.4 compatibility

1.2.26

(2020-01-14)

Fixed

• Replace backslash after string escape

1.2.25

(2019-11-04)

Fixed

• "Add New Address" translation

1.2.24

(2019-09-23)

Fixed

• JS issues
• Possible conflict with onestep checkout

1.2.23

(2019-08-30)

Security

• Fixed possible SQL injection (affected from version 1.2.11)

1.2.21

(2019-08-29)

Fixed

• Styling / image resize issues

1.2.20

(2019-08-08)

Fixed

• Order placement issues
• Frontent issues
• Removed google+
• Added column to sales order grid
• Fixed invoiced / received / desired items functionality

1.2.19

(2019-07-22)

Fixed

• Issue with invoiced/received for configurable products

1.2.18

(2019-07-17)

Fixed

• Checkout issue (missing shipping address on billing step)

1.2.17

(2019-07-08)

Fixed

• Issue on save registry from backend

1.2.16

(2019-06-10)

Fixed

• XSS vulnerabilities

1.2.15

(2019-04-16)

Improvements

• List product options on gift registry guest view page

1.2.14

(2019-03-27)

Fixed

• Issue with language of the Event Date picker in registry search form [#133]()

1.2.13

(2019-03-25)

Fixed

• Error while placing gift registry order [#40]()

1.2.12

(2019-03-05)

Fixed

• Issue in integration with Customer Segment module mirasvit/module-customer-segment[#33]()

1.2.11

(2018-02-25)

Fixed

• Search by registry uid

1.2.10

(2018-12-25)

Features

• Control ability to create new events by customers while creating gift registries
• added message on product detail page if referred from email #112

1.2.9

(2018-12-03)

Improvements

• Security update

1.2.8

(2018-12-03)

Features

• search within all registries [#117]()

1.2.7

(2018-11-29)

Improvements

• M2.3 support

Fixed

• Error gift registry view page with configurable items with custom options (since 1.2.6) [#118]()

1.2.6

(2018-11-20)

Fixed

• Error viewing registry's guest page #118

1.2.5

(2018-11-01)

Fixed

• Display public gift registries in the search result by default issue
• Several elements with the same identifier issue

Features

• Added admin notification about inactive giftr types
• Added message on frontend before create a new registry type (customer area)

1.2.4

(2018-09-17)

Features

• Allow to show/hide expired events (registries)

1.2.3

(2018-09-11)

Fixed

• Compatibility with Magento 2.1

1.2.2

(2018-08-29)

Fixed

• Gift registry search issue
• Group products add to cart processing
• Styles issue with Shipping Methods

1.2.1

(2018-08-03)

Fixed

• set account "My gift registries" link active on sub links

1.2.0

(2018-07-17)

Features

• Improved view and functionality of gift registry

1.1.9

(2018-06-08)

Fixed

• Gift registrant address is not displayed at checkout: problem with empty item buy request

Documentation

• Info on when the owner email notification is sent out

1.1.8

(2018-06-01)

Fixed

• 'Add to gift registry' button is not displayed on Infortis Ultimo theme

1.1.7

(2018-06-01)

Fixed

• Properly display and save custom date field values

1.1.6

(2018-04-19)

Fixed

• Display 'Add to Cart' button for registry products in mobile view

1.1.5

(2018-04-17)

Fixed

• fixed issue with configurable product image
• fixed conflict with ultimo theme
• fixed styling issue with custom themes for customer areas on create/edit registry page

1.1.4

(2018-04-13)

Fixed

• Problems with add to Gift Registry button at product page

1.1.3

(2018-04-12)

Fixed

• Registrant address is not displayed at checkout in some cases
• Do not display not visible products
• Grouped products are always marked as Complete

1.1.2

(2018-04-11)

Fixed

• Properly add 'Gift Registry' button to product view page
• Gift Registrant address reset at checkout page after login

1.1.1

(2018-03-15)

Fixed

• Error opening registry edit page from admin panel on Magento 2 EE

1.1.0

(2018-03-13)

Improvements

• Display public registries by default

Fixed

• Error placing an order in Magento 2.2
• Display gift registry item image using specified product options

1.0.47

(2018-02-23)

Fixed

• In some cases the 'Add to gift registry' button's text is not displayed

1.0.46

(2017-02-13)

Fixed

• Display only related order/item gift messages on gift registry pages

1.0.45

(2017-02-08)

Fixed

• Fix problem when product added to a registry of another customer due to Full Page Cache #32 (affects all)

1.0.44

(2017-02-01)

Fixed

• Wrong Gift Registry view link in Gift Registry grid in admin panel
• Fix error of displaying Gift Registry edit page in admin panel when a registry does not have assigned address

Improvements

• Added validation of required product properties when adding a product to a gift registry

1.0.43

(2017-12-12)

Fixed

• Fixed an issue with removing item from cart

1.0.42

(2017-11-29)

Fixed

• Corrected a typo in "Gift Registry Search"

1.0.41

(2017-11-28)

Fixed

• Compatibility with Magento 2.2.1 where country list is empty for new address

1.0.40

(2017-11-06)

Improvements

• Compatibility with PHP >= 7.0

1.0.39

(2017-11-06)

Fixed

• Use proper serialization method for Magento 2.2
• Fix problem validating quote during checkout in Magento 2.2

1.0.38

(2017-09-28)

Fixed

• Compatibility with Magento 2.2

1.0.37

(2017-09-26)

Improvements

• More translations

Fixed

• Provide correct 'Guest View' link for Gift Registry in Registry Grid within admin panel
• Properly retrieve orders associated with the gift registry

1.0.36

(2017-08-01)

Fixed

• Properly show gift registry share message

1.0.35

(2017-07-28)

Improvements

• Translate subjects in Gift Registry emails

1.0.34

(2017-07-24)

Improvements

• Translate text in email templates

1.0.33

(2017-06-30)

Fixed

• Do not show 'add to gift registry' dropdown dialog when another dropdown dialog activated

Improvements

• Translate select options for registry fields

1.0.32

(2017-06-27)

Improvements

• Translate calendar information

1.0.31

(2017-06-23)

Fixed

• Properly set page title

Improvements

• Include translation file
• Show totals for gift registry orders

1.0.30

(2017-05-18)

Fixed

• Compatibility with Magento versions 2.0.x
• Allow to add new product from admin panel by users with custom permissions

1.0.29

(2017-04-28)

Features

• Ability to show order gift messages on the gift registry guest page

1.0.28

(2017-04-18)

Fixed

• Show global product name in admin

1.0.27

(2017-04-14)

Fixed

• Resolve CustomerSegment module dependency (affects since 1.0.25)

1.0.26

(2017-04-14)

Fixed

• Not all Gift Regisry products QTY udpated after placing order

1.0.25

(2017-04-10)

Features

• Integration with Mirasvit Customer Segment extension, conditions to validate Gift Registry products

1.0.24

(2017-03-30)

Improvements

• Translate all the available messages

1.0.23

(2017-03-29)

Fixed

• Missed dependency (affects since 1.0.22)

1.0.22

(2017-03-24)

Fixed

• Fix security issue

1.0.21

(2017-03-17)

Fixed

• Do not overwrite Gift Registry ID when saving it in admin panel

1.0.20

(2017-03-06)

Fixed

• Fix error when updating Gift Registry items with empty list

1.0.19

(2017-02-24)

Improvements

• Ability to use multiple statuses to change Gift Registry ordered/received QTY

1.0.18

(2017-02-20)

Fixed

• Correctly display product images in emails when CDN used (affects all)

1.0.17

(2017-02-17)

Fixed

• Item QTY is not changed when order receives 'pending' status

Improvements

• Display item received QTY at the 'products' tab at the Gift Registry edit page

1.0.16

(2017-02-10)

Features

• Ability to create shipping address for gift registry using AJAX

1.0.15

(2017-01-25)

Fixed

• Fixed issue with product and order searching at registry edit page in admin (affects from 1.0.14)

1.0.14

(2017-01-20)

Features

• Ability to add products to gift registry from admin panel

1.0.13

(2016-12-12)

Fixed

• Correctly handle date for different locales

1.0.12

(2016-11-11)

Fixed

• Poperly display values for custom registry fields
• Correctly handle custom registry checkbox field

1.0.11

(2016-10-04)

Fixed

• Fix small issues with the buttons at the checkout
• Correctly display grid of orders in Orders tab for the gift registry

1.0.10

(2016-09-13)

Fixed

• Fix date gift registry event date issue
• Convert JS compatible date format to PHP

1.0.9

(2016-08-09)

Fixed

• Fix error in order edit page within admin panel (affects from 1.0.8)
• Correctly display grid with registries (affects all)

1.0.8

(2016-07-29)

Improvements

• Gift Registry information for the order pages

1.0.7

(2016-06-24)

Fixed

• Change const to var for JS (issue in Safari) (affects all)

1.0.6

(2016-06-24)

Improvements

• Support of Magento 2.1.0

1.0.5

(2016-06-17)

Fixed

• Issue with checkout for guests
• Update minicart on adding gift registry item to cart

Improvements

• Ability to search by co-registrant's name

1.0.4

(2016-05-17)

Features

• Ability to show/hide public registries from search results by default

Fixed

• Process gift registries per website

1.0.3

(2016-05-04)

Features

• Ability to set placeholder for new gift registries

Fixed

• Fixing small admin issues

Documentation

• added initial setup and settings

1.0.2

(2016-03-01)

Fixed

• Do not allow to delete/disable system and required fields/sections

Improvements

• Interface improvements
• Interface improvements of search page
• Sample data & Backend

1.0.1-alpha3

(2016-02-16)

Fixed

• Use correct date format in admin panel
• Add product to registry immediately, when the registry is only one

1.0.1-alpha2

(2016-02-15)

Fixed

• Empty link for sharing gift registry
• Problem while saving registry in admin panel
• Fixed Highlight menu item in admin panel
• Close dropdown after adding product to registry
• Do not cache page for managing items

Improvements

• Organized menu items in a consistent manner

1.0.1-alpha

(2016-02-12)

Fixed

• Customer session does not contain customer data in blocks

1.0.0

(2016-02-09)

Improvements

• Responsive css
• Fixed readme.md
• Fixed no_action instead of set_null for FK
• Install giftr_type table earlier than giftr_registry
• Remove FK::ACTION_CASCADE and tmp disable function for config products

100.0.0

(2016-02-08)

Improvements

• Fixed no_action instead of set_null for FK
• Install giftr_type table earlier than giftr_registry
• Remove FK::ACTION_CASCADE and tmp disable function for config products

Tests

• All tests fixed
• Fixing PHP-MD tests
• Solving phpmd warnings
• Complete unit tests
• GRY2-3