Important:
The Wix eCommerce Gift Cards service plugin is available for both REST and SDK integrations. Due to npm package naming limitations, the SDK version is named "Gift Vouchers service plugin". Both names refer to the same extension and provide identical functionality, and may be used interchangeably throughout this introduction.
When developing websites or building apps with Blocks, use Velo service plugins.
The Wix eCommerce Gift Cards 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.
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 Studio workspace, and configuring the Gift Cards Provider service plugin.
To enable Wix to communicate with your app:
Go to Extensions in your app's dashboard.
Click + Create Extension in the top right.
Find Gift Cards Provider and click + Create.
Use the JSON editor to create the extension's configuration file. Configure the parameters by referencing the table below or the Documentation section to the right of the editor. For each parameter, add the parameter name and value in the JSON editor.
| Name | Type | Description |
|---|---|---|
deploymentUri | string | Required. Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI. For example, to call the Balance Retrieval endpoint at https://my-gift-cards.com/v1/getBalance, the base URI you provide here is https://my-gift-cards.com/. |
componentName | string | Unique name for this component, that appears only in the app dashboard. |
When a site owner installs and authorizes your app to provide gift card operations, Wix will send a JSON Web Token (JWT) with an instance ID to your deployment URI + endpoint path. The app should collect the JWT, decode it, and store the resulting instance ID.
For example, the token in this request:
Decodes into: