C# Class LinnworksAPI.ProcessedOrdersMethods

Exibir arquivo Open project: LinnSystems/LinnworksNetSDK

Public Methods

Method	Description
AddOrderNote ( System.Guid pkOrderID, String noteText, System.Boolean isInternal, String ApiToken, String ApiServer ) : System.Guid
AddReturnCategory ( String categoryName, String ApiToken, String ApiServer ) : OrderReturnCategory
ChangeOrderNote ( System.Guid pkOrderNoteId, String noteText, System.Boolean isInternal, String ApiToken, String ApiServer ) : void
CheckOrderFullyReturned ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : System.Boolean
CreateExchange ( System.Guid pkOrderId, List exchangeItems, System.Guid despatchLocation, System.Guid returnLocation, String channelReason, String channelSubReason, String category, String reason, System.Boolean isBooking, System.Boolean ignoredValidation, String ApiToken, String ApiServer ) : List
CreateFullResend ( System.Guid pkOrderId, System.Guid despatchLocation, String category, String reason, Double additionalCost, String ApiToken, String ApiServer ) : List
CreateProcessedOrdersCSV ( System.DateTime from, System.DateTime to, SearchDateType dateType, String searchField, System.Boolean exactMatch, String searchTerm, String sortColumn, System.Boolean sortDirection, String ApiToken, String ApiServer ) : String
CreateResend ( System.Guid pkOrderId, List resendItems, System.Guid despatchLocation, String category, String reason, Double additionalCost, String ApiToken, String ApiServer ) : List
CreateReturn ( System.Guid pkOrderId, List returnitems, System.Guid returnLocation, String channelReason, String channelSubReason, String category, String reason, System.Boolean isReturnBooking, System.Boolean ignoredValidation, String ApiToken, String ApiServer ) : List
DeleteOrderNote ( System.Guid pkOrderNoteId, String ApiToken, String ApiServer ) : void
DeleteReturnCategory ( Int32 pkItemId, String ApiToken, String ApiServer ) : void
GetChannelRefundReasons ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
GetOrderInfo ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : ProcessedOrderWeb
GetPackageSplit ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
GetProcessedAuditTrail ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
GetProcessedOrderExtendedProperties ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
GetProcessedOrderNotes ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
GetProcessedRelatives ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
GetRefundableServiceItems ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
GetRefunds ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
GetRefundsOptions ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : RefundScreenOptions
GetReturnCategories ( String ApiToken, String ApiServer ) : List
GetReturnItemsInfo ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
GetReturnOrderInfo ( System.Guid pkOrderId, System.Boolean includeRefundLink, String ApiToken, String ApiServer ) : ReturnOrderHeader
GetReturnsExchanges ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
GetTotalRefunds ( System.Guid pkOrderId, System.Boolean includeBookings, String ApiToken, String ApiServer ) : ExistingRefundTotal
IsRefundValid ( System.Guid pkOrderId, List refundItems, String ApiToken, String ApiServer ) : ValidationResult
IsRefundValidationRequiredByOrderId ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : System.Boolean
MarkManualRefundsAsActioned ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : void
RefundCompleteOrder ( System.Guid pkOrderId, System.Boolean isManualRefund, String ApiToken, String ApiServer ) : List
RefundFreeText ( System.Guid pkOrderId, List refundItems, String ApiToken, String ApiServer ) : List
RefundServices ( System.Guid pkOrderId, List refundItems, String ApiToken, String ApiServer ) : List
RefundShipping ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
RenameReturnCategory ( Int32 pkItemId, String newName, String ApiToken, String ApiServer ) : void
SearchProcessedOrdersPaged ( System.DateTime from, System.DateTime to, SearchDateType dateType, String searchField, System.Boolean exactMatch, String searchTerm, Int32 pageNum, Int32 numEntriesPerPage, String ApiToken, String ApiServer ) : GenericPagedResult
ValidateCompleteOrderRefund ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : ValidationResult

Method Details

