Skip to content

Commit 154c145

Browse files
committed
Update docs for protected user data
1 parent 73ff255 commit 154c145

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/content/en/setup.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,17 @@ Set up an app at https://dev.shopify.com/dashboard/ with the following details:
4848
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.
4949
4. App URL: your website's URL
5050

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+
5162
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.
5263

5364
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
6273

6374
The quickest way is to run the registration command once your credentials are configured:
6475

76+
6577
```bash
6678
php artisan shopify:webhooks:register
6779
```
6880

6981
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.
7082

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+
7185
Full details can be found in the ["Webhooks"](/cms/webhooks) section.
7286

7387
### Step 5. Finalise your .env

0 commit comments

Comments
 (0)