Viewrium Docs
HTTP referenceProducts

Get a product's QR code

GET/v1/products/{id}/qr

The product's QR code as a square PNG, size pixels on a side (256-2048, default 1024). It encodes the product's hosted viewer page (viewer_url).

  • guide=false (default): "View in your room" above the code, "Powered by Viewrium" below it.
  • guide=true: the whole "View in your room" card, with the three steps beside the code.

Answered for every product, published or not, so a code can be printed before launch; the link opens once the product is published, which the Viewrium-Published header states. 404 for a product you cannot see; 503 when QR rendering is unavailable.

Path Parameters

id*Id

The product's id.

Formatuuid

Query Parameters

guide?Guide

false (the default): "View in your room" above the code and "Powered by Viewrium" below it. true: the whole "View in your room" card, with the three steps beside the code.

Defaultfalse
size?Size

The PNG's edge in pixels, 256 to 2048. Default 1024.

Range256 <= value <= 2048
Default1024

Response Body

application/json

curl -X GET "https://example.com/v1/products/497f6eca-6276-4993-bfeb-53cbbbba6f08/qr"
null
{  "error": {    "code": "string",    "message": "string",    "details": null  }}