Getting started with building fulfillment constraints

You have three products which can be sold individually. The products are fulfilled from your warehouse location, which has been set as a shipping origin within your shipping profile. You want to group and ship the three products in a special package only when they're purchased together. The grouping of the products should only be assembled at your physical store location in Ottawa.

The function you'll build in this tutorial adjusts the fulfillment location for the three products only when they are purchased together.

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

• Generate starter code for Shopify Functions.
• Use GraphQL to define the input of your function.
• Deploy functions to the Shopify platform.
• Setup your app to register your fulfillment constraint rule with your Shopify store.
• Review logs for your function.

• You've created a Partner account.
• You've created a development store with the Checkout and Customer Accounts Extensibility developer preview enabled.

• You've created an app that uses Shopify CLI 3.49.5 or higher. If you previously installed Shopify CLI, then make sure that you're using the latest version.

  If you plan to create a UI for your extension, then start with the Remix app template.

• You've installed Node.js 16 or higher.

• You've installed your app on the development store with the Checkout and Customer Accounts Extensibility developer preview enabled.

The following requirements are specific to Rust-based development with Shopify Functions.

• You've installed Rust.

  On Windows, Rust requires the Microsoft C++ Build Tools. Make sure to select the Desktop development with C++ workload when installing the tools.

• You've installed cargo-wasi:

To create your fulfillment constraint rule function, you can use Shopify CLI to generate a starter function, specify the inputs for your function using an input query, and implement your function logic using Rust.

1. Navigate to your app directory:

2. Run the following command to create a new fulfillment constraint rule extension:

3. Choose the language that you want to use. For this tutorial, you should select either JavaScript or Rust.

4. Navigate to extensions/my-fulfillment-constraint-function:

5. Replace the contents of src/run.graphql file with the following code:

   run.graphql defines the input for the function. For this function, you need access to the cart object to determine the products in the checkout. You also need access to the location in which you want the products to be fulfilled from. In this case, you're looking for a location with a certain name.

   The query differs slightly in JavaScript and Rust due to code generation requirements.

6. If you're using JavaScript, then run the following command to regenerate types based on your input query:

7. Replace the src/run.js or src/run.rs file with the following code.

   The function logic constructs a MustFulfillFrom fulfillment constraint for all products with the Promotional candle tag when three or more products exist, and fulfills the order from the Ottawa Store location.

8. If you're using Rust, then build the function's Wasm module:

   If you encounter any errors, then ensure that you've installed Rust and cargo-wasi.

To test your function, you need to make it available to your development store.

1. If you're developing a function in a language other than JavaScript or TypeScript, ensure you have configured build.watch in your function extension configuration.

2. Navigate back to your app root:

3. Use the Shopify CLI dev command to start app preview:

   You can keep the preview running as you work on your function. When you make changes to a watched file, Shopify CLI rebuilds your function and updates the function extension's drafts, so you can immediately test your changes.

4. Follow the CLI prompts to preview your app, and install it on your development store.

You can test your fulfillment constraint rule to ensure it's working as expected, and review logs for your function.

1. Find the ID of your function by executing the following query:

   The result contains a node with your function's ID:

2. From within your app, use the ID of your function to invoke the fulfillmentConstraintRuleCreate mutation to register the FulfillmentConstraintRule. The app needs to be the same app that deployed the function.

3. From your development store's admin, set up the Ottawa Store location along with three or more products with the Promotional candle tag.

4. Open your development store and build a cart containing three or more of the products you created, and then proceed through checkout.

5. Open your development store's admin, and find your new order. The products should be assigned to your Ottawa Store location. If you change one of the product's inventory locations, then checkout won't return any shipping rates and buyers won't be able to complete checkout.

   

6. 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 > fulfillment-constraints.
   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.