com.shopify.buy3

Class Storefront.OrderQuery

java.lang.Object

com.shopify.graphql.support.Query<Storefront.OrderQuery>

com.shopify.buy3.Storefront.OrderQuery

Enclosing class:

Storefront

public static class Storefront.OrderQuery
extends Query<Storefront.OrderQuery>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storefront.OrderQuery.DiscountApplicationsArguments
static interface	Storefront.OrderQuery.DiscountApplicationsArgumentsDefinition
class	Storefront.OrderQuery.LineItemsArguments
static interface	Storefront.OrderQuery.LineItemsArgumentsDefinition
class	Storefront.OrderQuery.MetafieldArguments
static interface	Storefront.OrderQuery.MetafieldArgumentsDefinition
class	Storefront.OrderQuery.SuccessfulFulfillmentsArguments
static interface	Storefront.OrderQuery.SuccessfulFulfillmentsArgumentsDefinition

Field Summary

Fields inherited from class com.shopify.graphql.support.Query

_queryBuilder, ALIAS_SUFFIX_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Storefront.OrderQuery	billingAddress(Storefront.MailingAddressQueryDefinition queryDef) The address associated with the payment method.
Storefront.OrderQuery	canceledAt() The date and time when the order was canceled.
Storefront.OrderQuery	cancelReason() The reason for the order's cancellation.
Storefront.OrderQuery	currencyCode() The code of the currency used for the payment.
Storefront.OrderQuery	currentSubtotalPrice(Storefront.MoneyV2QueryDefinition queryDef) The subtotal of line items and their discounts, excluding line items that have been removed.
Storefront.OrderQuery	currentTotalDuties(Storefront.MoneyV2QueryDefinition queryDef) The total cost of duties for the order, including refunds.
Storefront.OrderQuery	currentTotalPrice(Storefront.MoneyV2QueryDefinition queryDef) The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed.
Storefront.OrderQuery	currentTotalShippingPrice(Storefront.MoneyV2QueryDefinition queryDef) The total cost of shipping, excluding shipping lines that have been refunded or removed.
Storefront.OrderQuery	currentTotalTax(Storefront.MoneyV2QueryDefinition queryDef) The total of all taxes applied to the order, excluding taxes for returned line items.
Storefront.OrderQuery	customAttributes(Storefront.AttributeQueryDefinition queryDef) A list of the custom attributes added to the order.
Storefront.OrderQuery	customerLocale() The locale code in which this specific order happened.
Storefront.OrderQuery	customerUrl() The unique URL that the customer can use to access the order.
Storefront.OrderQuery	discountApplications(Storefront.DiscountApplicationConnectionQueryDefinition queryDef) Discounts that have been applied on the order.
Storefront.OrderQuery	discountApplications(Storefront.OrderQuery.DiscountApplicationsArgumentsDefinition argsDef, Storefront.DiscountApplicationConnectionQueryDefinition queryDef) Discounts that have been applied on the order.
Storefront.OrderQuery	edited() Whether the order has had any edits applied or not.
Storefront.OrderQuery	email() The customer's email address.
Storefront.OrderQuery	financialStatus() The financial status of the order.
Storefront.OrderQuery	fulfillmentStatus() The fulfillment status for the order.
Storefront.OrderQuery	lineItems(Storefront.OrderLineItemConnectionQueryDefinition queryDef) List of the order’s line items.
Storefront.OrderQuery	lineItems(Storefront.OrderQuery.LineItemsArgumentsDefinition argsDef, Storefront.OrderLineItemConnectionQueryDefinition queryDef) List of the order’s line items.
Storefront.OrderQuery	metafield(java.lang.String key, Storefront.MetafieldQueryDefinition queryDef) Returns a metafield found by namespace and key.
Storefront.OrderQuery	metafield(java.lang.String key, Storefront.OrderQuery.MetafieldArgumentsDefinition argsDef, Storefront.MetafieldQueryDefinition queryDef) Returns a metafield found by namespace and key.
Storefront.OrderQuery	metafields(java.util.List<Storefront.HasMetafieldsIdentifier> identifiers, Storefront.MetafieldQueryDefinition queryDef) The metafields associated with the resource matching the supplied list of namespaces and keys.
Storefront.OrderQuery	name() Unique identifier for the order that appears on the order.
Storefront.OrderQuery	orderNumber() A unique numeric identifier for the order for use by shop owner and customer.
Storefront.OrderQuery	originalTotalDuties(Storefront.MoneyV2QueryDefinition queryDef) The total cost of duties charged at checkout.
Storefront.OrderQuery	originalTotalPrice(Storefront.MoneyV2QueryDefinition queryDef) The total price of the order before any applied edits.
Storefront.OrderQuery	phone() The customer's phone number for receiving SMS notifications.
Storefront.OrderQuery	processedAt() The date and time when the order was imported.
Storefront.OrderQuery	shippingAddress(Storefront.MailingAddressQueryDefinition queryDef) The address to where the order will be shipped.
Storefront.OrderQuery	shippingDiscountAllocations(Storefront.DiscountAllocationQueryDefinition queryDef) The discounts that have been allocated onto the shipping line by discount applications.
Storefront.OrderQuery	statusUrl() The unique URL for the order's status page.
Storefront.OrderQuery	subtotalPrice(Storefront.MoneyV2QueryDefinition queryDef) Price of the order before shipping and taxes.
Storefront.OrderQuery	subtotalPriceV2(Storefront.MoneyV2QueryDefinition queryDef) Deprecated. Use `subtotalPrice` instead.
Storefront.OrderQuery	successfulFulfillments(Storefront.FulfillmentQueryDefinition queryDef) List of the order’s successful fulfillments.
Storefront.OrderQuery	successfulFulfillments(Storefront.OrderQuery.SuccessfulFulfillmentsArgumentsDefinition argsDef, Storefront.FulfillmentQueryDefinition queryDef) List of the order’s successful fulfillments.
Storefront.OrderQuery	totalPrice(Storefront.MoneyV2QueryDefinition queryDef) The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).
Storefront.OrderQuery	totalPriceV2(Storefront.MoneyV2QueryDefinition queryDef) Deprecated. Use `totalPrice` instead.
Storefront.OrderQuery	totalRefunded(Storefront.MoneyV2QueryDefinition queryDef) The total amount that has been refunded.
Storefront.OrderQuery	totalRefundedV2(Storefront.MoneyV2QueryDefinition queryDef) Deprecated. Use `totalRefunded` instead.
Storefront.OrderQuery	totalShippingPrice(Storefront.MoneyV2QueryDefinition queryDef) The total cost of shipping.
Storefront.OrderQuery	totalShippingPriceV2(Storefront.MoneyV2QueryDefinition queryDef) Deprecated. Use `totalShippingPrice` instead.
Storefront.OrderQuery	totalTax(Storefront.MoneyV2QueryDefinition queryDef) The total cost of taxes.
Storefront.OrderQuery	totalTaxV2(Storefront.MoneyV2QueryDefinition queryDef) Deprecated. Use `totalTax` instead.

