About the Wix eCommerce Shipping Rates Service Plugin

Important: When developing websites or building apps with Blocks, use Velo service plugins.

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:

Provide shipping estimates, including fees and times.
Provide shipping rates using your own custom logic.
Provide services for delivery and pickup.

Prerequisites

Complete the following steps to adapt Wix system's integration to make your shipping rates available to merchants and their customers.

Create an app in your Wix Studio workspace and retrieve its app ID either from the URL or as displayed in your app's dashboard.
Go to Extensions in your app's dashboard.
Click Create Extension in the top right.
Filter by eCommerce in the left menu, then find Ecom Shipping Rates 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 Get Shipping Rates endpoint at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.
`name`	string	Required. Human-readable name of the shipping provider. Max characters: 64.
`description`	string	Description of the shipping provider. Max characters: 200.
`learnMoreUrl`	string	URL to more info about the shipping provider.
`dashboardUrl`	string	URL to reach the shipping provider app's dashboard.
`fallbackDefinitionMandatory`	boolean	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.
`thumbnail_url`	string	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.

Click Test Your App.
After adding your app to the test site, enable a shipping rule in the dashboard to show your shipping rates during checkout.

About the Wix eCommerce Shipping Rates Service Plugin

Prerequisites

See also