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-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -174,10 +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` | ComplexTextValue | 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` | ProductImage | The URL and label for the main image on the product page
180
+
`image` | ProductImage | An object that contains the URL and label for the main image on the product page
181
181
`is_returnable` | String | Indicates whether the product can be returned. This attribute is defined in the Rma module.
182
182
`manufacturer` | Int | A number representing the product's manufacturer
183
183
`media_gallery_entries` | [MediaGalleryEntry] | An array of [MediaGalleryEntry](#MediaGalleryEntry) objects
@@ -192,16 +192,16 @@ Attribute | Data type | Description
192
192
`page_layout` | String | The page layout of the product page. Values are `1column-center`, `2columns-left`, `2columns-right`, and `3columns`
193
193
`price` | ProductPrices | The price of an item. A `ProductPrice` object is returned. See [ProductPrices](#ProductPrices) for more information.
194
194
`product_links` | [ProductLinks] | An array of [ProductLinks](#ProductLinks) objects
195
-
`short_description` | ComplexTextValue | A short description of the product. Its use depends on the store's theme. The value can include simple HTML tags
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
196
196
`sku` | String | A number or code assigned to a product to identify the product, options, price, and manufacturer
197
-
`small_image` | ProductImage | The URL and label for the small image used on catalog pages
197
+
`small_image` | ProductImage | An object that contains the URL and label for the small image used on catalog pages
198
198
`special_from_date` | String | The beginning date that a product has a special price
199
199
`special_price` | Float | The discounted price of the product
200
200
`special_to_date` | String | The end date that a product has a special price
201
201
`stock_status` | ProductStockStatus | An enumeration describing the stock status of the product. Possible values are `IN_STOCK` and `OUT_OF_STOCK`.
202
202
`swatch_image` | String | The file name of a swatch image. This attribute is defined in the Swatches module.
203
203
`tax_class_id` | Int | An ID assigned to a tax class. This attribute is defined in the Tax module.
204
-
`thumbnail` | ProductImage | The URL and label for the product's thumbnail image
204
+
`thumbnail` | ProductImage | An object that contains the URL and label for the product's thumbnail image
205
205
`tier_price` | Float | The price when tier pricing is in effect and the items purchased threshold has been reached
206
206
`tier_prices` | [ProductTierPrices] | An array of [ProductTierPrices](#ProductTier) objects
207
207
`type_id` | String | One of `simple`, `virtual`, `bundle`, `downloadable`,`grouped`, `configurable`
0 commit comments