An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. More...

Inheritance diagram for Shopify.Unity.Order:

Public Member Functions
	Order (Dictionary< string, object > dataJSON)
	Accepts deserialized json data. Will further parse passed in data. More...

CurrencyCode	currencyCode ()
	The code of the currency used for the payment. More...

string	customerLocale ()
	The locale code in which this specific order happened. More...

string	customerUrl ()
	The unique URL that the customer can use to access the order. More...

DiscountApplicationConnection	discountApplications (string alias=null)
	Discounts that have been applied on the order. More...

string	email ()
	The customer's email address. More...

string	id ()
	Globally unique identifier. More...

OrderLineItemConnection	lineItems (string alias=null)
	List of the order’s line items. More...

string	name ()
	Unique identifier for the order that appears on the order. For example, _#1000_ or _Store1001. More...

long	orderNumber ()
	A unique numeric identifier for the order for use by shop owner and customer. More...

string	phone ()
	The customer's phone number for receiving SMS notifications. More...

DateTime?	processedAt ()
	The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time. More...

MailingAddress	shippingAddress ()
	The address to where the order will be shipped. More...

List< DiscountAllocation >	shippingDiscountAllocations ()
	The discounts that have been allocated onto the shipping line by discount applications. More...

string	statusUrl ()
	The unique URL for the order's status page. More...

decimal	subtotalPrice ()
	Price of the order before shipping and taxes. More...

MoneyV2	subtotalPriceV2 ()
	Price of the order before duties, shipping and taxes. More...

List< Fulfillment >	successfulFulfillments (string alias=null)
	List of the order’s successful fulfillments. More...

decimal	totalPrice ()
	The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). More...

MoneyV2	totalPriceV2 ()
	The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). More...

decimal	totalRefunded ()
	The total amount that has been refunded. More...

MoneyV2	totalRefundedV2 ()
	The total amount that has been refunded. More...

decimal	totalShippingPrice ()
	The total cost of shipping. More...

MoneyV2	totalShippingPriceV2 ()
	The total cost of shipping. More...

decimal	totalTax ()
	The total cost of taxes. More...

MoneyV2	totalTaxV2 ()
	The total cost of taxes. More...

object	Clone ()

Additional Inherited Members
Protected Member Functions inherited from Shopify.Unity.SDK.AbstractResponse
T	Get< T > (string field, string alias=null)

Protected Attributes inherited from Shopify.Unity.SDK.AbstractResponse
Dictionary< string, object >	Data

Properties inherited from Shopify.Unity.SDK.AbstractResponse
Dictionary< string, object >	DataJSON `[get, protected set]`

Detailed Description

An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.

Constructor & Destructor Documentation

◆ Order()

Shopify.Unity.Order.Order ( Dictionary< string, object > dataJSON )

inline

Accepts deserialized json data. Will further parse passed in data.

Parameters

dataJSON Deserialized JSON data for Order

Member Function Documentation

◆ currencyCode()

CurrencyCode Shopify.Unity.Order.currencyCode ( )

inline

The code of the currency used for the payment.

◆ customerLocale()

string Shopify.Unity.Order.customerLocale ( )

inline

The locale code in which this specific order happened.

◆ customerUrl()

string Shopify.Unity.Order.customerUrl ( )

inline

The unique URL that the customer can use to access the order.

◆ discountApplications()

DiscountApplicationConnection Shopify.Unity.Order.discountApplications ( string alias = null )

inline

Discounts that have been applied on the order.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ email()

string Shopify.Unity.Order.email ( )

inline

The customer's email address.

◆ id()

string Shopify.Unity.Order.id ( )

inline

Globally unique identifier.

Implements Shopify.Unity.Node.

◆ lineItems()

OrderLineItemConnection Shopify.Unity.Order.lineItems ( string alias = null )

inline

List of the order’s line items.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ name()

string Shopify.Unity.Order.name ( )

inline

Unique identifier for the order that appears on the order. For example, _#1000_ or _Store1001.

◆ orderNumber()

long Shopify.Unity.Order.orderNumber ( )

inline

A unique numeric identifier for the order for use by shop owner and customer.

◆ phone()

string Shopify.Unity.Order.phone ( )

inline

The customer's phone number for receiving SMS notifications.

◆ processedAt()

DateTime? Shopify.Unity.Order.processedAt ( )

inline

The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time.

◆ shippingAddress()

MailingAddress Shopify.Unity.Order.shippingAddress ( )

inline

The address to where the order will be shipped.

◆ shippingDiscountAllocations()

List<DiscountAllocation> Shopify.Unity.Order.shippingDiscountAllocations ( )

inline

The discounts that have been allocated onto the shipping line by discount applications.

◆ statusUrl()

string Shopify.Unity.Order.statusUrl ( )

inline

The unique URL for the order's status page.

◆ subtotalPrice()

decimal Shopify.Unity.Order.subtotalPrice ( )

inline

Price of the order before shipping and taxes.

Deprecated:: Use subtotalPriceV2 instead

◆ subtotalPriceV2()

MoneyV2 Shopify.Unity.Order.subtotalPriceV2 ( )

inline

Price of the order before duties, shipping and taxes.

◆ successfulFulfillments()

List<Fulfillment> Shopify.Unity.Order.successfulFulfillments ( string alias = null )

inline

List of the order’s successful fulfillments.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ totalPrice()

decimal Shopify.Unity.Order.totalPrice ( )

inline

The sum of all the prices of all the items in the order, taxes and discounts included (must be positive).

Deprecated:: Use totalPriceV2 instead

◆ totalPriceV2()

MoneyV2 Shopify.Unity.Order.totalPriceV2 ( )

inline

The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).

◆ totalRefunded()

decimal Shopify.Unity.Order.totalRefunded ( )

inline

The total amount that has been refunded.

Deprecated:: Use totalRefundedV2 instead

◆ totalRefundedV2()

MoneyV2 Shopify.Unity.Order.totalRefundedV2 ( )

inline

The total amount that has been refunded.

◆ totalShippingPrice()

decimal Shopify.Unity.Order.totalShippingPrice ( )

inline

The total cost of shipping.

Deprecated:: Use totalShippingPriceV2 instead

◆ totalShippingPriceV2()

MoneyV2 Shopify.Unity.Order.totalShippingPriceV2 ( )

inline

The total cost of shipping.

◆ totalTax()

decimal Shopify.Unity.Order.totalTax ( )

inline

The total cost of taxes.

Deprecated:: Use totalTaxV2 instead

◆ totalTaxV2()

MoneyV2 Shopify.Unity.Order.totalTaxV2 ( )

inline

The total cost of taxes.

The documentation for this class was generated from the following file:

Assets/Shopify/Unity/Generated/Order.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Order()

Member Function Documentation

◆ currencyCode()

◆ customerLocale()

◆ customerUrl()

◆ discountApplications()

◆ email()

◆ id()

◆ lineItems()

◆ name()

◆ orderNumber()

◆ phone()

◆ processedAt()

◆ shippingAddress()

◆ shippingDiscountAllocations()

◆ statusUrl()

◆ subtotalPrice()

◆ subtotalPriceV2()

◆ successfulFulfillments()

◆ totalPrice()

◆ totalPriceV2()

◆ totalRefunded()

◆ totalRefundedV2()

◆ totalShippingPrice()

◆ totalShippingPriceV2()

◆ totalTax()

◆ totalTaxV2()