Viewrium Docs
HTTP referenceProducts

Export product images

GET/v1/products/export

Returns a ZIP of finished images - each composited onto its background with its shadow - selected by ids or by the list's filters, at most 200 products. image_review_status chooses which images go in (default accepted and pending). The archive's manifest.json names every entry and every image skipped. The 3D model is never included.

  • 200: the ZIP.
  • 202: more images need finishing than one request can do. They are finished in the background, a download link is emailed, and the same request then returns the ZIP.

400 past 200 products.

Query Parameters

org_id?|

The organization to read. With a key, its own organization is read and org_id may be left out. Signed in, it is required unless you belong to one organization or send scope=all.

scope?ListScope

org (the default) reads one organization. all reads every organization you can reach; it needs a signed-in session (400 with a key).

Default"org"

Value in

  • "org"
  • "all"
q?|

Search text, 1 to 200 characters: products whose title or custom_id contains it, ignoring case.

custom_id?|

Only the product with exactly this custom_id.

status?array<>|

Only products showing one of these statuses (their display_status). Repeat the parameter for several.

tag?array<string>|

Only products with these tags. Repeat the parameter for several; tag_match decides whether a product needs all of them or any.

tag_match?TagMatch

all (the default): a product must carry every tag. any: at least one.

Default"all"

Value in

  • "all"
  • "any"
created_after?|

Only products created at or after this time (ISO 8601).

created_before?|

Only products created before this time (ISO 8601).

created_by?array<>|

Only products created by these users, by user id. Repeat the parameter for several.

has_comments?|

true: only products with comments. false: only products without.

has_warnings?|

true: only products with a warning. false: only products without.

form?array<string>|

Only products of these shape classes: regular, wall, cylindrical, character or painting. Repeat the parameter for several.

source_type?array<>|

Only products created from these sources: image, video, url or model. Repeat the parameter for several.

ids?array<>|

The products to export, up to 200. Repeat the parameter or separate the ids with commas. When sent, the other filters are ignored.

image_review_status?array<>

Which images go in, by your review decision. Repeat the parameter for several. Default accepted and pending, so only rejected images are left out.

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/products/export"
null
{  "status": "queued",  "products": 0,  "images": 0,  "to_finish": 0,  "notify_email": "string"}
{  "error": {    "code": "string",    "message": "string",    "details": null  }}

Publish or unpublish products POST

Publishes or unpublishes up to 100 products at once; a single product can also be toggled with `PATCH /v1/products/{id}`. Answers each id's outcome. `402` when the plan does not allow publishing, or publishing them would pass the plan's active-product limit.

List product tags GET

Every distinct tag across the products in scope (`org_id` or `scope=all`, as the list), with how many products carry each, most used first. Only `org_id` and `scope` apply; the list's other filters are accepted and ignored.