Repository navigation
Proposal: application/delivery-rule — estimated delivery date rules #12
Replies: 2 comments
|
Hey! How are you? Thank you for your proposal (and your patience). We’re working on aligning on this app intent type and. Looking at the big picture of the platform, we found some overlapping domains and some adjustments that we may need to do to clarify the purpose of this intent. We're figuring out the best way to handle it. I’ll let you know as we make progress. |
|
Hey @drashtiprajapti! This is out!! #78 is merged and it shipped as application/delivery-estimate. Two variations from your proposal: we renamed it from Thanks for helping expand the platform! Happy coding! |
Uh oh!
There was an error while loading. Please reload this page.
application/delivery-ruleA merchant-defined rule that determines the estimated delivery or dispatch date shown
to a buyer for a given set of products, and the message used to express it.
create,edithttps://extensions.shopifycdn.com/shopifycloud/schemas/v1/application/delivery-rule.jsonWhen to register
Register this intent if your app lets merchants define which delivery estimate is
shown, to whom, and when. This is a distinct merchant object: it is authored, named,
enabled/disabled, and targeted, independently of any order or shipment.
Merchants express these intents in natural language today:
Each of these targets one rule. Without an intent type, the merchant must leave the
conversation, find the rule by hand among potentially hundreds, and edit it there.
Who would use it. Delivery-date and shipping-estimate apps are a large, established
category on the App Store — estimated delivery date apps, dispatch/lead-time apps, and
shipping-rate apps that also surface delivery windows. They independently converge on the
same object: a targeted rule producing a customer-facing delivery message. Three or more
apps in this category would register this type.
Registration example
Registration notes
editcovers enabling and disabling a rule (enabled: false). A separatedeleteaction is not proposed — merchants overwhelmingly disable rather than delete, since a
rule encodes tuning they don't want to lose.
createreceives a partial object to prefill;editadditionally receives the target rule's identifier.
admin.app.intent.rendersuits this type: the rule editor is dense (targeting, stockstate, geography, message), and rendering it inline avoids sending the merchant out of
the conversation.
Input schema example
./delivery-rule-schema.json:{ "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "https://extensions.shopifycdn.com/shopifycloud/schemas/v1/application/delivery-rule.json" }No fields are declared
required. Sidekick may know only the target and the message("delivery rule for the Summer collection, 5 days") and the app supplies the rest.
Fields
titleenabledfalseis how a rule is disabled.targettarget.scopeall,product,collection,tag,vendor. Apps may support a subset.target.idsproductorcollection.target.valuestagorvendor.messageestimateestimate.min_daysestimate.max_daysestimate.business_days_onlyavailabilityavailability.stock_statein_stock,out_of_stock,any.availability.country_codesactive_periodactive_period.starts_atactive_period.ends_atDeliberately excluded, as app-specific rather than merchant-object concerns: cutoff times,
holiday calendars, per-language message variants, zip-code and shipping-method targeting,
and inventory-location targeting. Apps that support these should collect them in their own
UI after the intent opens. Including them would make the schema an app-configuration dump
rather than a merchant object.
Common pitfalls
application/shipmentdescribes a physicalconsignment that exists after an order. A delivery rule is authored before any order and
applies to products, not parcels. They share vocabulary and nothing else.
target. A rule targets one scope. A merchant asking for "theSummer collection and anything tagged fragile" wants two rules, and Sidekick should
create them as two intents.
estimateandmessagetogether. Some apps compute the messageentirely from the estimate; others let merchants write free text and ignore the day
counts. Both are valid.
app configuration, not a merchant object, and belongs on a settings page.
Related types
application/shipment— a consignment created after an order; see the pitfall above.shopify/product— a rule targets products but is not one.Discussion history
All reactions