C# Class VirtoCommerce.SwaggerApiClient.Api.OrderModuleApi

Represents a collection of functions to interact with the API endpoints

Inheritance: IOrderModuleApi

Datei anzeigen Open project: VirtoCommerce/vc-internal

Public Methods

Method	Description
GetBasePath ( ) : String	Gets the base path of the API client.
OrderModuleApi ( ApiClient apiClient = null ) : System	Initializes a new instance of the OrderModuleApi class.
OrderModuleApi ( String basePath ) : System	Initializes a new instance of the OrderModuleApi class.
OrderModuleCreateOrder ( VirtoCommerceOrderModuleWebModelCustomerOrder customerOrder ) : VirtoCommerceOrderModuleWebModelCustomerOrder	Add new customer order to system
OrderModuleCreateOrderAsync ( VirtoCommerceOrderModuleWebModelCustomerOrder customerOrder ) : System.Threading.Tasks.Task	Add new customer order to system
OrderModuleCreateOrderFromCart ( string id ) : VirtoCommerceOrderModuleWebModelCustomerOrder	Create new customer order based on shopping cart.
OrderModuleCreateOrderFromCartAsync ( string id ) : System.Threading.Tasks.Task	Create new customer order based on shopping cart.
OrderModuleDelete ( string id, string operationId ) : void	Delete a concrete customer order operation (document)
OrderModuleDeleteAsync ( string id, string operationId ) : System.Threading.Tasks.Task	Delete a concrete customer order operation (document)
OrderModuleDeleteOrdersByIds ( List ids ) : void	Delete a whole customer orders
OrderModuleDeleteOrdersByIdsAsync ( List ids ) : System.Threading.Tasks.Task	Delete a whole customer orders
OrderModuleGetById ( string id ) : VirtoCommerceOrderModuleWebModelCustomerOrder	Find customer order by id Return a single customer order with all nested documents
OrderModuleGetByIdAsync ( string id ) : System.Threading.Tasks.Task	Find customer order by id Return a single customer order with all nested documents
OrderModuleGetDashboardStatistics ( System.DateTime start, System.DateTime end ) : VirtoCommerceOrderModuleWebModelDashboardStatisticsResult	Get a some order statistic information for Commerce manager dashboard
OrderModuleGetDashboardStatisticsAsync ( System.DateTime start, System.DateTime end ) : System.Threading.Tasks.Task	Get a some order statistic information for Commerce manager dashboard
OrderModuleGetNewPayment ( string id ) : VirtoCommerceOrderModuleWebModelPaymentIn	Get new payment for specified customer order Return new payment document with populates all required properties.
OrderModuleGetNewPaymentAsync ( string id ) : System.Threading.Tasks.Task	Get new payment for specified customer order Return new payment document with populates all required properties.
OrderModuleGetNewShipment ( string id ) : VirtoCommerceOrderModuleWebModelShipment	Get new shipment for specified customer order Return new shipment document with populates all required properties.
OrderModuleGetNewShipmentAsync ( string id ) : System.Threading.Tasks.Task	Get new shipment for specified customer order Return new shipment document with populates all required properties.
OrderModuleProcessOrderPayments ( VirtoCommerceDomainPaymentModelBankCardInfo bankCardInfo, string orderId, string paymentId ) : VirtoCommerceOrderModuleWebModelCustomerOrder	Registration customer order payment in external payment system Used in front-end checkout or manual order payment registration
OrderModuleProcessOrderPaymentsAsync ( VirtoCommerceDomainPaymentModelBankCardInfo bankCardInfo, string orderId, string paymentId ) : System.Threading.Tasks.Task	Registration customer order payment in external payment system Used in front-end checkout or manual order payment registration
OrderModuleSearch ( string criteriaResponseGroup, string criteriaKeyword, string criteriaCustomerId, string criteriaEmployeeId, List criteriaStoreIds, System.DateTime criteriaStartDate, System.DateTime criteriaEndDate, int criteriaStart, int criteriaCount ) : VirtoCommerceOrderModuleWebModelSearchResult	Search customer orders by given criteria
OrderModuleSearchAsync ( string criteriaResponseGroup, string criteriaKeyword, string criteriaCustomerId, string criteriaEmployeeId, List criteriaStoreIds, System.DateTime criteriaStartDate, System.DateTime criteriaEndDate, int criteriaStart, int criteriaCount ) : System.Threading.Tasks.Task	Search customer orders by given criteria
OrderModuleUpdate ( VirtoCommerceOrderModuleWebModelCustomerOrder customerOrder ) : void	Update a existing customer order
OrderModuleUpdateAsync ( VirtoCommerceOrderModuleWebModelCustomerOrder customerOrder ) : System.Threading.Tasks.Task	Update a existing customer order
SetBasePath ( String basePath ) : void	Sets the base path of the API client.

