You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: guides/v2.3/graphql/reference/products.md
+5-8Lines changed: 5 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -174,11 +174,10 @@ Attribute | Data type | Description
174
174
`custom_design_to` | String| The date at which a theme is no longer applied to the product page
175
175
`custom_layout` | String | The name of a custom layout
176
176
`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
178
178
`gift_message_available` | String | Indicates whether a gift message is available
179
179
`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
182
181
`is_returnable` | String | Indicates whether the product can be returned. This attribute is defined in the Rma module.
183
182
`manufacturer` | Int | A number representing the product's manufacturer
184
183
`media_gallery_entries` | [MediaGalleryEntry] | An array of [MediaGalleryEntry](#MediaGalleryEntry) objects
@@ -193,18 +192,16 @@ Attribute | Data type | Description
193
192
`page_layout` | String | The page layout of the product page. Values are `1column-center`, `2columns-left`, `2columns-right`, and `3columns`
194
193
`price` | ProductPrices | The price of an item. A `ProductPrice` object is returned. See [ProductPrices](#ProductPrices) for more information.
195
194
`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
197
196
`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
200
198
`special_from_date` | String | The beginning date that a product has a special price
201
199
`special_price` | Float | The discounted price of the product
202
200
`special_to_date` | String | The end date that a product has a special price
203
201
`stock_status` | ProductStockStatus | An enumeration describing the stock status of the product. Possible values are `IN_STOCK` and `OUT_OF_STOCK`.
204
202
`swatch_image` | String | The file name of a swatch image. This attribute is defined in the Swatches module.
205
203
`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
208
205
`tier_price` | Float | The price when tier pricing is in effect and the items purchased threshold has been reached
209
206
`tier_prices` | [ProductTierPrices] | An array of [ProductTierPrices](#ProductTier) objects
210
207
`type_id` | String | One of `simple`, `virtual`, `bundle`, `downloadable`,`grouped`, `configurable`
0 commit comments