URL parameters
You can change how the plugin behaves by adding parameters to the iframe URL.
| Parameter | Values | Description |
|---|---|---|
lang | en, tr, pt, it, fr, ru | Sets the UI language. |
catalog | false | Hides the built-in catalog UI. You apply variants through the SDK. |
custom | true | Runs the plugin in custom mode: the try-on engine only, without the built-in UI. |
mode | integration | Shows warnings when the iframe size is wrong. For development only. |
#partnerAnalyticsId | Your user or account ID | Links analytics events to your own user ID. This is a hash (#), not a query parameter. |
Parameters can be combined:
https://plugin.pulpoar.com/vto/<project-key>?lang=fr&catalog=false
lang
Sets the language of static UI text, such as buttons, titles and the GDPR text.
https://plugin.pulpoar.com/vto/<project-key>?lang=tr
If lang isn't set, the plugin uses the browser language, and falls back to English. See Languages.
catalog
catalog=false hides the catalog UI (brands, categories, products and variants) but keeps the try-on controls. Use it when your page has its own product or shade picker, and apply variants with applyVariants.
https://plugin.pulpoar.com/vto/<project-key>?catalog=false
custom
custom=true runs only the try-on engine. It hides the built-in UI, including the catalog, the opacity slider and the before/after slider. You build the full UI and control the plugin through the SDK. See Custom UI.
https://plugin.pulpoar.com/vto/<project-key>?custom=true
| You want | Use |
|---|---|
| Your own product picker, with the built-in sliders and controls | ?catalog=false |
| A fully custom UI | ?custom=true |
mode
mode=integration turns on Integration mode, which shows a warning banner if the iframe size doesn't match the recommended dimensions. Remove it before going to production.
https://plugin.pulpoar.com/vto/<project-key>?mode=integration
#partnerAnalyticsId
Links analytics events to your own user or account ID. The ID can contain letters, digits, ., _ and -, up to 128 characters. Use the hash when you know the ID before the plugin loads, so startup events are linked too:
https://plugin.pulpoar.com/vto/<project-key>#partnerAnalyticsId=user-123
To set or clear the ID later, for example after login or logout, use the setPartnerAnalyticsId action.