com.adobe.cq.commerce.magento.graphql

Class ReturnQuery

java.lang.Object

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

com.adobe.cq.commerce.magento.graphql.ReturnQuery

public class ReturnQuery
extends AbstractQuery<ReturnQuery>

Customer return

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
ReturnQuery	addFragmentReference(Fragment<ReturnQuery> fragment) Adds a ReturnQuery fragment reference at the current position of the query.
ReturnQuery	availableShippingCarriers(ReturnShippingCarrierQueryDefinition queryDef) A list of shipping carriers available for returns
ReturnQuery	comments(ReturnCommentQueryDefinition queryDef) A list of comments posted for the return request
ReturnQuery	createdAt() The date the return was requested
static Fragment<ReturnQuery>	createFragment(String name, ReturnQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
ReturnQuery	customer(ReturnCustomerQueryDefinition queryDef) The data from customer who created the return request
ReturnQuery	items(ReturnItemQueryDefinition queryDef) A list of items being returned
ReturnQuery	number() Human-readable return number
ReturnQuery	order(CustomerOrderQueryDefinition queryDef) The order associated with the return
ReturnQuery	shipping(ReturnShippingQueryDefinition queryDef) Shipping information for the return
ReturnQuery	status() The status of the return request
ReturnQuery	uid() The unique ID for a `Return` object

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

availableShippingCarriers

public ReturnQuery availableShippingCarriers(ReturnShippingCarrierQueryDefinition queryDef)

A list of shipping carriers available for returns

comments

public ReturnQuery comments(ReturnCommentQueryDefinition queryDef)

A list of comments posted for the return request

createdAt

public ReturnQuery createdAt()

The date the return was requested

customer

public ReturnQuery customer(ReturnCustomerQueryDefinition queryDef)

The data from customer who created the return request

items

public ReturnQuery items(ReturnItemQueryDefinition queryDef)

A list of items being returned

number

public ReturnQuery number()

Human-readable return number

order

public ReturnQuery order(CustomerOrderQueryDefinition queryDef)

The order associated with the return

shipping

public ReturnQuery shipping(ReturnShippingQueryDefinition queryDef)

Shipping information for the return

status

public ReturnQuery status()

The status of the return request

uid

public ReturnQuery uid()

The unique ID for a `Return` object

createFragment

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

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