Broadleaf Microservices
  • v1.0.0-latest-prod

Commerce Quote-ui Types

AddQuoteNoteMessages

Property Type Description

addQuoteNoteNoteRequired

MessageDescriptor

addQuoteNoteNoteLabel

MessageDescriptor

addQuoteNoteBudgetLabel

MessageDescriptor

addQuoteNoteTimeframeLabel

MessageDescriptor

addQuoteNoteTimeframePlaceholder

MessageDescriptor

addQuoteNoteError

MessageDescriptor

addQuoteNoteSubmit

MessageDescriptor

BrowseQuoteColumn

Property Type Description

field

string

The field to display in the column

labelKey

string

The key for the message descriptor to use to label the field’s column

sortable

boolean

Whether the column is sortable

BrowseQuoteDetailsMessages

extends BrowseQuoteSummaryMessages, ViewQuoteNotesMessages, QuoteStatusMessages, AddQuoteNoteMessages, RejectQuoteNoteMessages, ViewChangeHistoryMessages, QuoteActionTypeMessages

Property Type Description

errorFetchingQuote

MessageDescriptor

Error message if the quote can’t be fetched

backToMyQuotes

MessageDescriptor

Label for the action to return to the browse quotes view

quoteDetails

MessageDescriptor

Title for the page

quoteNameId

MessageDescriptor

Label to show the quote’s name

quoteFallbackName

MessageDescriptor

Fallback message to use when the quote has no name

quoteItems

MessageDescriptor

Heading for the list of items in the quote

quoteItemQuantity

MessageDescriptor

Heading for the quantity column

quoteItemPrice

MessageDescriptor

Heading for the price column

makeActiveQuote

MessageDescriptor

Label for the action to make the quote the active cart

cancelQuote

MessageDescriptor

Label for the action to cancel the quote

convertToCart

MessageDescriptor

Label to convert the expired quote into a cart

convertToNewRequest

MessageDescriptor

Label to convert the expired quote into a new quote request

viewNotes

MessageDescriptor

Label for the action to view the quote’s notes

viewQuoteNotesModalTitle

MessageDescriptor

Label for the modal displaying the quote’s notes

addQuoteNoteModalTitle

MessageDescriptor

Label for the modal displaying the quote’s notes

addNote

MessageDescriptor

Label to add a new note to the quote

rejectQuoteNoteModalTitle

MessageDescriptor

Label for the modal for the quote rejection reason

quoteDetailsCreateDate

MessageDescriptor

Label for the Quote Created Date

quoteDetailsExpiresOn

MessageDescriptor

Label for the Quote Expiration Date if any

quoteDetailsExpiresOnDate

MessageDescriptor

Display message containing the expiration date when not being edited

quoteDetailsRejectionReason

MessageDescriptor

Display message containing the note for the rejection of the quote

updateNameButton

MessageDescriptor

Label for the submit update to name button

cancelUpdateNameButton

MessageDescriptor

Label for the cancel update-name button

quoteNoName

MessageDescriptor

Placeholder if the quote has no name

cancelUpdateExpirationDateButton

MessageDescriptor

Label for the cancel update-expiration-date button

editExpirationDate

MessageDescriptor

Label for the expiration date

expirationDateInvalid

MessageDescriptor

Error message if the provided expiration date is invalid

updateExpirationDateButton

MessageDescriptor

Label for the button to save changes to the expiration date

editNameButton

MessageDescriptor

Label for the edit name button

viewChangeHistory

MessageDescriptor

Label for the action to view the quote change history

viewChangeHistoryModalTitle

MessageDescriptor

Label for the modal displaying the quote’s change history

BrowseQuoteItemsMessages

Property Type Description

itemSkuLabel

MessageDescriptor

Label for an item’s SKU

itemQuantityLabel

MessageDescriptor

Label for an item’s quantity

addNote

MessageDescriptor

Label to add a new note to the quote

viewNotes

MessageDescriptor

Label for the action to view the quote’s notes

[key: string]

MessageDescriptor

Additional custom messages related to displaying cart item attributes

BrowseQuoteMessages

