Set Warehouse Based on Zip

Assign the default warehouse based on the delivery address zip code.

Overview

The Set Warehouse Based on Zip step assigns warehouses to shipments based on the delivery zip code. It uses warehouse zip code range configurations to determine which warehouse should fulfill orders for each geographic area.

Identifier

PropertyValue
KeySetWarehouseBasedOnZip
GroupReallocate
Applicable StatusesNew

Configuration Properties

PropertyTypeRequiredDescription
ignoreZipCodeRangebooleanNoIf true, ignores warehouse zip code range restrictions
storeRolesstringNoFilter eligible warehouses by role

Behavior

What It Does

  1. Validates that the order has shipments
  2. Looks up the delivery address zip code using configuration options
  3. Finds the warehouse configured to serve that zip code range
  4. Sets the warehouse on applicable shipments

Prerequisites

  • Order must have shipments
  • Warehouses must have zip code ranges configured
  • Order must have a valid delivery address with zip code

Side Effects

  • Updates WarehouseCode on shipments
  • Does not check inventory availability (use reallocation steps for that)

Business Cases

When to Use

  • Regional fulfillment: Route orders to regional warehouses based on delivery location
  • Initial allocation: Set the starting warehouse for new orders
  • Simple distribution: When you have clear geographic warehouse territories

Example Scenarios

Scenario 1: Regional Warehouses Warehouse "EAST" serves zip codes 00000-49999, "WEST" serves 50000-99999. Orders are routed accordingly.

Scenario 2: Store Roles Configure storeRoles = "fulfillment" to only consider warehouses with fulfillment capability, excluding retail-only stores.

Error Handling

ConditionResultContinues Workflow?
No shipmentsWarningYes
Warehouse changedSuccessYes
No change neededSuccessYes
ExceptionError (logged)Depends on StopOnError

On this page