---
title: Build the UI for the delivery customization function
description: >-
  Create a UI that merchants can use to configure your delivery customization
  function.
source_url:
  html: >-
    https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui
  md: >-
    https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md
---

ExpandOn this page

* [What you'll learn](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#what-youll-learn)
* [Requirements](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#requirements)
* [Step 1: Create the frontend UI for your function](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#step-1-create-the-frontend-ui-for-your-function)
* [Step 2: Update your input query to use an app-owned namespace](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#step-2-update-your-input-query-to-use-an-app-owned-namespace)
* [Step 3: Configure the create UI path for your function](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#step-3-configure-the-create-ui-path-for-your-function)
* [Step 4: Update your app access scopes](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#step-4-update-your-app-access-scopes)
* [Step 5: Create and test your delivery customization](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#step-5-create-and-test-your-delivery-customization)
* [Deploy your app](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#deploy-your-app)
* [Next steps](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#next-steps)

# Build the UI for the delivery customization function

Merchants create and manage delivery customizations in the Shopify admin. Shopify uses [URLs that you configure](https://shopify.dev/docs/apps/build/functions/input-queries/metafields-for-input-queries#creating-your-merchant-interface) to render the delivery customization creation and editing experience for the merchant. You can customize this UI for your function's configuration needs, or to meet other requirements of your app.

***

## What you'll learn

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](https://shopify.dev/docs/apps/build/functions/input-queries/metafields-for-input-queries#how-it-works).
* Configure the UI paths for your function.

![Screenshot that shows the merchant UI for configuring the delivery function](https://shopify.dev/assets/assets/images/apps/checkout/delivery-customization-merchant-ui-DLtubh1w.png)

***

## Requirements

* You've completed the [Add configuration to your delivery customization](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/add-configuration) tutorial.
* You created your app with the [React Router app template](https://shopify.dev/docs/api#app-templates).

***

## Step 1: Create the frontend UI for your function

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 React Router app template uses file-based routing, so the file name determines the page's URL. The `$` prefix indicates `functionId` and `id` are [dynamic segments](https://reactrouter.com/how-to/file-route-conventions#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`](https://reactrouter.com/start/framework/data-loading#introduction) 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`](https://reactrouter.com/start/framework/actions) 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](https://polaris.shopify.com/components) and [React Router hooks](https://reactrouter.com/start/framework/navigating).

   ## app/routes/app.delivery-customization.$functionId.$id.jsx

   ```javascript
   import { useState, useEffect } from "react";
   import type { FormEvent } from "react";
   import {
     useActionData,
     useNavigation,
     useSubmit,
     useLoaderData,
   } from "react-router";
   import type { LoaderFunctionArgs, ActionFunctionArgs } from "react-router";
   import { authenticate } from "../shopify.server";


   interface LoaderData {
     headers: { "Content-Type": string };
     body: string;
   }


   interface ActionData {
     errors: Array<{ message: string }>;
   }


   interface DeliveryCustomizationData {
     stateProvinceCode: string;
     message: string;
   }


   export const loader = async ({ params, request }: LoaderFunctionArgs): Promise<LoaderData> => {
     const { id } = params;
     const { admin } = await authenticate.admin(request);


     if (id !== "new") {
       const gid = `gid://shopify/DeliveryCustomization/${id}`;


       const response = await admin.graphql(
         `#graphql
           query getDeliveryCustomization($id: ID!) {
             deliveryCustomization(id: $id) {
   ```

***

## Step 2: Update your input query to use an app-owned namespace

In the [previous tutorial](https://shopify.dev/docs/apps/selling-strategies/discounts/experience/config), 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](https://shopify.dev/docs/apps/build/custom-data/ownership#reserved-prefixes) 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 Rust and JavaScript due to code generation requirements.

## run.graphql

## src/run.graphql

```graphql
query RunInput {
  cart {
    deliveryGroups {
      deliveryAddress {
        provinceCode
      }
      deliveryOptions {
        handle
        title
      }
    }
  }
  deliveryCustomization {
    metafield(namespace: "$app:delivery-customization", key: "function-configuration") {
      value
    }
  }
}
```

```graphql
query Input {
  cart {
    deliveryGroups {
      deliveryAddress {
        provinceCode
      }
      deliveryOptions {
        handle
        title
      }
    }
  }
  deliveryCustomization {
    metafield(namespace: "$app:delivery-customization", key: "function-configuration") {
      value
    }
  }
}
```

##### JavaScript input query

```
query RunInput {
  cart {
    deliveryGroups {
      deliveryAddress {
        provinceCode
      }
      deliveryOptions {
        handle
        title
      }
    }
  }
  deliveryCustomization {
    metafield(namespace: "$app:delivery-customization", key: "function-configuration") {
      value
    }
  }
}
```

##### Rust input query

```
query Input {
  cart {
    deliveryGroups {
      deliveryAddress {
        provinceCode
      }
      deliveryOptions {
        handle
        title
      }
    }
  }
  deliveryCustomization {
    metafield(namespace: "$app:delivery-customization", key: "function-configuration") {
      value
    }
  }
}
```

***

## Step 3: Configure the create UI path for your function

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](https://shopify.dev/docs/apps/build/functions/input-queries/metafields-for-input-queries#dynamic-id-values) 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`.

## extensions/delivery-customization/shopify.extension.toml

```toml
[ui.paths]
create = "/app/delivery-customization/function-handle/new"
details = "/app/delivery-customization/function-handle/:id"
```

***

## Step 4: Update your app access scopes

You must request the `write_delivery_customizations` [access scope](https://shopify.dev/docs/api/usage/access-scopes) 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.

   ## shopify.app.toml

   ```toml
   # This file stores configurations for your Shopify app.


   scopes = "write_products, write_delivery_customizations"
   ```

2. Save your configuration file. If [`app dev`](https://shopify.dev/docs/api/shopify-cli/app/app-dev) is running, the scope changes will be applied automatically. If not, start the command:

   ## Terminal

   ```terminal
   shopify app dev
   ```

***

## Step 5: Create and test your delivery customization

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**.

1) Open your development store, build a cart, and proceed to checkout.
2) Enter a delivery address that doesn't use the specified state/province code. You shouldn't see any additional messaging on the delivery options.
3) Change your shipping address to use your chosen state/province code. Your delivery options should now have the additional messaging.

1. Open your terminal where `shopify app dev` is running, and review your function executions.

   When [testing functions on development stores](https://shopify.dev/docs/apps/build/functions/test-debug-functions#test-your-function-on-a-development-store), the output of `dev` includes executions of your functions, any debug logging you have added to them, and a link to a local file with the full function execution details.

2. In a new terminal window, use the Shopify CLI [`app function replay`](https://shopify.dev/docs/api/shopify-cli/app/app-function-replay) command to [replay a function execution locally](https://shopify.dev/docs/apps/build/functions/test-debug-functions#execute-the-function-locally-using-shopify-cli), and debug your function without the need to re-trigger the function execution on Shopify.

## Terminal

```terminal
shopify app function replay
```

1. Select the function execution from the top of the list. Press `q` to quit when you are finished debugging.

***

## Deploy your app

When you're ready to release your changes to users, you can create and release an [app version](https://shopify.dev/docs/apps/launch/deployment/app-versions). An app version is a snapshot of your app configuration and all extensions.

1. Navigate to your app directory.

2. Run the following command.

   Optionally, you can provide a name or message for the version using the `--version` and `--message` flags.

   ## Terminal

   ```terminal
   shopify app deploy
   ```

Releasing an app version replaces the current active version that's served to stores that have your app installed. It might take several minutes for app users to be upgraded to the new version.

Tip

If you want to create a version, but avoid releasing it to users, then run the `deploy` command with a `--no-release` flag. You can release the unreleased app version using Shopify CLI's [`release`](https://shopify.dev/docs/api/shopify-cli/app/app-release) command, or through the Dev Dashboard.

***

## Next steps

* Learn more about how [Shopify Functions](https://shopify.dev/docs/api/functions/current) work and the benefits of using Shopify Functions.
* Consult the [API references for Shopify Functions](https://shopify.dev/docs/api/functions).
* Learn how to use [variables](https://shopify.dev/docs/apps/build/functions/input-queries/use-variables-input-queries) in your input query.

- Review the [UX guidelines](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/ux-for-delivery-options) to learn how to implement delivery customizations in user interfaces.

***

* [What you'll learn](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#what-youll-learn)
* [Requirements](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#requirements)
* [Step 1: Create the frontend UI for your function](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#step-1-create-the-frontend-ui-for-your-function)
* [Step 2: Update your input query to use an app-owned namespace](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#step-2-update-your-input-query-to-use-an-app-owned-namespace)
* [Step 3: Configure the create UI path for your function](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#step-3-configure-the-create-ui-path-for-your-function)
* [Step 4: Update your app access scopes](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#step-4-update-your-app-access-scopes)
* [Step 5: Create and test your delivery customization](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#step-5-create-and-test-your-delivery-customization)
* [Deploy your app](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#deploy-your-app)
* [Next steps](https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-ui.md#next-steps)