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

Merge small-changes branch into master #8377

Merged
merged 12 commits into from
Dec 14, 2020
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
5 changes: 3 additions & 2 deletions src/_includes/graphql/cart-object-24.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Attribute | Data Type | Description
`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
`applied_reward_points`| [`RewardPointsAmount`][RewardPointsAmount] | The amount of reward points applied to the cart
`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
`available_gift_wrappings` | [GiftWrapping]! | The list of available gift wrapping options for the cart
`available_gift_wrappings` | [[GiftWrapping]][GiftWrapping]! | The list of available gift wrapping options for the cart
`available_payment_methods` | [[AvailablePaymentMethod]][AvailablePaymentMethod] | Available payment methods
`billing_address` | [BillingCartAddress][BillingCartAddress] | Contains the billing address specified in the customer's cart
`email` | String | The customer's email address
`gift_message` | [GiftMessage][GiftMessage] | A gift message added to the cart
`gift_receipt_included` | Boolean! | Indicates if the customer requested a gift receipt for the cart
`gift_wrapping` | GiftWrapping | The selected gift wrapping for the cart
`gift_wrapping` | [GiftWrapping][GiftWrapping] | The selected gift wrapping for the cart
`id` | ID! | The ID of the cart
`is_virtual` | Boolean! | Indicates whether the cart contains only virtual products
`items` | [[CartItemInterface]][CartItemInterface] | Contains the items in the customer's cart
Expand All @@ -29,6 +29,7 @@ Attribute | Data Type | Description
[CartItemInterface]: {{page.baseurl}}/graphql/queries/cart.html#CartItemInterface
[CartPrices]: {{page.baseurl}}/graphql/queries/cart.html#CartPrices
[GiftMessage]: {{page.baseurl}}/graphql/queries/cart.html#GiftMessage
[GiftWrapping]: {{page.baseurl}}/graphql/queries/cart.html#GiftWrapping
[RewardPointsAmount]: {{page.baseurl}}/graphql/queries/cart.html#RewardPointsAmount
[SelectedPaymentMethod]: {{page.baseurl}}/graphql/queries/cart.html#SelectedPaymentMethod
[ShippingCartAddress]: {{page.baseurl}}/graphql/queries/cart.html#ShippingCartAddress
44 changes: 22 additions & 22 deletions src/_includes/graphql/customer-orders-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,23 +43,23 @@ Attribute | Data type | Description
--- | --- | ---
`billing_address` | [OrderAddress](#OrderAddress) | The billing address for the order
`carrier` | String | The shipping carrier for the order delivery
`comments` | [[SalesCommentItem](#SalesCommentItem)] | Comments on the order
`comments` | [[SalesCommentItem]](#SalesCommentItem) | Comments on the order
`created_at` | String | Deprecated. Use the `order_date` attribute instead
`credit_memos` | [[CreditMemo](#CreditMemo)] | Contains a list of credit memos for the order
`credit_memos` | [[CreditMemo]](#CreditMemo) | Contains a list of credit memos for the order
`grand_total` | Float | Deprecated. Use the `totals.grand_total` attribute instead
`gift_message` | [GiftMessage](#GiftMessage) | The entered gift message for the order
`gift_receipt_included` | Boolean! | Indicates if the customer requested a gift receipt for the order
`gift_wrapping` | [GiftWrapping](#GiftWrapping) | The selected gift wrapping for the order
`id` | ID! | Unique identifier for the order
`increment_id` | String | Deprecated. Use the `id` attribute instead
`invoices` | [[Invoice](#Invoice)]! | Contains a list of invoices for the order
`items` | [[OrderItemInterface](#OrderItemInterface)] | An array containing the items purchased in this order
`invoices` | [[Invoice]](#Invoice)! | Contains a list of invoices for the order
`items` | [[OrderItemInterface]](#OrderItemInterface) | An array containing the items purchased in this order
`number` | String! | The order number
`order_date` | String! | The date the order was placed
`order_number` | String! | Deprecated. Use the `number` attribute instead
`payment_methods` | [[PaymentMethod](#PaymentMethod)] | Payment details for the order
`payment_methods` | [[PaymentMethod]](#PaymentMethod) | Payment details for the order
`printed_card_included` | Boolean! | Indicates if the customer requested a printed card for the order
`shipments` | [[OrderShipment](#OrderShipment)] | Shipment list for the order
`shipments` | [[OrderShipment]](#OrderShipment) | Shipment list for the order
`shipping_address` | [OrderAddress](#OrderAddress) | Shipping address for the order
`shipping_method` | String | Shipping method for the order
`status` | String! | The current status of the order
Expand All @@ -73,9 +73,9 @@ The `CreditMemo` object contains details about credit memos applied to an order.

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

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

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

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

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

Expand Down Expand Up @@ -227,11 +227,11 @@ Attribute | Data type | Description

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

#### OrderTotal attributes {#OrderTotal}

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

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

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

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

#### TaxItem attributes {#TaxItem}
Expand Down
12 changes: 9 additions & 3 deletions src/_includes/graphql/customer-output-24.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@
{% assign customeraddress_text = '[CustomerAddress](#customerAddressOutput)' %}
{% assign customeroutput_text = '[CustomerOrders](#customerOrders)' %}
{% assign crossref_text = '. See [`orders` input attributes](#orders) for details' %}
{% assign productreview_text = '[ProductReviews](#ProductReviews)!' %}
{% assign rewardpoints_text = '[RewardPoints](#RewardPoints)' %}
{% assign wishlist_text = '[Wishlist](#Wishlist)!' %}
{% else %}
{% assign customeraddress_text = 'CustomerAddress' %}
{% assign customeroutput_text = '[CustomerOrders]' %}
{% assign crossref_text = '' %}
{% assign productreview_text = '[ProductReviews]!' %}
{% assign rewardpoints_text = '[RewardPoints]' %}
{% assign wishlist_text = '[Wishlist]!' %}
{% endif %}

Attribute | Data Type | Description
Expand All @@ -26,8 +32,8 @@ Attribute | Data Type | Description
`middlename` |String | The customer's middle name
`orders(<FilterCriteria>)` | {{ customeroutput_text }} | A list of the customer's placed orders{{ crossref_text }}
`prefix` | String | An honorific, such as Dr., Mr., or Mrs.
`reviews(pageSize: Int = 20 currentPage: Int = 1)` | ProductReviews! | The list of reviews of the product
`reward_points` | RewardPoints | Details about the customer's reward points
`reviews(pageSize: Int = 20 currentPage: Int = 1)` | {{ productreview_text }} | The list of reviews of the product
`reward_points` | {{ rewardpoints_text }} | Details about the customer's reward points
`suffix` | String | A value such as Sr., Jr., or III
`taxvat` | String | The customer's Tax/VAT number (for corporate customers)
`wishlist` | Wishlist! | Contains the contents of the customer's wish lists
`wishlist` | {{ wishlist_text }} | Contains the contents of the customer's wish lists
2 changes: 1 addition & 1 deletion src/_includes/graphql/invoice-item-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Attribute | Data type | Description
--- | --- | ---
`discounts` | [Discount] | Contains information about the final discount amount for the base product, including discounts on options
`id` | ID! | The unique ID of the invoice item
`order_item` | OrderItemInterface | Contains details about an individual order item
`order_item` | [OrderItemInterface]({{page.baseurl}}/graphql/interfaces/order-item-interface.html) | Contains details about an individual order item
`product_name` | String | The name of the base product
`product_sale_price` | Money! | The sale price for the base product including selected options
`product_sku` | String! | The SKU of the base product
Expand Down
13 changes: 10 additions & 3 deletions src/_includes/graphql/order-item-interface.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Attribute | Data Type | Description
--- | --- | ---
`discounts` | [Discount] | Final discount information for the product
`entered_options` | [OrderItemOption] | The entered option for the base product, such as a logo or image
`entered_options` | [`[OrderItemOption]`](#OrderItemOption) | The entered option for the base product, such as a logo or image
`id` | ID! | The unique identifier for the order item
`product_name` | String | The name of the base product
`product_sale_price` | Money! | The sale price of the base product, including selected options
Expand All @@ -14,5 +14,12 @@ Attribute | Data Type | Description
`quantity_refunded` | Float | The number of refunded items
`quantity_returned` | Float | The number of returned items
`quantity_shipped` | Float | The number of shipped items
`selected_options` | [OrderItemOption] | The selected options for the base product, such as color or size
`status` | String | The status of the order item
`selected_options` | [`[OrderItemOption]`](#OrderItemOption) | The selected options for the base product, such as color or size
`status` | String | The status of the order item

#### OrderItemOption attributes {#OrderItemOption}

Attribute | Data type | Description
--- | --- | ---
`label` | String! | The name of the option
`value` | String! | The value of the option
4 changes: 2 additions & 2 deletions src/_includes/graphql/product-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Attribute | Data Type | Description
`average_rating` | Float! | The average rating for product review
`created_at` | String! | Date indicating when the review was created
`nickname` | String! | The customer's nickname. Defaults to the customer name, if logged in
`product` | ProductInterface! | Contains details about the reviewed product
`ratings_breakdown` | [ProductReviewRating!]! | An array of ratings by rating category, such as quality, price, and value
`product` | [ProductInterface!]({{ page.baseurl }}/graphql/interfaces/product-interface.html)| Contains details about the reviewed product
`ratings_breakdown` | [[ProductReviewRating!]](#ProductReviewRating)! | An array of ratings by rating category, such as quality, price, and value
`summary` | String! | The summary (title) of the review
`text` | String! | The review text

Expand Down
6 changes: 3 additions & 3 deletions src/guides/v2.3/extension-dev-guide/view-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ View models can be used by passing the view model class as an argument to a temp
```xml
<block name="orangeco.new.viewmodel" template="OrangeCompany_Catalog::example.phtml">
<arguments>
<argument name="view_model" xsi:type="object">OrangeCompany\Catalog\ViewModel\MyNewViewModel</argument>
<argument name="viewModel" xsi:type="object">OrangeCompany\Catalog\ViewModel\MyNewViewModel</argument>
</arguments>
</block>
```
Expand All @@ -34,7 +34,7 @@ In the following example, the same view model is used with an existing block in
```xml
<referenceBlock name="checkout.cart.item.renderers.default">
<arguments>
<argument name="view_model" xsi:type="object">OrangeCompany\Catalog\ViewModel\MyNewViewModel</argument>
<argument name="viewModel" xsi:type="object">OrangeCompany\Catalog\ViewModel\MyNewViewModel</argument>
</arguments>
</referenceBlock>
```
Expand Down Expand Up @@ -78,7 +78,7 @@ The view model class is passed as an argument to the `product.info.upsell` block
<block class="Magento\Catalog\Block\Product\ProductList\Upsell" name="product.info.upsell" template="Magento_Catalog::product/list/items.phtml">
<arguments>
<argument name="type" xsi:type="string">upsell</argument>
<argument name="view_model" xsi:type="object">Magento\Catalog\ViewModel\Product\Listing\PreparePostData</argument>
<argument name="viewModel" xsi:type="object">Magento\Catalog\ViewModel\Product\Listing\PreparePostData</argument>
</arguments>
</block>
```
Expand Down
2 changes: 1 addition & 1 deletion src/guides/v2.3/graphql/mutations/add-bundle-products.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,8 +247,8 @@ Attribute | Data Type | Description

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

## Related topics
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,12 @@ Attribute | Data Type | Description

Error | Description
--- | ---
`Could not find a cart with ID "XXX"` | The specified `cart_id` value does not exist in the `quote_id_mask` table.
`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.
`Could not find a product with SKU "XXX"` | The configurable product with SKU specified in the `parent_sku` argument does not exist.
`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.
`Required parameter "cart_id" is missing` | The `cart_id` argument was omitted or contains an empty value.
`Required parameter "cart_items" is missing` | The `cart_items` argument was omitted or contains an empty array.
`Required parameter "email" is missing` | The `email` argument was omitted or contains an empty value.
`The requested qty is not available` | The requested quantity specified `data`.`quantity` is not available.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,8 @@ Attribute | Data Type | Description

Error | Description
--- | ---
`Could not find a cart with ID "XXX"` | The specified `cart_id` value does not exist in the `quote_id_mask` table.
`Could not find a product with SKU "YYY"` | A product with the SKU specified in the `data`.`sku` argument does not exist.
`Required parameter "cart_id" is missing` | The mutation does not contain a `cart_id` argument.
`Required parameter "cart_items" is missing` | The `cart_items` argument is empty or is not of type `array`.
`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.
Loading