Repository navigation
Replies: 2 comments 1 reply
|
Hey! How are you? Thank you for your proposal (and your patience). We've aligned on this app intent type and will be making it available soon! I'll let you know when it lands. |
1 reply
|
Hey @varunce7! This is out!! #71 is merged and it's documented as One boundary worth knowing: the intent opens one product's specification editor per invocation and never writes anything itself... your app stages the change and the merchant saves. Bulk work ("add dry-clean care to all my sarees") stays in your app's own bulk flow. Thanks for helping expand the platform! Happy coding! |
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
1. What type are you proposing?
application/product-specification, actionscreateandedit.It represents structured, app-owned descriptive data about one product that Shopify's product object does not model well: fabric composition with percentages, care instructions, fit, model measurements and size worn, size-chart data, construction, sustainability and origin. The same shape fits other verticals (nutrition and allergens, electronics specifications, material and dimension sheets, compliance data).
editopens the app's editor for one product's specification.createopens the same page for a product that has none yet.2. What do merchants ask Sidekick to do that needs it?
3. What apps would register intents for it?
We have only read these apps' public listings, which do not say where each app stores its data, so these are examples of apps that give the merchant an editor for per-product specification or chart data. We are not claiming how any of them stores it.
4. What fields does it need?
Following
application/quoteand the openapplication/product-feeproposal, the canonical schema stays identity-only and allows additional properties:6. How it would work
Same flow as other
application/types: Sidekick invokesedit:application/product-specificationwith the product reference, Shopify opens the app's page (admin.app.intent.link) or an overlay (admin.app.intent.render), the app may register page tools that stage changes in its form, and the merchant reviews and saves. Sidekick never writes the data.7. Questions for maintainers
valueas the Shopify Product GID. Our specification has no identity apart from its product, so we proposevalue=gid://shopify/Product/<id>rather than an app-ownedgid://application/product-specification/…. Is that acceptable for anapplication/type? (PR Add application/product-fee intent type (create, edit) #25 asks the same. Theapplication-quoteexample uses an app-owned GID, so we want to confirm the Product GID is also supported. If not, we will usegid://application/product-specification/<product id>.)edittarget per product acceptable, with the app resolving which record to show? (Our schema offers optionalcategory_idandsubcategory_idprefill fields so Sidekick can name the record; without them the app decides which record to show.)product-specificationorproduct-attributes? We lean toproduct-specification.+bulkforapplication/. "Add dry-clean care to all my sarees" would run through the app's own bulk flow. Is that the intended pattern?create. Every product can have a specification, possibly empty. Is registering both actions that open the same page acceptable, as in PR Add application/product-fee intent type (create, edit) #25?We are happy to open a PR with the type file and schema once the direction is agreed.
1. What type are you proposing?application/product-specification, actions create and edit.
It represents structured, app-owned descriptive data about one product that Shopify's product object does not model well: fabric composition with percentages, care instructions, fit, model measurements and size worn, size-chart data, construction, sustainability and origin. The same shape fits other verticals (nutrition and allergens, electronics specifications, material and dimension sheets, compliance data).
edit opens the app's editor for one product's specification. create opens the same page for a product that has none yet.
2. What do merchants ask Sidekick to do that needs it?
"Set the fabric on the Banarasi silk saree to 70% silk, 30% zari."
"Add dry-clean-only care to the green kurta."
"Fill in the missing model size for the green kurta."
After a read-only tool answers "8 sarees have no fabric composition", the merchant says "fix the first one". Today Sidekick can only link to the app. It cannot open the right editor for that product and stage a change for the merchant to confirm.
3. What apps would register intents for it?
StyleImprint (fashion product specifications, the app proposing this).
Size-chart and size-guide apps, for example Smart Size Chart & Size Guide. A merchant asking "open the size chart for this product" is the same hand-off.
Product specification and attribute apps with their own editors, for example Product Specifications and Bear Specs & Comparison Tables.
We have only read these apps' public listings, which do not say where each app stores its data, so these are examples of apps that give the merchant an editor for per-product specification or chart data. We are not claiming how any of them stores it.
4. What fields does it need?
Following application/quote and the open application/product-fee proposal, the canonical schema stays identity-only and allows additional properties:
Field Type Notes
id string The product whose specification is opened, as a Shopify Product GID. Travels as value.
Not proposed for the first version, but likely asks later: title, category, an attributes list. Apps declare their own optional prefill fields in inputSchema.properties (ours would be focus, category_id and subcategory_id). No field is required; names are snake_case.
5. Anything close in the existing list?
Existing Why it does not cover this
shopify/product (import, import+bulk) Takes a Shopify product in and returns a Shopify product. A specification app writes its own data and does not produce a product. Its doc says to use application/ when the app owns the artifact.
application/optimization-plan A durable plan of proposed improvements, not one product's data record.
application/product-fee (open PR #25) Same pattern (app-owned data attached to one product, value is the Product GID) for a different artifact. Not a substitute, but it shows the shape is already being proposed.
application/review, faq, … Different data.
Product metafields They store values in Shopify. They do not provide the app's editor, validation or review step, which is what Sidekick would hand the merchant to. An app can write metafields from its editor as well. The merchant still needs that editor opened at the right product.
6. How it would work
Same flow as other application/* types: Sidekick invokes edit:application/product-specification with the product reference, Shopify opens the app's page (admin.app.intent.link) or an overlay (admin.app.intent.render), the app may register page tools that stage changes in its form, and the merchant reviews and saves. Sidekick never writes the data.
7. Questions for maintainers
value as the Shopify Product GID. Our specification has no identity apart from its product, so we propose value = gid://shopify/Product/ rather than an app-owned gid://application/product-specification/…. Is that acceptable for an application/* type? (PR #25 asks the same. The application-quote example uses an app-owned GID, so we want to confirm the Product GID is also supported. If not, we will use gid://application/product-specification/.)
Several records per product. An app may keep one record per product type. Is one edit target per product acceptable, with the app resolving which record to show? (Our schema offers optional category_id and subcategory_id prefill fields so Sidekick can name the record; without them the app decides which record to show.)
Naming. product-specification or product-attributes? We lean to product-specification.
Bulk. There is no +bulk for application/*. "Add dry-clean care to all my sarees" would run through the app's own bulk flow. Is that the intended pattern?
create. Every product can have a specification, possibly empty. Is registering both actions that open the same page acceptable, as in PR #25?
We are happy to open a PR with the type file and schema once the direction is agreed.
All reactions