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

Commit eb588a6

Browse files
keharperRakeshJesadiyasathiyaaajeff-matthews
authored
Merge small-changes branch into master (#8377)
* Update braintree-vault.md (#8345) * Update braintree-vault.md Request data is invalid. Syntax Error: Expected Name, found <EOF>". * Update braintree-vault.md * Update payflow-pro.md (#8346) Resolved Syntax Error: Expected Name, found <EOF> from the GraphQL Request. * add reference to the order item options and link (#8344) * Update add-products-to-cart.md (#8355) * Update add-products-to-cart.md Cart Id Invalid Error message. * Update add-products-to-cart.md Co-authored-by: Kevin Harper <[email protected]> * customer query improvements (#8353) * cart query object improvement (#8352) * Update category-list.md (#8313) * Update category-list.md Give Example of url_key and url_path attribute with categoryList query. * Update category-list.md * Update category-list.md * Update category-list.md Co-authored-by: Kevin Harper <[email protected]> * used viewModel * Update customizable-option-interface.md (#8328) * Update customizable-option-interface.md Added Example of the custom option type CustomizableFieldOption for the text field. * Update customizable-option-interface.md * Update customizable-option-interface.md * add error message on the product type (#8361) Co-authored-by: Rakesh Jesadiya <[email protected]> Co-authored-by: Sathiya Prakash <[email protected]> Co-authored-by: Jeff Matthews <[email protected]>
1 parent 027fc29 commit eb588a6

23 files changed

+259
-73
lines changed

src/_includes/graphql/cart-object-24.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Attribute | Data Type | Description
55
`applied_gift_cards` | [[`AppliedGiftCard`]][AppliedGiftCard] | An array of `AppliedGiftCard` objects. An `AppliedGiftCard` object contains the `code` text attribute, which specifies the gift card code. `applied_gift_cards` is a Commerce-only attribute, defined in the GiftCardAccountGraphQl module
66
`applied_reward_points`| [`RewardPointsAmount`][RewardPointsAmount] | The amount of reward points applied to the cart
77
`applied_store_credit` | [`AppliedStoreCredit`][AppliedStoreCredit] | Contains store credit information applied to the cart. `applied_store_credit` is a Commerce-only attribute, defined in the CustomerBalanceGraphQl module
8-
`available_gift_wrappings` | [GiftWrapping]! | The list of available gift wrapping options for the cart
8+
`available_gift_wrappings` | [[GiftWrapping]][GiftWrapping]! | The list of available gift wrapping options for the cart
99
`available_payment_methods` | [[AvailablePaymentMethod]][AvailablePaymentMethod] | Available payment methods
1010
`billing_address` | [BillingCartAddress][BillingCartAddress] | Contains the billing address specified in the customer's cart
1111
`email` | String | The customer's email address
1212
`gift_message` | [GiftMessage][GiftMessage] | A gift message added to the cart
1313
`gift_receipt_included` | Boolean! | Indicates if the customer requested a gift receipt for the cart
14-
`gift_wrapping` | GiftWrapping | The selected gift wrapping for the cart
14+
`gift_wrapping` | [GiftWrapping][GiftWrapping] | The selected gift wrapping for the cart
1515
`id` | ID! | The ID of the cart
1616
`is_virtual` | Boolean! | Indicates whether the cart contains only virtual products
1717
`items` | [[CartItemInterface]][CartItemInterface] | Contains the items in the customer's cart
@@ -29,6 +29,7 @@ Attribute | Data Type | Description
2929
[CartItemInterface]: {{page.baseurl}}/graphql/queries/cart.html#CartItemInterface
3030
[CartPrices]: {{page.baseurl}}/graphql/queries/cart.html#CartPrices
3131
[GiftMessage]: {{page.baseurl}}/graphql/queries/cart.html#GiftMessage
32+
[GiftWrapping]: {{page.baseurl}}/graphql/queries/cart.html#GiftWrapping
3233
[RewardPointsAmount]: {{page.baseurl}}/graphql/queries/cart.html#RewardPointsAmount
3334
[SelectedPaymentMethod]: {{page.baseurl}}/graphql/queries/cart.html#SelectedPaymentMethod
3435
[ShippingCartAddress]: {{page.baseurl}}/graphql/queries/cart.html#ShippingCartAddress

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/invoice-item-interface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Attribute | Data type | Description
22
--- | --- | ---
33
`discounts` | [Discount] | Contains information about the final discount amount for the base product, including discounts on options
44
`id` | ID! | The unique ID of the invoice item
5-
`order_item` | OrderItemInterface | Contains details about an individual order item
5+
`order_item` | [OrderItemInterface]({{page.baseurl}}/graphql/interfaces/order-item-interface.html) | Contains details about an individual order item
66
`product_name` | String | The name of the base product
77
`product_sale_price` | Money! | The sale price for the base product including selected options
88
`product_sku` | String! | The SKU of the base product

src/_includes/graphql/order-item-interface.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Attribute | Data Type | Description
22
--- | --- | ---
33
`discounts` | [Discount] | Final discount information for the product
4-
`entered_options` | [OrderItemOption] | The entered option for the base product, such as a logo or image
4+
`entered_options` | [`[OrderItemOption]`](#OrderItemOption) | The entered option for the base product, such as a logo or image
55
`id` | ID! | The unique identifier for the order item
66
`product_name` | String | The name of the base product
77
`product_sale_price` | Money! | The sale price of the base product, including selected options
@@ -14,5 +14,12 @@ Attribute | Data Type | Description
1414
`quantity_refunded` | Float | The number of refunded items
1515
`quantity_returned` | Float | The number of returned items
1616
`quantity_shipped` | Float | The number of shipped items
17-
`selected_options` | [OrderItemOption] | The selected options for the base product, such as color or size
18-
`status` | String | The status of the order item
17+
`selected_options` | [`[OrderItemOption]`](#OrderItemOption) | The selected options for the base product, such as color or size
18+
`status` | String | The status of the order item
19+
20+
#### OrderItemOption attributes {#OrderItemOption}
21+
22+
Attribute | Data type | Description
23+
--- | --- | ---
24+
`label` | String! | The name of the option
25+
`value` | String! | The value of the option

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/extension-dev-guide/view-models.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ View models can be used by passing the view model class as an argument to a temp
2424
```xml
2525
<block name="orangeco.new.viewmodel" template="OrangeCompany_Catalog::example.phtml">
2626
<arguments>
27-
<argument name="view_model" xsi:type="object">OrangeCompany\Catalog\ViewModel\MyNewViewModel</argument>
27+
<argument name="viewModel" xsi:type="object">OrangeCompany\Catalog\ViewModel\MyNewViewModel</argument>
2828
</arguments>
2929
</block>
3030
```
@@ -34,7 +34,7 @@ In the following example, the same view model is used with an existing block in
3434
```xml
3535
<referenceBlock name="checkout.cart.item.renderers.default">
3636
<arguments>
37-
<argument name="view_model" xsi:type="object">OrangeCompany\Catalog\ViewModel\MyNewViewModel</argument>
37+
<argument name="viewModel" xsi:type="object">OrangeCompany\Catalog\ViewModel\MyNewViewModel</argument>
3838
</arguments>
3939
</referenceBlock>
4040
```
@@ -78,7 +78,7 @@ The view model class is passed as an argument to the `product.info.upsell` block
7878
<block class="Magento\Catalog\Block\Product\ProductList\Upsell" name="product.info.upsell" template="Magento_Catalog::product/list/items.phtml">
7979
<arguments>
8080
<argument name="type" xsi:type="string">upsell</argument>
81-
<argument name="view_model" xsi:type="object">Magento\Catalog\ViewModel\Product\Listing\PreparePostData</argument>
81+
<argument name="viewModel" xsi:type="object">Magento\Catalog\ViewModel\Product\Listing\PreparePostData</argument>
8282
</arguments>
8383
</block>
8484
```

src/guides/v2.3/graphql/mutations/add-bundle-products.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,8 +247,8 @@ Attribute | Data Type | Description
247247

248248
Error | Description
249249
--- | ---
250+
`Could not find a cart with ID "XXX"` | The specified `cart_id` value does not exist in the `quote_id_mask` table.
250251
`Could not find a product with SKU "XXX"` | A simple product with the SKU specified in the `data.sku` argument does not exist.
251-
`Could not find a cart with ID "XXX"` | The specified `cart_id` value does not exist in the `quote_id_mask` database table.
252252
`Required parameter "cart_id" is missing` | The `cart_id` argument is omitted or contains an empty value.
253253

254254
## Related topics

src/guides/v2.3/graphql/mutations/add-configurable-products.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,12 @@ Attribute | Data Type | Description
144144

145145
Error | Description
146146
--- | ---
147+
`Could not find a cart with ID "XXX"` | The specified `cart_id` value does not exist in the `quote_id_mask` table.
147148
`Could not add the product with SKU configurable to the shopping cart: The product that was requested doesn't exist. Verify the product and try again.` | The simple product with the SKU specified in the `data`.`sku` attribute does not exist.
148149
`Could not find a product with SKU "XXX"` | The configurable product with SKU specified in the `parent_sku` argument does not exist.
149150
`Could not find specified product.` | The simple product specified in the `data`.`sku` argument is not assigned to the configurable product provided in the `parent_sku` attribute.
150151
`Required parameter "cart_id" is missing` | The `cart_id` argument was omitted or contains an empty value.
152+
`Required parameter "cart_items" is missing` | The `cart_items` argument was omitted or contains an empty array.
151153
`Required parameter "email" is missing` | The `email` argument was omitted or contains an empty value.
152154
`The requested qty is not available` | The requested quantity specified `data`.`quantity` is not available.
153155

src/guides/v2.3/graphql/mutations/add-downloadable-products.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,8 @@ Attribute | Data Type | Description
258258

259259
Error | Description
260260
--- | ---
261+
`Could not find a cart with ID "XXX"` | The specified `cart_id` value does not exist in the `quote_id_mask` table.
262+
`Could not find a product with SKU "YYY"` | A product with the SKU specified in the `data`.`sku` argument does not exist.
261263
`Required parameter "cart_id" is missing` | The mutation does not contain a `cart_id` argument.
262264
`Required parameter "cart_items" is missing` | The `cart_items` argument is empty or is not of type `array`.
263265
`Please specify product link(s).` | You tried to add a downloadable product in which the `Links can be purchased separately` option is enabled, but you did not specify individual product links.

0 commit comments

Comments
 (0)