Broadleaf Microservices
  • v1.0.0-latest-prod

Release Notes for 1.0.2-GA

New Features & Notable Changes

  • Updated the JpaCreditAccount domain to be ApplicationTrackable, instead of TenantTrackable. This allows you to define account-scoped accounts vs tenant-scoped accounts.

  • Introduced alternativeOwningUserType & alternativeOwningUserRef to the CreditAccount domain to allow you to capture two different owning user references.

  • Introduced a generic attributes map to the CreditAccount domain.

  • * Broadleaf customer-owned store credit account creation & deactivation endpoints to use the BACKEND_STORE_CREDIT_ACCOUNT permission root, instead of CUSTOMER_STORE_CREDIT_ACCOUNT, so that these endpoints are not accessible by customers by default.

  • Updated customer store credit metadata to leverage the new BACKEND_STORE_CREDIT_ACCOUNT permission root.

  • Introduced the new Admin UI to view and manage the various credit accounts. This new view can be found under the Commerce → Credit Accounts navigation menu.

  • Introduce support for granting credit that expires. See Granting Credit That Can Expire

API Changes

Endpoint Updates

Path Description

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

The new permission BACKEND_STORE_CREDIT_ACCOUNT replaces the previously used CUSTOMER_STORE_CREDIT_ACCOUNT

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

The new permission BACKEND_STORE_CREDIT_ACCOUNT replaces the previously used CUSTOMER_STORE_CREDIT_ACCOUNT

New Endpoints

Path Permission Root Description

POST /credit-accounts

BACKEND_CREDIT_ACCOUNT

Create a CreditAccount endpoint for backend or admin interactions. This endpoint is not meant to be customer-facing.

GET /credit-accounts

BACKEND_CREDIT_ACCOUNT

Read CreditAccounts endpoint for backend or admin interactions. This endpoint is not meant to be customer-facing.

GET /credit-accounts/{accountNumber}

BACKEND_CREDIT_ACCOUNT

Read an individual CreditAccount by account number endpoint for backend or admin interactions. This endpoint is not meant to be customer-facing.

GET /credit-accounts/{accountNumber}/transactions

BACKEND_CREDIT_ACCOUNT

Read an individual CreditAccount’s transactions endpoint for backend or admin interactions. This endpoint is not meant to be customer-facing.

DELETE /credit-accounts/{accountNumber}

BACKEND_CREDIT_ACCOUNT

Delete CreditAccount endpoint for backend or admin interactions. This endpoint is not meant to be customer-facing.

POST /credit-accounts/{accountNumber}/credit

CREDIT_ACCOUNT_CREDIT_TRANSACTION

Executes a credit transaction against a store credit account.

POST /credit-accounts/{accountNumber}/debit

CREDIT_ACCOUNT_DEBIT_TRANSACTION

Executes a debit transaction against a store credit account.

Configuration Properties

Added Properties

  • broadleaf.creditaccount.web.store-credit.legacy-customer-store-credit-permission-enabled

    • Description: If set to true, then the legacy permission root of CUSTOMER_STORE_CREDIT_ACCOUNT can be used for CustomerStoreCreditAccountEndpoint interactions.

    • Default value: false

Spring Cloud Message Changes

New Message Bindings

triggeredJobEventCreditAccountTransactionExpiration:
    group: credit-account-transaction-expire-event
    destination: triggeredJobEvent