Skip to main content

Creating Flows

With flows, you can extend an existing resource or create a new resource for your store or organization. You can also use to create simple custom fields for existing resources or complex collections of fields and data. You can create useful resources for your customers, such as a want list, or blogs for your store or organization.

For more information about using flows in Commerce, see Custom Data (Flows).


Do not create flows in SYSTEM > Flows. Use Product Experience Manager > Configurations > Templates page to create a Product Experience Manager flow. However, all flows in the store are displayed in the SYSTEM > Flows page where the template flows are labelled with a prefix PXM. We recommend not to update template flows in this page.

Creating Flows

  1. Go to System > Flows.

    All flows available in the store are displayed, if any.

  2. Click New flow.

    The Create New Flow window is displayed.

  3. In the Name field, enter a name for the flow.

  4. In the Slug field, enter a slug.

    By default, the name is used as the slug.

  5. In the Description field, enter a description for the flow.

  6. To enable the flow, select Enabled.

  7. Click Save.

    The new flow is added to the list of flows available in the store. All flows are displayed under the FLOWS header in the sidebar. You can also click Store > Flows in the sidebar and view all flows.

Adding fields to a flow

  1. To add field to a flow, in the Flows page, select the flow.

    A window with the details of the flow is displayed.

  2. Click +New Field.

  3. In Field Type, select one of the following:

    • Boolean
    • Float
    • Integer
    • String
    • Date
    • Relationship A relationship type specifies the relationship between the flow and a Composable Commerce resource, such as products. You can have several relationships in a flow.
  4. Enter the following common settings:

    • Name: Specifies the name of the field.
    • Slug: Specifies a unique slug identifier for the field.
    • Description: Specifies a description for this field.
    • Required Field: Specifies whether the field is required. Choose Yes or No. Select No if the Field Type is Relationship.
    • Default Value: Specifies a default value for the field if no value is provided and the field is required.
    • Order: Specifies the order in which this field is returned relative to the rest of the flow fields. Use a number.
  5. In the Validation field, enter the valid input options for the field:

    Field typeValidation description
    BooleanNo validation required.
    Float,Enter a range of valid values. Optionally, you can add a list of valid values.
    IntegerEnter a range of valid integer values. Optionally, you can add a list of valid values.
    StringSelect a valid value for the field, such as email, slug, or uuid, or enter a list of valid string options.
    DateEnter a date that matches the standard date format described previously. You can also list valid dates.
    RelationshipSelect One to One as the relationship type, and select the Resource. The Resource can be one of Products, Brands, Collections, Categories, Customers, Orders, or Promotions resources.
  6. Click Save.

You can delete a field by clicking the delete icon in the field listing.

Adding values to fields

  1. In the sidebar menu, go to FLOWS and click the flow name.

All field names in the flow are displayed.

  1. Click New Entry and enter values for the fields as required.

You cannot add attributes for template flows in this page. Use the Product Experience Manager > Configurations > Attributes page to add attributes in a Product Experience Manager template.

Updating Flow Settings

  1. Go to System > Flows.
  2. To edit a flow, click the flow.
  3. In the Fields window, click Flow Settings.
  4. In the Flow Settings window, update the settings as required.
  5. Click Save.

Deleting Flows

  1. Go to System > Flows.
  2. To delete a flow, click the flow.
  3. In the Fields window, click Delete Flow.
  4. When prompted to confirm the delete action, click Delete.

Sorting and Filtering Flows

You can sort the flow list by Name, Slug, Description or Status.

You can filter the list to show only Enabled or Disabled flows.