- v1.0.0-latest-prod
Order Operations guides the workflows for Order, Order Fulfillments, and Returns, but does not provide facilities for persistence out-of-box. Instead, it relies on integration hook-points called "providers" to handle those functions.
All the default providers in Order Operations interact with the Order Service, but are kept separate to allow using an alternative source.
The default external provider implementations facilitate HTTP requests against Order Services endpoints:
Order Provider (ExternalOrderProvider)
Fulfillment Provider (ExternalFulfillmentProvider)
ReturnAuthorization Provider (ExternalReturnAuthorizationProvider)
Campaign Provider (ExternalCampaignProvider)
Offer Provider (ExternalOfferProvider)
Payment Provider (ExternalPaymentProvider)
ResourceLock Provider (ExternalResourceLockProvider)
ExternalOrderProperties defines the properties used to configure each of the external providers for Order Services. These include:
broadleaf.orderoperation.orderprovider.url: The base url for an external order service, which handles persistence of orders, fulfillments, returns, and resource locks
broadleaf.orderoperation.orderprovider.order-uri: The context path for singular order retrieval. This is appended to the url property.
broadleaf.orderoperation.orderprovider.fulfillment-uri: The context path for singular fulfillment retrieval. This is appended to the url property.
broadleaf.orderoperation.orderprovider.order-returns-uri: The context path for singular return retrieval within an order. This is appended to the url property.
broadleaf.orderoperation.orderprovider.return-authorizations-uri: The context path for return retrieval for multiple order IDs. This is appended to the url property.
broadleaf.orderoperation.orderprovider.resource-locks-uri: The context path for resource locks. This is appended to the url property.
ExternalCampaignProperties defines the properties used to configure the external provider for Campaign Services. These include:
broadleaf.orderoperation.campaignprovider.url: The base url for an external campaign service.
broadleaf.orderoperation.campaignprovider.generate-voucher-codes-uri: The context path for generating voucher codes.
ExternalOfferProperties defines the properties used to configure the external provider for Offer Services. These include:
broadleaf.orderoperation.offerprovider.url: The base url for an external offer service.
broadleaf.orderoperation.offerprovider.validate-voucher-uri: The context path for validating vouchers.
ExternalPaymentProperties defines the properties used to configure the external provider for Payment Transaction Services. These include:
broadleaf.orderoperation.paymentprovider.url: The base url for an external payment transaction service.
broadleaf.orderoperation.paymentprovider.payments-uri: The context path for basic CRUD operations on payments and basic transaction executions on payments.
broadleaf.orderoperation.paymentprovider.capture-uri: The context path for capture transaction execution.
broadleaf.orderoperation.paymentprovider.reverse-authorize-uri: The context path for reverse authorize transaction execution.
broadleaf.orderoperation.paymentprovider.refund-uri: The context path for refund transaction execution.