About the Wix eCommerce Shipping Rates Service Plugin

As a shipping provider, you can integrate your shipping rates service plugin (formerly SPI) with Wix to allow a merchant's stores or businesses to request and use your shipping services on their Wix sites. The 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 (created in the Wix Studio workspace), and the Wix Shipping Rates service plugin.

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.

Terminology

• Get Shipping Rates: Wix calls this service plugin endpoint to retrieve the shipping rates you provide.
• Merchant: Business that offers products on their Wix site to customers.
• Wix site owner: The person managing the merchant's Wix site.
• Shipping Rates Provider: A 3rd-party app that implements custom logic to calculate shipping rates.

Prerequisites

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

1. Create an app and retrieve its app ID either from the URL or as displayed in your app's dashboard.

   

2. Go to Extensions in your app's dashboard.

3. Click Create Extension in the top right.

4. Filter by eCommerce in the left menu, then find Ecom Shipping Rates and click Create.

5. 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.

6. Click Test Your App.

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

See also

• Wix service plugin extensions
• Tutorial | Create a Self-hosted Custom Shipping Rates App