Broadleaf Microservices
  • v1.0.0-latest-prod

Fulfillment Services Data Model

Data Diagram

The following data shows the key tables used by the Fulfillment Service.

Fulfillment Data Model

FulfillmentCalculator (BLC_FULFILLMENT_CALCULATOR_CONFIG)

The Fulfillment Calculator Config table maintains the data that drives calculator eligibility and calculations.

Field Description

FULFILLMENT_CALCULATOR_CONFIG_ID

Unique id of the calculator

NAME

The friendly name of the calculator

FULFILLMENT_METHOD

The fulfillment method this calculator applies to (typically SHIP)

SERVICE_LEVEL

The service level this calculator is used for (e.g. STANDARD, EXPRESS)

ACTIVE

Indicator if this calculator is active. Can be turn off calculators with active dates.

EST_MIN_DAYS

The typical, minimum number of days required for delivery

EST_MAX_DAYS

The typical, max number of days required for delivery

CURRENCY

The 3 digit currency code (e.g. USD, EUR)

DESTINATION_TYPE

Which destinations this calculator can price. One of ANY, COUNTRY_CODE, or FULFILLMENT_DESTINATION

FULFILLMENT_DESTINATION

When dest type is FULFILLMENT_DESTINATION, the id of a fullfilment destination

DEST_COUNTY_CODE

When dest type is COUNTRY_CODE, the 2 digit country code (e.g. US)

ORIGIN_TYPE

Which origins this calculator can process. One of ANY, INVENTORY_LOCATION, or FULFILLMENT_ORIGIN

INVENTORY_LOCATION

When origin type is INVENTORY_LOCATION, a value representing the inventory location

CALCULATION_METHOD

Determines which total will be used to determine the pricing tier. One of ELIGIBLE_ITEMS, INDIVIDUAL_ITEM, FULFILLMENT_GROUP_TOTAL, or CART_TOTAL

CALCULATOR_OPERATION

One of fixed amount or rate

BAND_FIELD

Determines if the PRICE or WEIGHT is used to determine the pricing tier

WEIGHT_UNIT

The unit of measure used when the BAND_FIELD is of type weight

FULFILLMENT_PRICE_TIERS

A structure representing the pricing bands with minimum threshold and the amount for each band

INVENTORY_TYPE

Typically PHYSICAL

PRIORITY

Offer evaluation priority

ACTIVE_START_DATE

valid dates for the offer

ACTIVE_END_DATE

valid dates for the offer

Fulfillment Price Tier

Embeddable JSON structure in BLC_FULFILLMENT_CALCULATOR_CONFIG table.

Field

Description

minValue

The minimum value of the total needed to reach this tier

amount

The amount to use for this tier

operationType

Usually null, defaulting to the CALCULATION_OPERATION in the calculator config

FulfillmentDestination (BLC_FULFILLMENT_DESTINATION)

Structure identifying the destinations that can be used for this calculator

Field Description

FULFILLMENT_DESTINATION_ID

Unique Id for the Fulfillment Destination

NAME

Friendly name

INCLUDED_DESTINATIONS

List of embedded FulfillmentDestination JSON objects to to filter items that can be processed by this calculator

EXCLUDED_DESTINATIONS

List of embedded FulfillmentDestination JSON objects to exclude items from being processed by this calculator

Fulfillment Destination

Embeddable JSON structure in BLC_FULFILLMENT_DESTINATION table.

Field

Description

id

Unique id of this fulfillment destination

name

Friendly name

countryCode

2 letter country code

regionCode

Typically a state or province abbreviation

city

A city name

postal

A postal code

FulfillmentOrigin (BLC_FULFILLMENT_ORIGIN)

Structure identifying the fulfillment origin.

Field Description

FULFILLMENT_ORIGIN_ID

Unique Id for the Fulfillment Origin

NAME

Friendly name

INVENTORY_LOCATIONS

Embedded list of Strings representing inventory locations

FulfillmentPricingConfig (BLC_FULFILLMENT_PRICING_CONFIG)

Stores defaults used by fulfillment pricing. These can be set at the tenant or application level

Field Description

FULFILLMENT_PRICING_CONFIG_ID

Unique Id for the Configuration

SERVICE_LEVEL

The default service level to use (typically STANDARD)

PRICING_STRATEGY

Defaults to GROUP, whether to provide Options at the Group or Item level

Broadleaf Common Data Features

All entities are Application Trackable - to allow application specific configurations.