Publish a catalog
publish_catalogMake a catalog live and start rendering its PDF. The viewer link works immediately — the flipbook does not wait for the PDF. A large catalog takes a few minutes to render; one not finished within about twenty seconds comes back with render.state "rendering" and a jobId, which is not a failure: the catalog is published, the link works, and get_catalog_pdf with that jobId returns the PDF once it is done. render.state is "ready" (with downloadUrl), "rendering", "failed" (with reason) or "not_configured". A draft goes live only on a call with confirm: true. Without it, nothing changes and the answer lists what would go live under requiresConfirmation — the catalog and its public link — for the merchant to approve, with confirmWith holding the arguments that carry it out. A catalog that is already live re-renders its PDF with no confirmation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| render | No | Set false to publish without rendering a PDF (default true) | |
| confirm | No | true once the merchant has agreed to make a draft public | |
| catalogId | Yes | Catalog id, as returned by list_catalogs | |
| pdfFormat | No | The dialog's PDF format: compressed (default, smaller, for sharing and email) or print (press quality) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| render | No | Where the PDF render stands | |
| status | No | ||
| applied | No | false: a draft waiting for the merchant to confirm going live | |
| catalog | No | ||
| publicUrl | No | Where the catalog would go live | |
| published | No | ||
| viewerUrl | No | The public link, live at once | |
| confirmWith | No | The arguments that carry the change out once the merchant agrees | |
| requiresConfirmation | No | Present when nothing was changed: the consequences to show the merchant before calling again with confirm: true |