AddOrderNote() public static method

public static AddOrderNote ( System.Guid pkOrderID, String noteText, System.Boolean isInternal, String ApiToken, String ApiServer ) : System.Guid
pkOrderID	System.Guid
noteText	String
isInternal	System.Boolean
ApiToken	String
ApiServer	String
return	System.Guid

AddReturnCategory() public static method

public static AddReturnCategory ( String categoryName, String ApiToken, String ApiServer ) : OrderReturnCategory
categoryName	String
ApiToken	String
ApiServer	String
return	OrderReturnCategory

ChangeOrderNote() public static method

public static ChangeOrderNote ( System.Guid pkOrderNoteId, String noteText, System.Boolean isInternal, String ApiToken, String ApiServer ) : void
pkOrderNoteId	System.Guid
noteText	String
isInternal	System.Boolean
ApiToken	String
ApiServer	String
return	void

CheckOrderFullyReturned() public static method

public static CheckOrderFullyReturned ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : System.Boolean
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	System.Boolean

CreateExchange() public static method

public static CreateExchange ( System.Guid pkOrderId, List exchangeItems, System.Guid despatchLocation, System.Guid returnLocation, String channelReason, String channelSubReason, String category, String reason, System.Boolean isBooking, System.Boolean ignoredValidation, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
exchangeItems	List
despatchLocation	System.Guid
returnLocation	System.Guid
channelReason	String
channelSubReason	String
category	String
reason	String
isBooking	System.Boolean
ignoredValidation	System.Boolean
ApiToken	String
ApiServer	String
return	List

CreateFullResend() public static method

public static CreateFullResend ( System.Guid pkOrderId, System.Guid despatchLocation, String category, String reason, Double additionalCost, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
despatchLocation	System.Guid
category	String
reason	String
additionalCost	Double
ApiToken	String
ApiServer	String
return	List

CreateProcessedOrdersCSV() public static method

public static CreateProcessedOrdersCSV ( System.DateTime from, System.DateTime to, SearchDateType dateType, String searchField, System.Boolean exactMatch, String searchTerm, String sortColumn, System.Boolean sortDirection, String ApiToken, String ApiServer ) : String
from	System.DateTime
to	System.DateTime
dateType	SearchDateType
searchField	String
exactMatch	System.Boolean
searchTerm	String
sortColumn	String
sortDirection	System.Boolean
ApiToken	String
ApiServer	String
return	String

CreateResend() public static method

public static CreateResend ( System.Guid pkOrderId, List resendItems, System.Guid despatchLocation, String category, String reason, Double additionalCost, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
resendItems	List
despatchLocation	System.Guid
category	String
reason	String
additionalCost	Double
ApiToken	String
ApiServer	String
return	List

CreateReturn() public static method

public static CreateReturn ( System.Guid pkOrderId, List returnitems, System.Guid returnLocation, String channelReason, String channelSubReason, String category, String reason, System.Boolean isReturnBooking, System.Boolean ignoredValidation, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
returnitems	List
returnLocation	System.Guid
channelReason	String
channelSubReason	String
category	String
reason	String
isReturnBooking	System.Boolean
ignoredValidation	System.Boolean
ApiToken	String
ApiServer	String
return	List

DeleteOrderNote() public static method

public static DeleteOrderNote ( System.Guid pkOrderNoteId, String ApiToken, String ApiServer ) : void
pkOrderNoteId	System.Guid
ApiToken	String
ApiServer	String
return	void

DeleteReturnCategory() public static method

public static DeleteReturnCategory ( Int32 pkItemId, String ApiToken, String ApiServer ) : void
pkItemId	System.Int32
ApiToken	String
ApiServer	String
return	void

GetChannelRefundReasons() public static method

public static GetChannelRefundReasons ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	List

GetOrderInfo() public static method

public static GetOrderInfo ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : ProcessedOrderWeb
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	ProcessedOrderWeb

GetPackageSplit() public static method

public static GetPackageSplit ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	List

GetProcessedAuditTrail() public static method

public static GetProcessedAuditTrail ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	List

GetProcessedOrderExtendedProperties() public static method

public static GetProcessedOrderExtendedProperties ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	List

GetProcessedOrderNotes() public static method

public static GetProcessedOrderNotes ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	List

GetProcessedRelatives() public static method

public static GetProcessedRelatives ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	List

GetRefundableServiceItems() public static method

public static GetRefundableServiceItems ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	List

GetRefunds() public static method

public static GetRefunds ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	List

GetRefundsOptions() public static method

public static GetRefundsOptions ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : RefundScreenOptions
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	RefundScreenOptions

GetReturnCategories() public static method

public static GetReturnCategories ( String ApiToken, String ApiServer ) : List
ApiToken	String
ApiServer	String
return	List

GetReturnItemsInfo() public static method

public static GetReturnItemsInfo ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	List

GetReturnOrderInfo() public static method

public static GetReturnOrderInfo ( System.Guid pkOrderId, System.Boolean includeRefundLink, String ApiToken, String ApiServer ) : ReturnOrderHeader
pkOrderId	System.Guid
includeRefundLink	System.Boolean
ApiToken	String
ApiServer	String
return	ReturnOrderHeader

GetReturnsExchanges() public static method

public static GetReturnsExchanges ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	List

GetTotalRefunds() public static method

public static GetTotalRefunds ( System.Guid pkOrderId, System.Boolean includeBookings, String ApiToken, String ApiServer ) : ExistingRefundTotal
pkOrderId	System.Guid
includeBookings	System.Boolean
ApiToken	String
ApiServer	String
return	ExistingRefundTotal

IsRefundValid() public static method

public static IsRefundValid ( System.Guid pkOrderId, List refundItems, String ApiToken, String ApiServer ) : ValidationResult
pkOrderId	System.Guid
refundItems	List
ApiToken	String
ApiServer	String
return	ValidationResult

IsRefundValidationRequiredByOrderId() public static method

public static IsRefundValidationRequiredByOrderId ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : System.Boolean
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	System.Boolean

MarkManualRefundsAsActioned() public static method

public static MarkManualRefundsAsActioned ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : void
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	void

RefundCompleteOrder() public static method

public static RefundCompleteOrder ( System.Guid pkOrderId, System.Boolean isManualRefund, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
isManualRefund	System.Boolean
ApiToken	String
ApiServer	String
return	List

RefundFreeText() public static method

public static RefundFreeText ( System.Guid pkOrderId, List refundItems, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
refundItems	List
ApiToken	String
ApiServer	String
return	List

RefundServices() public static method

public static RefundServices ( System.Guid pkOrderId, List refundItems, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
refundItems	List
ApiToken	String
ApiServer	String
return	List

RefundShipping() public static method

public static RefundShipping ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : List
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	List

RenameReturnCategory() public static method

public static RenameReturnCategory ( Int32 pkItemId, String newName, String ApiToken, String ApiServer ) : void
pkItemId	System.Int32
newName	String
ApiToken	String
ApiServer	String
return	void

SearchProcessedOrdersPaged() public static method

public static SearchProcessedOrdersPaged ( System.DateTime from, System.DateTime to, SearchDateType dateType, String searchField, System.Boolean exactMatch, String searchTerm, Int32 pageNum, Int32 numEntriesPerPage, String ApiToken, String ApiServer ) : GenericPagedResult
from	System.DateTime
to	System.DateTime
dateType	SearchDateType
searchField	String
exactMatch	System.Boolean
searchTerm	String
pageNum	System.Int32
numEntriesPerPage	System.Int32
ApiToken	String
ApiServer	String
return	GenericPagedResult

ValidateCompleteOrderRefund() public static method

public static ValidateCompleteOrderRefund ( System.Guid pkOrderId, String ApiToken, String ApiServer ) : ValidationResult
pkOrderId	System.Guid
ApiToken	String
ApiServer	String
return	ValidationResult