Methods inherited from class com.shopify.graphql.support.Query

appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

billingAddress

public Storefront.OrderQuery billingAddress(Storefront.MailingAddressQueryDefinition queryDef)

The address associated with the payment method.

cancelReason

public Storefront.OrderQuery cancelReason()

The reason for the order's cancellation. Returns `null` if the order wasn't canceled.

canceledAt

public Storefront.OrderQuery canceledAt()

The date and time when the order was canceled. Returns null if the order wasn't canceled.

currencyCode

public Storefront.OrderQuery currencyCode()

The code of the currency used for the payment.

currentSubtotalPrice

public Storefront.OrderQuery currentSubtotalPrice(Storefront.MoneyV2QueryDefinition queryDef)

The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes aren't included unless the order is a taxes-included order.

currentTotalDuties

public Storefront.OrderQuery currentTotalDuties(Storefront.MoneyV2QueryDefinition queryDef)

The total cost of duties for the order, including refunds.

currentTotalPrice

public Storefront.OrderQuery currentTotalPrice(Storefront.MoneyV2QueryDefinition queryDef)

The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed.

currentTotalShippingPrice

public Storefront.OrderQuery currentTotalShippingPrice(Storefront.MoneyV2QueryDefinition queryDef)

The total cost of shipping, excluding shipping lines that have been refunded or removed. Taxes aren't included unless the order is a taxes-included order.

currentTotalTax

public Storefront.OrderQuery currentTotalTax(Storefront.MoneyV2QueryDefinition queryDef)

The total of all taxes applied to the order, excluding taxes for returned line items.

customAttributes

public Storefront.OrderQuery customAttributes(Storefront.AttributeQueryDefinition queryDef)

A list of the custom attributes added to the order.

customerLocale

public Storefront.OrderQuery customerLocale()

The locale code in which this specific order happened.

customerUrl

public Storefront.OrderQuery customerUrl()

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

discountApplications

public Storefront.OrderQuery discountApplications(Storefront.DiscountApplicationConnectionQueryDefinition queryDef)

Discounts that have been applied on the order.

discountApplications

public Storefront.OrderQuery discountApplications(Storefront.OrderQuery.DiscountApplicationsArgumentsDefinition argsDef,
                                                  Storefront.DiscountApplicationConnectionQueryDefinition queryDef)

Discounts that have been applied on the order.

edited

public Storefront.OrderQuery edited()

