Marketplace Provider Submissions API: Sample Flows

This article presents a possible use case and corresponding sample flow that you can support. It provides a useful starting point as you plan your implementation.

Report generated mockup results back to Wix

A site owner has asked Wix to preview one or more of your products with a specific image applied, such as the site logo or a custom design. Wix calls your platform via Bulk Generate Mockups, which kicks off asynchronous mockup generation on your side. Once each mockup is ready—or you've determined it can't be produced—you report the outcome back to Wix so the site owner's UI can reflect the result.

To report generated mockup results back to Wix:

  1. Receive the incoming Bulk Generate Mockups request from Wix. For each item, note the providerProductId, the image URL, and the imageType.
  2. Generate the mockups on your platform.
  3. As mockups become ready, call Submit Generated Mockups with a batch of up to 100 results. For each successful result, set status to COMPLETED and include the mockupUrl. For each failure, set status to FAILED. Always echo the same providerProductId and imageType from the original request so Wix writes the result to the correct mockup slot.
  4. Continue submitting additional submissions as more mockups finish. You don't need to submit results in the same grouping or order as the original request, and you can combine results from different Bulk Generate Mockups requests in a single call.
  5. Inspect the per-item itemMetadata in each response to confirm that each submission was accepted, and retry individual items if needed.
Did this help?