QueryRoot

Version 2020-01 (Release candidate)

The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.

Connections

appInstallations (AppInstallationConnection!)

List of app installations.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

category ( AppInstallationCategory )

The category of app installations to fetch.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

privacy ( AppInstallationPrivacy )

The privacy level of app installations to fetch.
Default value: PUBLIC

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( AppInstallationSortKeys )

Sort the underlying list by the given key.
Default value: INSTALLED_AT

automaticDiscountNodes (DiscountAutomaticNodeConnection!)

List of automatic discounts.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • status
  • type

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( AutomaticDiscountSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

automaticDiscountSavedSearches (SavedSearchConnection!)

List of the shop's automatic discount saved searches.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

codeDiscountNodes (DiscountCodeNodeConnection!)

List of code discounts. Special fields for query params:

  • status: active, expired, scheduled
  • type: bxgy, fixed_amount, free_shipping, percentage.
after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • ends_at
  • starts_at
  • status
  • times_used
  • type
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( CodeDiscountSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

codeDiscountSavedSearches (SavedSearchConnection!)

List of the shop's code discount saved searches.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

collectionSavedSearches (SavedSearchConnection!)

List of the shop's collection saved searches.

Required access

read_products access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

collections (CollectionConnection!)

List of collections.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • collection_type
  • publishable_status
  • published_status
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( CollectionSortKeys )

Sort the underlying list by the given key.
Default value: ID

customerSavedSearches (SavedSearchConnection!)

List of the shop's customer saved searches.

Required access

read_customers access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • name

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( CustomerSavedSearchSortKeys )

Sort the underlying list by the given key.
Default value: ID

customers (CustomerConnection!)

List of customers.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • accepts_marketing
  • country
  • customer_date
  • email
  • last_abandoned_order_date
  • order_date
  • orders_count
  • phone
  • state
  • tag
  • total_spent
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( CustomerSortKeys )

Sort the underlying list by the given key.
Default value: ID

deletionEvents (DeletionEventConnection!)

The paginated list of deletion events.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • occurred_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( DeletionEventSortKeys )

Sort the underlying list by the given key.
Default value: ID

subjectTypes ( [DeletionEventSubjectType!] )

List of subject types to filter by.

deliveryProfiles (DeliveryProfileConnection!)

List of saved delivery profiles.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

merchantOwnedOnly ( Boolean )

Only include delivery profiles that are created by the merchant.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

draftOrderSavedSearches (SavedSearchConnection!)

List of the shop's draft order saved searches.

Required access

read_draft_orders access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

draftOrders (DraftOrderConnection!)

List of saved draft orders.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • customer_id
  • status
  • tag
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( DraftOrderSortKeys )

Sort the underlying list by the given key.
Default value: ID

inventoryItems (InventoryItemConnection!)

List of inventory items.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • id
  • sku
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

locations (LocationConnection!)

List of active locations.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

includeInactive ( Boolean )

If true, also include the locations that are deactivated.
Default value: false

includeLegacy ( Boolean )

If true, also include the legacy locations of fulfillment services.
Default value: false

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • active
  • address1
  • address2
  • city
  • country
  • legacy
  • name
  • province
  • zip

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( LocationSortKeys )

Sort the underlying list by the given key.
Default value: NAME

locationsAvailableForDeliveryProfilesConnection (LocationConnection!)

Returns a list of all origin locations available for a delivery profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

marketingActivities (MarketingActivityConnection!)

List of a campaign's marketing activities.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • app_id
  • created_at
  • marketing_campaign_id
  • tactic
  • title

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( MarketingActivitySortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

marketingEvents (MarketingEventConnection!)

List of marketing events.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • app_id
  • description
  • started_at
  • type

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( MarketingEventSortKeys )

Sort the underlying list by the given key.
Default value: ID

metafieldStorefrontVisibilities (MetafieldStorefrontVisibilityConnection!)

List of metafield namespaces and keys visible to the Storefront API.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

namespace ( String )

Filter the metafields storefront whitelist by namespace.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

orderSavedSearches (SavedSearchConnection!)

List of the shop's order saved searches.

Required access

read_orders access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

orders (OrderConnection!)

List of orders placed.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • cart_token
  • channel_id
  • chargeback_status
  • checkout_token
  • created_at
  • credit_card_last4
  • customer_id
  • discount_code
  • email
  • financial_status
  • fraud_protection_level
  • fulfillment_status
  • location_id
  • processed_at
  • reference_location_id
  • risk_level
  • sales_channel
  • source_name
  • status
  • tag
  • test
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( OrderSortKeys )

Sort the underlying list by the given key.
Default value: PROCESSED_AT

priceRuleSavedSearches (SavedSearchConnection!)

List of the shop's price rule saved searches.

Required access

read_price_rules access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

priceRules (PriceRuleConnection!)

List of price rules.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • discount_type
  • ends_at
  • starts_at
  • status
  • times_used
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( PriceRuleSortKeys )

Sort the underlying list by the given key.
Default value: ID

privateMetafields (PrivateMetafieldConnection!)

List of private metafields.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

namespace ( String )

Filter the private metafields by namespace.

owner ( ID! ) required

Retrieve the private metafields of a certain resource, specified by the resource ID.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

productSavedSearches (SavedSearchConnection!)

List of the shop's product saved searches.

Required access

read_products access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

productVariants (ProductVariantConnection!)

List of the product variants.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • barcode
  • collection
  • delivery_profile_id
  • gift_card
  • inventory_quantity
  • location_id
  • managed
  • managed_by
  • product_id
  • product_type
  • publishable_status
  • published_status
  • sku
  • tag
  • taxable
  • title
  • updated_at
  • vendor

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( ProductVariantSortKeys )

Sort the underlying list by the given key.
Default value: ID

products (ProductConnection!)

List of products.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • barcode
  • created_at
  • delivery_profile_id
  • error_feedback
  • gift_card
  • inventory_total
  • out_of_stock_somewhere
  • product_type
  • publishable_status
  • published_status
  • sku
  • tag
  • title
  • updated_at
  • vendor

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( ProductSortKeys )

Sort the underlying list by the given key.
Default value: ID

publications (PublicationConnection!)

List of the active publications.

Required access

read_publications access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

scriptTags (ScriptTagConnection!)

List of script tags.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

src ( URL )

The source URL of the script tag to filter by.

tenderTransactions (TenderTransactionConnection!)

List of TenderTransactions associated with the Shop.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • processed_at
  • test

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

translatableResources (TranslatableResourceConnection!)

List of translatable resources.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

resourceType ( TranslatableResourceType! ) required

Return only resources of a type.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

webhookSubscriptions (WebhookSubscriptionConnection!)

List of webhook subscriptions.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

callbackUrl ( URL )

Callback URL to filter by.

first ( Int )

Returns up to the first n elements from the list.

format ( WebhookSubscriptionFormat )

Response format to filter by.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( WebhookSubscriptionSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

topics ( [WebhookSubscriptionTopic!] )

List of webhook subscription topics to filter by.

Fields

app (App)

Lookup an App by ID or return the currently authenticated App.

id ( ID )

The ID to lookup the App by.

appByHandle (App)

Fetches app by handle. Returns null if the app doesn't exist.

handle ( String! ) required

Handle of the App.

appByKey (App)

Fetches app by apiKey. Returns null if the app doesn't exist.

apiKey ( String! ) required

API key of the App.

appInstallation (AppInstallation)

Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.

id ( ID )

ID used to lookup AppInstallation.

automaticDiscountNode (DiscountAutomaticNode)

Returns an automatic discount resource by ID.

id ( ID! ) required

The ID of the DiscountAutomaticNode to return.

availableCarrierServices ([DeliveryCarrierServiceAndLocations!]!)

List of activated carrier services and which shop locations support them.

availableLocales ([Locale!]!)

List of available locales.

carrierService (DeliveryCarrierService)

Lookup a carrier service by ID.

id ( ID! ) required

The ID of the DeliveryCarrierService to return.

codeDiscountNode (DiscountCodeNode)

Returns a code discount resource by ID.

id ( ID! ) required

The ID of the DiscountCodeNode to return.

codeDiscountNodeByCode (DiscountCodeNode)

Returns a code discount identified by its code.

code ( String! ) required

The code of the DiscountCodeNode to return.

collection (Collection)

Returns a Collection resource by ID.

id ( ID! ) required

The ID of the Collection to return.

collectionByHandle (Collection)

Return a collection by its handle.

handle ( String! ) required

The handle of the collection.

collectionRulesConditions ([CollectionRuleConditions!]!)

A list of rule conditions to define how collections with rules can be created.

currentAppInstallation (AppInstallation!)

Return the AppInstallation for the currently authenticated App.

currentBulkOperation (BulkOperation)

Returns the current app's most recent BulkOperation.

customer (Customer)

Returns a Customer resource by ID.

id ( ID! ) required

The ID of the Customer to return.

deliveryProfile (DeliveryProfile)

Lookup a Delivery Profile by ID.

id ( ID! ) required

The ID of the DeliveryProfile to return.

deliverySettings (DeliverySetting)

The shop-wide shipping settings.

domain (Domain)

Lookup a Domain by ID.

id ( ID! ) required

The ID of the Domain to return.

draftOrder (DraftOrder)

Returns a DraftOrder resource by ID.

id ( ID! ) required

The ID of the DraftOrder to return.

fulfillment (Fulfillment)

Returns a Fulfillment resource by ID.

id ( ID! ) required

The ID of the Fulfillment to return.

fulfillmentOrder (FulfillmentOrder)

Returns a Fulfillment order resource by ID.

id ( ID! ) required

The ID of the FulfillmentOrder to return.

inventoryItem (InventoryItem)

Returns an InventoryItem resource by ID.

id ( ID! ) required

The ID of the InventoryItem to return.

inventoryLevel (InventoryLevel)

Returns an InventoryLevel resource by ID.

id ( ID! ) required

The ID of the InventoryLevel to return.

job (Job)

Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.

id ( ID! ) required

ID of the job to query

location (Location)

Returns an inventory Location resource by ID.

id ( ID )

The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.

marketingActivity (MarketingActivity)

Returns a MarketingActivity resource by ID.

id ( ID! ) required

The ID of the MarketingActivity to return.

marketingEvent (MarketingEvent)

Returns a MarketingEvent resource by ID.

id ( ID! ) required

The ID of the MarketingEvent to return.

metafieldStorefrontVisibility (MetafieldStorefrontVisibility)

Returns metafield storefront visibility by ID.

id ( ID! ) required

The ID of the MetafieldStorefrontVisibility to return.

node (Node)

Returns a specific node by ID.

id ( ID! ) required

The ID of the Node to return.

nodes ([Node]!)

Returns the list of nodes with the given IDs.

ids ( [ID!]! ) required

The IDs of the Nodes to return.

order (Order)

Returns an Order resource by ID.

id ( ID! ) required

The ID of the Order to return.

priceRule (PriceRule)

Lookup a price rule by ID.

id ( ID! ) required

The ID of the PriceRule to return.

privateMetafield (PrivateMetafield)

Returns a private metafield by ID.

id ( ID! ) required

The ID of the PrivateMetafield to return.

product (Product)

Returns a Product resource by ID.

id ( ID! ) required

The ID of the Product to return.

productByHandle (Product)

Return a product by its handle.

handle ( String! ) required

The handle of the product.

productVariant (ProductVariant)

Returns a ProductVariant resource by ID.

id ( ID! ) required

The ID of the ProductVariant to return.

publicApiVersions ([ApiVersion!]!)

The list of public Admin API versions, including supported, release candidate and unstable versions.

publication (Publication)

Lookup a publication by ID.

id ( ID! ) required

The ID of the Publication to return.

refund (Refund)

Returns a Refund resource by ID.

id ( ID! ) required

The ID of the Refund to return.

scriptTag (ScriptTag)

Lookup a script tag resource by ID.

id ( ID! ) required

The ID of the ScriptTag to return.

shop (Shop!)

Returns a Shop resource corresponding to access token used in request.

shopLocales ([ShopLocale!]!)

List of locales available on a shop.

published ( Boolean )

Return only published locales.

translatableResource (TranslatableResource)

Translatable resource.

resourceId ( ID! ) required

Find a translatable resource by ID.

webhookSubscription (WebhookSubscription)

Returns a webhook subscription by ID.

id ( ID! ) required

The ID of the WebhookSubscription to return.

Deprecated fields

Show/Hide
automaticDiscount (DiscountAutomatic) deprecated

Returns an automatic discount resource by ID.

Deprecation warning

Use automaticDiscountNode instead

id ( ID! ) required

The ID of the DiscountAutomatic to return.

automaticDiscounts (DiscountAutomaticConnection!) deprecated

List of automatic discounts.

Deprecation warning

Use automaticDiscountNodes instead

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • status
  • type

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( AutomaticDiscountSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

channel (Channel) deprecated

Lookup a channel by ID.

Deprecation warning

Use publication instead

id ( ID! ) required

The ID of the Channel to return.

channels (ChannelConnection!) deprecated

List of the active sales channels.

Deprecation warning

Use publications instead

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

locationsAvailableForDeliveryProfiles ([Location!]) deprecated

Returns a list of all origin locations available for a delivery profile.

Deprecation warning

Use locationsAvailableForDeliveryProfilesConnection instead

Version 2019-10 (Latest)

The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.

Connections

appInstallations (AppInstallationConnection!)

List of app installations.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

category ( AppInstallationCategory )

The category of app installations to fetch.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

privacy ( AppInstallationPrivacy )

The privacy level of app installations to fetch.
Default value: PUBLIC

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( AppInstallationSortKeys )

Sort the underlying list by the given key.
Default value: INSTALLED_AT

automaticDiscountNodes (DiscountAutomaticNodeConnection!)

List of automatic discounts.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • status
  • type

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( AutomaticDiscountSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

automaticDiscountSavedSearches (SavedSearchConnection!)

List of the shop's automatic discount saved searches.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

codeDiscountNodes (DiscountCodeNodeConnection!)

List of code discounts. Special fields for query params:

  • status: active, expired, scheduled
  • type: bxgy, fixed_amount, free_shipping, percentage.
after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • ends_at
  • starts_at
  • status
  • times_used
  • type
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( CodeDiscountSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

codeDiscountSavedSearches (SavedSearchConnection!)

List of the shop's code discount saved searches.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

collectionSavedSearches (SavedSearchConnection!)

List of the shop's collection saved searches.

Required access

read_products access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

collections (CollectionConnection!)

List of collections.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • collection_type
  • publishable_status
  • published_status
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( CollectionSortKeys )

Sort the underlying list by the given key.
Default value: ID

customerSavedSearches (SavedSearchConnection!)

List of the shop's customer saved searches.

Required access

read_customers access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • name

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( CustomerSavedSearchSortKeys )

Sort the underlying list by the given key.
Default value: ID

customers (CustomerConnection!)

List of customers.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • accepts_marketing
  • country
  • customer_date
  • email
  • last_abandoned_order_date
  • order_date
  • orders_count
  • phone
  • state
  • tag
  • total_spent
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( CustomerSortKeys )

Sort the underlying list by the given key.
Default value: ID

deletionEvents (DeletionEventConnection!)

The paginated list of deletion events.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • occurred_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( DeletionEventSortKeys )

Sort the underlying list by the given key.
Default value: ID

subjectTypes ( [DeletionEventSubjectType!] )

List of subject types to filter by.

deliveryProfiles (DeliveryProfileConnection!)

List of saved delivery profiles.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

draftOrderSavedSearches (SavedSearchConnection!)

List of the shop's draft order saved searches.

Required access

read_draft_orders access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

draftOrders (DraftOrderConnection!)

List of saved draft orders.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • customer_id
  • status
  • tag
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( DraftOrderSortKeys )

Sort the underlying list by the given key.
Default value: ID

inventoryItems (InventoryItemConnection!)

List of inventory items.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • id
  • sku
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

locations (LocationConnection!)

List of active locations.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

includeInactive ( Boolean )

If true, also include the locations that are deactivated.
Default value: false

includeLegacy ( Boolean )

If true, also include the legacy locations of fulfillment services.
Default value: false

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • active
  • address1
  • address2
  • city
  • country
  • legacy
  • name
  • province
  • zip

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( LocationSortKeys )

Sort the underlying list by the given key.
Default value: NAME

locationsAvailableForDeliveryProfilesConnection (LocationConnection!)

Returns a list of all origin locations available for a delivery profile.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

marketingActivities (MarketingActivityConnection!)

List of a campaign's marketing activities.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • app_id
  • created_at
  • marketing_campaign_id
  • tactic
  • title

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( MarketingActivitySortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

marketingEvents (MarketingEventConnection!)

List of marketing events.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • app_id
  • description
  • started_at
  • type

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( MarketingEventSortKeys )

Sort the underlying list by the given key.
Default value: ID

metafieldStorefrontVisibilities (MetafieldStorefrontVisibilityConnection!)

List of metafield namespaces and keys visible to the Storefront API.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

namespace ( String )

Filter the metafields storefront whitelist by namespace.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

orderSavedSearches (SavedSearchConnection!)

List of the shop's order saved searches.

Required access

read_orders access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

orders (OrderConnection!)

List of orders placed.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • cart_token
  • channel_id
  • chargeback_status
  • checkout_token
  • created_at
  • credit_card_last4
  • customer_id
  • discount_code
  • email
  • financial_status
  • fraud_protection_level
  • fulfillment_status
  • location_id
  • processed_at
  • reference_location_id
  • risk_level
  • sales_channel
  • source_name
  • status
  • tag
  • test
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( OrderSortKeys )

Sort the underlying list by the given key.
Default value: PROCESSED_AT

priceRuleSavedSearches (SavedSearchConnection!)

List of the shop's price rule saved searches.

Required access

read_price_rules access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

priceRules (PriceRuleConnection!)

List of price rules.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • discount_type
  • ends_at
  • starts_at
  • status
  • times_used
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( PriceRuleSortKeys )

Sort the underlying list by the given key.
Default value: ID

privateMetafields (PrivateMetafieldConnection!)

List of private metafields.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

namespace ( String )

Filter the private metafields by namespace.

owner ( ID! ) required

Retrieve the private metafields of a certain resource, specified by the resource ID.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

productSavedSearches (SavedSearchConnection!)

List of the shop's product saved searches.

Required access

read_products access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

productVariants (ProductVariantConnection!)

List of the product variants.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • barcode
  • collection
  • delivery_profile_id
  • gift_card
  • inventory_quantity
  • location_id
  • managed
  • managed_by
  • product_id
  • product_type
  • publishable_status
  • published_status
  • sku
  • tag
  • taxable
  • title
  • updated_at
  • vendor

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( ProductVariantSortKeys )

Sort the underlying list by the given key.
Default value: ID

products (ProductConnection!)

List of products.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • barcode
  • created_at
  • delivery_profile_id
  • error_feedback
  • gift_card
  • inventory_total
  • out_of_stock_somewhere
  • product_type
  • publishable_status
  • published_status
  • sku
  • tag
  • title
  • updated_at
  • vendor

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( ProductSortKeys )

Sort the underlying list by the given key.
Default value: ID

publications (PublicationConnection!)

List of the active publications.

Required access

read_publications access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

scriptTags (ScriptTagConnection!)

List of script tags.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

src ( URL )

The source URL of the script tag to filter by.

tenderTransactions (TenderTransactionConnection!)

List of TenderTransactions associated with the Shop.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • processed_at
  • test

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

translatableResources (TranslatableResourceConnection!)

List of translatable resources.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

resourceType ( TranslatableResourceType! ) required

Return only resources of a type.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

webhookSubscriptions (WebhookSubscriptionConnection!)

List of webhook subscriptions.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

callbackUrl ( URL )

Callback URL to filter by.

first ( Int )

Returns up to the first n elements from the list.

format ( WebhookSubscriptionFormat )

Response format to filter by.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( WebhookSubscriptionSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

topics ( [WebhookSubscriptionTopic!] )

List of webhook subscription topics to filter by.

Fields

app (App)

Lookup an App by ID or return the currently authenticated App.

id ( ID )

The ID to lookup the App by.

appByHandle (App)

Fetches app by handle. Returns null if the app doesn't exist.

handle ( String! ) required

Handle of the App.

appByKey (App)

Fetches app by apiKey. Returns null if the app doesn't exist.

apiKey ( String! ) required

API key of the App.

appInstallation (AppInstallation)

Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.

id ( ID )

ID used to lookup AppInstallation.

automaticDiscountNode (DiscountAutomaticNode)

Returns an automatic discount resource by ID.

id ( ID! ) required

The ID of the DiscountAutomaticNode to return.

availableCarrierServices ([DeliveryCarrierServiceAndLocations!]!)

List of activated carrier services and which shop locations support them.

carrierService (DeliveryCarrierService)

Lookup a carrier service by ID.

id ( ID! ) required

The ID of the DeliveryCarrierService to return.

codeDiscountNode (DiscountCodeNode)

Returns a code discount resource by ID.

id ( ID! ) required

The ID of the DiscountCodeNode to return.

codeDiscountNodeByCode (DiscountCodeNode)

Returns a code discount identified by its code.

code ( String! ) required

The code of the DiscountCodeNode to return.

collection (Collection)

Returns a Collection resource by ID.

id ( ID! ) required

The ID of the Collection to return.

collectionByHandle (Collection)

Return a collection by its handle.

handle ( String! ) required

The handle of the collection.

collectionRulesConditions ([CollectionRuleConditions!]!)

A list of rule conditions to define how collections with rules can be created.

currentAppInstallation (AppInstallation!)

Return the AppInstallation for the currently authenticated App.

currentBulkOperation (BulkOperation)

Returns the current app's most recent BulkOperation.

customer (Customer)

Returns a Customer resource by ID.

id ( ID! ) required

The ID of the Customer to return.

deliveryProfile (DeliveryProfile)

Lookup a Delivery Profile by ID.

id ( ID! ) required

The ID of the DeliveryProfile to return.

deliverySettings (DeliverySetting)

The shop-wide shipping settings.

domain (Domain)

Lookup a Domain by ID.

id ( ID! ) required

The ID of the Domain to return.

draftOrder (DraftOrder)

Returns a DraftOrder resource by ID.

id ( ID! ) required

The ID of the DraftOrder to return.

fulfillment (Fulfillment)

Returns a Fulfillment resource by ID.

id ( ID! ) required

The ID of the Fulfillment to return.

inventoryItem (InventoryItem)

Returns an InventoryItem resource by ID.

id ( ID! ) required

The ID of the InventoryItem to return.

inventoryLevel (InventoryLevel)

Returns an InventoryLevel resource by ID.

id ( ID! ) required

The ID of the InventoryLevel to return.

job (Job)

Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.

id ( ID! ) required

ID of the job to query

location (Location)

Returns an inventory Location resource by ID.

id ( ID )

The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.

marketingActivity (MarketingActivity)

Returns a MarketingActivity resource by ID.

id ( ID! ) required

The ID of the MarketingActivity to return.

marketingEvent (MarketingEvent)

Returns a MarketingEvent resource by ID.

id ( ID! ) required

The ID of the MarketingEvent to return.

metafieldStorefrontVisibility (MetafieldStorefrontVisibility)

Returns metafield storefront visibility by ID.

id ( ID! ) required

The ID of the MetafieldStorefrontVisibility to return.

node (Node)

Returns a specific node by ID.

id ( ID! ) required

The ID of the Node to return.

nodes ([Node]!)

Returns the list of nodes with the given IDs.

ids ( [ID!]! ) required

The IDs of the Nodes to return.

order (Order)

Returns an Order resource by ID.

id ( ID! ) required

The ID of the Order to return.

priceRule (PriceRule)

Lookup a price rule by ID.

id ( ID! ) required

The ID of the PriceRule to return.

privateMetafield (PrivateMetafield)

Returns a private metafield by ID.

id ( ID! ) required

The ID of the PrivateMetafield to return.

product (Product)

Returns a Product resource by ID.

id ( ID! ) required

The ID of the Product to return.

productByHandle (Product)

Return a product by its handle.

handle ( String! ) required

The handle of the product.

productVariant (ProductVariant)

Returns a ProductVariant resource by ID.

id ( ID! ) required

The ID of the ProductVariant to return.

publicApiVersions ([ApiVersion!]!)

The list of public Admin API versions, including supported, release candidate and unstable versions.

publication (Publication)

Lookup a publication by ID.

id ( ID! ) required

The ID of the Publication to return.

refund (Refund)

Returns a Refund resource by ID.

id ( ID! ) required

The ID of the Refund to return.

scriptTag (ScriptTag)

Lookup a script tag resource by ID.

id ( ID! ) required

The ID of the ScriptTag to return.

shop (Shop!)

Returns a Shop resource corresponding to access token used in request.

shopLocales ([ShopLocale!]!)

List of locales available on a shop.

published ( Boolean )

Return only published locales.

translatableResource (TranslatableResource)

Translatable resource.

resourceId ( ID! ) required

Find a translatable resource by ID.

webhookSubscription (WebhookSubscription)

Returns a webhook subscription by ID.

id ( ID! ) required

The ID of the WebhookSubscription to return.

Deprecated fields

Show/Hide
automaticDiscount (DiscountAutomatic) deprecated

Returns an automatic discount resource by ID.

Deprecation warning

Use automaticDiscountNode instead

id ( ID! ) required

The ID of the DiscountAutomatic to return.

automaticDiscounts (DiscountAutomaticConnection!) deprecated

List of automatic discounts.

Deprecation warning

Use automaticDiscountNodes instead

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • status
  • type

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( AutomaticDiscountSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

channel (Channel) deprecated

Lookup a channel by ID.

Deprecation warning

Use publication instead

id ( ID! ) required

The ID of the Channel to return.

channels (ChannelConnection!) deprecated

List of the active sales channels.

Deprecation warning

Use publications instead

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

locationsAvailableForDeliveryProfiles ([Location!]) deprecated

Returns a list of all origin locations available for a delivery profile.

Deprecation warning

Use locationsAvailableForDeliveryProfilesConnection instead

Version 2019-07

The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.

Connections

appInstallations (AppInstallationConnection!)

List of app installations.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

category ( AppInstallationCategory )

The category of app installations to fetch.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

privacy ( AppInstallationPrivacy )

The privacy level of app installations to fetch.
Default value: PUBLIC

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( AppInstallationSortKeys )

Sort the underlying list by the given key.
Default value: INSTALLED_AT

automaticDiscountNodes (DiscountAutomaticNodeConnection!)

List of automatic discounts.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • status
  • type

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( AutomaticDiscountSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

automaticDiscountSavedSearches (SavedSearchConnection!)

List of the shop's automatic discount saved searches.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

codeDiscountNodes (DiscountCodeNodeConnection!)

List of code discounts. Special fields for query params:

  • status: active, expired, scheduled
  • type: bxgy, fixed_amount, free_shipping, percentage.
after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • ends_at
  • starts_at
  • status
  • times_used
  • type
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( CodeDiscountSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

codeDiscountSavedSearches (SavedSearchConnection!)

List of the shop's code discount saved searches.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

collectionSavedSearches (SavedSearchConnection!)

List of the shop's collection saved searches.

Required access

read_products access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

collections (CollectionConnection!)

List of collections.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • collection_type
  • publishable_status
  • published_status
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( CollectionSortKeys )

Sort the underlying list by the given key.
Default value: ID

customerSavedSearches (SavedSearchConnection!)

List of the shop's customer saved searches.

Required access

read_customers access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • name

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( CustomerSavedSearchSortKeys )

Sort the underlying list by the given key.
Default value: ID

customers (CustomerConnection!)

List of customers.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • accepts_marketing
  • country
  • customer_date
  • email
  • last_abandoned_order_date
  • order_date
  • orders_count
  • phone
  • state
  • tag
  • total_spent
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( CustomerSortKeys )

Sort the underlying list by the given key.
Default value: ID

deletionEvents (DeletionEventConnection!)

The paginated list of deletion events.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • occurred_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( DeletionEventSortKeys )

Sort the underlying list by the given key.
Default value: ID

subjectTypes ( [DeletionEventSubjectType!] )

List of subject types to filter by.

deliveryProfiles (DeliveryProfileConnection!)

List of saved delivery profiles.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

draftOrderSavedSearches (SavedSearchConnection!)

List of the shop's draft order saved searches.

Required access

read_draft_orders access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

draftOrders (DraftOrderConnection!)

List of saved draft orders.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • customer_id
  • status
  • tag
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( DraftOrderSortKeys )

Sort the underlying list by the given key.
Default value: ID

inventoryItems (InventoryItemConnection!)

List of inventory items.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • id
  • sku
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

locations (LocationConnection!)

List of active locations.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

includeInactive ( Boolean )

If true, also include the locations that are deactivated.
Default value: false

includeLegacy ( Boolean )

If true, also include the legacy locations of fulfillment services.
Default value: false

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • active
  • address1
  • address2
  • city
  • country
  • legacy
  • name
  • province
  • zip

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( LocationSortKeys )

Sort the underlying list by the given key.
Default value: NAME

marketingActivities (MarketingActivityConnection!)

List of a campaign's marketing activities.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • app_id
  • created_at
  • marketing_campaign_id
  • tactic
  • title

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( MarketingActivitySortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

marketingEvents (MarketingEventConnection!)

List of marketing events.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • app_id
  • description
  • started_at
  • type

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( MarketingEventSortKeys )

Sort the underlying list by the given key.
Default value: ID

metafieldStorefrontVisibilities (MetafieldStorefrontVisibilityConnection!)

List of metafield namespaces and keys visible to the Storefront API.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

namespace ( String )

Filter the metafields storefront whitelist by namespace.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

orderSavedSearches (SavedSearchConnection!)

List of the shop's order saved searches.

Required access

read_orders access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

orders (OrderConnection!)

List of orders placed.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • cart_token
  • channel_id
  • chargeback_status
  • checkout_token
  • created_at
  • credit_card_last4
  • customer_id
  • discount_code
  • email
  • financial_status
  • fraud_protection_level
  • fulfillment_status
  • location_id
  • processed_at
  • reference_location_id
  • risk_level
  • sales_channel
  • source_name
  • status
  • tag
  • test
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( OrderSortKeys )

Sort the underlying list by the given key.
Default value: PROCESSED_AT

priceRuleSavedSearches (SavedSearchConnection!)

List of the shop's price rule saved searches.

Required access

read_price_rules access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

priceRules (PriceRuleConnection!)

List of price rules.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • discount_type
  • ends_at
  • starts_at
  • status
  • times_used
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( PriceRuleSortKeys )

Sort the underlying list by the given key.
Default value: ID

productSavedSearches (SavedSearchConnection!)

List of the shop's product saved searches.

Required access

read_products access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

productVariants (ProductVariantConnection!)

List of the product variants.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • barcode
  • collection
  • delivery_profile_id
  • gift_card
  • inventory_quantity
  • location_id
  • managed
  • managed_by
  • product_id
  • product_type
  • publishable_status
  • published_status
  • sku
  • tag
  • taxable
  • title
  • updated_at
  • vendor

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( ProductVariantSortKeys )

Sort the underlying list by the given key.
Default value: ID

products (ProductConnection!)

List of products.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • barcode
  • created_at
  • delivery_profile_id
  • error_feedback
  • gift_card
  • inventory_total
  • out_of_stock_somewhere
  • product_type
  • publishable_status
  • published_status
  • sku
  • tag
  • title
  • updated_at
  • vendor

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( ProductSortKeys )

Sort the underlying list by the given key.
Default value: ID

publications (PublicationConnection!)

List of the active publications.

Required access

read_publications access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

scriptTags (ScriptTagConnection!)

List of script tags.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

src ( URL )

The source URL of the script tag to filter by.

tenderTransactions (TenderTransactionConnection!)

List of TenderTransactions associated with the Shop.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • processed_at
  • test

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

webhookSubscriptions (WebhookSubscriptionConnection!)

List of webhook subscriptions.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

callbackUrl ( URL )

Callback URL to filter by.

first ( Int )

Returns up to the first n elements from the list.

format ( WebhookSubscriptionFormat )

Response format to filter by.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( WebhookSubscriptionSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

topics ( [WebhookSubscriptionTopic!] )

List of webhook subscription topics to filter by.

Fields

app (App)

Lookup an App by ID or return the currently authenticated App.

id ( ID )

The ID to lookup the App by.

appByHandle (App)

Fetches app by handle. Returns null if the app doesn't exist.

handle ( String! ) required

Handle of the App.

appByKey (App)

Fetches app by apiKey. Returns null if the app doesn't exist.

apiKey ( String! ) required

API key of the App.

appInstallation (AppInstallation)

Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.

id ( ID )

ID used to lookup AppInstallation.

automaticDiscountNode (DiscountAutomaticNode)

Returns an automatic discount resource by ID.

id ( ID! ) required

The ID of the DiscountAutomaticNode to return.

availableCarrierServices ([DeliveryCarrierServiceAndLocations!]!)

List of activated carrier services and which shop locations support them.

carrierService (DeliveryCarrierService)

Lookup a carrier service by ID.

id ( ID! ) required

The ID of the DeliveryCarrierService to return.

codeDiscountNode (DiscountCodeNode)

Returns a code discount resource by ID.

id ( ID! ) required

The ID of the DiscountCodeNode to return.

codeDiscountNodeByCode (DiscountCodeNode)

Returns a code discount identified by its code.

code ( String! ) required

The code of the DiscountCodeNode to return.

collection (Collection)

Returns a Collection resource by ID.

id ( ID! ) required

The ID of the Collection to return.

collectionByHandle (Collection)

Return a collection by its handle.

handle ( String! ) required

The handle of the collection.

collectionRulesConditions ([CollectionRuleConditions!]!)

A list of rule conditions to define how collections with rules can be created.

currentAppInstallation (AppInstallation!)

Return the AppInstallation for the currently authenticated App.

customer (Customer)

Returns a Customer resource by ID.

id ( ID! ) required

The ID of the Customer to return.

deliveryProfile (DeliveryProfile)

Lookup a Delivery Profile by ID.

id ( ID! ) required

The ID of the DeliveryProfile to return.

deliverySettings (DeliverySetting)

The shop-wide shipping settings.

domain (Domain)

Lookup a Domain by ID.

id ( ID! ) required

The ID of the Domain to return.

draftOrder (DraftOrder)

Returns a DraftOrder resource by ID.

id ( ID! ) required

The ID of the DraftOrder to return.

fulfillment (Fulfillment)

Returns a Fulfillment resource by ID.

id ( ID! ) required

The ID of the Fulfillment to return.

inventoryItem (InventoryItem)

Returns an InventoryItem resource by ID.

id ( ID! ) required

The ID of the InventoryItem to return.

inventoryLevel (InventoryLevel)

Returns an InventoryLevel resource by ID.

id ( ID! ) required

The ID of the InventoryLevel to return.

job (Job)

Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.

id ( ID! ) required

ID of the job to query

location (Location)

Returns an inventory Location resource by ID.

id ( ID )

The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.

marketingActivity (MarketingActivity)

Returns a MarketingActivity resource by ID.

id ( ID! ) required

The ID of the MarketingActivity to return.

marketingEvent (MarketingEvent)

Returns a MarketingEvent resource by ID.

id ( ID! ) required

The ID of the MarketingEvent to return.

metafieldStorefrontVisibility (MetafieldStorefrontVisibility)

Returns metafield storefront visibility by ID.

id ( ID! ) required

The ID of the MetafieldStorefrontVisibility to return.

node (Node)

Returns a specific node by ID.

id ( ID! ) required

The ID of the Node to return.

nodes ([Node]!)

Returns the list of nodes with the given IDs.

ids ( [ID!]! ) required

The IDs of the Nodes to return.

order (Order)

Returns an Order resource by ID.

id ( ID! ) required

The ID of the Order to return.

priceRule (PriceRule)

Lookup a price rule by ID.

id ( ID! ) required

The ID of the PriceRule to return.

product (Product)

Returns a Product resource by ID.

id ( ID! ) required

The ID of the Product to return.

productByHandle (Product)

Return a product by its handle.

handle ( String! ) required

The handle of the product.

productVariant (ProductVariant)

Returns a ProductVariant resource by ID.

id ( ID! ) required

The ID of the ProductVariant to return.

publicApiVersions ([ApiVersion!]!)

The list of public Admin API versions, including supported, release candidate and unstable versions.

publication (Publication)

Lookup a publication by ID.

id ( ID! ) required

The ID of the Publication to return.

refund (Refund)

Returns a Refund resource by ID.

id ( ID! ) required

The ID of the Refund to return.

scriptTag (ScriptTag)

Lookup a script tag resource by ID.

id ( ID! ) required

The ID of the ScriptTag to return.

shop (Shop!)

Returns a Shop resource corresponding to access token used in request.

webhookSubscription (WebhookSubscription)

Returns a webhook subscription by ID.

id ( ID! ) required

The ID of the WebhookSubscription to return.

Deprecated fields

Show/Hide
activatedCarrierServices (DeliveryCarrierServiceConnection!) deprecated

List of activated carrier services.

Deprecation warning

Use availableCarrierServices instead

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

automaticDiscount (DiscountAutomatic) deprecated

Returns an automatic discount resource by ID.

Deprecation warning

Use automaticDiscountNode instead

id ( ID! ) required

The ID of the DiscountAutomatic to return.

automaticDiscounts (DiscountAutomaticConnection!) deprecated

List of automatic discounts.

Deprecation warning

Use automaticDiscountNodes instead

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • status
  • type

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( AutomaticDiscountSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

channel (Channel) deprecated

Lookup a channel by ID.

Deprecation warning

Use publication instead

id ( ID! ) required

The ID of the Channel to return.

channels (ChannelConnection!) deprecated

List of the active sales channels.

Deprecation warning

Use publications instead

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

locationsAvailableForDeliveryProfiles ([Location!]) deprecated

Returns a list of all origin locations available for a delivery profile.

Deprecation warning

Use locationsAvailableForDeliveryProfilesConnection instead

Version 2019-04

The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.

Connections

appInstallations (AppInstallationConnection!)

List of app installations.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

category ( AppInstallationCategory )

The category of app installations to fetch.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

privacy ( AppInstallationPrivacy )

The privacy level of app installations to fetch.
Default value: PUBLIC

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( AppInstallationSortKeys )

Sort the underlying list by the given key.
Default value: INSTALLED_AT

automaticDiscountNodes (DiscountAutomaticNodeConnection!)

List of automatic discounts.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • status
  • type

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( AutomaticDiscountSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

automaticDiscountSavedSearches (SavedSearchConnection!)

List of the shop's automatic discount saved searches.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

collectionSavedSearches (SavedSearchConnection!)

List of the shop's collection saved searches.

Required access

read_products access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

collections (CollectionConnection!)

List of collections.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • collection_type
  • publishable_status
  • published_status
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( CollectionSortKeys )

Sort the underlying list by the given key.
Default value: ID

customerSavedSearches (SavedSearchConnection!)

List of the shop's customer saved searches.

Required access

read_customers access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • name

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( CustomerSavedSearchSortKeys )

Sort the underlying list by the given key.
Default value: ID

customers (CustomerConnection!)

List of customers.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • accepts_marketing
  • country
  • customer_date
  • email
  • last_abandoned_order_date
  • order_date
  • orders_count
  • phone
  • state
  • tag
  • total_spent
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( CustomerSortKeys )

Sort the underlying list by the given key.
Default value: ID

deletionEvents (DeletionEventConnection!)

The paginated list of deletion events.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • occurred_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( DeletionEventSortKeys )

Sort the underlying list by the given key.
Default value: ID

subjectTypes ( [DeletionEventSubjectType!] )

List of subject types to filter by.

draftOrderSavedSearches (SavedSearchConnection!)

List of the shop's draft order saved searches.

Required access

read_draft_orders access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

draftOrders (DraftOrderConnection!)

List of saved draft orders.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • customer_id
  • status
  • tag
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( DraftOrderSortKeys )

Sort the underlying list by the given key.
Default value: ID

inventoryItems (InventoryItemConnection!)

List of inventory items.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • id
  • sku
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

locations (LocationConnection!)

List of active locations.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

includeInactive ( Boolean )

If true, also include the locations that are deactivated.
Default value: false

includeLegacy ( Boolean )

If true, also include the legacy locations of fulfillment services.
Default value: false

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • active
  • address1
  • address2
  • city
  • country
  • legacy
  • name
  • province
  • zip

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( LocationSortKeys )

Sort the underlying list by the given key.
Default value: NAME

marketingActivities (MarketingActivityConnection!)

List of a campaign's marketing activities.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • app_id
  • created_at
  • marketing_campaign_id
  • tactic
  • title

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( MarketingActivitySortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

marketingEvents (MarketingEventConnection!)

List of marketing events.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • app_id
  • description
  • started_at
  • type

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( MarketingEventSortKeys )

Sort the underlying list by the given key.
Default value: ID

orderSavedSearches (SavedSearchConnection!)

List of the shop's order saved searches.

Required access

read_orders access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

orders (OrderConnection!)

List of orders placed.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • cart_token
  • channel_id
  • chargeback_status
  • checkout_token
  • created_at
  • credit_card_last4
  • customer_id
  • discount_code
  • email
  • financial_status
  • fraud_protection_level
  • fulfillment_status
  • location_id
  • processed_at
  • reference_location_id
  • risk_level
  • sales_channel
  • source_name
  • status
  • tag
  • test
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( OrderSortKeys )

Sort the underlying list by the given key.
Default value: PROCESSED_AT

priceRuleSavedSearches (SavedSearchConnection!)

List of the shop's price rule saved searches.

Required access

read_price_rules access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

priceRules (PriceRuleConnection!)

List of price rules.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • discount_type
  • ends_at
  • starts_at
  • status
  • times_used
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( PriceRuleSortKeys )

Sort the underlying list by the given key.
Default value: ID

productSavedSearches (SavedSearchConnection!)

List of the shop's product saved searches.

Required access

read_products access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

productVariants (ProductVariantConnection!)

List of the product variants.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • barcode
  • collection
  • delivery_profile_id
  • gift_card
  • inventory_quantity
  • location_id
  • managed
  • managed_by
  • product_id
  • product_type
  • publishable_status
  • published_status
  • sku
  • tag
  • taxable
  • title
  • updated_at
  • vendor

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( ProductVariantSortKeys )

Sort the underlying list by the given key.
Default value: ID

products (ProductConnection!)

List of products.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • barcode
  • created_at
  • delivery_profile_id
  • error_feedback
  • gift_card
  • inventory_total
  • out_of_stock_somewhere
  • product_type
  • publishable_status
  • published_status
  • sku
  • tag
  • title
  • updated_at
  • vendor

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( ProductSortKeys )

Sort the underlying list by the given key.
Default value: ID

publications (PublicationConnection!)

List of the active publications.

Required access

read_publications access scope

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

scriptTags (ScriptTagConnection!)

List of script tags.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

src ( URL )

The source URL of the script tag to filter by.

tenderTransactions (TenderTransactionConnection!)

List of TenderTransactions associated with the Shop.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • processed_at
  • test

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

webhookSubscriptions (WebhookSubscriptionConnection!)

List of webhook subscriptions.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

callbackUrl ( URL )

Callback URL to filter by.

first ( Int )

Returns up to the first n elements from the list.

format ( WebhookSubscriptionFormat )

Response format to filter by.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( WebhookSubscriptionSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

topics ( [WebhookSubscriptionTopic!] )

List of webhook subscription topics to filter by.

Fields

app (App)

Lookup an App by ID or return the currently authenticated App.

id ( ID )

The ID to lookup the App by.

appByHandle (App)

Fetches app by handle. Returns null if the app doesn't exist.

handle ( String! ) required

Handle of the App.

appByKey (App)

Fetches app by apiKey. Returns null if the app doesn't exist.

apiKey ( String! ) required

API key of the App.

appInstallation (AppInstallation)

Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.

id ( ID )

ID used to lookup AppInstallation.

automaticDiscountNode (DiscountAutomaticNode)

Returns an automatic discount resource by ID.

id ( ID! ) required

The ID of the DiscountAutomaticNode to return.

collection (Collection)

Returns a Collection resource by ID.

id ( ID! ) required

The ID of the Collection to return.

collectionByHandle (Collection)

Return a collection by its handle.

handle ( String! ) required

The handle of the collection.

collectionRulesConditions ([CollectionRuleConditions!]!)

A list of rule conditions to define how collections with rules can be created.

currentAppInstallation (AppInstallation!)

Return the AppInstallation for the currently authenticated App.

customer (Customer)

Returns a Customer resource by ID.

id ( ID! ) required

The ID of the Customer to return.

domain (Domain)

Lookup a Domain by ID.

id ( ID! ) required

The ID of the Domain to return.

draftOrder (DraftOrder)

Returns a DraftOrder resource by ID.

id ( ID! ) required

The ID of the DraftOrder to return.

fulfillment (Fulfillment)

Returns a Fulfillment resource by ID.

id ( ID! ) required

The ID of the Fulfillment to return.

inventoryItem (InventoryItem)

Returns an InventoryItem resource by ID.

id ( ID! ) required

The ID of the InventoryItem to return.

inventoryLevel (InventoryLevel)

Returns an InventoryLevel resource by ID.

id ( ID! ) required

The ID of the InventoryLevel to return.

job (Job)

Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.

id ( ID! ) required

ID of the job to query

location (Location)

Returns an inventory Location resource by ID.

id ( ID )

The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.

marketingActivity (MarketingActivity)

Returns a MarketingActivity resource by ID.

id ( ID! ) required

The ID of the MarketingActivity to return.

marketingEvent (MarketingEvent)

Returns a MarketingEvent resource by ID.

id ( ID! ) required

The ID of the MarketingEvent to return.

node (Node)

Returns a specific node by ID.

id ( ID! ) required

The ID of the Node to return.

nodes ([Node]!)

Returns the list of nodes with the given IDs.

ids ( [ID!]! ) required

The IDs of the Nodes to return.

order (Order)

Returns an Order resource by ID.

id ( ID! ) required

The ID of the Order to return.

priceRule (PriceRule)

Lookup a price rule by ID.

id ( ID! ) required

The ID of the PriceRule to return.

product (Product)

Returns a Product resource by ID.

id ( ID! ) required

The ID of the Product to return.

productByHandle (Product)

Return a product by its handle.

handle ( String! ) required

The handle of the product.

productVariant (ProductVariant)

Returns a ProductVariant resource by ID.

id ( ID! ) required

The ID of the ProductVariant to return.

publicApiVersions ([ApiVersion!]!)

The list of public Admin API versions, including supported, release candidate and unstable versions.

publication (Publication)

Lookup a publication by ID.

id ( ID! ) required

The ID of the Publication to return.

refund (Refund)

Returns a Refund resource by ID.

id ( ID! ) required

The ID of the Refund to return.

scriptTag (ScriptTag)

Lookup a script tag resource by ID.

id ( ID! ) required

The ID of the ScriptTag to return.

shop (Shop!)

Returns a Shop resource corresponding to access token used in request.

webhookSubscription (WebhookSubscription)

Returns a webhook subscription by ID.

id ( ID! ) required

The ID of the WebhookSubscription to return.

Deprecated fields

Show/Hide
automaticDiscount (DiscountAutomatic) deprecated

Returns an automatic discount resource by ID.

Deprecation warning

Use automaticDiscountNode instead

id ( ID! ) required

The ID of the DiscountAutomatic to return.

automaticDiscounts (DiscountAutomaticConnection!) deprecated

List of automatic discounts.

Deprecation warning

Use automaticDiscountNodes instead

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • status
  • type

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( AutomaticDiscountSortKeys )

Sort the underlying list by the given key.
Default value: CREATED_AT

channel (Channel) deprecated

Lookup a channel by ID.

Deprecation warning

Use publication instead

id ( ID! ) required

The ID of the Channel to return.

channels (ChannelConnection!) deprecated

List of the active sales channels.

Deprecation warning

Use publications instead

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

Sign up for a Partner account to get started.

Sign up