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

Commit 841903c

Browse files
keharperkeharper
authored
GraphQL: small doc updates from Engcomm PRs (#5193)
* small doc updates from Engcomm PRs * place attribute in alphabetical order
1 parent 7982961 commit 841903c

File tree

5 files changed

+28
-28
lines changed

5 files changed

+28
-28
lines changed

‎guides/v2.3/graphql/reference/bundle-product.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,14 @@ Attribute | Type | Description
4040
`price_type` | PriceTypeEnum | One of FIXED, PERCENT, or DYNAMIC
4141
`price` | Float | The price of the selected option
4242
`product` | ProductInterface | The ProductInterface object, which contains details about this product option
43-
`qty` | Float | Indicates the quantity of this specific bundle item
43+
`qty` | Float | Deprecated. Use `quantity` instead.
44+
`quantity` | Float | Indicates the quantity of this specific bundle item
4445

4546
## Sample Query
4647

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

49-
```text
50+
```graphql
5051
{
5152
products(filter: {sku:
5253
{eq: "24-WG080"}
@@ -72,7 +73,7 @@ The following query returns information about bundle product `24-WG080`, which i
7273
sku
7374
options {
7475
id
75-
qty
76+
quantity
7677
position
7778
is_default
7879
price
@@ -91,4 +92,4 @@ The following query returns information about bundle product `24-WG080`, which i
9192
}
9293
}
9394
}
94-
```
95+
```

‎guides/v2.3/graphql/reference/categories.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ Attribute | Data type | Description
4242
`url_key`| String | The url key assigned to the category
4343
`url_path`| String | The url path assigned to the category
4444

45-
4645
#### CategoryProducts object
4746

4847
The `products` attribute can contain the following attributes:

‎guides/v2.3/graphql/reference/downloadable-product.md‎

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,10 @@ The `DownloadableProductSamples` object contains the following attributes:
103103

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

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

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

@@ -155,9 +155,6 @@ The following query returns information about downloadable product `240-LV04`, w
155155
downloadable_product_links {
156156
id
157157
sample_url
158-
sample_type
159-
is_shareable
160-
number_of_downloads
161158
sort_order
162159
title
163160
link_type
@@ -166,8 +163,6 @@ The following query returns information about downloadable product `240-LV04`, w
166163
downloadable_product_samples {
167164
title
168165
sort_order
169-
sort_order
170-
sample_type
171166
sample_file
172167
}
173168
}
@@ -201,9 +196,6 @@ The following query returns information about downloadable product `240-LV04`, w
201196
{
202197
"id": 1,
203198
"sample_url": null,
204-
"sample_type": null,
205-
"is_shareable": false,
206-
"number_of_downloads": 0,
207199
"sort_order": 1,
208200
"title": "Beginner's Yoga",
209201
"link_type": "FILE",
@@ -214,19 +206,16 @@ The following query returns information about downloadable product `240-LV04`, w
214206
{
215207
"title": "Trailer #1",
216208
"sort_order": 1,
217-
"sample_type": "FILE",
218209
"sample_file": "/l/u/luma_background_-_model_against_fence_4_sec_.mp4"
219210
},
220211
{
221212
"title": "Trailer #2",
222213
"sort_order": 1,
223-
"sample_type": "FILE",
224214
"sample_file": "/l/u/luma_background_-_model_against_fence_4_sec_.mp4"
225215
},
226216
{
227217
"title": "Trailer #3",
228218
"sort_order": 1,
229-
"sample_type": "FILE",
230219
"sample_file": "/l/u/luma_background_-_model_against_fence_4_sec_.mp4"
231220
}
232221
]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ Attribute | Data type | Description
202202
`updated_at` | String | The timestamp indicating when the product was last updated
203203
`upsell_products` | [[ProductInterface](#ProductInterface)] | An array of up-sell products
204204
`url_key` | String | The part of the URL that identifies the product. This attribute is defined in the `CatalogUrlRewriteGraphQl` module
205-
`url_path` | String | The part of the URL that precedes the `url_key`. This attribute is defined in the `CatalogUrlRewriteGraphQl` module
205+
`url_path` | String | Deprecated. Use `canonical_url` instead
206206
`url_rewrites` | [[UrlRewrite]](#urlRewriteObject) | A list of URL rewrites. See [UrlRewrite object](#urlRewriteObject) for more information and an [example query](#urlRewriteExample)
207207
`websites` | [Website] | An array of websites in which the product is available. See [Website object](#websiteObject) for more information and an [example query](#inclWebsiteInfoExample)
208208

‎guides/v2.3/graphql/reference/quote.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -507,6 +507,16 @@ Attribute | Data Type | Description
507507
`code` | String | The state or province code
508508
`label` | String | The display label for the region
509509

510+
511+
#### CartDiscount object {#CartDiscount}
512+
513+
The `CartDiscount` object must contain the following attributes.
514+
515+
Attribute | Data Type | Description
516+
--- | --- | ---
517+
`amount` | Money | The amount of all discounts applied to the cart
518+
`label` | [String!]! | A concatenated list of strings that describe each applied discount
519+
510520
#### CartItemInterface object {#CartItemInterface}
511521

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

0 commit comments

Comments
 (0)