Method Details

GetBasePath() public method

Gets the base path of the API client.

public GetBasePath ( ) : String
return	String

OrderModuleApi() public method

Initializes a new instance of the OrderModuleApi class.

public OrderModuleApi ( ApiClient apiClient = null ) : System
apiClient	VirtoCommerce.SwaggerApiClient.Client.ApiClient	an instance of ApiClient (optional)
return	System

OrderModuleApi() public method

Initializes a new instance of the OrderModuleApi class.

public OrderModuleApi ( String basePath ) : System
basePath	String
return	System

OrderModuleCreateOrder() public method

Add new customer order to system

public OrderModuleCreateOrder ( VirtoCommerceOrderModuleWebModelCustomerOrder customerOrder ) : VirtoCommerceOrderModuleWebModelCustomerOrder
customerOrder	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceOrderModuleWebModelCustomerOrder	customer order
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceOrderModuleWebModelCustomerOrder

OrderModuleCreateOrderAsync() public method

Add new customer order to system

public OrderModuleCreateOrderAsync ( VirtoCommerceOrderModuleWebModelCustomerOrder customerOrder ) : System.Threading.Tasks.Task
customerOrder	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceOrderModuleWebModelCustomerOrder	customer order
return	System.Threading.Tasks.Task

OrderModuleCreateOrderFromCart() public method

Create new customer order based on shopping cart.

public OrderModuleCreateOrderFromCart ( string id ) : VirtoCommerceOrderModuleWebModelCustomerOrder
id	string	shopping cart id
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceOrderModuleWebModelCustomerOrder

OrderModuleCreateOrderFromCartAsync() public method

Create new customer order based on shopping cart.

public OrderModuleCreateOrderFromCartAsync ( string id ) : System.Threading.Tasks.Task
id	string	shopping cart id
return	System.Threading.Tasks.Task

OrderModuleDelete() public method

Delete a concrete customer order operation (document)

public OrderModuleDelete ( string id, string operationId ) : void
id	string	customer order id
operationId	string	operation id
return	void

OrderModuleDeleteAsync() public method

Delete a concrete customer order operation (document)

public OrderModuleDeleteAsync ( string id, string operationId ) : System.Threading.Tasks.Task
id	string	customer order id
operationId	string	operation id
return	System.Threading.Tasks.Task

OrderModuleDeleteOrdersByIds() public method

Delete a whole customer orders

public OrderModuleDeleteOrdersByIds ( List ids ) : void
ids	List	customer order ids for delete
return	void

OrderModuleDeleteOrdersByIdsAsync() public method

Delete a whole customer orders

public OrderModuleDeleteOrdersByIdsAsync ( List ids ) : System.Threading.Tasks.Task
ids	List	customer order ids for delete
return	System.Threading.Tasks.Task

OrderModuleGetById() public method

Find customer order by id Return a single customer order with all nested documents

public OrderModuleGetById ( string id ) : VirtoCommerceOrderModuleWebModelCustomerOrder
id	string	customer order id
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceOrderModuleWebModelCustomerOrder

OrderModuleGetByIdAsync() public method

Find customer order by id Return a single customer order with all nested documents

public OrderModuleGetByIdAsync ( string id ) : System.Threading.Tasks.Task
id	string	customer order id
return	System.Threading.Tasks.Task

OrderModuleGetDashboardStatistics() public method

Get a some order statistic information for Commerce manager dashboard

public OrderModuleGetDashboardStatistics ( System.DateTime start, System.DateTime end ) : VirtoCommerceOrderModuleWebModelDashboardStatisticsResult
start	System.DateTime	start interval date
end	System.DateTime	end interval date
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceOrderModuleWebModelDashboardStatisticsResult

OrderModuleGetDashboardStatisticsAsync() public method

Get a some order statistic information for Commerce manager dashboard

public OrderModuleGetDashboardStatisticsAsync ( System.DateTime start, System.DateTime end ) : System.Threading.Tasks.Task
start	System.DateTime	start interval date
end	System.DateTime	end interval date
return	System.Threading.Tasks.Task

OrderModuleGetNewPayment() public method

