com.adobe.cq.commerce.magento.graphql

Class CustomerOrderQuery

java.lang.Object

com.shopify.graphql.support.AbstractQuery<CustomerOrderQuery>

com.adobe.cq.commerce.magento.graphql.CustomerOrderQuery

public class CustomerOrderQuery
extends AbstractQuery<CustomerOrderQuery>

Contains details about each of the customer's orders

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CustomerOrderQuery.ReturnsArguments
static interface	CustomerOrderQuery.ReturnsArgumentsDefinition

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method and Description
CustomerOrderQuery	addFragmentReference(Fragment<CustomerOrderQuery> fragment) Adds a CustomerOrderQuery fragment reference at the current position of the query.
CustomerOrderQuery	billingAddress(OrderAddressQueryDefinition queryDef) The billing address for the order
CustomerOrderQuery	carrier() The shipping carrier for the order delivery
CustomerOrderQuery	comments(SalesCommentItemQueryDefinition queryDef) Comments about the order
CustomerOrderQuery	createdAt() Deprecated. Use the order_date attribute instead
static Fragment<CustomerOrderQuery>	createFragment(String name, CustomerOrderQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
CustomerOrderQuery	creditMemos(CreditMemoQueryDefinition queryDef) A list of credit memos
CustomerOrderQuery	giftMessage(GiftMessageQueryDefinition queryDef) The entered gift message for the order
CustomerOrderQuery	giftReceiptIncluded() Whether customer requested gift receipt for the order
CustomerOrderQuery	giftWrapping(GiftWrappingQueryDefinition queryDef) The selected gift wrapping for the order
CustomerOrderQuery	grandTotal() Deprecated. Use the totals.grand_total attribute instead
CustomerOrderQuery	id() The unique ID for a `CustomerOrder` object
CustomerOrderQuery	incrementId() Deprecated. Use the id attribute instead
CustomerOrderQuery	invoices(InvoiceQueryDefinition queryDef) A list of invoices for the order
CustomerOrderQuery	items(OrderItemInterfaceQueryDefinition queryDef) An array containing the items purchased in this order
CustomerOrderQuery	itemsEligibleForReturn(OrderItemInterfaceQueryDefinition queryDef) A list of order items eligible to be in a return request
CustomerOrderQuery	number() The order number
CustomerOrderQuery	orderDate() The date the order was placed
CustomerOrderQuery	orderNumber() Deprecated. Use the number attribute instead
CustomerOrderQuery	paymentMethods(OrderPaymentMethodQueryDefinition queryDef) Payment details for the order
CustomerOrderQuery	printedCardIncluded() Whether customer requested printed card for the order
CustomerOrderQuery	returns(CustomerOrderQuery.ReturnsArgumentsDefinition argsDef, ReturnsQueryDefinition queryDef) Return requests associated with this order.
CustomerOrderQuery	returns(ReturnsQueryDefinition queryDef) Return requests associated with this order.
CustomerOrderQuery	shipments(OrderShipmentQueryDefinition queryDef) A list of shipments for the order
CustomerOrderQuery	shippingAddress(OrderAddressQueryDefinition queryDef) The shipping address for the order
CustomerOrderQuery	shippingMethod() The delivery method for the order
CustomerOrderQuery	status() The current status of the order
CustomerOrderQuery	total(OrderTotalQueryDefinition queryDef) Contains details about the calculated totals for this order

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

addCustomObjectField, addCustomSimpleField, 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 CustomerOrderQuery billingAddress(OrderAddressQueryDefinition queryDef)

The billing address for the order

carrier

public CustomerOrderQuery carrier()

The shipping carrier for the order delivery

comments

public CustomerOrderQuery comments(SalesCommentItemQueryDefinition queryDef)

Comments about the order

createdAt

@Deprecated
public CustomerOrderQuery createdAt()

Deprecated. Use the order_date attribute instead

creditMemos

public CustomerOrderQuery creditMemos(CreditMemoQueryDefinition queryDef)

A list of credit memos

giftMessage

public CustomerOrderQuery giftMessage(GiftMessageQueryDefinition queryDef)

The entered gift message for the order

giftReceiptIncluded

public CustomerOrderQuery giftReceiptIncluded()

Whether customer requested gift receipt for the order

giftWrapping

public CustomerOrderQuery giftWrapping(GiftWrappingQueryDefinition queryDef)

The selected gift wrapping for the order

grandTotal

@Deprecated
public CustomerOrderQuery grandTotal()

Deprecated. Use the totals.grand_total attribute instead

id

public CustomerOrderQuery id()

The unique ID for a `CustomerOrder` object

incrementId

@Deprecated
public CustomerOrderQuery incrementId()

Deprecated. Use the id attribute instead

invoices

public CustomerOrderQuery invoices(InvoiceQueryDefinition queryDef)

A list of invoices for the order

items

public CustomerOrderQuery items(OrderItemInterfaceQueryDefinition queryDef)

An array containing the items purchased in this order

itemsEligibleForReturn

public CustomerOrderQuery itemsEligibleForReturn(OrderItemInterfaceQueryDefinition queryDef)

A list of order items eligible to be in a return request

number

public CustomerOrderQuery number()

The order number

orderDate

public CustomerOrderQuery orderDate()

The date the order was placed

orderNumber

@Deprecated
public CustomerOrderQuery orderNumber()

Deprecated. Use the number attribute instead

paymentMethods

public CustomerOrderQuery paymentMethods(OrderPaymentMethodQueryDefinition queryDef)

Payment details for the order

printedCardIncluded

public CustomerOrderQuery printedCardIncluded()

Whether customer requested printed card for the order

returns

public CustomerOrderQuery returns(ReturnsQueryDefinition queryDef)

Return requests associated with this order.

returns

public CustomerOrderQuery returns(CustomerOrderQuery.ReturnsArgumentsDefinition argsDef,
                                  ReturnsQueryDefinition queryDef)

Return requests associated with this order.

shipments

public CustomerOrderQuery shipments(OrderShipmentQueryDefinition queryDef)

A list of shipments for the order

shippingAddress

public CustomerOrderQuery shippingAddress(OrderAddressQueryDefinition queryDef)

The shipping address for the order

shippingMethod

public CustomerOrderQuery shippingMethod()

The delivery method for the order

status

public CustomerOrderQuery status()

The current status of the order

total

public CustomerOrderQuery total(OrderTotalQueryDefinition queryDef)

Contains details about the calculated totals for this order

createFragment

public static Fragment<CustomerOrderQuery> createFragment(String name,
                                                          CustomerOrderQueryDefinition queryDef)

Creates a GraphQL "named" fragment with the specified query type definition. The generics nature of fragments ensures that a fragment can only be used at the right place in the GraphQL request.

Parameters:

name - The name of the fragment, must be unique for a given GraphQL request.

queryDef - The fragment definition.

Returns:

The fragment of a given generics type.

addFragmentReference

public CustomerOrderQuery addFragmentReference(Fragment<CustomerOrderQuery> fragment)

Adds a CustomerOrderQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query. For GraphQL types implementing an interface, there will be some similar methods using the Query type of each implemented interface.

Parameters:

fragment - The fragment to reference.