The Wix eCommerce Gift Vouchers Provider Service Plugin allows you to integrate with Wix as a gift card service provider, enabling Wix merchants to utilize your gift card functionalities directly on their sites, providing a seamless experience for their customers.
The Wix eCommerce Gift Cards service plugin is exposed here as the Wix eCommerce Gift Vouchers service plugin due to npm package limitations. Individual methods will refer to gift cards rather than gift vouchers.
By integrating your service with Wix, you can facilitate key gift card operations such as balance retrieval, redemption, and voiding transactions. These operations are seamlessly integrated into the site's checkout page, enhancing the overall customer experience.
The integration process involves creating an app in the Wix App Market via the Wix Dev Center, and configuring the Gift Vouchers Provider service plugin extension.
Follow these steps to begin implementing your service plugin:
You can implement this service plugin with the following frameworks:
To configure and customize your plugin, you need to provide important information in the service plugin configuration file. You can configure your plugin in the Wix Dev Center. For details, see Gift Vouchers Provider Extension Configuration.
Use giftVouchersProvider.provideHandlers() to define the following handler functions that implement your custom business logic. Make sure you define all required functions.
| Function | Required |
|---|---|
getbalance() | Yes |
redeem() | Yes |
_void() | Yes |
Below is an example for implementing the Gift Vouchers Provider service plugin in your code.
This is the basic code structure for implementing the Gift Vouchers Provider service plugin with the Wix CLI:
This is the basic code structure for implementing a self-hosted Gift Vouchers Provider service plugin:
To configure and customize your service plugin, you need to provide important details in the plugin.json configuration file.
If you created your service plugin extension with the CLI, required fields are automatically populated for you.
Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI. For example, to call the Get Balance endpoint at https://my-gift-cards.com/v1/balance, the base URI you provide here is https://my-gift-cards.com/.
This method requests that a gift card transaction be voided by your app. Wix calls this method when a purchase fails after gift card redemption.
This method retrieves gift card data from your app. Wix calls this method when a customer applies a gift card as a payment method at checkout.
This method requests that a transaction be created by your app. Wix calls this method when a customer completes a purchase that includes a gift card as a payment method at checkout.