Broadleaf Microservices
  • v1.0.0-latest-prod

Release Notes for 1.0.0-GA

Requirements

  • JDK 11 is now required for Broadleaf release trains 1.7.0-GA, and beyond.

New Features & Notable Changes

Feature/Notable Change Related Services Links

Introduction of CreditAccountServices to support an alternative form of payment such as store credit.

PaymentTransactionServices, Broadleaf’s StoreCredit Integration Library

Broadleaf’s StoreCredit Integration Library

Upgrade Guide

API Changes

CreditAccountServices OpenAPI Docs

New Endpoints

Path Description

GET /customers/{customerId}/store-credit-accounts

Read a customer’s store credit accounts

GET /customers/{customerId}/store-credit-accounts/{accountNumber}

Read a customer’s store credit account by account number

GET /customers/{customerId}/store-credit-accounts/{accountNumber}/transactions

Read a customer’s store credit account’s transactions

POST /customers/{customerId}/store-credit-accounts

Create a customer’s store credit account

DELETE /customers/{customerId}/store-credit-accounts/{accountNumber}

Deletes a customer’s store credit account

POST /store-credit-accounts/{accountNumber}/credit

Executes a credit transaction against a store credit account

POST /store-credit-accounts/{accountNumber}/debit

Executes a debit transaction against a store credit account

Liquibase Change Sets

Create/Update SQL

Drop SQL

Gateway Configuration

This service needs to be registered with both the Commerce and Admin gateways, using the following configuration:

Commerce Gateway

broadleaf:
  gateway:
    proxyurls:
      creditaccount: https://localhost:8478
    predicates:
      creditaccount: /api/credit-account/**
    filters:
      creditaccount: /api/credit-account/?(?<segment>.*), /$\{segment}
spring:
  cloud:
    gateway:
      routes:
        - id: credit-account
          uri: ${broadleaf.gateway.proxyurls.creditaccount}
          predicates:
            - Path=${broadleaf.gateway.predicates.creditaccount}
          filters:
            - RewritePath=${broadleaf.gateway.filters.creditaccount}
            - ApplicationToken

Admin Gateway

broadleaf:
  gateway:
    proxyurls:
      creditaccount: https://localhost:8478
    predicates:
      creditaccount: /api/credit-account/**
    filters:
      creditaccount: /api/credit-account/?(?<segment>.*), /$\{segment}
spring:
  cloud:
    gateway:
      routes:
        - id: credit-account
          uri: ${broadleaf.gateway.proxyurls.creditaccount}
          predicates:
            - Path=${broadleaf.gateway.predicates.creditaccount}
          filters:
            - RewritePath=${broadleaf.gateway.filters.creditaccount}

New Permissions

There are new permissions and scopes for some service OAuth2 clients. Permissions and scopes can be added via admin or sql script.

See AuthServices release notes for more details.