Skip to main content

Checkout Flows

Overview​

Breeze offers configurable checkout flows that allow each Tenant to use a different checkout process beyond the default cart checkout. This feature includes four checkout flows:

  1. Default Checkout
  2. On-the-Fly Checkout
  3. Scheduled Checkout
  4. Merge Checkout

These different flows provide greater flexibility in how Tenants manage the ordering and production of Credentials, tailoring the process to their specific operational needs.

What Are Checkout Flows?​

Checkout flows define how orders are processed from the point of adding items to the cart through to production. The four available flows---Default, On-the-Fly, Scheduled, and Merge---offer flexibility to suit various use cases, from manual checkout to fully automated processes.

Intentions of the Feature​

  • Customization: Allows Tenants to choose a checkout flow that best suits their workflow and production requirements.
  • Efficiency: Streamlines the ordering process by reducing unnecessary steps for certain use cases.
  • Automation: Enables automatic processing of orders without manual intervention, beneficial for API integrations and bulk processing.
  • Control: Offers options to merge orders and control the frequency and manner in which orders are processed by the production site.
  • Cost Savings: By merging orders, Tenants can reduce processing costs and optimize shipping.

Configuring Checkout Flows​

Required Roles​

Required Roles

Required roles: System Administrator

To perform the following configurations, you need to have the roles listed above.

Accessing Checkout Flow Settings​

  1. Navigate to the Tenant Settings page.
  2. Open the Production settings tab.
  3. Click on the Edit Production Settings button.
  4. Locate the Production Flow Settings settings box, and hit the Change Settings button.

Selecting a Checkout Flow​

In the Checkout Flow tab, you will see the available checkout flow options:

  • DEFAULT
  • ON_THE_FLY
  • SCHEDULED
  • MERGE

Select the desired checkout flow for your Tenant.

Checkout Flow Options​

1. Default Checkout​

This is the standard checkout process where users add items to their cart and manually proceed through the checkout steps.

  • Behavior: Credentials and products are added to the cart. Users must manually check out to place an order.
  • Use Case: Suitable for most Tenants where manual review and confirmation of orders are required.

2. On-the-Fly Checkout​

Description​

The On-the-Fly Checkout flow bypasses the cart and manual checkout process. Users create Credentials that are automatically processed and added to the production queue.

Behavior​

  • Menu Changes: The "Order New Credentials" option is replaced with "Create New Credentials".
  • Automatic Processing: New Credentials are immediately processed and sent to production upon creation.
  • No Cart: There is no cart or order associated with the Credential.
  • Approval Steps: If an approval workflow is configured, Credentials still require approval before production.

Configuration Steps​

  1. Select the ON_THE_FLY option in the Checkout Flow settings.

  2. Define Role Exceptions (Optional):

    • You can specify certain user roles that will still use the Default Checkout flow.
    • This is useful if, for example, administrators should bypass the cart while regular users should not.

Use Case​

Ideal for Tenants with local production facilities who want to produce Credentials immediately without the extra steps of cart checkout and order processing.

Important Notes​

  • The "Order Products and Accessories" option remains available and uses the Default Checkout flow.
  • Ensure users are trained on the new process, as it changes how they interact with the system.

3. Scheduled Checkout​

Description​

The Scheduled Checkout flow automatically checks out open carts at defined intervals.

Behavior​

  • Automatic Checkout: Items in users' carts are automatically checked out based on a schedule.
  • Cron Expression: A cron expression defines the checkout schedule.
  • Default Address and Shipping Method: Configurable defaults are used unless specified by the user.

Configuration Steps​

  1. Select the SCHEDULED option in the Checkout Flow settings.

  2. Set Up Cron Schedule:

    • Enter a cron expression to define when carts are automatically checked out.
    • Example: 0 0 * * * for daily at midnight.
    • Crontab.guru is a useful tool for generating cron expressions.

  3. Configure Default Settings:

    • Default Address: Specify the default shipping address for orders.
    • Shipping Method: Select the default shipping method to be used.

  4. Save the settings.

Use Case​

Beneficial for API users who place orders externally. Orders accumulate in the cart and are automatically processed without manual intervention.

Important Notes​

  • The scheduled flow applies to all carts on the Tenant.
  • Users can still manually check out orders through the Breeze interface.
  • After checkout, the order will be processed according to the Tenant's production settings like any other order.

4. Merge Checkout​

Description​

The Merge Checkout flow queues checked-out orders and merges them according to specified settings at scheduled intervals.

Behavior​

  • Order Queue: Checked-out orders receive the status "In Queue".
  • Scheduled Merging: Orders in the queue are merged based on the merge settings when the schedule triggers.
  • Reduced Processing: Merging reduces the number of orders processed by the production site.

Configuration Steps​

  1. Select the MERGE option in the Checkout Flow settings.

  2. Set Up Cron Schedule:

    • Enter a cron expression to define when orders are merged.
    • Example: 0 */6 * * * for every six hours.
    • Crontab.guru is a useful tool for generating cron expressions.

  3. Configure Merge Settings:

    • Merge Type: Choose one of the following options:
      • Static: Merge all orders using a predefined user, address, and delivery method.
      • Merge All: Merge all orders into one, using settings from the first order found.
      • Merge by User: Merge orders per user, using settings from each user's first order.
      • Merge by Delivery: Merge orders with the same delivery address and method.

  4. Define Static Settings (if applicable):

    • If using the Static merge type, specify the user, address, and delivery method to be used for the merged order.

  5. Save the settings.

Use Case​

Useful for Tenants that want to control order frequency and reduce processing overhead by consolidating orders.

Merge Settings Explained​

  • Static:

    • Purpose: All queued orders are merged into a single order with predefined settings.
    • When to Use: When all orders should be delivered to the same location regardless of the original order details.

  • Merge All:

    • Purpose: Merges all queued orders using settings from the first order in the queue.
    • When to Use: When orders can be combined and the first order's settings are acceptable for all.

  • Merge by User:

    • Purpose: Merges orders for each user separately.
    • When to Use: When you want to consolidate orders per user.
    • Note: Each user's first order address and method are used for the merged order.

  • Merge by Delivery:

    • Purpose: Merges orders that share the same delivery address and method.
    • When to Use: When orders to the same destination can be combined to optimize shipping.

Important Notes​

  • Orders with different delivery settings may not be merged, depending on the merge type selected.
  • Ensure that merging orders does not violate any business rules or customer agreements.
  • Users will be informed in the checkout process that their order may be merged.