Skip to content

Shopify documentation now reflects v1.3.0 settings #6864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 10, 2025
Merged

Shopify documentation now reflects v1.3.0 settings #6864

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
94c39f9
Shopify documentation now reflects v1.3.0 settings
RachBreeze Feb 9, 2025
2cb0580
Update marketplace-and-integrations/integrations/shopify.md
RachBreeze Feb 10, 2025
802c69a
Update marketplace-and-integrations/integrations/shopify.md
RachBreeze Feb 10, 2025
0cb4ceb
Update marketplace-and-integrations/integrations/shopify.md
RachBreeze Feb 10, 2025
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
22 changes: 21 additions & 1 deletion marketplace-and-integrations/integrations/shopify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
}
Expand All @@ -77,6 +78,7 @@ Use the access token and add it to your website's configuration file alongside s
<add key="Umbraco.Cms.Integrations.Commerce.Shopify.ApiVersion" value="2022-01" />
<add key="Umbraco.Cms.Integrations.Commerce.Shopify.AccessToken" value="[your access token]" />
<add key="Umbraco.Cms.Integrations.Commerce.Shopify.Shop" value="[your shop's name]" />
<add key="Umbraco.Cms.Integrations.Commerce.Shopify.CacheLevel" value="Snapshot" />
</appSettings>
```
{% endcode %}
Expand Down Expand Up @@ -158,6 +160,23 @@ 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 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`

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

To use the products picker, a new Data Type should be created based on the Shopify Products Picker property editor.
Expand Down Expand Up @@ -187,3 +206,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.