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

Commit 9bfb643

Browse files
customer query improvements (#8353)
1 parent 36a43d3 commit 9bfb643

File tree

6 files changed

+37
-31
lines changed

6 files changed

+37
-31
lines changed

src/_includes/graphql/customer-orders-output.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -43,23 +43,23 @@ Attribute | Data type | Description
4343
--- | --- | ---
4444
`billing_address` | [OrderAddress](#OrderAddress) | The billing address for the order
4545
`carrier` | String | The shipping carrier for the order delivery
46-
`comments` | [[SalesCommentItem](#SalesCommentItem)] | Comments on the order
46+
`comments` | [[SalesCommentItem]](#SalesCommentItem) | Comments on the order
4747
`created_at` | String | Deprecated. Use the `order_date` attribute instead
48-
`credit_memos` | [[CreditMemo](#CreditMemo)] | Contains a list of credit memos for the order
48+
`credit_memos` | [[CreditMemo]](#CreditMemo) | Contains a list of credit memos for the order
4949
`grand_total` | Float | Deprecated. Use the `totals.grand_total` attribute instead
5050
`gift_message` | [GiftMessage](#GiftMessage) | The entered gift message for the order
5151
`gift_receipt_included` | Boolean! | Indicates if the customer requested a gift receipt for the order
5252
`gift_wrapping` | [GiftWrapping](#GiftWrapping) | The selected gift wrapping for the order
5353
`id` | ID! | Unique identifier for the order
5454
`increment_id` | String | Deprecated. Use the `id` attribute instead
55-
`invoices` | [[Invoice](#Invoice)]! | Contains a list of invoices for the order
56-
`items` | [[OrderItemInterface](#OrderItemInterface)] | An array containing the items purchased in this order
55+
`invoices` | [[Invoice]](#Invoice)! | Contains a list of invoices for the order
56+
`items` | [[OrderItemInterface]](#OrderItemInterface) | An array containing the items purchased in this order
5757
`number` | String! | The order number
5858
`order_date` | String! | The date the order was placed
5959
`order_number` | String! | Deprecated. Use the `number` attribute instead
60-
`payment_methods` | [[PaymentMethod](#PaymentMethod)] | Payment details for the order
60+
`payment_methods` | [[PaymentMethod]](#PaymentMethod) | Payment details for the order
6161
`printed_card_included` | Boolean! | Indicates if the customer requested a printed card for the order
62-
`shipments` | [[OrderShipment](#OrderShipment)] | Shipment list for the order
62+
`shipments` | [[OrderShipment]](#OrderShipment) | Shipment list for the order
6363
`shipping_address` | [OrderAddress](#OrderAddress) | Shipping address for the order
6464
`shipping_method` | String | Shipping method for the order
6565
`status` | String! | The current status of the order
@@ -73,9 +73,9 @@ The `CreditMemo` object contains details about credit memos applied to an order.
7373

7474
Attribute | Data type | Description
7575
--- | --- | ---
76-
`comments` | [[SalesCommentItem](#SalesCommentItem)] | Comments on the credit memo
76+
`comments` | [[SalesCommentItem]](#SalesCommentItem) | Comments on the credit memo
7777
`id` | ID! | The unique ID of the credit memo
78-
`items` | [[CreditMemoItemInterface](#CreditMemoItemInterface)] | An array containing details about refunded items
78+
`items` | [[CreditMemoItemInterface]](#CreditMemoItemInterface) | An array containing details about refunded items
7979
`number` | String! | The sequential credit memo number
8080
`total` | [CreditMemoTotal](#CreditMemoTotal) | Contains details about the total refunded amount
8181

@@ -95,11 +95,11 @@ Attribute | Data type | Description
9595
--- | --- | ---
9696
`adjustment` | Money! | An adjustment manually applied to the order
9797
`base_grand_total` | Money! | The final base grand total amount in the base currency
98-
`discounts` | [Discount] | The applied discounts to the order
98+
`discounts` | [[Discount]](#Discount) | The applied discounts to the order
9999
`grand_total` | Money! | The final total amount, including shipping, discounts, and taxes
100100
`shipping_handling` | [ShippingHandling](#ShippingHandling) | Contains details about the shipping and handling costs for the credit memo
101101
`subtotal` | Money! | The subtotal of the order, excluding shipping, discounts, and taxes
102-
`taxes` | [[TaxItem](#TaxItem)]! | An array containing information about taxes on individual orders
102+
`taxes` | [[TaxItem]](#TaxItem)! | An array containing information about taxes on individual orders
103103
`total_shipping` | Money! | The shipping amount for the credit memo
104104
`total_tax` | Money! | The amount of tax applied to all orders
105105

@@ -126,9 +126,9 @@ The `Invoice` object provides details about a customer invoice.
126126

127127
Attribute | Data type | Description
128128
--- | --- | ---
129-
`comments` | [[SalesCommentItem](#SalesCommentItem)] | Comments on the invoice
129+
`comments` | [[SalesCommentItem]](#SalesCommentItem) | Comments on the invoice
130130
`id` | ID! | The internal ID of the invoice
131-
`items` | [[InvoiceItemInterface](#InvoiceItemInterface)]! | Contains details about invoiced products
131+
`items` | [[InvoiceItemInterface]](#InvoiceItemInterface)! | Contains details about invoiced products
132132
`number` | String! | The sequential number of the invoice
133133
`total` | [InvoiceTotal](#InvoiceTotal)! | Invoice total amount details
134134

@@ -149,11 +149,11 @@ The InvoiceTotal object contains details about the totals of an invoice.
149149
Attribute | Data type | Description
150150
--- | --- | ---
151151
`base_grand_total` | Money! | The final base grand total amount in the base currency
152-
`discounts` | [Discount] | The applied discounts to the invoice
152+
`discounts` | [[Discount]](#Discount) | The applied discounts to the invoice
153153
`grand_total` | Money! | The final total amount, including shipping, discounts, and taxes
154154
`shipping_handling` | [ShippingHandling](#ShippingHandling) | Contains details about the shipping and handling costs for the invoice
155155
`subtotal` | Money! | The subtotal of the invoice, excluding shipping, discounts, and taxes
156-
`taxes` | [[TaxItem](#TaxItem)] | An array containing information about taxes on individual invoices
156+
`taxes` | [[TaxItem]](#TaxItem) | An array containing information about taxes on individual invoices
157157
`total_shipping` | Money! | The shipping amount for the invoice
158158
`total_tax` | Money! | The amount of tax applied to all invoices
159159

@@ -227,11 +227,11 @@ Attribute | Data type | Description
227227

228228
Attribute | Data type | Description
229229
--- | --- | ---
230-
`comments` | [[SalesCommentItem](#SalesCommentItem)] | Comments added to the shipment
230+
`comments` | [[SalesCommentItem]](#SalesCommentItem) | Comments added to the shipment
231231
`id` | ID! | The unique ID of the shipment
232-
`items` | [[ShipmentItemInterface](#ShipmentItemInterface)] | Contains items included in the shipment
232+
`items` | [[ShipmentItemInterface]](#ShipmentItemInterface) | Contains items included in the shipment
233233
`number` | String! | The sequential credit shipment number
234-
`tracking` | [[ShipmentTracking](#ShipmentTracking)] | Contains shipment tracking detail
234+
`tracking` | [[ShipmentTracking]](#ShipmentTracking) | Contains shipment tracking detail
235235

236236
#### OrderTotal attributes {#OrderTotal}
237237

@@ -240,11 +240,11 @@ The `OrderTotal` object contains details about the sales total amounts used to c
240240
Attribute | Data type | Description
241241
--- | --- | ---
242242
`base_grand_total` | Money! | The final base grand total amount in the base currency
243-
`discounts` | [Discount] | The applied discounts to the order
243+
`discounts` | [[Discount]](#Discount) | The applied discounts to the order
244244
`grand_total` | Money! | The final total amount, including shipping, discounts, and taxes
245245
`shipping_handling` | [ShippingHandling](#ShippingHandling) | The shipping and handling costs for the order
246246
`subtotal` | Money! | The subtotal of the order, excluding shipping, discounts, and taxes
247-
`taxes` | [[TaxItem](#TaxItem)]! | An array containing information about taxes on individual orders
247+
`taxes` | [[TaxItem]](#TaxItem)! | An array containing information about taxes on individual orders
248248
`total_shipping` | Money! | The shipping costs for the order
249249
`total_tax` | Money! | The amount of tax applied to the order
250250

@@ -254,7 +254,7 @@ The PaymentMethod data type contains details about the payment method used to pa
254254

255255
Attribute | Data type | Description
256256
--- | --- | ---
257-
`additional_data` | [[KeyValue](#KeyValue)] | Additional data per payment method type
257+
`additional_data` | [[KeyValue]](#KeyValue) | Additional data per payment method type
258258
`name` | String! | The label that describes the payment method
259259
`type` | String! | The payment method code that indicates how the order was paid for
260260

@@ -378,8 +378,8 @@ Attribute | Data type | Description
378378
--- | --- | ---
379379
`amount_excluding_tax` | Money | The shipping amount, excluding tax
380380
`amount_including_tax` | Money | The shipping amount, including tax
381-
`discounts` | [ShippingDiscount] | The applied discounts to the shipping
382-
`taxes` | [[TaxItem](#TaxItem)] | Contains details about taxes applied for shipping
381+
`discounts` | [[ShippingDiscount]](#ShippingDiscount) | The applied discounts to the shipping
382+
`taxes` | [[TaxItem]](#TaxItem) | Contains details about taxes applied for shipping
383383
`total_amount`| Money! | The total amount for shipping
384384

385385
#### TaxItem attributes {#TaxItem}

src/_includes/graphql/customer-output-24.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22
{% assign customeraddress_text = '[CustomerAddress](#customerAddressOutput)' %}
33
{% assign customeroutput_text = '[CustomerOrders](#customerOrders)' %}
44
{% assign crossref_text = '. See [`orders` input attributes](#orders) for details' %}
5+
{% assign productreview_text = '[ProductReviews](#ProductReviews)!' %}
6+
{% assign rewardpoints_text = '[RewardPoints](#RewardPoints)' %}
7+
{% assign wishlist_text = '[Wishlist](#Wishlist)!' %}
58
{% else %}
69
{% assign customeraddress_text = 'CustomerAddress' %}
710
{% assign customeroutput_text = '[CustomerOrders]' %}
811
{% assign crossref_text = '' %}
12+
{% assign productreview_text = '[ProductReviews]!' %}
13+
{% assign rewardpoints_text = '[RewardPoints]' %}
14+
{% assign wishlist_text = '[Wishlist]!' %}
915
{% endif %}
1016

1117
Attribute | Data Type | Description
@@ -26,8 +32,8 @@ Attribute | Data Type | Description
2632
`middlename` |String | The customer's middle name
2733
`orders(<FilterCriteria>)` | {{ customeroutput_text }} | A list of the customer's placed orders{{ crossref_text }}
2834
`prefix` | String | An honorific, such as Dr., Mr., or Mrs.
29-
`reviews(pageSize: Int = 20 currentPage: Int = 1)` | ProductReviews! | The list of reviews of the product
30-
`reward_points` | RewardPoints | Details about the customer's reward points
35+
`reviews(pageSize: Int = 20 currentPage: Int = 1)` | {{ productreview_text }} | The list of reviews of the product
36+
`reward_points` | {{ rewardpoints_text }} | Details about the customer's reward points
3137
`suffix` | String | A value such as Sr., Jr., or III
3238
`taxvat` | String | The customer's Tax/VAT number (for corporate customers)
33-
`wishlist` | Wishlist! | Contains the contents of the customer's wish lists
39+
`wishlist` | {{ wishlist_text }} | Contains the contents of the customer's wish lists

src/_includes/graphql/product-review.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Attribute | Data Type | Description
55
`average_rating` | Float! | The average rating for product review
66
`created_at` | String! | Date indicating when the review was created
77
`nickname` | String! | The customer's nickname. Defaults to the customer name, if logged in
8-
`product` | ProductInterface! | Contains details about the reviewed product
9-
`ratings_breakdown` | [ProductReviewRating!]! | An array of ratings by rating category, such as quality, price, and value
8+
`product` | [ProductInterface!]({{ page.baseurl }}/graphql/interfaces/product-interface.html)| Contains details about the reviewed product
9+
`ratings_breakdown` | [[ProductReviewRating!]](#ProductReviewRating)! | An array of ratings by rating category, such as quality, price, and value
1010
`summary` | String! | The summary (title) of the review
1111
`text` | String! | The review text
1212

src/guides/v2.3/graphql/queries/customer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ The `customer` object can contain the following attributes:
273273

274274
Attribute | Data type | Description
275275
--- | --- | ---
276-
`items` | [[WishlistItem](#wishlistitem)] | An array of items in the customer's wish list
276+
`items` | [[WishlistItem]](#wishlistitem) | An array of items in the customer's wish list
277277
`items_count` | Int | The number of items in the wish list
278278
`id` | ID | The unique identifier of the wish list
279279
`sharing_code` | String | An encrypted code that Magento uses to link to the wish list

src/guides/v2.4/graphql/interfaces/product-interface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Attribute | Data Type | Description
166166

167167
Attribute | Data Type | Description
168168
--- | --- | ---
169-
`items` | [ProductReview]! | An array of product reviews
169+
`items` | [[ProductReview]](#ProductReview)! | An array of product reviews
170170
`page_info` | [SearchResultPageInfo!]({{page.baseurl}}/graphql/queries/products.html#SearchResultPageInfo) | Metadata for pagination rendering
171171

172172
#### ProductReview object {#ProductReview}

src/guides/v2.4/graphql/queries/customer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -622,7 +622,7 @@ Attribute | Data Type | Description
622622

623623
Attribute | Data Type | Description
624624
--- | --- | ---
625-
`items` | [ProductReview]! | An array of product reviews
625+
`items` | [[ProductReview]](#ProductReview)! | An array of product reviews
626626
`page_info` | [SearchResultPageInfo!]({{page.baseurl}}/graphql/queries/products.html#SearchResultPageInfo) | Metadata for pagination rendering
627627

628628
#### ProductReview object {#ProductReview}
@@ -633,7 +633,7 @@ Attribute | Data Type | Description
633633

634634
Attribute | Data type | Description
635635
--- | --- | ---
636-
`items` | [[WishlistItem](#wishlistitem)] | An array of items in the customer's wish list
636+
`items` | [[WishlistItem]](#wishlistitem) | An array of items in the customer's wish list
637637
`items_count` | Int | The number of items in the wish list
638638
`id` | ID | The unique identifier of the wish list
639639
`sharing_code` | String | An encrypted code that Magento uses to link to the wish list

0 commit comments

Comments
 (0)