Extension Config

The JSON object below defines the configuration for this service plugin extension. How you supply values depends on the framework you’re using:

  • Self-hosted apps: After adding a service plugin extension to your app in the app dashboard, provide configuration details in your extension's page. Learn more about how to add and configure a self-hosted service plugin extension with REST or the SDK.
  • CLI apps: When you add a service plugin extension to your app with the Wix CLI, the required configuration details are populated automatically. You can then customize them in your extension's plugin.json file.
Note

If you created your service plugin extension with the CLI, required fields are automatically populated for you.

Configuration Params
deploymentUristringminLength 1

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

namestringminLength 1maxLength 64

Human-readable name of the shipping provider.

descriptionstringmaxLength 200

Description of the shipping provider.

learnMoreUrlstringmaxLength 200

URL to more info about the shipping provider.

dashboardUrlstringminLength 1maxLength 2048format WEB_URL

URL to reach the shipping provider app's dashboard.

fallbackDefinitionMandatoryboolean

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.

thumbnailUrlstringformat WEB_URL

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.

Did this help?