Shopify SDK for Unity
Public Member Functions | List of all members
Shopify.Unity.GraphQL.OrderQuery Class Reference

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...

Public Member Functions

 OrderQuery (StringBuilder query)
 OrderQuery is used to build queries. Typically OrderQuery will not be used directly but instead will be used when building queries from either QueryRootQuery or MutationQuery. More...
 
OrderQuery currencyCode ()
 The code of the currency used for the payment. More...
 
OrderQuery customerLocale ()
 The locale code in which this specific order happened. More...
 
OrderQuery customerUrl ()
 The unique URL that the customer can use to access the order. More...
 
OrderQuery discountApplications (DiscountApplicationConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, string alias=null)
 Discounts that have been applied on the order. More...
 
OrderQuery email ()
 The customer's email address. More...
 
OrderQuery id ()
 Globally unique identifier. More...
 
OrderQuery lineItems (OrderLineItemConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, string alias=null)
 List of the order’s line items. More...
 
OrderQuery name ()
 Unique identifier for the order that appears on the order. For example, _#1000_ or _Store1001. More...
 
OrderQuery orderNumber ()
 A unique numeric identifier for the order for use by shop owner and customer. More...
 
OrderQuery phone ()
 The customer's phone number for receiving SMS notifications. More...
 
OrderQuery 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...
 
OrderQuery shippingAddress (MailingAddressDelegate buildQuery)
 The address to where the order will be shipped. More...
 
OrderQuery shippingDiscountAllocations (DiscountAllocationDelegate buildQuery)
 The discounts that have been allocated onto the shipping line by discount applications. More...
 
OrderQuery statusUrl ()
 The unique URL for the order's status page. More...
 
OrderQuery subtotalPrice ()
 Price of the order before shipping and taxes. More...
 
OrderQuery subtotalPriceV2 (MoneyV2Delegate buildQuery)
 Price of the order before duties, shipping and taxes. More...
 
OrderQuery successfulFulfillments (FulfillmentDelegate buildQuery, long? first=null, string alias=null)
 List of the order’s successful fulfillments. More...
 
OrderQuery totalPrice ()
 The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). More...
 
OrderQuery totalPriceV2 (MoneyV2Delegate buildQuery)
 The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). More...
 
OrderQuery totalRefunded ()
 The total amount that has been refunded. More...
 
OrderQuery totalRefundedV2 (MoneyV2Delegate buildQuery)
 The total amount that has been refunded. More...
 
OrderQuery totalShippingPrice ()
 The total cost of shipping. More...
 
OrderQuery totalShippingPriceV2 (MoneyV2Delegate buildQuery)
 The total cost of shipping. More...
 
OrderQuery totalTax ()
 The total cost of taxes. More...
 
OrderQuery totalTaxV2 (MoneyV2Delegate buildQuery)
 The total cost of taxes. More...
 

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

◆ OrderQuery()

Shopify.Unity.GraphQL.OrderQuery.OrderQuery ( StringBuilder  query)
inline

OrderQuery is used to build queries. Typically OrderQuery will not be used directly but instead will be used when building queries from either QueryRootQuery or MutationQuery.

Member Function Documentation

◆ currencyCode()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.currencyCode ( )
inline

The code of the currency used for the payment.

◆ customerLocale()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.customerLocale ( )
inline

The locale code in which this specific order happened.

◆ customerUrl()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.customerUrl ( )
inline

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

◆ discountApplications()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.discountApplications ( DiscountApplicationConnectionDelegate  buildQuery,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
string  alias = null 
)
inline

Discounts that have been applied on the order.

Parameters
firstReturns up to the first n elements from the list.
afterReturns the elements that come after the specified cursor.
lastReturns up to the last n elements from the list.
beforeReturns the elements that come before the specified cursor.
reverseReverse the order of the underlying list.

◆ email()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.email ( )
inline

The customer's email address.

◆ id()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.id ( )
inline

Globally unique identifier.

◆ lineItems()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.lineItems ( OrderLineItemConnectionDelegate  buildQuery,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
string  alias = null 
)
inline

List of the order’s line items.

Parameters
firstReturns up to the first n elements from the list.
afterReturns the elements that come after the specified cursor.
lastReturns up to the last n elements from the list.
beforeReturns the elements that come before the specified cursor.
reverseReverse the order of the underlying list.

◆ name()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.name ( )
inline

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

◆ orderNumber()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.orderNumber ( )
inline

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

◆ phone()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.phone ( )
inline

The customer's phone number for receiving SMS notifications.

◆ processedAt()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.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()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.shippingAddress ( MailingAddressDelegate  buildQuery)
inline

The address to where the order will be shipped.

◆ shippingDiscountAllocations()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.shippingDiscountAllocations ( DiscountAllocationDelegate  buildQuery)
inline

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

◆ statusUrl()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.statusUrl ( )
inline

The unique URL for the order's status page.

◆ subtotalPrice()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.subtotalPrice ( )
inline

Price of the order before shipping and taxes.

Deprecated:
Use subtotalPriceV2 instead

◆ subtotalPriceV2()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.subtotalPriceV2 ( MoneyV2Delegate  buildQuery)
inline

Price of the order before duties, shipping and taxes.

◆ successfulFulfillments()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.successfulFulfillments ( FulfillmentDelegate  buildQuery,
long?  first = null,
string  alias = null 
)
inline

List of the order’s successful fulfillments.

Parameters
firstTruncate the array result to this size.

◆ totalPrice()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.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()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.totalPriceV2 ( MoneyV2Delegate  buildQuery)
inline

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

◆ totalRefunded()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.totalRefunded ( )
inline

The total amount that has been refunded.

Deprecated:
Use totalRefundedV2 instead

◆ totalRefundedV2()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.totalRefundedV2 ( MoneyV2Delegate  buildQuery)
inline

The total amount that has been refunded.

◆ totalShippingPrice()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.totalShippingPrice ( )
inline

The total cost of shipping.

Deprecated:
Use totalShippingPriceV2 instead

◆ totalShippingPriceV2()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.totalShippingPriceV2 ( MoneyV2Delegate  buildQuery)
inline

The total cost of shipping.

◆ totalTax()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.totalTax ( )
inline

The total cost of taxes.

Deprecated:
Use totalTaxV2 instead

◆ totalTaxV2()

OrderQuery Shopify.Unity.GraphQL.OrderQuery.totalTaxV2 ( MoneyV2Delegate  buildQuery)
inline

The total cost of taxes.


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