Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 0e51f28

Browse files
authored
Merge pull request #3854 from magento/em_magento-graphqlCatalog
Updating ProductInterface endpoint with new data types
2 parents ca6727f + 2e093ff commit 0e51f28

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

guides/v2.3/graphql/reference/products.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -174,11 +174,10 @@ Attribute | Data type | Description
174174
`custom_design_to` | String| The date at which a theme is no longer applied to the product page
175175
`custom_layout` | String | The name of a custom layout
176176
`custom_layout_update` | String | XML code that is applied as a layout update to the product page
177-
`description` | String | Detailed information about the product. The value can include simple HTML tags
177+
`description` | ComplexTextValue | An object that contains detailed information about the product. The object can include simple HTML tags
178178
`gift_message_available` | String | Indicates whether a gift message is available
179179
`id` | Int | The ID number assigned to the product
180-
`image` | String | The relative path for the main image on the product page
181-
`image_label` | String | The label assigned to a product image
180+
`image` | ProductImage | An object that contains the URL and label for the main image on the product page
182181
`is_returnable` | String | Indicates whether the product can be returned. This attribute is defined in the Rma module.
183182
`manufacturer` | Int | A number representing the product's manufacturer
184183
`media_gallery_entries` | [MediaGalleryEntry] | An array of [MediaGalleryEntry](#MediaGalleryEntry) objects
@@ -193,18 +192,16 @@ Attribute | Data type | Description
193192
`page_layout` | String | The page layout of the product page. Values are `1column-center`, `2columns-left`, `2columns-right`, and `3columns`
194193
`price` | ProductPrices | The price of an item. A `ProductPrice` object is returned. See [ProductPrices](#ProductPrices) for more information.
195194
`product_links` | [ProductLinks] | An array of [ProductLinks](#ProductLinks) objects
196-
`short_description` | String | A short description of the product. Its use depends on the store's theme.
195+
`short_description` | ComplexTextValue | An object that contains a short description of the product. Its use depends on the store's theme. The object can include simple HTML tags
197196
`sku` | String | A number or code assigned to a product to identify the product, options, price, and manufacturer
198-
`small_image` | String | The relative path to the small image, which is used on catalog pages
199-
`small_image_label` | String | The label assigned to a product's small image
197+
`small_image` | ProductImage | An object that contains the URL and label for the small image used on catalog pages
200198
`special_from_date` | String | The beginning date that a product has a special price
201199
`special_price` | Float | The discounted price of the product
202200
`special_to_date` | String | The end date that a product has a special price
203201
`stock_status` | ProductStockStatus | An enumeration describing the stock status of the product. Possible values are `IN_STOCK` and `OUT_OF_STOCK`.
204202
`swatch_image` | String | The file name of a swatch image. This attribute is defined in the Swatches module.
205203
`tax_class_id` | Int | An ID assigned to a tax class. This attribute is defined in the Tax module.
206-
`thumbnail` | String | The relative path to the product's thumbnail image
207-
`thumbnail_label` | String | The label assigned to a product's thumbnail image
204+
`thumbnail` | ProductImage | An object that contains the URL and label for the product's thumbnail image
208205
`tier_price` | Float | The price when tier pricing is in effect and the items purchased threshold has been reached
209206
`tier_prices` | [ProductTierPrices] | An array of [ProductTierPrices](#ProductTier) objects
210207
`type_id` | String | One of `simple`, `virtual`, `bundle`, `downloadable`,`grouped`, `configurable`

0 commit comments

Comments
 (0)