ZAzalster
creatives

Preview

Server-side SVG for one product: the parity reference for the editor's own render.

With profile "clean", the document's clean image instead (decision 124): drawn from clean_document exactly as a render draws it, in any of the three formats, with no variant and no rule set. With "lifestyle", its lifestyle image (decision 128), in 1:1 or 4:5; variant then names which of them (decision 138): default for the first, 2 to 5 after it.

post/companies/{company_id}/templates/{template_id}/preview

Request

  • Base URL
    https://app.zalster.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

company_idstring uuid required

Company id

template_idstring uuid required

Query parameters

atstring date-time nullable

draw as at this moment, with a time zone; now when left out

themestring nullable

none, scheduled (the default: the company's theme now) or a theme's id

Request body

documentobject nullable
product_idstring uuid nullable
formatstring
variantstring
profile'designed' | 'clean' | 'lifestyle'

Which picture of a product a template makes for a channel (decision 124).

designed is the template as drawn. clean is the product alone on a plain ground — what Google Shopping requires of image_link, which disapproves a product whose picture carries a price, a badge, a call to action, a logo or a border. lifestyle (decision 128) is the product's approved cut-out on a vivid colour or a scene, for Google's lifestyle_image_link: a picture a feed sends beside its main one, never instead of it.

Response

Successful Response

product_idstring uuid required
external_idstring required
formatstring required
svgstring required
warningsobject[] required
boundobject required
visibilityobject required
subject_boxesobject
picturesobject
overridesobject
conditionsobject
partsobject
picture_findingsobject[]
touchupsobject
codesobject
tablesobject
layoutstring nullable
explainobject

Changes

No recorded changes to this operation across all 1 revision of this API.