> For the complete documentation index, see [llms.txt](https://docs.firework.com/firework-for-developers/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.firework.com/firework-for-developers/web/integration-guide/events/shopping-events.md).

# Shopping events

Description of custom events related to shopping experience either in short videos or during livestream. Shopping events can be used to integrate with Firework into your e-commerce platform.

### Shopping

<table data-header-hidden><thead><tr><th width="398" valign="middle">Name</th><th>Description</th></tr></thead><tbody><tr><td valign="middle"><strong>Name</strong></td><td><strong>Description</strong></td></tr><tr><td valign="middle"><code>fw:shopping:product-clicked</code></td><td><p>Emitted when user clicks on product detail including product list, carousel or pinned highlight.</p><p><code>event.detail</code></p><ul><li><code>product_id</code> - current product id</li><li><code>video</code> - current video</li></ul></td></tr><tr><td valign="middle"><strong>Product List</strong></td><td></td></tr><tr><td valign="middle"><code>fw:shopping:product-list-item-impression</code></td><td><p>Emitted for each product in a shopping bag list visible for at least 1 second.<br><code>event.detail</code></p><ul><li><code>video</code></li><li><code>product</code></li></ul></td></tr><tr><td valign="middle"><code>fw:shopping:product-list-item-clicked</code></td><td><p>Emitted after user clicks on a shopping bag product item.</p><p><code>event.detail</code></p><ul><li><code>video</code></li><li><code>product</code></li></ul></td></tr><tr><td valign="middle"><strong>Product Card (including pinned highlight)</strong></td><td></td></tr><tr><td valign="middle"><code>fw:shopping:product-card-impression</code></td><td><p>Emitted for each product card visible for at least 1 second.</p><p><code>event.detail</code></p><ul><li><code>video</code></li><li><code>product</code></li></ul></td></tr><tr><td valign="middle"><code>fw:shopping:product-card-clicked</code></td><td><p>Emitted when a click happens on product cards (video overlay), only applicable to short video or trailer.</p><p><code>event.detail</code></p><ul><li><code>product_id</code> - current product id</li><li><code>video</code> - current video</li></ul></td></tr><tr><td valign="middle"><code>fw:shopping:pinned-product-impression</code></td><td>Emitted when pinned product is visible for 1 second.</td></tr><tr><td valign="middle"><code>fw:shopping:pinned-product-clicked</code></td><td><p>Emitted when a click happen on pinned product (product highlight)</p><p><code>event.detail</code></p><ul><li><code>product_id</code> - current pinned product id</li><li><code>video</code> - current video</li></ul></td></tr><tr><td valign="middle"><code>fw:shopping:pdp-primary-cta-clicked</code></td><td><p>Emitted when a click happen on the primary CTA on product details.</p><p><code>event.detail</code></p><ul><li><code>product</code> - current product</li><li><code>product_unit</code> - current unit</li><li><code>video</code> - current video</li><li><p><code>type</code></p><ul><li><code>BUY NOW</code>: Instant checkout buy now button</li><li><code>SHOP NOW</code>: A viewer will be redirected to off player PDP on click.</li><li><code>ADD TO CART</code>: Add to cart button</li></ul></li></ul></td></tr><tr><td valign="middle"><strong>Checkout</strong></td><td></td></tr><tr><td valign="middle"><code>fw:shopping:request-checkout</code></td><td><p>Emitted when use clicks checkout.</p><p><code>event.detail</code></p><ul><li><code>video</code> - current video</li><li><code>products</code> - cart conten</li></ul></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.firework.com/firework-for-developers/web/integration-guide/events/shopping-events.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.