Skip to content

Commit e36751f

Browse files
authored
Merge pull request #6864 from RachBreeze/Shopify
Shopify documentation now reflects v1.3.0 settings
2 parents 28d1c62 + 0cb4ceb commit e36751f

File tree

1 file changed

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

1 file changed

+21
-1
lines changed

marketplace-and-integrations/integrations/shopify.md

Lines changed: 21 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,23 @@ 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+
165+
Added in version 1.3.0 of the integration.
166+
167+
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.
168+
169+
The values available are:
170+
171+
- `Snapshot` (default)
172+
- `Unknown`
173+
- `Element`
174+
- `Elements`
175+
- `None`
176+
177+
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.
178+
179+
161180
## Backoffice usage
162181

163182
To use the products picker, a new Data Type should be created based on the Shopify Products Picker property editor.
@@ -187,3 +206,4 @@ Assuming a property based on the created Data Type with the alias `shopifyProduc
187206
```
188207

189208
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.
209+

0 commit comments

Comments
 (0)