Whether the order has had any edits applied or not.

email

public Storefront.OrderQuery email()

The customer's email address.

financialStatus

public Storefront.OrderQuery financialStatus()

The financial status of the order.

fulfillmentStatus

public Storefront.OrderQuery fulfillmentStatus()

The fulfillment status for the order.

lineItems

public Storefront.OrderQuery lineItems(Storefront.OrderLineItemConnectionQueryDefinition queryDef)

List of the order’s line items.

lineItems

public Storefront.OrderQuery lineItems(Storefront.OrderQuery.LineItemsArgumentsDefinition argsDef,
                                       Storefront.OrderLineItemConnectionQueryDefinition queryDef)

List of the order’s line items.

metafield

public Storefront.OrderQuery metafield(java.lang.String key,
                                       Storefront.MetafieldQueryDefinition queryDef)

Returns a metafield found by namespace and key.

metafield

public Storefront.OrderQuery metafield(java.lang.String key,
                                       Storefront.OrderQuery.MetafieldArgumentsDefinition argsDef,
                                       Storefront.MetafieldQueryDefinition queryDef)

Returns a metafield found by namespace and key.

metafields

public Storefront.OrderQuery metafields(java.util.List<Storefront.HasMetafieldsIdentifier> identifiers,
                                        Storefront.MetafieldQueryDefinition queryDef)

The metafields associated with the resource matching the supplied list of namespaces and keys.

name

public Storefront.OrderQuery name()

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

orderNumber

public Storefront.OrderQuery orderNumber()

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

originalTotalDuties

public Storefront.OrderQuery originalTotalDuties(Storefront.MoneyV2QueryDefinition queryDef)

The total cost of duties charged at checkout.

originalTotalPrice

public Storefront.OrderQuery originalTotalPrice(Storefront.MoneyV2QueryDefinition queryDef)

The total price of the order before any applied edits.

phone

public Storefront.OrderQuery phone()

The customer's phone number for receiving SMS notifications.

processedAt

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

shippingAddress

public Storefront.OrderQuery shippingAddress(Storefront.MailingAddressQueryDefinition queryDef)

The address to where the order will be shipped.

shippingDiscountAllocations

public Storefront.OrderQuery shippingDiscountAllocations(Storefront.DiscountAllocationQueryDefinition queryDef)

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

statusUrl

public Storefront.OrderQuery statusUrl()

The unique URL for the order's status page.

subtotalPrice

public Storefront.OrderQuery subtotalPrice(Storefront.MoneyV2QueryDefinition queryDef)

Price of the order before shipping and taxes.

subtotalPriceV2

@Deprecated
public Storefront.OrderQuery subtotalPriceV2(Storefront.MoneyV2QueryDefinition queryDef)

Deprecated. Use `subtotalPrice` instead.

Price of the order before duties, shipping and taxes.

successfulFulfillments

public Storefront.OrderQuery successfulFulfillments(Storefront.FulfillmentQueryDefinition queryDef)

List of the order’s successful fulfillments.

successfulFulfillments

public Storefront.OrderQuery successfulFulfillments(Storefront.OrderQuery.SuccessfulFulfillmentsArgumentsDefinition argsDef,
                                                    Storefront.FulfillmentQueryDefinition queryDef)

List of the order’s successful fulfillments.

totalPrice

public Storefront.OrderQuery totalPrice(Storefront.MoneyV2QueryDefinition queryDef)

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

totalPriceV2

@Deprecated
public Storefront.OrderQuery totalPriceV2(Storefront.MoneyV2QueryDefinition queryDef)

Deprecated. Use `totalPrice` instead.

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

totalRefunded

public Storefront.OrderQuery totalRefunded(Storefront.MoneyV2QueryDefinition queryDef)

The total amount that has been refunded.

totalRefundedV2

@Deprecated
public Storefront.OrderQuery totalRefundedV2(Storefront.MoneyV2QueryDefinition queryDef)

Deprecated. Use `totalRefunded` instead.

The total amount that has been refunded.

totalShippingPrice

public Storefront.OrderQuery totalShippingPrice(Storefront.MoneyV2QueryDefinition queryDef)

The total cost of shipping.

totalShippingPriceV2

@Deprecated
public Storefront.OrderQuery totalShippingPriceV2(Storefront.MoneyV2QueryDefinition queryDef)

Deprecated. Use `totalShippingPrice` instead.

The total cost of shipping.

totalTax

public Storefront.OrderQuery totalTax(Storefront.MoneyV2QueryDefinition queryDef)

The total cost of taxes.

totalTaxV2

@Deprecated
public Storefront.OrderQuery totalTaxV2(Storefront.MoneyV2QueryDefinition queryDef)

Deprecated. Use `totalTax` instead.

The total cost of taxes.