This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.
When a site owner selects products to import from a marketplace provider, Wix calls your service plugin to retrieve the full product details and add them to the site's store catalog.
To import products:
Wix calls your Bulk Add Products To Store method with an array of product references. Each reference contains a providerProductId identifying the product in your system, an optional options object for provider-specific data, and a visibleInStore flag indicating whether the site owner wants the product visible in their store immediately.
Your service looks up each product in your catalog using the providerProductId, retrieves the full product details (name, description, price, images, variants), and prepares the response.
Your implementation uses the received product details to create or update products in the site's Wix Stores catalog.
Your implementation returns a result for each product, including item metadata indicating success or failure. For each successful product, include the product reference in the result.
When a site owner requests mockup previews, Wix calls your service plugin to generate composite images showing the site owner's logo or custom image on the products.
To generate mockups:
Wix calls your Bulk Generate Mockups method with an array of mockup requests. Each request contains a providerProductId and an image to overlay on the product. The image includes a URL and a type indicating whether it's the site's logo, a custom image, or a fallback placeholder.
Your service validates the request and returns a response with item metadata indicating whether mockup generation was accepted for each product. If a product doesn't support mockup generation, return a MOCKUP_GENERATION_NOT_SUPPORTED error. If the image isn't supported, return an IMAGE_NOT_SUPPORTED error.
Your service generates the composite mockup images asynchronously. This involves overlaying the provided image onto product templates for each requested product.
Once the mockup images are ready, call Submit Generated Mockups on the Marketplace Provider Submissions API to deliver the generated images to Wix.
Wix receives the generated mockup images and makes them available for the site owner to preview and use in their store.
When a site owner opens a product details page, Wix calls your service plugin to retrieve current stock levels for the product's variants.
To check inventory:
providerProductId and optional choices to filter by specific variants.choices are provided, only return inventory for matching variants. If choices is empty, return inventory for all available variants.