com.adobe.cq.commerce.magento.graphql

Class OrderShipmentQuery

java.lang.Object

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

com.adobe.cq.commerce.magento.graphql.OrderShipmentQuery

public class OrderShipmentQuery
extends AbstractQuery<OrderShipmentQuery>

Order shipment details

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
OrderShipmentQuery	addFragmentReference(Fragment<OrderShipmentQuery> fragment) Adds a OrderShipmentQuery fragment reference at the current position of the query.
OrderShipmentQuery	comments(SalesCommentItemQueryDefinition queryDef) Comments added to the shipment
static Fragment<OrderShipmentQuery>	createFragment(String name, OrderShipmentQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
OrderShipmentQuery	id() The unique ID for a `OrderShipment` object
OrderShipmentQuery	items(ShipmentItemInterfaceQueryDefinition queryDef) Contains items included in the shipment
OrderShipmentQuery	number() The sequential credit shipment number
OrderShipmentQuery	tracking(ShipmentTrackingQueryDefinition queryDef) Contains shipment tracking details

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

comments

public OrderShipmentQuery comments(SalesCommentItemQueryDefinition queryDef)

Comments added to the shipment

id

public OrderShipmentQuery id()

The unique ID for a `OrderShipment` object

items

public OrderShipmentQuery items(ShipmentItemInterfaceQueryDefinition queryDef)

Contains items included in the shipment

number

public OrderShipmentQuery number()

The sequential credit shipment number

tracking

public OrderShipmentQuery tracking(ShipmentTrackingQueryDefinition queryDef)

Contains shipment tracking details

createFragment

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

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