Skip to content

Commit 94c39f9

Browse files
authored
Shopify documentation now reflects v1.3.0 settings
Updated the documentation to reflect the contents of this PR umbraco/Umbraco.Cms.Integrations#240
1 parent 63bd785 commit 94c39f9

File tree

1 file changed

+17
-1
lines changed
  • marketplace-and-integrations/integrations

1 file changed

+17
-1
lines changed

marketplace-and-integrations/integrations/shopify.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ Use the access token and add it to your website's configuration file alongside s
5959
"Settings": {
6060
"ApiVersion": "2022-01",
6161
"Shop": "[your shop's name]",
62-
"AccessToken": "[your access token]"
62+
"AccessToken": "[your access token]",
63+
"CacheLevel": "Snapshot"
6364
}
6465
}
6566
}
@@ -77,6 +78,7 @@ Use the access token and add it to your website's configuration file alongside s
7778
<add key="Umbraco.Cms.Integrations.Commerce.Shopify.ApiVersion" value="2022-01" />
7879
<add key="Umbraco.Cms.Integrations.Commerce.Shopify.AccessToken" value="[your access token]" />
7980
<add key="Umbraco.Cms.Integrations.Commerce.Shopify.Shop" value="[your shop's name]" />
81+
<add key="Umbraco.Cms.Integrations.Commerce.Shopify.CacheLevel" value="Snapshot" />
8082
</appSettings>
8183
```
8284
{% endcode %}
@@ -158,6 +160,19 @@ If you are selecting your own authorization flow that uses the `AuthorizationSer
158160

159161
The authorization controller uses the `window.postMessage` interface for cross-window communications when redirecting from the Shopify authorization server.
160162

163+
### CacheLevel
164+
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.
165+
166+
The values available are:
167+
- `Unknown`
168+
- `Element`
169+
- `Elements`
170+
- `None`
171+
- Default value is `Snapshot`.
172+
173+
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).
174+
175+
161176
## Backoffice usage
162177

163178
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
187202
```
188203

189204
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.
205+

0 commit comments

Comments
 (0)