Broadleaf Microservices

Order Common Library

Table of Contents

Overview

OrderCommon is a shared library which provides a single source for order-related domain to support both Cart Services and Order Services.

Domain

These are the key domain defined in Order Common. Their usages are described where applicable within Cart Services and Order Services.

  • Address

  • Adjustment

  • AttributeChoiceValue

  • CampaignRef

  • FulfillmentOption

  • OfferRef

  • OverrideDetail

  • Payment

  • PaymentTransaction

  • Phone

Some of these are stored in data schemas within Cart Services and Order Services as JSON:

Order Common Data Model

Enums

See the JavaDocs for more detail.

  • DefaultOverrideTypes - The types of overrides a CSR might perform on a cart

    • CART_ITEM_PRICE_OVERRIDE - CSR overrides the unit price of a cart item

    • FULFILLMENT_PRICE_OVERRIDE - CSR overrides the total fulfillment price on a fulfillment group

  • DefaultTransactionStatuses - The possible states of a PaymentTransaction

    • SENDING_TO_PROCESSOR - The transaction is being prepared, hasn’t been executed, or had an error

    • SUCCESS - The transaction was successfully processed

    • FAILURE - The transaction failed to be processed

  • FulfillmentType - Specifies different ways items could be fulfilled

    • SHIP - Items will be physically shipped

    • PICKUP - Items will be physically picked up

    • VIRTUAL - Items will be sent virtually, not physically

  • PaymentTransactionAdditionalFieldType - Data from a payment gateway response to store on a transaction

    • NAME_ON_CARD - Cardholder’s Name

    • CARD_TYPE - Card Type

    • EXP_DATE - Expiration Date

    • EXP_MONTH - Expiration Month

    • EXP_YEAR - Expiration Year

    • PAYMENT_TYPE - Type of Order Payment

    • GATEWAY_TYPE - Gateway Type

    • NAME_ON_ACCOUNT - Name on Account

    • ACCOUNT_TYPE - Account Type

    • LAST_FOUR - Last Four Digits of Account or Credit Card Number

    • GIFT_CARD_NUM - Gift Card Number

    • EMAIL - Email

    • ACCOUNT_CREDIT_NUM - Account Credit Number

    • AUTH_CODE - Authorization Code

    • REQUEST_ID - Request Id

    • SUBSCRIPTION_ID - Subscription ID

    • SUBSCRIPTION_TITLE - Subscription Title

    • TOKEN - Payment Token

    • DECLINE_TYPE - Decline Type

    • PAYMENT_NAME - Payment Name