extends QuoteListItemMessages

Property Type Description

errorFetchingQuotes

MessageDescriptor

Error message if quotes can’t be fetched

myQuotes

MessageDescriptor

Label for the My Quotes grid

searchByName

MessageDescriptor

Label for the search input

filterFrom

MessageDescriptor

Label for the Filter From date input

filterTo

MessageDescriptor

Label for the Filter To date input

quoteName

MessageDescriptor

For the default column Quote Name

quoteStatus

MessageDescriptor

For the default column Quote Status

quoteCreatedDate

MessageDescriptor

For the default column Quote Created Date

quoteExpirationDate

MessageDescriptor

For the default column Quote Expiration Date

[key: string]

MessageDescriptor

Represents any other messages passed in for custom columns

BrowseQuoteSummaryMessages

extends BrowseQuoteItemsMessages

Property Type Description

quoteSummaryTitle

MessageDescriptor

Title of the quote summary section

quoteShippingAddressHeading

MessageDescriptor

Label for the shipping address section

quoteShippingNoAddress

MessageDescriptor

Message to display if no shipping address has been added yet

quoteShippingMethod

MessageDescriptor

Label for the shipping method section

quoteShippingNoMethod

MessageDescriptor

Message to display if no shipping method has been added yet

quoteOrderSummary

MessageDescriptor

Title of the order (pricing) summary section

quoteSubtotal

MessageDescriptor

Label for the subtotal

quoteTaxes

MessageDescriptor

Label for the tax total

quoteShippingAmount

MessageDescriptor

Label for the shipping total

quoteTotal

MessageDescriptor

Label for the total

BrowseRowActionsMessages

Property Type Description

makeActiveQuote

MessageDescriptor

For the action to make the quote the active one

assignQuote

MessageDescriptor

For the action to assign the quote to a seller

unassignQuote

MessageDescriptor

For the action to un-assign the quote from a seller

publishQuote

MessageDescriptor

For the action to publish the quote by a seller

recallQuote

MessageDescriptor

For the action to un-publish/recall the quote

rejectQuote

MessageDescriptor

For the action to reject the quote by a seller

enableEditingQuote

MessageDescriptor

For the action to make the quote the active one

cancelQuote

MessageDescriptor

For the action to cancel the quote

deleteQuote

MessageDescriptor

For the action to delete the quote

convertToCart

MessageDescriptor

For the action to convert an expired quote into a new cart

convertToNewRequest

MessageDescriptor

For the action to convert an expired quote into a new quote request

CartPaginationProps

Property Type Description

cq

string

page?

number | string

forward?

boolean

offset?

number | string

size

number | string

sort

string

ConfigState

Property Type Description

cartContextUri

string

URI that maps to the root cart view context. Defaults to /cart

checkoutContextUri

string

URI that maps to the root checkout view context. Defaults to /checkout

customerScope

string

Security scope(s) for customers to test access or get access tokens with

csrScope

string

Security scope(s) for CSR to test access or get access tokens with

gatewayHost

string

The URL host of the gateway application.

preview?

PreviewOptions

Preview options to include in requests when in sandbox-preview mode

productRoutePrefix

string

Value to prefix to product URLs if any such as /product

quoteContextUri

string

URI that maps to the root quote view context. Defaults to /my-account/quotes

quoteBrowsePageSize

number

Size of the page of quotes

FormattedAmountOrZeroProps

Property Type Description

className?

string

fallbackClassName?

string

fallbackCurrency

string

monetaryAmount?

MonetaryAmount

PageLoaderProps

Property Type Description

className?

string

loading

boolean

PreviewOptions

Property Type Description

token

string

Preview token to authorize that a request has access to preview data for a given sandbox

sandbox

string

The Sandbox ID.

date?

string

The date in which to preview data.

QuoteActionTypeMessages

Property Type Description

quoteActionTypeDraftQuote

MessageDescriptor

Label for the DRAFT_QUOTE action type

quoteActionTypeRequestQuote

MessageDescriptor

Label for the REQUEST_QUOTE action type

quoteActionTypeEditQuote

MessageDescriptor

