Skip to content

DATA-7320: Document the unified product media gallery #627

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
slavvka wants to merge 2 commits into
base: main
Choose a base branch
from
Open

DATA-7320: Document the unified product media gallery #627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb1298c
DATA-7320: Catalog Service products: ACO videos/images.sortOrder supp…
slavvka Oct 7, 2026
0d0a074
Merge branch 'main' into DATA-7320-product-media-gallery
erikmarr Oct 8, 2026
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
7 changes: 7 additions & 0 deletions src/pages/graphql/schema/catalog-service/queries/product-variants.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -632,6 +632,7 @@ The `ProductView` return object is an interface that can contain the following f
| `description` | String | The detailed description of the product. |
| `externalId`| String | The external ID of the product. |
| `id` | ID! | The product ID, generated as a composite key, unique per locale. |
| `gallery` | [`[ProductViewMedia]`](#productviewmedia-union) | A single ordered list containing all images and videos defined for the product. |
| `images(roles: [String])` | [`[ProductViewImage]`](#productviewimage-type) | A list of images defined for the product. |
| `inputOptions` | [`[ProductViewInputOption]`](#productviewinputoption-type) | A list of input options the shopper can supply to customize a product. |
| `inStock` | Boolean | Indicates whether the product is in stock. |
Expand All @@ -658,6 +659,7 @@ The `ComplexProductView` type represents bundle, configurable, and group product
| `description` | String | The detailed description of the product. |
| `externalId`| String | The external ID of the product. |
| `id` | ID! | The product ID, generated as a composite key, unique per locale. |
| `gallery` | [`[ProductViewMedia]`](#productviewmedia-union) | A single ordered list containing all images and videos defined for the product. |
| `images(roles: [String])` | [`[ProductViewImage]`](#productviewimage-type) | A list of images defined for the product. |
| `inputOptions` | [`[ProductViewInputOption]`](#productviewinputoption-type) | A list of input options the shopper can supply to customize a product. |
| `inStock` | Boolean | Indicates whether the product is in stock. |
Expand Down Expand Up @@ -704,6 +706,10 @@ The `ProductViewAttribute` type is a container for customer-defined attributes t
| `roles` | [String] | Roles designated for an attribute on the storefront, such as "Show on PLP", "Show in PDP", or "Show in Search". |
| `value` | JSON | Attribute value, arbitrary of type. |

### ProductViewMedia union

The `ProductViewMedia` union represents an entry in the ordered product media gallery. Use inline fragments on `ProductViewImage` and `ProductViewVideo` to retrieve fields for each media type. Entries are returned in resolved display order, and clients should preserve that order.

### ProductViewImage type

The `ProductViewImage` type contains details about a product image.
Expand Down Expand Up @@ -862,6 +868,7 @@ The `SimpleProductView` type represents all product types, except bundle, config
| `description` | String | The detailed description of the product. |
| `externalId`| String | The external ID of the product. |
| `id` | ID! | The product ID, generated as a composite key, unique per locale. |
| `gallery` | [`[ProductViewMedia]`](#productviewmedia-union) | A single ordered list containing all images and videos defined for the product. |
| `images(roles: [String])` | [`[ProductViewImage]`](#productviewimage-type) | A list of images defined for the product. |
| `inputOptions` | [`[ProductViewInputOption]`](#productviewinputoption-type) | A list of input options the shopper can supply to customize a product. |
| `inStock` | Boolean | Indicates whether the product is in stock. |
Expand Down
7 changes: 7 additions & 0 deletions src/pages/graphql/schema/catalog-service/queries/products.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -845,6 +845,7 @@ The `ProductView` return object is an interface that can contain the following f
| `description` | String | The detailed description of the product. |
| `externalId`| String | The external ID of the product. |
| `id` | ID! | The product ID, generated as a composite key, unique per locale. |
| `gallery` | [`[ProductViewMedia]`](#productviewmedia-union) | A single ordered list containing all images and videos defined for the product. |
| `images(roles: [String])` | [`[ProductViewImage]`](#productviewimage-type) | A list of images defined for the product. |
| `inputOptions` | [`[ProductViewInputOption]`](#productviewinputoption-type) | A list of input options the shopper can supply to customize a product. |
| `inStock` | Boolean | Indicates whether the product is in stock. |
Expand All @@ -871,6 +872,7 @@ The `ComplexProductView` type represents bundle, configurable, and group product
| `description` | String | The detailed description of the product. |
| `externalId`| String | The external ID of the product. |
| `id` | ID! | The product ID, generated as a composite key, unique per locale. |
| `gallery` | [`[ProductViewMedia]`](#productviewmedia-union) | A single ordered list containing all images and videos defined for the product. |
| `images(roles: [String])` | [`[ProductViewImage]`](#productviewimage-type) | A list of images defined for the product. |
| `inputOptions` | [`[ProductViewInputOption]`](#productviewinputoption-type) | A list of input options the shopper can supply to customize a product. |
| `inStock` | Boolean | Indicates whether the product is in stock. |
Expand Down Expand Up @@ -917,6 +919,10 @@ The `ProductViewAttribute` type is a container for customer-defined attributes t
| `roles` | [String] | Roles designated for an attribute on the storefront, such as "Show on PLP", "Show in PDP", or "Show in Search". |
| `value` | JSON | Attribute value, arbitrary of type. |

### ProductViewMedia union

The `ProductViewMedia` union represents an entry in the ordered product media gallery. Use inline fragments on `ProductViewImage` and `ProductViewVideo` to retrieve fields for each media type. Entries are returned in resolved display order, and clients should preserve that order.

### ProductViewImage type

The `ProductViewImage` type contains details about a product image.
Expand Down Expand Up @@ -1075,6 +1081,7 @@ The `SimpleProductView` type represents all product types, except bundle, config
| `description` | String | The detailed description of the product. |
| `externalId`| String | The external ID of the product. |
| `id` | ID! | The product ID, generated as a composite key, unique per locale. |
| `gallery` | [`[ProductViewMedia]`](#productviewmedia-union) | A single ordered list containing all images and videos defined for the product. |
| `images(roles: [String])` | [`[ProductViewImage]`](#productviewimage-type) | A list of images defined for the product. |
| `inputOptions` | [`[ProductViewInputOption]`](#productviewinputoption-type) | A list of input options the shopper can supply to customize a product. |
| `inStock` | Boolean | Indicates whether the product is in stock. |
Expand Down
7 changes: 7 additions & 0 deletions src/pages/graphql/schema/catalog-service/queries/refine-product.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,7 @@ The `ProductView` return object is an interface that can contain the following f
| `description` | String | The detailed description of the product. |
| `externalId`| String | The external ID of the product. |
| `id` | ID! | The product ID, generated as a composite key, unique per locale. |
| `gallery` | [`[ProductViewMedia]`](#productviewmedia-union) | A single ordered list containing all images and videos defined for the product. |
| `images(roles: [String])` | [`[ProductViewImage]`](#productviewimage-type) | A list of images defined for the product. |
| `inputOptions` | [`[ProductViewInputOption]`](#productviewinputoption-type) | A list of input options the shopper can supply to customize a product. |
| `inStock` | Boolean | Indicates whether the product is in stock. |
Expand All @@ -315,6 +316,7 @@ The `ComplexProductView` type represents bundle, configurable, and group product
| `description` | String | The detailed description of the product. |
| `externalId`| String | The external ID of the product. |
| `id` | ID! | The product ID, generated as a composite key, unique per locale. |
| `gallery` | [`[ProductViewMedia]`](#productviewmedia-union) | A single ordered list containing all images and videos defined for the product. |
| `images(roles: [String])` | [`[ProductViewImage]`](#productviewimage-type) | A list of images defined for the product. |
| `inputOptions` | [`[ProductViewInputOption]`](#productviewinputoption-type) | A list of input options the shopper can supply to customize a product. |
| `inStock` | Boolean | Indicates whether the product is in stock. |
Expand Down Expand Up @@ -361,6 +363,10 @@ The `ProductViewAttribute` type is a container for customer-defined attributes t
| `roles` | [String] | Roles designated for an attribute on the storefront, such as "Show on PLP", "Show in PDP", or "Show in Search". |
| `value` | JSON | Attribute value, arbitrary of type. |

### ProductViewMedia union

The `ProductViewMedia` union represents an entry in the ordered product media gallery. Use inline fragments on `ProductViewImage` and `ProductViewVideo` to retrieve fields for each media type. Entries are returned in resolved display order, and clients should preserve that order.

### ProductViewImage type

The `ProductViewImage` type contains details about a product image.
Expand Down Expand Up @@ -519,6 +525,7 @@ The `SimpleProductView` type represents all product types, except bundle, config
| `description` | String | The detailed description of the product. |
| `externalId`| String | The external ID of the product. |
| `id` | ID! | The product ID, generated as a composite key, unique per locale. |
| `gallery` | [`[ProductViewMedia]`](#productviewmedia-union) | A single ordered list containing all images and videos defined for the product. |
| `images(roles: [String])` | [`[ProductViewImage]`](#productviewimage-type) | A list of images defined for the product. |
| `inputOptions` | [`[ProductViewInputOption]`](#productviewinputoption-type) | A list of input options the shopper can supply to customize a product. |
| `inStock` | Boolean | Indicates whether the product is in stock. |
Expand Down
7 changes: 7 additions & 0 deletions src/pages/includes/graphql/catalog-service/product-view.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ The `ProductView` return object is an interface that can contain the following f
| `description` | String | The detailed description of the product. |
| `externalId`| String | The external ID of the product. |
| `id` | ID! | The product ID, generated as a composite key, unique per locale. |
| `gallery` | [`[ProductViewMedia]`](#productviewmedia-union) | A single ordered list containing all images and videos defined for the product. |
| `images(roles: [String])` | [`[ProductViewImage]`](#productviewimage-type) | A list of images defined for the product. |
| `inputOptions` | [`[ProductViewInputOption]`](#productviewinputoption-type) | A list of input options the shopper can supply to customize a product. |
| `inStock` | Boolean | Indicates whether the product is in stock. |
Expand All @@ -33,6 +34,7 @@ The `ComplexProductView` type represents bundle, configurable, and group product
| `description` | String | The detailed description of the product. |
| `externalId`| String | The external ID of the product. |
| `id` | ID! | The product ID, generated as a composite key, unique per locale. |
| `gallery` | [`[ProductViewMedia]`](#productviewmedia-union) | A single ordered list containing all images and videos defined for the product. |
| `images(roles: [String])` | [`[ProductViewImage]`](#productviewimage-type) | A list of images defined for the product. |
| `inputOptions` | [`[ProductViewInputOption]`](#productviewinputoption-type) | A list of input options the shopper can supply to customize a product. |
| `inStock` | Boolean | Indicates whether the product is in stock. |
Expand Down Expand Up @@ -79,6 +81,10 @@ The `ProductViewAttribute` type is a container for customer-defined attributes t
| `roles` | [String] | Roles designated for an attribute on the storefront, such as "Show on PLP", "Show in PDP", or "Show in Search". |
| `value` | JSON | Attribute value, arbitrary of type. |

### ProductViewMedia union

The `ProductViewMedia` union represents an entry in the ordered product media gallery. Use inline fragments on `ProductViewImage` and `ProductViewVideo` to retrieve fields for each media type. Entries are returned in resolved display order, and clients should preserve that order.

### ProductViewImage type

The `ProductViewImage` type contains details about a product image.
Expand Down Expand Up @@ -237,6 +243,7 @@ The `SimpleProductView` type represents all product types, except bundle, config
| `description` | String | The detailed description of the product. |
| `externalId`| String | The external ID of the product. |
| `id` | ID! | The product ID, generated as a composite key, unique per locale. |
| `gallery` | [`[ProductViewMedia]`](#productviewmedia-union) | A single ordered list containing all images and videos defined for the product. |
| `images(roles: [String])` | [`[ProductViewImage]`](#productviewimage-type) | A list of images defined for the product. |
| `inputOptions` | [`[ProductViewInputOption]`](#productviewinputoption-type) | A list of input options the shopper can supply to customize a product. |
| `inStock` | Boolean | Indicates whether the product is in stock. |
Expand Down