Skip to content

Add mention of extended IProductSnapshot interfaces #7680

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+5 −0
Open

Add mention of extended IProductSnapshot interfaces #7680

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1de6a56
Add mention of extended IProductSnapshot interfaces
jemayn Dec 1, 2025
fe129b6
Update 17/umbraco-commerce/key-concepts/product-adapters.md
jemayn Dec 1, 2025
02e4163
Update 17/umbraco-commerce/key-concepts/product-adapters.md
jemayn Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions 17/umbraco-commerce/key-concepts/product-adapters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ public interface IProductSnapshot

```

{% hint style="info" %}
`IProductSnapshot` is the base model for what Umbraco Commerce needs. If you want to include images or measurements (for example, if you need weight-based shipping), then there are other interfaces you can return.
Copy link
Contributor

@sofietoft sofietoft Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've attempted to make these sentences more direct. What do you think?

Suggested change
`IProductSnapshot` is the base model for what Umbraco Commerce needs. If you want to include images or measurements (for example, if you need weight-based shipping), then there are other interfaces you can return.
`IProductSnapshot` is the base model for enriching the Umbraco Commerce product model. To include images or custom measurements, such as weight-based shipping, more specific interfaces are available.

`IProductSnapshotWithImage`, `IProductSnapshotWithCategories` & `IProductSnapshotWithMeasurements` are all valid return types that allows you to enrich the product model.
Copy link
Contributor

@sofietoft sofietoft Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if there are in fact more available interfaces - you probably know that better than me ;)
But how about we use a list here? 🤔

Suggested change
`IProductSnapshotWithImage`, `IProductSnapshotWithCategories` & `IProductSnapshotWithMeasurements` are all valid return types that allows you to enrich the product model.
Valid interfaces include, but are not limited to:
* `IProductSnapshotWithImage`
* `IProductSnapshotWithCategories`
* `IProductSnapshotWithMeasurements`

{% endhint %}

## Support editable carts

To allow Umbraco Commerce to search for products/variants to add to a cart via the backoffice, Product Adapters can implement 3 additional methods. This can also be done to support editable carts.
Expand Down