About the Wix eCommerce Additional Fees Service Plugin
As an additional fees calculation service plugin (formerly SPI), you can integrate your service with Wix to allow merchants to request and use your services on their Wix sites. By integrating your service with Wix, the additional fees are then included on the site's cart and checkout pages.
The integration is done via an app in the Wix App Market (created in the Wix Developers Center) and the Wix Additional Fees service plugin.
Using the service plugin, you can design your app to calculate various additional fees for your merchant's customers, including:
- Fragile packaging fees
- Shipping insurance fees
- Item warranty fees
- Gift wrapping fees
- Carbon offset fees
Learn more about service plugin extensions.
Before you begin
It's important to note that when Wix calls your implementation of the Calculate Additional Fees service plugin endpoint, the app must return fees in the same currency as the Wix site. Extract the currency
for a site from the request envelope to ensure the correct currency is used in your calculation.
Terminology
- Calculate additional fees: Wix calls this service plugin endpoint to retrieve the various additional fees you calculate.
- Line items: Line items to calculate additional fees for. For more information, see eCommerce Integration in Wix Stores Catalog.
- Site owner: The person managing the merchant's Wix site.
Prerequisites
Follow these steps to customize Wix system's integration and enable merchants and their customers to access your additional fees calculations.
-
Create an app and retrieve its app ID either from the URL or as displayed in the My Apps dashboard in the Wix Developers Center.
-
Go to the Extensions tab in the Wix Developers Center.
-
Click Create Extension in the top right.
-
Filter by eCommerce in the left menu, then find Ecom Additional Fees and click Create.
-
Use the JSON editor to create the extension's configuration file. Take care to include the required fields noted in the table below. Click Save.
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 Calculate Additional Fees endpoint at https://my-additional-fees.com/v1/calculateAdditionalFees
, the base URI you provide here ishttps://my-additional-fees.com/
.componentName
string A unique name for this component. This is an internal name that will only appear in the Dev Center. -
Click Test Your App.