Try our conversational search powered by Generative AI!

AI OnAI Off

Class DefaultShipmentProcessor

This class is intended to be used internally by EPiServer. We do not support any backward compatibility on this. Please DO NOT use this in your project.

Default implementation of IShipmentProcessor to handle operations on IShipment.

Inheritance
System.Object
DefaultShipmentProcessor
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Commerce.Order.Internal
Assembly: EPiServer.Business.Commerce.dll
Version: 13.30.0
Syntax
public class DefaultShipmentProcessor : IShipmentProcessor

Constructors

DefaultShipmentProcessor(IOrderGroupCalculator, IShippingCalculator, IOrderGroupFactory, IPaymentProcessor, ISynchronizedObjectInstanceCache, ReferenceConverter, IContentRepository, ILineItemCalculator, ILineItemValidator, IInventoryProcessor, IPromotionEngine, IMarketService)

Initializes a new instance of the DefaultShipmentProcessor class.

Declaration
public DefaultShipmentProcessor(IOrderGroupCalculator orderGroupCalculator, IShippingCalculator shippingCalculator, IOrderGroupFactory orderGroupFactory, IPaymentProcessor paymentProcessor, ISynchronizedObjectInstanceCache picklistCache, ReferenceConverter referenceConverter, IContentRepository contentRepository, ILineItemCalculator lineItemCalculator, ILineItemValidator lineItemValidator, IInventoryProcessor inventoryProcessor, IPromotionEngine promotionEngine, IMarketService marketService)
Parameters
Type Name Description
IOrderGroupCalculator orderGroupCalculator

The order group calculator.
IShippingCalculator shippingCalculator

The shipping calculator.
IOrderGroupFactory orderGroupFactory

The order group factory.
IPaymentProcessor paymentProcessor

The payment processor.
EPiServer.Framework.Cache.ISynchronizedObjectInstanceCache picklistCache

The picklist cache.
ReferenceConverter referenceConverter

The reference converter.
EPiServer.IContentRepository contentRepository

The content repository.
ILineItemCalculator lineItemCalculator

The line item calculator.
ILineItemValidator lineItemValidator

The line item validator.
IInventoryProcessor inventoryProcessor

The inventory processor.
IPromotionEngine promotionEngine

The promotion engine.
IMarketService marketService

The market service.

Methods

AddShipmentToPicklist(IPurchaseOrder, IShipment, Int32)

Adds an IShipment to picklist. After processed, the IShipment status is set to Packing.

Declaration
public virtual OrderProcessingResult AddShipmentToPicklist(IPurchaseOrder purchaseOrder, IShipment shipment, int pickListId)
Parameters
Type Name Description
IPurchaseOrder purchaseOrder

The purchase order.
IShipment shipment

The shipment.
System.Int32 pickListId

The pick list id.
Returns
Type Description
OrderProcessingResult

The order processing result.

CancelShipment(IPurchaseOrder, IShipment)

Cancels an IShipment. After processed, the IShipment status is set to Cancelled.

Declaration
public virtual OrderProcessingResult CancelShipment(IPurchaseOrder purchaseOrder, IShipment shipment)
Parameters
Type Name Description
IPurchaseOrder purchaseOrder

The purchase order.
IShipment shipment

The shipment.
Returns
Type Description
OrderProcessingResult

The order processing result.

CapturePayment(IOrderGroup, IShipment)

Captures payment for IShipment on an IOrderGroup.

Declaration
public virtual void CapturePayment(IOrderGroup order, IShipment shipment)
Parameters
Type Name Description
IOrderGroup order

The purchase order.
IShipment shipment

The shipment that needed to capture payment.

CompleteShipment(IPurchaseOrder, IEnumerable<IShipment>)

Completes a list of IShipment. After processed, the IShipment status is set to Shipped.

Declaration
public virtual OrderProcessingResult CompleteShipment(IPurchaseOrder purchaseOrder, IEnumerable<IShipment> shipments)
Parameters
Type Name Description
IPurchaseOrder purchaseOrder

The purchase order.
System.Collections.Generic.IEnumerable<IShipment> shipments

The enumerable of IShipment.
Returns
Type Description
OrderProcessingResult

The order processing result.

ReleaseShipment(IPurchaseOrder, IEnumerable<IShipment>)

Releases a list of IShipment. After processed, the IShipment status is set to Released.

Declaration
public virtual OrderProcessingResult ReleaseShipment(IPurchaseOrder purchaseOrder, IEnumerable<IShipment> shipments)
Parameters
Type Name Description
IPurchaseOrder purchaseOrder

The purchase order.
System.Collections.Generic.IEnumerable<IShipment> shipments

The enumerable of IShipment.
Returns
Type Description
OrderProcessingResult

The order processing result.

RemoveShipmentFromPicklist(IPurchaseOrder, IShipment)

Removes an IShipment from picklist. After processed, the IShipment status is set to Released.

Declaration
public virtual OrderProcessingResult RemoveShipmentFromPicklist(IPurchaseOrder purchaseOrder, IShipment shipment)
Parameters
Type Name Description
IPurchaseOrder purchaseOrder

The purchase order.
IShipment shipment

The shipment.
Returns
Type Description
OrderProcessingResult

The order processing result.

Implements

Extension Methods