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

Commit 9ffc305

Browse files
keharperfoomandineshvbsathiyaaaRakeshJesadiya
authored
Merge small-changes branch into master (#8462)
* correct path for di.xml * Added the error coverage for redeemGiftCardBalanceAsStoreCredit mutation (#8444) * added the error coverage for redeemGiftCardBalanceAsStoreCredit mutation * Update redeem-giftcard-balance.md Co-authored-by: Kevin Harper <[email protected]> * added error coverage for remove-store-credit mutation (#8447) * added the error coverage for removeRewardPointsFromCart mutation (#8448) * added the error coverage for removeRewardPointsFromCart mutation * Update remove-reward-points.md Co-authored-by: Kevin Harper <[email protected]> * added the errors coverage for apply giftCard mutation (#8449) * added error coverage for apply giftcard mutation * lint error * Update apply-giftcard.md Co-authored-by: Kevin Harper <[email protected]> * Added the error coverage for applyStoreCreditToCart mutation (#8450) * added the error coverage for applyStoreCreditToCart mutation * added the error coverage for applyStoreCreditToCart mutation * added the error coverage for applyStoreCreditToCart mutation * Update apply-store-credit.md * Update apply-store-credit.md Co-authored-by: Kevin Harper <[email protected]> * added the error coverage for pickupLocations query (#8452) * Added the error coverage for urlResolver query (#8453) * added error coverage for payflowtoken mutation (#8454) * added error coverage for payflowtoken mutation * fixed the lint errors * Update create-payflow-pro-token.md Co-authored-by: Kevin Harper <[email protected]> * added error coverage for apply-reward-points mutation (#8455) * Added the error coverage for giftCardAccount query (#8456) * Added the error coverage for giftCardAccount query * Update giftcard-account.md Co-authored-by: Kevin Harper <[email protected]> * Added errors documentation for paypal express token mutation (#8457) Co-authored-by: Kevin Harper <[email protected]> * sample-data-update (#8430) * Token expires info added (#8463) Co-authored-by: Kristof, Fooman <[email protected]> Co-authored-by: Dinesh V B <[email protected]> Co-authored-by: Sathiya Prakash <[email protected]> Co-authored-by: Rakesh Jesadiya <[email protected]> Co-authored-by: Ajith <[email protected]>
1 parent 55e4c5f commit 9ffc305

16 files changed

+110
-5
lines changed

src/_includes/install/sampledata/sample-data_list-of-modules.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
* magento/module-theme-sample-data
2222
* magento/module-widget-sample-data
2323
* magento/module-wishlist-sample-data
24-
* magento/sample-data
2524
* magento/sample-data-media
2625

2726
{{site.data.var.ee}} only:

src/guides/v2.3/frontend-dev-guide/themes/admin_theme_apply.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ Each step is described further with more details.
4242

4343
## Specify the custom Admin theme in `di.xml` {#specify_di}
4444

45-
You need to specify the admin theme to be used in the `<your_module_dir>/etc/adminhtml/di.xml` file. Add it, if the file does not yet exist in your module.
45+
You need to specify the admin theme to be used in the `<your_module_dir>/etc/di.xml` file. Add it, if the file does not yet exist in your module.
4646

47-
In `<your_module_dir>/etc/adminhtml/di.xml` add the following (replace the placeholders with the vendor name and theme code of your Admin theme):
47+
In `<your_module_dir>/etc/di.xml` add the following (replace the placeholders with the vendor name and theme code of your Admin theme):
4848

4949
```xml
5050
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">

src/guides/v2.3/graphql/authorization-tokens.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,12 @@ You can now use this token in the Authorization request header field for any que
4343

4444
If necessary, you also can [revoke the customer's token]({{ page.baseurl }}/graphql/mutations/revoke-customer-token.html
4545

46+
By default, a customer token is valid for 1 hour. You can change these values from Admin by selecting **Stores** > **Settings** > **Configuration** > **Services** > **OAuth** > **Access Token Expiration** > **Customer Token Lifetime**.
47+
4648
## Admin tokens
4749

4850
In Magento GraphQL, you specify an admin token only if you need to query products, categories, price rules, or other entities that are scheduled to be in a campaign (staged content). Staging is supported in {{site.data.var.ee}} only. See [Staging queries]({{page.baseurl}}/graphql/queries/index.html#staging) for more information.
4951

5052
Magento does not provide a GraphQL mutation that generates an admin token. You must use the `POST /V1/integration/admin/token` REST endpoint instead. [Generate the admin token]({{page.baseurl}}/rest/tutorials/prerequisite-tasks/create-admin-token.html) shows how to use this endpoint.
53+
54+
By default, an admin token is valid for 4 hours. You can change these values from Admin by selecting **Stores** > **Settings** > **Configuration** > **Services** > **OAuth** > **Access Token Expiration** > **Admin Token Lifetime**.

src/guides/v2.3/graphql/mutations/apply-store-credit.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,11 @@ Attribute | Data Type | Description
110110
{% include graphql/cart-object.md %}
111111

112112
[Cart query output]({{page.baseurl}}/graphql/queries/cart.html#cart-output) provides more information about the `Cart` object.
113+
114+
## Errors
115+
116+
Error | Description
117+
--- | ---
118+
`Could not find a cart with ID \"xxxxx\"` | The ID provided in the `cart_id` field is invalid or the cart does not exist for the customer.
119+
`The cart isn't active` | The cart with the given cart ID is unavailable, because the items have been purchased and the cart ID becomes inactive.
120+
`Field ApplyStoreCreditToCartInput.cart_id of required type String! was not provided` | The value specified in the `ApplyStoreCreditToCartInput.cart_id` argument is empty.

src/guides/v2.3/graphql/mutations/create-payflow-pro-token.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,14 @@ Attribute | Data Type | Description
103103
`result_code` | Int! | The **RESULT** returned by PayPal. A value of `0` indicates the transaction was approved
104104
`secure_token` | String! | Secure token generated by PayPal
105105
`secure_token_id` | String! | Secure token ID generated by PayPal
106+
107+
## Errors
108+
109+
Error | Description
110+
--- | ---
111+
`Could not find a cart with ID "XXX"` | The specified `cart_id` value does not exist in the `quote_id_mask` table.
112+
`Field PayflowProTokenInput.cart_id of required type String! was not provided.` | You must specify the `cart_id` attribute.
113+
`Field PayflowProTokenInput.urls of required type PayflowProUrlInput! was not provided.` | You must specify the `urls` attribute.
114+
`Field PayflowProUrlInput.return_url of required type String! was not provided.` | You must specify the `return_url` attribute.
115+
`Field PayflowProUrlInput.error_url of required type String! was not provided.` | You must specify the `error_url` attribute.
116+
`Field PayflowProUrlInput.cancel_url of required type String! was not provided.` | You must specify the `cancel_url` attribute.

src/guides/v2.3/graphql/mutations/create-paypal-express-token.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,3 +112,14 @@ Attribute | Data Type | Description
112112
--- | --- | ---
113113
`edit` | String | The PayPal URL that allows the buyer to edit their checkout details
114114
`start` | String | The URL to the PayPal login page
115+
116+
## Errors
117+
118+
Error | Description
119+
--- | ---
120+
`Required parameter "cart_id" is missing` | The mutation does not contain a `cart_id` argument.
121+
`Could not find a cart with ID "XXX"` | The specified `cart_id` value does not exist in the `quote_id_mask` table.
122+
`Field PaypalExpressTokenInput.code of required type String! was not provided.` | The required attribute `code` is missing.
123+
`The requested Payment Method is not available.` | The payment method is not configured.
124+
`Field PaypalExpressUrlsInput.cancel_url of required type String! was not provided.` | The required attribute `cancel_url` is missing.
125+
`Field PaypalExpressUrlsInput.return_url of required type String! was not provided.` | The required attribute `return_url` is missing.

src/guides/v2.3/graphql/mutations/redeem-giftcard-balance.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,4 +79,11 @@ Attribute | Data Type | Description
7979
--- | --- | ---
8080
`balance` | Money | The remaining balance of the gift card, including the currency
8181
`code` | String | The gift card code
82-
`expiration_date` | String | The date when the gift card expires, if any
82+
`expiration_date` | String | The date when the gift card expires, if any
83+
84+
## Errors
85+
86+
Error | Description
87+
--- | ---
88+
`Gift card not found` | The specified `gift_card_code` value does not exist in the `giftcardaccount` table or the amount has been already redeemed.
89+
`Field GiftCardAccountInput.gift_card_code of required type String! was not provided` | The value specified in the `GiftCardAccountInput.gift_card_code` argument is empty.

src/guides/v2.3/graphql/queries/giftcard-account.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,10 @@ Attribute | Data Type | Description
6969
`balance` | Money | Returns the currency and remaining balance of the gift card
7070
`code` | String | Returns the gift card code
7171
`expiration_date` | String | Returns the date when the gift card expires, if any
72+
73+
## Errors
74+
75+
Error | Description
76+
--- | ---
77+
`Gift card not found` | The specified `gift_card_code` value does not exist in the `giftcardaccount` table, or the full amount has already been redeemed.
78+
`Field GiftCardAccountInput.gift_card_code of required type String! was not provided` | The value specified in the `GiftCardAccountInput.gift_card_code` argument is empty.

src/guides/v2.3/graphql/queries/url-resolver.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,3 +134,9 @@ Attribute | Data Type | Description
134134
## Related topics
135135

136136
[Products endpoint]({{page.baseurl}}/graphql/queries/products.html)
137+
138+
## Errors
139+
140+
Error | Description
141+
--- | ---
142+
`Field urlResolver.url of type String! is required but not provided.` | The value specified in the `urlResolver.url` argument is empty.

src/guides/v2.4/graphql/authorization-tokens.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,12 @@ You can now use this token in the Authorization request header field for any que
4343

4444
If necessary, you also can [revoke the customer's token]({{ page.baseurl }}/graphql/mutations/revoke-customer-token.html
4545

46+
By default, a customer token is valid for 1 hour. You can change these values from Admin by selecting **Stores** > **Settings** > **Configuration** > **Services** > **OAuth** > **Access Token Expiration** > **Customer Token Lifetime**.
47+
4648
## Admin tokens
4749

4850
In Magento GraphQL, you specify an admin token only if you need to query products, categories, price rules, or other entities that are scheduled to be in a campaign (staged content). Staging is supported in {{site.data.var.ee}} only. See [Staging queries]({{page.baseurl}}/graphql/queries/index.html#staging) for more information.
4951

5052
Magento does not provide a GraphQL mutation that generates an admin token. You must use a REST endpoint such as `POST /V1/tfa/provider/google/authenticate` instead. [Generate the admin token]({{page.baseurl}}/rest/tutorials/prerequisite-tasks/create-admin-token.html) shows how to use this endpoint.
53+
54+
By default, an admin token is valid for 4 hours. You can change these values from Admin by selecting **Stores** > **Settings** > **Configuration** > **Services** > **OAuth** > **Access Token Expiration** > **Admin Token Lifetime**.

src/guides/v2.4/graphql/mutations/apply-giftcard.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,15 @@ Attribute | Data Type | Description
9696

9797
{% include graphql/cart-object-24.md %}
9898

99-
[Cart query output]({{page.baseurl}}/graphql/queries/cart.html#cart-output) provides more information about the `Cart` object.
99+
[Cart query output]({{page.baseurl}}/graphql/queries/cart.html#cart-output) provides more information about the `Cart` object.
100+
101+
## Errors
102+
103+
Error | Description
104+
--- | ---
105+
`The gift card code couldn't be added. Verify your information and try again.` | The specified `gift_card_code` is incorrect.
106+
`Could not find a cart with ID "XXX"` | The specified `cart_id` value does not exist in the `quote_id_mask` table.
107+
`Field ApplyGiftCardToCartInput.gift_card_code of required type String! was not provided.` | The required field `gift_card_code` was not provided.
108+
`Required parameter \"gift_card_code\" is missing` | The value provided in the field `gift_card_code` is empty.
109+
`Field ApplyGiftCardToCartInput.cart_id of required type String! was not provided.` | The required field `cart_id` was not provided.
110+
`Required parameter \"cart_id\" is missing` | The value provided in the field `cart_id` is empty.

src/guides/v2.4/graphql/mutations/apply-reward-points.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,3 +134,10 @@ Attribute | Data Type | Description
134134
{% include graphql/cart-object-24.md %}
135135

136136
[Cart query output]({{page.baseurl}}/graphql/queries/cart.html#cart-output) provides more information about the `Cart` object.
137+
138+
## Errors
139+
140+
Error | Description
141+
--- | ---
142+
`Required parameter "cart_id" is missing` | The mutation does not contain a `cart_id` argument.
143+
`Could not find a cart with ID "XXX"` | The specified `cart_id` value does not exist in the `quote_id_mask` table.

src/guides/v2.4/graphql/mutations/apply-store-credit.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,11 @@ Attribute | Data Type | Description
102102
{% include graphql/cart-object-24.md %}
103103

104104
[Cart query output]({{page.baseurl}}/graphql/queries/cart.html#cart-output) provides more information about the `Cart` object.
105+
106+
## Errors
107+
108+
Error | Description
109+
--- | ---
110+
`Could not find a cart with ID \"xxxxx\"` | The ID provided in the `cart_id` field is invalid or the cart does not exist for the customer.
111+
`The cart isn't active` | The cart with the given cart ID is unavailable, because the items have been purchased and the cart ID becomes inactive.
112+
`Field ApplyStoreCreditToCartInput.cart_id of required type String! was not provided` | The value specified in the `ApplyStoreCreditToCartInput.cart_id` argument is empty.

src/guides/v2.4/graphql/mutations/remove-reward-points.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,11 @@ Attribute | Data Type | Description
9494
{% include graphql/cart-object-24.md %}
9595

9696
[Cart query output]({{page.baseurl}}/graphql/queries/cart.html#cart-output) provides more information about the `Cart` object.
97+
98+
## Errors
99+
100+
Error | Description
101+
--- | ---
102+
`Could not find a cart with ID \"xxxxx\"` | The ID provided in the `cart_id` field is invalid or the cart does not exist for the customer.
103+
`The cart isn't active` | The cart with the specified cart ID is unavailable, because the items have been purchased and the cart ID becomes inactive.
104+
`Field removeRewardPointsFromCart.cart_id of required type String! was not provided` | The value specified in the `removeRewardPointsFromCart.cart_id` argument is empty.

src/guides/v2.4/graphql/mutations/remove-store-credit.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,10 @@ Attribute | Data Type | Description
9595
{% include graphql/cart-object-24.md %}
9696

9797
[Cart query output]({{page.baseurl}}/graphql/queries/cart.html#cart-output) provides more information about the `Cart` object.
98+
99+
## Errors
100+
101+
Error | Description
102+
--- | ---
103+
`Please specify a valid customer.` | The mutation requires a valid authorization token.
104+
`Required parameter "cart_id" is missing` | The value specified in `cart_id` is empty.

src/guides/v2.4/graphql/queries/pickup-locations.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,3 +207,10 @@ Attribute | Data type | Description
207207
`current_page` | Int | Specifies which page of results to return
208208
`page_size` | Int | Specifies the maximum number of items to return
209209
`total_pages` | Int | Total pages
210+
211+
## Errors
212+
213+
Error | Description
214+
--- | ---
215+
`Field AreaInput.radius of required type Int! was not provided` | The value specified in the `AreaInput.radius` argument is empty.
216+
`Field AreaInput.search_term of required type String! was not provided` | The value specified in the `AreaInput.search_term` argument is empty.

0 commit comments

Comments
 (0)