Marketplace Provider Service Plugin

The Marketplace Provider service plugin allows third-party supplier and fulfillment platforms to integrate their product catalogs with Wix Stores. When a Wix site owner imports products from a marketplace provider, Wix calls your service plugin to retrieve product details, generate product mockup images, check real-time inventory levels, and optionally surface a pricing breakdown.

Terminology

TermDescription
Marketplace providerA third-party supplier or fulfillment platform (such as Printful or Modalyst) that provides products to Wix site owners.
Product referenceA link between a product in the provider's system and a product in a Wix site's store. Contains the provider's product ID and optional provider-specific data.
MockupA composite product preview image that shows the site owner's logo or custom image on a provider's product. For example, a t-shirt with the site's logo printed on it.
ChoiceA product variant option such as size, color, or material. Each choice has a name (for example, "Size") and a value (for example, "M").

How This Service Plugin Works

Wix calls your service plugin implementation when a site owner interacts with marketplace provider products in the Suppliers Hub or their store. Wix calls Bulk Add Products To Store when the site owner selects products to import, Bulk Generate Mockups when they request mockup previews, Get Inventory when they open a product's details page, and Get Pricing Breakdown when they view pricing details in the Suppliers Hub Marketplace.

Wix calls Bulk Add Products To Store to create products in the site's Wix Stores catalog. For Bulk Generate Mockups, the call is asynchronous — your implementation acknowledges the request, then delivers the generated mockup images by calling Submit Generated Mockups on the Marketplace Provider Submissions API. For Get Inventory, Wix displays the returned stock levels on the product details page. For Get Pricing Breakdown, Wix displays the returned base cost, suggested retail price, potential profit, and markup rate to help the site owner decide whether to import the product.

Get Pricing Breakdown is opt-in. Wix only calls it when your provider config sets toggleGetPricingBreakdownEnabled to true. Otherwise, Wix skips the call and the Suppliers Hub UI omits the pricing breakdown.

Notifying Wix

Your service plugin can notify Wix when mockup generation is complete by calling these methods:

Get started

To enable Wix to communicate with your app:

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

  2. Click Create Extension in the top right.

  3. Filter by Suppliers Hub in the left menu, then find Marketplace Provider and click Create.

  4. Provide the following configuration in the JSON editor and then click Save.

    NameTypeDescription
    deploymentUristringRequired. Base URI where your service plugin endpoints are deployed. Wix appends the endpoint path to this base URI. For example, to reach the Bulk Add Products To Store endpoint at https://my-provider.com/v2/bulk/add-products-to-store, provide https://my-provider.com/ as the base URI.
    toggleGetPricingBreakdownEnabledbooleanWhether your implementation supports the Get Pricing Breakdown method. When false, Wix doesn't call your implementation for pricing breakdowns and the Suppliers Hub UI omits that section. Default: false.

Get started

Self-hosted implementations:

To enable Wix to communicate with your app:

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

  2. Click Create Extension in the top right.

  3. Filter by Suppliers Hub in the left menu, then find Marketplace Provider and click Create.

  4. Provide the following configuration in the JSON editor and then click Save.

    NameTypeDescription
    deploymentUristringRequired. Base URI where your service plugin endpoints are deployed. Wix appends the endpoint path to this base URI. For example, to reach the Bulk Add Products To Store endpoint at https://my-provider.com/v2/bulk/add-products-to-store, provide https://my-provider.com/ as the base URI.
    toggleGetPricingBreakdownEnabledbooleanWhether your implementation supports the Get Pricing Breakdown method. When false, Wix doesn't call your implementation for pricing breakdowns and the Suppliers Hub UI omits that section. Default: false.

Define handler functions using marketplaceProvider.provideHandlers():

FunctionRequired
bulkAddProductsToStore()Yes
bulkGenerateMockups()Yes
getInventory()Yes
getPricingBreakdown()No (only if toggleGetPricingBreakdownEnabled is true)

Self-hosted: Basic code structure

Copy

CLI implementations:

Learn how to implement a service plugin with the CLI and the SDK.

Define handler functions using marketplaceProvider.provideHandlers():

FunctionRequired
bulkAddProductsToStore()Yes
bulkGenerateMockups()Yes
getInventory()Yes
getPricingBreakdown()No (only if toggleGetPricingBreakdownEnabled is true)

CLI: Basic code structure

Copy

Requirements and constraints

Your service plugin implementation must meet the following requirements:

  • Respond within 10 seconds for all methods. Longer response times result in timeout errors.
  • Maintain high availability (99.9% uptime recommended). Downtime affects all Wix sites using your implementation.
  • Handle timeouts gracefully. If your implementation doesn't respond within the timeout window, Wix falls back to default behavior and logs the timeout event.

Error handling

Your service plugin implementation must support returning defined errors when appropriate conditions occur. Implement proper error handling to ensure Wix can respond appropriately to different failure scenarios.

The Bulk Generate Mockups method defines specific error codes for cases where a product doesn't support mockup generation or the provided image isn't supported. Return these errors with the appropriate error code so Wix can display a helpful message to the site owner.

Did this help?