Get new payment for specified customer order Return new payment document with populates all required properties.

public OrderModuleGetNewPayment ( string id ) : VirtoCommerceOrderModuleWebModelPaymentIn
id	string	customer order id
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceOrderModuleWebModelPaymentIn

OrderModuleGetNewPaymentAsync() public method

Get new payment for specified customer order Return new payment document with populates all required properties.

public OrderModuleGetNewPaymentAsync ( string id ) : System.Threading.Tasks.Task
id	string	customer order id
return	System.Threading.Tasks.Task

OrderModuleGetNewShipment() public method

Get new shipment for specified customer order Return new shipment document with populates all required properties.

public OrderModuleGetNewShipment ( string id ) : VirtoCommerceOrderModuleWebModelShipment
id	string	customer order id
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceOrderModuleWebModelShipment

OrderModuleGetNewShipmentAsync() public method

Get new shipment for specified customer order Return new shipment document with populates all required properties.

public OrderModuleGetNewShipmentAsync ( string id ) : System.Threading.Tasks.Task
id	string	customer order id
return	System.Threading.Tasks.Task

OrderModuleProcessOrderPayments() public method

Registration customer order payment in external payment system Used in front-end checkout or manual order payment registration

public OrderModuleProcessOrderPayments ( VirtoCommerceDomainPaymentModelBankCardInfo bankCardInfo, string orderId, string paymentId ) : VirtoCommerceOrderModuleWebModelCustomerOrder
bankCardInfo	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceDomainPaymentModelBankCardInfo	banking card information
orderId	string	customer order id
paymentId	string	payment id
return	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceOrderModuleWebModelCustomerOrder

OrderModuleProcessOrderPaymentsAsync() public method

Registration customer order payment in external payment system Used in front-end checkout or manual order payment registration

public OrderModuleProcessOrderPaymentsAsync ( VirtoCommerceDomainPaymentModelBankCardInfo bankCardInfo, string orderId, string paymentId ) : System.Threading.Tasks.Task
bankCardInfo	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceDomainPaymentModelBankCardInfo	banking card information
orderId	string	customer order id
paymentId	string	payment id
return	System.Threading.Tasks.Task

OrderModuleSearch() public method

Search customer orders by given criteria

public OrderModuleSearch ( string criteriaResponseGroup, string criteriaKeyword, string criteriaCustomerId, string criteriaEmployeeId, List criteriaStoreIds, System.DateTime criteriaStartDate, System.DateTime criteriaEndDate, int criteriaStart, int criteriaCount ) : VirtoCommerceOrderModuleWebModelSearchResult
criteriaResponseGroup	string
criteriaKeyword	string
criteriaCustomerId	string
criteriaEmployeeId	string
criteriaStoreIds	List
criteriaStartDate	System.DateTime
criteriaEndDate	System.DateTime
criteriaStart	int
criteriaCount	int
return	VirtoCommerceOrderModuleWebModelSearchResult

OrderModuleSearchAsync() public method

Search customer orders by given criteria

public OrderModuleSearchAsync ( string criteriaResponseGroup, string criteriaKeyword, string criteriaCustomerId, string criteriaEmployeeId, List criteriaStoreIds, System.DateTime criteriaStartDate, System.DateTime criteriaEndDate, int criteriaStart, int criteriaCount ) : System.Threading.Tasks.Task
criteriaResponseGroup	string
criteriaKeyword	string
criteriaCustomerId	string
criteriaEmployeeId	string
criteriaStoreIds	List
criteriaStartDate	System.DateTime
criteriaEndDate	System.DateTime
criteriaStart	int
criteriaCount	int
return	System.Threading.Tasks.Task

OrderModuleUpdate() public method

Update a existing customer order

public OrderModuleUpdate ( VirtoCommerceOrderModuleWebModelCustomerOrder customerOrder ) : void
customerOrder	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceOrderModuleWebModelCustomerOrder	customer order
return	void

OrderModuleUpdateAsync() public method

Update a existing customer order

public OrderModuleUpdateAsync ( VirtoCommerceOrderModuleWebModelCustomerOrder customerOrder ) : System.Threading.Tasks.Task
customerOrder	VirtoCommerce.SwaggerApiClient.Model.VirtoCommerceOrderModuleWebModelCustomerOrder	customer order
return	System.Threading.Tasks.Task

SetBasePath() public method

Sets the base path of the API client.

public SetBasePath ( String basePath ) : void
basePath	String	The base path
return	void