Product operation results

What the bulk and review operations answer - batch delete and publish, the review flush, a queued export and the tag list.

ProductBatchResponse

JavaScript: ProductBatchResult · Python: viewrium.ProductBatchResponse

Each id's outcome. The request succeeds even when some ids were not found.

affecteduuid[]required

The ids the operation was applied to.

not_founduuid[]required

The ids that do not exist or are not visible to you.

forbiddenuuid[]required

The ids that exist but you may not change.

ProductReviewResponse

JavaScript: ProductReviewResult · Python: viewrium.ProductReviewResponse

product_iduuidrequired

The product.

appliedintegerrequired

How many rows the flush changed (the product, each changed image, the model).

display_statusDisplayStatusrequired

The status to show: the stored status, except generating while any asset is in flight, failed when nothing usable was produced, and published once it is live.

One of "published", "generating", "failed", "awaiting_review", "needs_attention", "ready_to_publish", "complete"

ProductExportQueuedResponse

JavaScript: ProductExportQueued · Python: viewrium.ProductExportQueued

More images need finishing than one request can do: they are being finished in the background, and a download link is emailed to notify_email when they are done. The same request then returns the ZIP.

status"queued"optional

Always queued.

Default "queued"

productsintegerrequired

How many products the export covers.

imagesintegerrequired

How many images the export covers.

to_finishintegerrequired

How many images are being finished in the background.

notify_emailstringoptionalnullable

Where the download link is emailed when they are done.

TagsResponse

JavaScript: Tags · Python: viewrium.TagsResponse

Every distinct tag across the products in scope, with how many carry it.

dataTagCount[]required

Every distinct tag in the scope, with its product count.

TagCount

JavaScript: no alias - an element of the type that holds it · Python: viewrium.TagCount

tagstringrequired

The tag.

countintegerrequired

How many products carry it.