com.adobe.cq.commerce.magento.graphql

Class OrderItemQuery

java.lang.Object

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

com.adobe.cq.commerce.magento.graphql.OrderItemQuery

public class OrderItemQuery
extends AbstractQuery<OrderItemQuery>

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
OrderItemQuery	addFragmentReference(Fragment<OrderItemQuery> fragment) Adds a OrderItemQuery fragment reference at the current position of the query.
OrderItemQuery	addOrderItemInterfaceFragmentReference(Fragment<OrderItemInterfaceQuery> fragment) Adds a OrderItemInterfaceQuery fragment reference at the current position of the query.
static Fragment<OrderItemQuery>	createFragment(String name, OrderItemQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
OrderItemQuery	discounts(DiscountQueryDefinition queryDef) The final discount information for the product
OrderItemQuery	eligibleForReturn() Indicates whether the order item is eligible is eligible to be in a return request
OrderItemQuery	enteredOptions(OrderItemOptionQueryDefinition queryDef) The entered option for the base product, such as a logo or image
OrderItemQuery	giftWrapping(GiftWrappingQueryDefinition queryDef) The selected gift wrapping for the order item
OrderItemQuery	id() The unique ID for a `OrderItemInterface` object
OrderItemQuery	productName() The name of the base product
OrderItemQuery	productSalePrice(MoneyQueryDefinition queryDef) The sale price of the base product, including selected options
OrderItemQuery	productSku() The SKU of the base product
OrderItemQuery	productType() The type of product, such as simple, configurable, etc.
OrderItemQuery	productUrlKey() URL key of the base product
OrderItemQuery	quantityCanceled() The number of canceled items
OrderItemQuery	quantityInvoiced() The number of invoiced items
OrderItemQuery	quantityOrdered() The number of units ordered for this item
OrderItemQuery	quantityRefunded() The number of refunded items
OrderItemQuery	quantityReturned() The number of returned items
OrderItemQuery	quantityShipped() The number of shipped items
OrderItemQuery	selectedOptions(OrderItemOptionQueryDefinition queryDef) The selected options for the base product, such as color or size
OrderItemQuery	status() The status of the order item

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

discounts

public OrderItemQuery discounts(DiscountQueryDefinition queryDef)

The final discount information for the product

eligibleForReturn

public OrderItemQuery eligibleForReturn()

Indicates whether the order item is eligible is eligible to be in a return request

enteredOptions

public OrderItemQuery enteredOptions(OrderItemOptionQueryDefinition queryDef)

The entered option for the base product, such as a logo or image

giftWrapping

public OrderItemQuery giftWrapping(GiftWrappingQueryDefinition queryDef)

The selected gift wrapping for the order item

id

public OrderItemQuery id()

The unique ID for a `OrderItemInterface` object

productName

public OrderItemQuery productName()

The name of the base product

productSalePrice

public OrderItemQuery productSalePrice(MoneyQueryDefinition queryDef)

The sale price of the base product, including selected options

productSku

public OrderItemQuery productSku()

The SKU of the base product

productType

public OrderItemQuery productType()

The type of product, such as simple, configurable, etc.

productUrlKey

public OrderItemQuery productUrlKey()

URL key of the base product

quantityCanceled

public OrderItemQuery quantityCanceled()

The number of canceled items

quantityInvoiced

public OrderItemQuery quantityInvoiced()

The number of invoiced items

quantityOrdered

public OrderItemQuery quantityOrdered()

The number of units ordered for this item

quantityRefunded

public OrderItemQuery quantityRefunded()

The number of refunded items

quantityReturned

public OrderItemQuery quantityReturned()

The number of returned items

quantityShipped

public OrderItemQuery quantityShipped()

The number of shipped items

selectedOptions

public OrderItemQuery selectedOptions(OrderItemOptionQueryDefinition queryDef)

The selected options for the base product, such as color or size

status

public OrderItemQuery status()

The status of the order item

createFragment

public static Fragment<OrderItemQuery> createFragment(String name,
                                                      OrderItemQueryDefinition 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 OrderItemQuery addFragmentReference(Fragment<OrderItemQuery> fragment)

Adds a OrderItemQuery 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.

addOrderItemInterfaceFragmentReference

public OrderItemQuery addOrderItemInterfaceFragmentReference(Fragment<OrderItemInterfaceQuery> fragment)

Adds a OrderItemInterfaceQuery 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.

Parameters:

fragment - The fragment to reference.