Build a a UI for customized delivery options

In this tutorial, you'll learn how to do the following tasks:

• Create an App Bridge UI that enables users to create a function owner.
• Configure the UI paths for your function.

• You've completed the Add configuration to your delivery customization tutorial.
• You created your app with the Remix app template.

The following example builds a React-based page that enables merchants to create and configure a new delivery customization. The code renders a frontend page in your app and uses the GraphQL Admin API to create a delivery customization.

1. In app/routes, create a new file named app.delivery-customization.$functionId.$id.jsx.

   The Shopify Remix app template uses file-based routing, so the file name determines the page's URL. The $ prefix indicates functionId and id are dynamic segments. The path for this page is /app/delivery-customization/{functionId}/{id} .

2. Add the following code in app.delivery-customization.$functionId.$id.jsx:

   • The loader function handles fetching the data to populate the form and is used when this page has an id value that is not new.
   • The action function handles submitting the form data to Shopify to create the delivery customization.
   • The DeliveryCustomization function renders the page and form components using Polaris components and Remix hooks.

In the previous tutorial, you used a metafield namespace that was accessible to any app, so that the metafield namespace could be populated using GraphiQL. To make your function ready for production, you should update the metafield namespace to use a reserved prefix so that other apps can't use your metafield.

Replace the code in the extensions/delivery-customization/src/run.graphql file with the following code. The query differs slightly in JavaScript and Rust due to code generation requirements.

In shopify.extension.toml, define the URLs that users will access to create and edit delivery customizations using your function. Shopify automatically fills in any dynamic tokens in these URLs.

In extensions/delivery-customization/shopify.extension.toml, populate the two settings directly under [ui.paths]. This change is automatically reflected as long as you're running dev.

You must request the write_delivery_customizations access scope to invoke delivery customization mutations in the Admin API.

1. In shopify.app.toml in the root of your app, add the write_delivery_customizations scope.

2. Deploy your updated configuration to Shopify:

3. Restart your app:

4. Use the URL provided by the CLI to open and re-install your app. You should be prompted to accept the new access scope permissions in your store.

1. From the Shopify admin, go to Settings > Shipping and delivery.
2. Under the Delivery customizations section, click Manage.
3. If you have existing customizations from previous tutorials, then click the checkbox next to each of them, and then click Deactivate.
4. Click Add a customization and then click delivery-customization by {your app}.

5. Fill in the delivery customization form, then click Save.

6. Open your development store, build a cart, and proceed to checkout.

7. Enter a delivery address that doesn't use the specified state/province code. You shouldn't see any additional messaging on the delivery options.

8. Change your shipping address to use your chosen state/province code. Your delivery options should now have the additional messaging.

9. To debug your function, or view its output, you can review its logs in your Partner Dashboard.

   1. Log in to your Partner Dashboard and navigate to Apps > {your app} > Extensions > delivery-customization.
   2. Click on any function run to view its input, output, and any logs written to STDERR.

• Learn more about how Shopify Functions work and the benefits of using Shopify Functions.
• Consult the API references for Shopify Functions.

• Learn how to use variables in your input query.

• Review the UX guidelines to learn how to implement delivery customizations in user interfaces.