Getting AppSectionPath to use to insert app section via API

Highlighted
Excursionist
19 0 4

According to https://help.shopify.com/en/api/guides/modifying-online-store/app-sections#appsectiondata.  You can use the rest API to add an app section to a page with an API call by passing the AppSectionPath to the section_file property of the app section.  However There is no documentation to state the format or how to get the AppSectionPath of your created app section. 

 

What value do we need to use here in order to add an app section via the api and how can I get the section_file/appSectionPath of my app section?

0 Likes
Highlighted
Shopify Staff
Shopify Staff
580 6 108

Hey there @Corknine 

 

The method for how we are surfacing the path for app sections is something our internal dev team are currently working on. What would be a use-case of working with the REST API to insert app sections in pages that would be helpful in your workflow? An insight into use-cases will help inform our internal dev team who are implementing a solution that would provide the best experience for merchants and partners using the new online store editor. 

 

Cheers,

 

Liam Griffin 

Shopify | Partner Education

0 Likes
Highlighted
Excursionist
19 0 4

Hi Liam,

I see many use cases, however the first one is the following.

- Our app creates an app section(a button for the customer account page that links to an app proxy page also created by the app)

- We would like to add this button programatically to the top of the page so the merchant doesn't need to do anything to add it, they could then change or adjust it in their theme editor.

 

We are trying to use the API as it is described in the sections api documentation, as the documentation is written this would be possible, however the docs say to use the app section path but I cannot find out what the AppSectionPath of my app section is.

0 Likes
Highlighted
Shopify Staff
Shopify Staff
580 6 108

Thanks @Corknine 

 

These examples will be helpful when reviewing how best to surface app section paths and outline best practices for use. I'll post here when there's a further update.

 

Cheers,

 

Liam

0 Likes