As a shipping provider, you can integrate with Wix to allow a merchant's stores or businesses to request and use your shipping services on their Wix sites. Your shipping rates are then displayed on the site's cart and checkout pages.
The integration is done via an app in the Wix App Market and by implementing the Shipping Rates service plugin. After the app is installed on a site, Wix triggers a call to your service whenever the site needs to retrieve shipping rates for a transaction.
Using the service plugin, you can design your app to:
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 Shipping Rates Extension Configuration.
Use shippingRates.provideHandlers() to define the following handler functions that implement your custom business logic. Make sure you define all required functions.
| Function | Required |
|---|---|
getShippingRates() | Yes |
Below is an example for implementing the Shipping Rates service plugin in your code.
This is the basic code structure for implementing the Shipping Rates service plugin with the Wix CLI:
This is the basic code structure for implementing a self-hosted Shipping Rates 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.
URL to reach the shipping provider app's dashboard.
Base URI where the endpoints are called.
Wix eCommerce appends the endpoint path to the base URI.
For example, to call the Get Shipping Rates endpoint at https://my-shipping-provider.com/v1/getRates,
the base URI you provide here is https://my-shipping-provider.com/.
Description of the shipping provider.
Whether to require the site owner to define a fallback/default rate. Set to true if you do not provide rates as part of the integration.
URL to more info about the shipping provider.
Human-readable name of the shipping provider.
Thumbnail image of the shipping rates provider. Displayed in the shipping settings section in the Dashboard. The URL must be of an image uploaded to the Wix Media Manager.