Order Services Release Notes for 2.2.0-GA

Table of Contents

Requirements
New Features & Notable Changes

Tip	The 2.x versions are Spring Boot 3 compatible.

Requirements

JDK 17 is required for Broadleaf release trains 2.0.0-GA, and beyond.
This version now requires DataTracking 2.0.3+

New Features & Notable Changes

Retail Delivery Fees

Added support for Retail Delivery Fees
- Added support for optionally refunding RDFs in OMS views
  - Added property to gate enabling RDF refund choice for CSRs in the Admin OMS views (broadleaf.order.metadata.enable-refunds-on-retail-delivery-fees - false by default)
  - Added metadata attribute on the return action to pass the property value to AdminWeb.
- Added new fee domain to the JpaReturnAuthorization
Support Admin Workflow UI for Order Fulfillments
- New properties
  - broadleaf.order.metadata.support-views-as-body-content-for-fulfillment-view-enabled=false: Enables FulfillmentView to have subview sections like OrderView rather than only having a single hardcoded view
  - broadleaf.order.metadata.workflow-service-integration-enabled=false: Enables a workflow view section for Fulfillments to integrate with an external workflow service
- Added FulfillmentViewSection to allow FulfillmentView to have sub-views like OrderView. Analogous to OrderViewSection
- Added FulfillmentSummaryViewSection to be a FulfillmentViewSection representing the default view previously hardcoded into FulfillmentView. Use in combination with the property specified above
- Added FulfillmentMainView interface to include shared configuration options between FulfillmentSummaryViewSection and FulfillmentView to reduce duplication
- Added FulfillmentWorkflowViewSection to represent the workflow from the workflow service for the Fulfillment. Use in combination with the property specified above
- Added FulfillmentWorkflowCommandAction to represent the commands that can be issued against a Workflow
- Added OMS metadata DSL support for inventoryLookupEndpoint on ItemsOrderViewSection to replace manual construction
- Added DSL helper util FulfillmentActions for initializing workflow command class instances
- Added DSL helper util FulfillmentViews for initializing instances of difference Fulfillment related classes
- Added workflow view related messages to messages/workflow.properties
Added Cancellation Policy ref fields to the JpaOrderItem

New API for Consolidated Returnable Items and Fees Information

Added new endpoint to read a ReturnableFulfillmentInfo object that contains both the returnable items and refundable fees to avoid multiple calls in the UI
This replaces the returnable items endpoint, which is now deprecated
Also added IncludedFees to the OrderFulfillment domain for persistence
- This is a JSON array with summaries of each fee captured or canceled along with an OrderFulfillment
- Column INCLUDED_EXTRA_FEES

Table 1. New Endpoints
Purpose	HTTP Method	Path	Response
Get returnable info for entire order	`GET`	`/orders/{id}/returnable-info`	`ReturnableFulfillmentInfo`
Get returnable info for an order fulfillment	`GET`	`/orders/{orderId}/fulfillments/{id}/returnable-info`	`ReturnableFulfillmentInfo`

Table 2. Deprecated Endpoints
Purpose	HTTP Method	Path	Response
Get returnable fulfillment items for entire order	`GET`	`/orders/{id}/returnable-items`	`List<OrderFulfillmentItem>`
Get returnable fulfillment items for an order fulfillment	`GET`	`/orders/{orderId}/fulfillments/{id}/returnable-items`	`List<OrderFulfillmentItem>`

ReturnableFulfillmentInfo

{
  "returnableItems": OrderFulfillmentItem[];
  "returnableFees": IncludedFee[];
}

Schema Changes

Added new columns to the blc_order_item table
- CANCEL_POLICY_REF_ATTR
- CANCEL_POLICY_REF_ID
- CANCEL_POLICY_REF_SRC_ID
- CANCEL_POLICY_REF_SRC_TYPE