Interface IShipmentProcessor
The processor responsible for processing a IShipment.
Namespace: EPiServer.Commerce.Order
Assembly: EPiServer.Business.Commerce.dll
Version: 12.17.2Syntax
public interface IShipmentProcessorMethods
AddShipmentToPicklist(IPurchaseOrder, IShipment, Int32)
Adds an IShipment to picklist.
Declaration
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.
Declaration
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 the payment for an IShipment.
Declaration
void CapturePayment(IOrderGroup order, IShipment shipment)Parameters
| Type | Name | Description |
|---|---|---|
| IOrderGroup | order | The order group. |
| IShipment | shipment | The shipment. |
CompleteShipment(IPurchaseOrder, IEnumerable<IShipment>)
Completes a list of IShipment.
Declaration
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.
Declaration
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.
Declaration
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. |