Label for the EDIT_QUOTE action type

quoteActionTypeCancelQuote

MessageDescriptor

Label for the CANCEL_QUOTE action type

quoteActionTypeAssignSalesRep

MessageDescriptor

Label for the ASSIGN_SALES_REP action type

quoteActionTypePublishQuote

MessageDescriptor

Label for the PUBLISH_QUOTE action type

quoteActionTypeRejectQuote

MessageDescriptor

Label for the REJECT_QUOTE action type

quoteActionTypePurchaseQuote

MessageDescriptor

Label for the PURCHASE_QUOTE action type

quoteActionTypeRevisePrices

MessageDescriptor

Label for the REVISE_PRICES action type

quoteActionTypeModifyItem

MessageDescriptor

Label for the MODIFY_ITEM action type

quoteActionTypeAddItem

MessageDescriptor

Label for the ADD_ITEM action type

quoteActionTypeRemoveItem

MessageDescriptor

Label for the REMOVE_ITEM action type

quoteActionTypeMarkExpired

MessageDescriptor

Label for the MARK_EXPIRED action type

quoteActionTypeRecallQuote

MessageDescriptor

Label for the RECALL_QUOTE action type

quoteActionTypeUnknown

MessageDescriptor

Label for the UNKNOWN action type

[key: string]

MessageDescriptor

Represents any other messages passed in for custom quote action types

QuoteListItemMessages

extends BrowseRowActionsMessages, QuoteStatusMessages

Property Type Description

quoteNameAndQuantity

MessageDescriptor

Name label. Takes two params: name and quantity

quoteNoName

MessageDescriptor

Fallback message to use when the quote has no name

activeQuoteTag

MessageDescriptor

Label for the tag marking the Active quote

[key: string]

MessageDescriptor

Represents any other messages passed in for custom quote statuses

QuoteStatusMessages

Property Type Description

quoteInProcess

MessageDescriptor

Label for the In Process status

quoteDrafting

MessageDescriptor

Label for the Drafting status

quoteQuoteRequested

MessageDescriptor

Label for the Requested status

quoteAssigned

MessageDescriptor

Label for the Assigned status

quotePublished

MessageDescriptor

Label for the Published status

quoteEditing

MessageDescriptor

Label for the Editing status

quotePurchased

MessageDescriptor

Label for the Purchased status

quoteRejected

MessageDescriptor

Label for the Rejected status

quoteCancelled

MessageDescriptor

Label for the Cancelled status

quoteNoExpiration

MessageDescriptor

If there is no expiration date

submitRequest

MessageDescriptor

Label for the action to submit the quote request by the buyer

checkout

MessageDescriptor

Label for the action to begin checking out the quote

[key: string]

MessageDescriptor

Represents any other messages passed in for custom quote statuses

RejectQuoteNoteMessages

Property Type Description

rejectQuoteNoteNoteRequired

MessageDescriptor

rejectQuoteNoteNoteLabel

MessageDescriptor

rejectQuoteNoteError

MessageDescriptor

rejectQuoteNoteSubmit

MessageDescriptor

ViewChangeHistoryMessages

Property Type Description

viewChangeHistoryColumnActionType

MessageDescriptor

viewChangeHistoryColumnComment

MessageDescriptor

viewChangeHistoryColumnCurrentStatus

MessageDescriptor

viewChangeHistoryColumnDateOfChange

MessageDescriptor

viewChangeHistoryColumnPreviousStatus

MessageDescriptor

viewChangeHistoryColumnUserEmail

MessageDescriptor

viewChangeHistoryEmpty

MessageDescriptor

viewChangeHistoryError

MessageDescriptor

viewChangeHistoryModalClose

MessageDescriptor

ViewQuoteNotesMessages

Property Type Description

viewQuoteNotesColumnAuthor

MessageDescriptor

viewQuoteNotesColumnDateCreated

MessageDescriptor

viewQuoteNotesColumnNote

MessageDescriptor

viewQuoteNotesEmpty

MessageDescriptor

viewQuoteNotesError

MessageDescriptor

viewQuoteNotesModalClose

MessageDescriptor