Embed the catalog in a store page
embed_catalog_in_storePut a published catalog on a page of the merchant's own Shopify or WooCommerce store, as the Publish dialog's store tab does. With only catalogId it lists the store's pages, which ones already embed a catalog, and their links. With pageId (one of those pages) or newPageTitle (a new page), the store is changed only on a call with confirm: true; without it nothing changes and the answer lists, under requiresConfirmation, the catalog, the store page and the public link, for the merchant to approve — with confirmWith holding the arguments that carry it out. width and height size the embed (defaults 100% and 800). A draft is refused, since an embedded draft shows nothing. Owner only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| width | No | e.g. "100%" or "800px" | |
| height | No | e.g. "800" or "600px" | |
| pageId | No | A page id from the listing | |
| confirm | No | true once the merchant has agreed to change their store | |
| catalogId | Yes | Catalog id, as returned by list_catalogs | |
| newPageTitle | No | Creates a new store page with this title |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | The store page now showing the catalog | |
| pages | No | The store's pages, when called with only catalogId | |
| applied | No | ||
| catalog | No | ||
| embedded | No | ||
| platform | Yes | ||
| storePage | No | The page that would change, while waiting for confirmation | |
| 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 |