Interface OrderProvider
- All Known Implementing Classes:
ExternalOrderProvider
public interface OrderProvider
Provider for interfacing with operations involving orders. Typically utilizes
WebClient
to make requests to an external REST API.-
Method Summary
Modifier and TypeMethodDescription<F extends com.broadleafcommerce.order.client.domain.OrderFulfillment>
org.springframework.data.domain.Page<F>readAllByOrderFulfillmentLink
(String orderFulfillmentLink, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Retrieve all of theOrderFulfillments
using the provided API URL.<O extends com.broadleafcommerce.order.client.domain.Order>
OreadByOrderLink
(String orderLink, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Retrieve theOrder
using the provided API URL.
-
Method Details
-
readByOrderLink
<O extends com.broadleafcommerce.order.client.domain.Order> O readByOrderLink(String orderLink, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Retrieve theOrder
using the provided API URL.- Parameters:
orderLink
- the API URL to read the OrdercontextInfo
- context information around sandbox and multitenant state.- Returns:
- the
Order
for the provided API URL
-
readAllByOrderFulfillmentLink
<F extends com.broadleafcommerce.order.client.domain.OrderFulfillment> org.springframework.data.domain.Page<F> readAllByOrderFulfillmentLink(String orderFulfillmentLink, @Nullable org.springframework.data.domain.Pageable page, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Retrieve all of theOrderFulfillments
using the provided API URL.- Parameters:
orderFulfillmentLink
- the API URL to read the Order fulfillmentspage
- the requested page of results from the databasecontextInfo
- context information around sandbox and multitenant state.- Returns:
- the fulfillments for the provided API URL
-