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/.
{ "deploymentUri": "https://my-gift-cards.com/" }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.
function getBalance(
payload: GetBalanceEnvelope,
): GetBalanceResponse | Promise<GetBalanceResponse>;import { giftVouchersProvider } from "@wix/ecom/service-plugins";
giftVouchersProvider.provideHandlers({
getBalance: async (payload) => {
const { request, metadata } = payload;
// Use the `request` and `metadata` received from Wix and
// apply custom logic.
return {
// Return your response exactly as documented to integrate with Wix.
// Return value example:
balance: "100.00",
currencyCode: "USD",
};
},
});