You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/en/setup.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,6 +48,17 @@ Set up an app at https://dev.shopify.com/dashboard/ with the following details:
48
48
3. Scopes: At a minimum we need: `write_customers, read_inventory, read_metaobjects, read_orders, read_product_listings, read_products, read_publications, read_translations`, however your site may need others.
49
49
4. App URL: your website's URL
50
50
51
+
If you plan to use customer order history or addresses on your site, you need to request access to protected user fields:
52
+
53
+
To request access:
54
+
55
+
1. From the Partner Dashboard, go to Apps, and then select your app.
56
+
2. In the sidebar, click API access requests.
57
+
3. Find Protected customer data access and click Request access.
58
+
4. Select Protected customer data, provide your reasons for using it (we suggest 'App functionality'), and click Save.
59
+
5. If your app needs access to protected customer fields, then select the relevant fields, provide your reasons for using them, and click Save.
60
+
6. Complete your Data protection details, making sure that your app meets the protected customer data requirements.
61
+
51
62
Once the app is created, add the `Client ID` to your .env as `SHOPIFY_CLIENT_ID` and the `Client Secret` as `SHOPIFY_CLIENT_SECRET`. Then click "Install" and add it to your Shopify store.
52
63
53
64
This add-on will automatically negotiate a new Admin API token for you when you make GraphQL calls and handle expirations.
@@ -62,12 +73,15 @@ In order for the addon to receive updates from Shopify about your products and c
62
73
63
74
The quickest way is to run the registration command once your credentials are configured:
64
75
76
+
65
77
```bash
66
78
php artisan shopify:webhooks:register
67
79
```
68
80
69
81
This will register all required webhooks in your Shopify store automatically. You can also check webhook status at any time from the **Shopify** section of the Control Panel.
70
82
83
+
Note: if you have not requested access to protected customer fields, the order create, user create and user update webhooks will fail to register.
84
+
71
85
Full details can be found in the ["Webhooks"](/cms/webhooks) section.
0 commit comments