C# Class ShopifySharp.ShopifyOrderService

A service for manipulating Shopify orders.

Inheritance: ShopifySharp.ShopifyService

Public Methods

Method	Description
CancelAsync ( long orderId, ShopifyOrderCancelOptions options = null ) : System.Threading.Tasks.Task	Cancels an order.
CloseAsync ( long id ) : Task	Closes an order.
CountAsync ( ShopifyOrderFilter filter = null ) : Task	Gets a count of all of the shop's orders.
CreateAsync ( ShopifySharp.ShopifyOrder order, ShopifySharp.ShopifyOrderCreateOptions options = null ) : Task	Creates a new ShopifyOrder on the store.
DeleteAsync ( long orderId ) : System.Threading.Tasks.Task	Deletes an order with the given Id.
GetAsync ( long orderId, string fields = null ) : Task	Retrieves the ShopifyOrder with the given id.
ListAsync ( ShopifyOrderFilter options = null ) : Task>	Gets a list of up to 250 of the shop's orders.
ListForCustomerAsync ( long customerId, ShopifyOrderFilter options = null ) : Task>	Gets a list of up to 250 of the customer's orders.
OpenAsync ( long id ) : Task	Opens a closed order.
ShopifyOrderService ( string myShopifyUrl, string shopAccessToken ) : Newtonsoft.Json.Linq	Creates a new instance of ShopifyOrderService.
UpdateAsync ( ShopifySharp.ShopifyOrder order ) : Task	Updates the given ShopifyOrder. Id must not be null.

Cancels an order.

public CancelAsync ( long orderId, ShopifyOrderCancelOptions options = null ) : System.Threading.Tasks.Task
orderId	long	The order's id.
options	ShopifyOrderCancelOptions
return	System.Threading.Tasks.Task

Closes an order.

public CloseAsync ( long id ) : Task
id	long	The order's id.
return	Task

Gets a count of all of the shop's orders.

public CountAsync ( ShopifyOrderFilter filter = null ) : Task
filter	ShopifyOrderFilter	Options for filtering the count.
return	Task

Creates a new ShopifyOrder on the store.

public CreateAsync ( ShopifySharp.ShopifyOrder order, ShopifySharp.ShopifyOrderCreateOptions options = null ) : Task
order	ShopifySharp.ShopifyOrder	A new . Id should be set to null.
options	ShopifySharp.ShopifyOrderCreateOptions	Options for creating the order.
return	Task

Deletes an order with the given Id.

public DeleteAsync ( long orderId ) : System.Threading.Tasks.Task
orderId	long	The order object's Id.
return	System.Threading.Tasks.Task

Retrieves the ShopifyOrder with the given id.

public GetAsync ( long orderId, string fields = null ) : Task
orderId	long	The id of the order to retrieve.
fields	string	A comma-separated list of fields to return.
return	Task

Gets a list of up to 250 of the shop's orders.

public ListAsync ( ShopifyOrderFilter options = null ) : Task>
options	ShopifyOrderFilter	Options for filtering the list.
return	Task>

Gets a list of up to 250 of the customer's orders.

public ListForCustomerAsync ( long customerId, ShopifyOrderFilter options = null ) : Task>
customerId	long	The id of the customer to list orders for.
options	ShopifyOrderFilter	Options for filtering the list.
return	Task>

Opens a closed order.

public OpenAsync ( long id ) : Task
id	long	The order's id.
return	Task

Creates a new instance of ShopifyOrderService.

public ShopifyOrderService ( string myShopifyUrl, string shopAccessToken ) : Newtonsoft.Json.Linq
myShopifyUrl	string	The shop's *.myshopify.com URL.
shopAccessToken	string	An API access token for the shop.
return	Newtonsoft.Json.Linq

Updates the given ShopifyOrder. Id must not be null.

public UpdateAsync ( ShopifySharp.ShopifyOrder order ) : Task
order	ShopifySharp.ShopifyOrder	The to update.
return	Task