> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetProductMockups # Package: suppliersHub # Namespace: MarketplaceProvider # Method link: https://dev.wix.com/docs/api-reference/business-solutions/suppliers-hub/marketplace-provider-service-plugin/get-product-mockups.md ## Introduction Retrieves ready-made product mockup image URLs for one or more products. Wix calls this method when a site owner views product mockups in the Suppliers Hub Marketplace. Wix calls it only when your implementation enables it by setting `toggleGetProductMockupsEnabled` to `true` in the marketplace provider config. Return your existing, ready-made mockup images for each requested product. Unlike [Bulk Generate Mockups](https://dev.wix.com/docs/api-reference/business-solutions/suppliers-hub/marketplace-provider-service-plugin/bulk-generate-mockups.md), this method doesn't generate new images or apply a site owner's logo or custom image. Wix uses the response to display mockup images for the requested products. --- ## REST API ### Schema ``` Method: getProductMockups Description: Retrieves ready-made product mockup image URLs for one or more products. Wix calls this method when a site owner views product mockups in the Suppliers Hub Marketplace. Wix calls it only when your implementation enables it by setting `toggleGetProductMockupsEnabled` to `true` in the marketplace provider config. Return your existing, ready-made mockup images for each requested product. Unlike [Bulk Generate Mockups](https://dev.wix.com/docs/api-reference/business-solutions/suppliers-hub/marketplace-provider-service-plugin/bulk-generate-mockups.md), this method doesn't generate new images or apply a site owner's logo or custom image. Wix uses the response to display mockup images for the requested products. URL: null Method: POST Method parameters: param name: providerProductIds | type: array | description: Product GUIDs on the provider's platform to retrieve mockups for. | validation: minItems 1, maxItems 100, minLength 1, maxLength 36 Return type: GetProductMockupsResponse - name: productMockups | type: array | description: Mockups for the requested products. | validation: maxItems 100 - name: providerProductId | type: string | description: Product GUID on the provider's platform. | validation: minLength 1, maxLength 36 - name: mockupImageUrls | type: array | description: Ready-made mockup image URLs for the product. | validation: maxItems 100, format WEB_URL ``` ### Examples ### Get Product Mockups Retrieves ready-made product mockup image URLs for one or more products ```curl curl -X POST \ 'https://provider.example.com/v2/get-product-mockups' \ -H 'user-agent: Wix' \ -H 'accept-encoding: gzip, deflate' \ -H 'content-type: text/plain; charset=utf-8' \ -d '{ "providerProductIds": [ "73cfa507-221b-417a-bd62-c7b62065068e", "9b1d3c2a-4f5e-4a8b-8c7d-1e2f3a4b5c6d" ] }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.suppliersHub.marketplaceProvider.getProductMockups(request, metadata) Description: Retrieves ready-made product mockup image URLs for one or more products. Wix calls this method when a site owner views product mockups in the Suppliers Hub Marketplace. Wix calls it only when your implementation enables it by setting `toggleGetProductMockupsEnabled` to `true` in the marketplace provider config. Return your existing, ready-made mockup images for each requested product. Unlike [Bulk Generate Mockups](https://dev.wix.com/docs/api-reference/business-solutions/suppliers-hub/marketplace-provider-service-plugin/bulk-generate-mockups.md), this method doesn't generate new images or apply a site owner's logo or custom image. Wix uses the response to display mockup images for the requested products. Method parameters: param name: metadata | type: Context | description: this message is not directly used by any service, it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform. e.g. SPIs, event-handlers, etc.. NOTE: this context object MUST be provided as the last argument in each Velo method signature. Example: ```typescript export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) { ... } ``` - name: requestId | type: string | description: A unique identifier of the request. You may print this GUID to your logs to help with future debugging and easier correlation with Wix's logs. - name: currency | type: string | description: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. | validation: format CURRENCY - name: identity | type: IdentificationData | description: An object that describes the identity that triggered this request. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site. | validation: format GUID - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site. | validation: format GUID - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.). | validation: format GUID - name: appId | type: string | description: GUID of an app. | validation: format GUID - name: languages | type: array | description: A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. - name: instanceId | type: string | description: The service provider app's instance GUID. | validation: format GUID param name: request | type: GetProductMockupsRequest - name: providerProductIds | type: array | description: Product GUIDs on the provider's platform to retrieve mockups for. | validation: minItems 1, maxItems 100, minLength 1, maxLength 36 Return type: PROMISE - name: productMockups | type: array | description: Mockups for the requested products. | validation: maxItems 100 - name: providerProductId | type: string | description: Product GUID on the provider's platform. | validation: minLength 1, maxLength 36 - name: mockupImageUrls | type: array | description: Ready-made mockup image URLs for the product. | validation: maxItems 100, format WEB_URL ``` ### Examples ### getProductMockups ```javascript import { marketplaceProvider } from '@wix/suppliers-hub/service-plugins'; async function getProductMockups(request,metadata) { const response = await marketplaceProvider.getProductMockups(request,metadata); }; ``` ### getProductMockups (with elevated permissions) ```javascript import { marketplaceProvider } from '@wix/suppliers-hub/service-plugins'; import { auth } from '@wix/essentials'; async function myGetProductMockupsMethod(request,metadata) { const elevatedGetProductMockups = auth.elevate(marketplaceProvider.getProductMockups); const response = await elevatedGetProductMockups(request,metadata); } ``` ### getProductMockups (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { marketplaceProvider } from '@wix/suppliers-hub/service-plugins'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { marketplaceProvider }, // Include the auth strategy and host as relevant }); async function getProductMockups(request,metadata) { const response = await myWixClient.marketplaceProvider.getProductMockups(request,metadata); }; ``` ---