From 94c39f99735e9b012e31377acafc4c13d1b322e6 Mon Sep 17 00:00:00 2001 From: Rachel Breeze Date: Sun, 9 Feb 2025 12:29:25 +0000 Subject: [PATCH 1/4] Shopify documentation now reflects v1.3.0 settings Updated the documentation to reflect the contents of this PR https://github.com/umbraco/Umbraco.Cms.Integrations/pull/240 --- .../integrations/shopify.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/marketplace-and-integrations/integrations/shopify.md b/marketplace-and-integrations/integrations/shopify.md index f8b9d773880..39d1f0faf48 100644 --- a/marketplace-and-integrations/integrations/shopify.md +++ b/marketplace-and-integrations/integrations/shopify.md @@ -59,7 +59,8 @@ Use the access token and add it to your website's configuration file alongside s "Settings": { "ApiVersion": "2022-01", "Shop": "[your shop's name]", - "AccessToken": "[your access token]" + "AccessToken": "[your access token]", + "CacheLevel": "Snapshot" } } } @@ -77,6 +78,7 @@ Use the access token and add it to your website's configuration file alongside s + ``` {% endcode %} @@ -158,6 +160,19 @@ If you are selecting your own authorization flow that uses the `AuthorizationSer The authorization controller uses the `window.postMessage` interface for cross-window communications when redirecting from the Shopify authorization server. +### CacheLevel +Added in version 1.3.0 of the integration. The property cache level by default is set to `Snapshot` this can mean sites utilising this integration can hit rate limits on the Shopify Admin API. More information on rate limits is found here [Shopify Rate Limits](https://shopify.dev/docs/api/usage/rate-limits). The default value `Snapshot` has been retained for backwards compatibility. + +The values available are: +- `Unknown` +- `Element` +- `Elements` +- `None` +- Default value is `Snapshot`. + +The values correlate to the values available for property caching. More information on property caching is available here [Property Cache Level](https://docs.umbraco.com/umbraco-cms/10.latest/extending/property-editors/property-value-converters#propertycachelevel-getpropertycachelevel-ipublishedpropertytype-propertytype). + + ## Backoffice usage To use the products picker, a new Data Type should be created based on the Shopify Products Picker property editor. @@ -187,3 +202,4 @@ Assuming a property based on the created Data Type with the alias `shopifyProduc ``` You can use the default rendering view and style using the existing CSS classes, or use it as inspiration for your views. The path to your custom view will be then passed as a parameter to the HTML helper method. + From 2cb0580eb10379d561032a450b9378f4fe174b89 Mon Sep 17 00:00:00 2001 From: Rachel Breeze Date: Mon, 10 Feb 2025 10:27:14 +0000 Subject: [PATCH 2/4] Update marketplace-and-integrations/integrations/shopify.md Co-authored-by: sofietoft --- marketplace-and-integrations/integrations/shopify.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/marketplace-and-integrations/integrations/shopify.md b/marketplace-and-integrations/integrations/shopify.md index 39d1f0faf48..1563063ddba 100644 --- a/marketplace-and-integrations/integrations/shopify.md +++ b/marketplace-and-integrations/integrations/shopify.md @@ -161,7 +161,10 @@ If you are selecting your own authorization flow that uses the `AuthorizationSer The authorization controller uses the `window.postMessage` interface for cross-window communications when redirecting from the Shopify authorization server. ### CacheLevel -Added in version 1.3.0 of the integration. The property cache level by default is set to `Snapshot` this can mean sites utilising this integration can hit rate limits on the Shopify Admin API. More information on rate limits is found here [Shopify Rate Limits](https://shopify.dev/docs/api/usage/rate-limits). The default value `Snapshot` has been retained for backwards compatibility. + +Added in version 1.3.0 of the integration. + +The property cache level is set to `Snapshot` by default. This means that sites utilizing this integration can hit rate limits on the Shopify Admin API. More information on rate limits can be found in the Shopify Development Documentation under [Shopify Rate Limits](https://shopify.dev/docs/api/usage/rate-limits). The default value `Snapshot` has been retained for backward compatibility. The values available are: - `Unknown` From 802c69a40f64824a665e40e34fb4ff53c07973db Mon Sep 17 00:00:00 2001 From: Rachel Breeze Date: Mon, 10 Feb 2025 10:27:24 +0000 Subject: [PATCH 3/4] Update marketplace-and-integrations/integrations/shopify.md Co-authored-by: sofietoft --- marketplace-and-integrations/integrations/shopify.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/marketplace-and-integrations/integrations/shopify.md b/marketplace-and-integrations/integrations/shopify.md index 1563063ddba..a2a58b8463e 100644 --- a/marketplace-and-integrations/integrations/shopify.md +++ b/marketplace-and-integrations/integrations/shopify.md @@ -167,11 +167,12 @@ Added in version 1.3.0 of the integration. The property cache level is set to `Snapshot` by default. This means that sites utilizing this integration can hit rate limits on the Shopify Admin API. More information on rate limits can be found in the Shopify Development Documentation under [Shopify Rate Limits](https://shopify.dev/docs/api/usage/rate-limits). The default value `Snapshot` has been retained for backward compatibility. The values available are: + +- `Snapshot` (default) - `Unknown` - `Element` - `Elements` - `None` -- Default value is `Snapshot`. The values correlate to the values available for property caching. More information on property caching is available here [Property Cache Level](https://docs.umbraco.com/umbraco-cms/10.latest/extending/property-editors/property-value-converters#propertycachelevel-getpropertycachelevel-ipublishedpropertytype-propertytype). From 0cb4ceba303965a23ab696545d9054ab92434b53 Mon Sep 17 00:00:00 2001 From: Rachel Breeze Date: Mon, 10 Feb 2025 10:27:33 +0000 Subject: [PATCH 4/4] Update marketplace-and-integrations/integrations/shopify.md Co-authored-by: sofietoft --- marketplace-and-integrations/integrations/shopify.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/marketplace-and-integrations/integrations/shopify.md b/marketplace-and-integrations/integrations/shopify.md index a2a58b8463e..4327f11b607 100644 --- a/marketplace-and-integrations/integrations/shopify.md +++ b/marketplace-and-integrations/integrations/shopify.md @@ -174,7 +174,7 @@ The values available are: - `Elements` - `None` -The values correlate to the values available for property caching. More information on property caching is available here [Property Cache Level](https://docs.umbraco.com/umbraco-cms/10.latest/extending/property-editors/property-value-converters#propertycachelevel-getpropertycachelevel-ipublishedpropertytype-propertytype). +The values correlate to the values available for property caching. More information on property caching is available in the [Property Cache Level](https://docs.umbraco.com/umbraco-cms/10.latest/extending/property-editors/property-value-converters#propertycachelevel-getpropertycachelevel-ipublishedpropertytype-propertytype) article. ## Backoffice usage