Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 5 additions & 4 deletions guides/v2.3/graphql/reference/bundle-product.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,14 @@ Attribute | Type | Description
`price_type` | PriceTypeEnum | One of FIXED, PERCENT, or DYNAMIC
`price` | Float | The price of the selected option
`product` | ProductInterface | The ProductInterface object, which contains details about this product option
`qty` | Float | Indicates the quantity of this specific bundle item
`qty` | Float | Deprecated. Use `quantity` instead.
`quantity` | Float | Indicates the quantity of this specific bundle item

## Sample Query

The following query returns information about bundle product `24-WG080`, which is defined in the sample data.

```text
```graphql
{
products(filter: {sku:
{eq: "24-WG080"}
Expand All @@ -72,7 +73,7 @@ The following query returns information about bundle product `24-WG080`, which i
sku
options {
id
qty
quantity
position
is_default
price
Expand All @@ -91,4 +92,4 @@ The following query returns information about bundle product `24-WG080`, which i
}
}
}
```
```
1 change: 0 additions & 1 deletion guides/v2.3/graphql/reference/categories.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ Attribute | Data type | Description
`url_key`| String | The url key assigned to the category
`url_path`| String | The url path assigned to the category


#### CategoryProducts object

The `products` attribute can contain the following attributes:
Expand Down
33 changes: 11 additions & 22 deletions guides/v2.3/graphql/reference/downloadable-product.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,10 @@ The `DownloadableProductSamples` object contains the following attributes:

Attribute | Type | Description
--- | --- | ---
`id` | Int | The unique ID for the downloadable product sample
`sample_file` | String | The relative path to the downloadable sample
`sample_type` | DownloadableFileTypeEnum | Either FILE or URL
`sample_url` | String | The relative URL to the downloadable sample
`id` | Int | Deprecated. This information should not be exposed on frontend
`sample_file` | String | Deprecated. Use `sample_url` instead
`sample_type` | DownloadableFileTypeEnum | Deprecated. Use `sample_url` instead
`sample_url` | String | The URL to the downloadable sample
`sort_order` | Int | A number indicating the sort order
`title` | String | The display name of the sample

Expand All @@ -115,14 +115,14 @@ The `DownloadableProductLinks` object contains the following attributes:

Attribute | Type | Description
--- | --- | ---
`id` | Int | The unique ID for the link to the downloadable product
`is_shareable` | Boolean | Indicates whether the link is shareable
`link_type` | DownloadableFileTypeEnum | Either FILE or URL
`number_of_downloads` | Int | The maximum number of times the product can be downloaded. A value of 0 means unlimited.
`id` | Int | Deprecated. This information should not be exposed on frontend
`is_shareable` | Boolean | Deprecated. This information should not be exposed on frontend
`link_type` | DownloadableFileTypeEnum | Deprecated. Use `sample_url` instead
`number_of_downloads` | Int | Deprecated. This information should not be exposed on frontend
`price` | Float | The price of the downloadable product
`sample_file` | String | The relative path to the downloadable sample
`sample_type` | DownloadableFileTypeEnum | Either FILE or URL
`sample_url` | String | The relative URL to the downloadable sample
`sample_file` | String | Deprecated. Use `sample_url` instead
`sample_type` | DownloadableFileTypeEnum | Deprecated. Use `sample_url` instead
`sample_url` | String | The URL to the downloadable sample
`sort_order` | Int | A number indicating the sort order
`title` | String | The display name of the link

Expand Down Expand Up @@ -155,9 +155,6 @@ The following query returns information about downloadable product `240-LV04`, w
downloadable_product_links {
id
sample_url
sample_type
is_shareable
number_of_downloads
sort_order
title
link_type
Expand All @@ -166,8 +163,6 @@ The following query returns information about downloadable product `240-LV04`, w
downloadable_product_samples {
title
sort_order
sort_order
sample_type
sample_file
}
}
Expand Down Expand Up @@ -201,9 +196,6 @@ The following query returns information about downloadable product `240-LV04`, w
{
"id": 1,
"sample_url": null,
"sample_type": null,
"is_shareable": false,
"number_of_downloads": 0,
"sort_order": 1,
"title": "Beginner's Yoga",
"link_type": "FILE",
Expand All @@ -214,19 +206,16 @@ The following query returns information about downloadable product `240-LV04`, w
{
"title": "Trailer #1",
"sort_order": 1,
"sample_type": "FILE",
"sample_file": "/l/u/luma_background_-_model_against_fence_4_sec_.mp4"
},
{
"title": "Trailer #2",
"sort_order": 1,
"sample_type": "FILE",
"sample_file": "/l/u/luma_background_-_model_against_fence_4_sec_.mp4"
},
{
"title": "Trailer #3",
"sort_order": 1,
"sample_type": "FILE",
"sample_file": "/l/u/luma_background_-_model_against_fence_4_sec_.mp4"
}
]
Expand Down
2 changes: 1 addition & 1 deletion guides/v2.3/graphql/reference/products.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ Attribute | Data type | Description
`updated_at` | String | The timestamp indicating when the product was last updated
`upsell_products` | [[ProductInterface](#ProductInterface)] | An array of up-sell products
`url_key` | String | The part of the URL that identifies the product. This attribute is defined in the `CatalogUrlRewriteGraphQl` module
`url_path` | String | The part of the URL that precedes the `url_key`. This attribute is defined in the `CatalogUrlRewriteGraphQl` module
`url_path` | String | Deprecated. Use `canonical_url` instead
`url_rewrites` | [[UrlRewrite]](#urlRewriteObject) | A list of URL rewrites. See [UrlRewrite object](#urlRewriteObject) for more information and an [example query](#urlRewriteExample)
`websites` | [Website] | An array of websites in which the product is available. See [Website object](#websiteObject) for more information and an [example query](#inclWebsiteInfoExample)

Expand Down
11 changes: 11 additions & 0 deletions guides/v2.3/graphql/reference/quote.md
Original file line number Diff line number Diff line change
Expand Up @@ -507,6 +507,16 @@ Attribute | Data Type | Description
`code` | String | The state or province code
`label` | String | The display label for the region


#### CartDiscount object {#CartDiscount}

The `CartDiscount` object must contain the following attributes.

Attribute | Data Type | Description
--- | --- | ---
`amount` | Money | The amount of all discounts applied to the cart
`label` | [String!]! | A concatenated list of strings that describe each applied discount

#### CartItemInterface object {#CartItemInterface}

The `CartItemInterface` object can contain the following attributes.
Expand All @@ -533,6 +543,7 @@ The `CartPrices` object can contain the following attributes.
Attribute | Data Type | Description
--- | --- | ---
`applied_taxes` | [[CartTaxItem]](#CartTaxItem) | An array containing the names and amounts of taxes applied to the item
`discount` | CartDiscount | The total amount of all discounts applied to the cart
`grand_total` | Money | The total, including discounts, taxes, shipping, and other fees
`subtotal_excluding_tax` | Money | Subtotal without taxes
`subtotal_including_tax` | Money | Subtotal with taxes
Expand Down