QueryRoot

Version 2019-04 (latest)

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

Show definition

"""
The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.
"""
type QueryRoot {
  """
  Lookup an App by ID or return the currently authenticated App.
  """
  app(
    """
    The ID to lookup the App by.
    """
    id: ID
  ): App
  """
  Fetches app by handle.
  Returns null if the app doesn't exist.
  """
  appByHandle(
    """
    Handle of the App.
    """
    handle: String!
  ): App
  """
  Fetches app by apiKey.
  Returns null if the app doesn't exist.
  """
  appByKey(
    """
    API key of the App.
    """
    apiKey: String!
  ): App
  """
  Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.
  """
  appInstallation(
    """
    ID used to lookup AppInstallation.
    """
    id: ID
  ): AppInstallation
  """
  List of app installations.
  """
  appInstallations(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    The category of app installations to fetch.
    """
    category: AppInstallationCategory
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    The privacy level of app installations to fetch.
    """
    privacy: AppInstallationPrivacy = PUBLIC
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: AppInstallationSortKeys = INSTALLED_AT
  ): AppInstallationConnection!
  """
  Lookup a channel by ID.
  """
  channel(
    """
    The ID of the Channel to return.
    """
    id: ID!
  ): Channel
  """
  List of the active sales channels.
  """
  channels(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): ChannelConnection!
  """
  Returns a Collection resource by ID.
  """
  collection(
    """
    The ID of the Collection to return.
    """
    id: ID!
  ): Collection
  """
  Return a collection by its handle.
  """
  collectionByHandle(
    """
    The handle of the collection.
    """
    handle: String!
  ): Collection
  """
  A list of rule conditions to define how collections with rules can be created.
  """
  collectionRulesConditions: [CollectionRuleConditions!]!
  """
  List of the shop's collection saved searches.
  """
  collectionSavedSearches(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): SavedSearchConnection!
  """
  List of collections.
  """
  collections(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - collection_type
     - published_status
     - title
     - updated_at
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    ID of an existing saved search.
    The search’s query string will be used as the query argument.
    """
    savedSearchId: ID
    """
    Sort the underlying list by the given key.
    """
    sortKey: CollectionSortKeys = ID
  ): CollectionConnection!
  """
  Return the AppInstallation for the currently authenticated App.
  """
  currentAppInstallation: AppInstallation!
  """
  Returns a Customer resource by ID.
  """
  customer(
    """
    The ID of the Customer to return.
    """
    id: ID!
  ): Customer
  """
  List of the shop's customer saved searches.
  """
  customerSavedSearches(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - name
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: CustomerSavedSearchSortKeys = ID
  ): SavedSearchConnection!
  """
  List of customer accounts.
  """
  customers(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    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.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: CustomerSortKeys = ID
  ): CustomerConnection!
  """
  The paginated list of deletion events.
  """
  deletionEvents(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - occurred_at
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: DeletionEventSortKeys = ID
    """
    List of subject types to filter by.
    """
    subjectTypes: [DeletionEventSubjectType!]
  ): DeletionEventConnection!
  """
  Lookup a Domain by ID.
  """
  domain(
    """
    The ID of the Domain to return.
    """
    id: ID!
  ): Domain
  """
  Returns a DraftOrder resource by ID.
  """
  draftOrder(
    """
    The ID of the DraftOrder to return.
    """
    id: ID!
  ): DraftOrder
  """
  List of the shop's draft order saved searches.
  """
  draftOrderSavedSearches(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): SavedSearchConnection!
  """
  List of saved draft orders.
  """
  draftOrders(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - created_at
     - customer_id
     - status
     - tag
     - updated_at
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: DraftOrderSortKeys = ID
  ): DraftOrderConnection!
  """
  Returns a Fulfillment resource by ID.
  """
  fulfillment(
    """
    The ID of the Fulfillment to return.
    """
    id: ID!
  ): Fulfillment
  """
  Returns an InventoryItem resource by ID.
  """
  inventoryItem(
    """
    The ID of the InventoryItem to return.
    """
    id: ID!
  ): InventoryItem
  """
  List of inventory items.
  """
  inventoryItems(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - created_at
     - id
     - sku
     - updated_at
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): InventoryItemConnection!
  """
  Returns an InventoryLevel resource by ID.
  """
  inventoryLevel(
    """
    The ID of the InventoryLevel to return.
    """
    id: ID!
  ): InventoryLevel
  """
  Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
  """
  job(
    """
    ID of the job to query
    """
    id: ID!
  ): Job
  """
  Returns an inventory Location resource by ID.
  """
  location(
    """
    The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.
    """
    id: ID
  ): Location
  """
  List of active locations.
  """
  locations(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    If true, also include the locations that are deactivated.
    """
    includeInactive: Boolean = false
    """
    If true, also include the legacy locations of fulfillment services.
    """
    includeLegacy: Boolean = false
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - active
     - address1
     - address2
     - city
     - country
     - legacy
     - name
     - province
     - zip
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: LocationSortKeys = NAME
  ): LocationConnection!
  """
  List of a campaign's marketing activities.
  """
  marketingActivities(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - app_id
     - created_at
     - marketing_campaign_id
     - tactic
     - title
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    ID of an existing saved search.
    The search’s query string will be used as the query argument.
    """
    savedSearchId: ID
    """
    Sort the underlying list by the given key.
    """
    sortKey: MarketingActivitySortKeys = CREATED_AT
  ): MarketingActivityConnection!
  """
  Returns a MarketingActivity resource by ID.
  """
  marketingActivity(
    """
    The ID of the MarketingActivity to return.
    """
    id: ID!
  ): MarketingActivity
  """
  Returns a MarketingEvent resource by ID.
  """
  marketingEvent(
    """
    The ID of the MarketingEvent to return.
    """
    id: ID!
  ): MarketingEvent
  """
  List of marketing events.
  """
  marketingEvents(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - app_id
     - description
     - started_at
     - type
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: MarketingEventSortKeys = ID
  ): MarketingEventConnection!
  """
  Returns a specific node by ID.
  """
  node(
    """
    The ID of the Node to return.
    """
    id: ID!
  ): Node
  """
  Returns the list of nodes with the given IDs.
  """
  nodes(
    """
    The IDs of the Nodes to return.
    """
    ids: [ID!]!
  ): [Node]!
  """
  Returns an Order resource by ID.
  """
  order(
    """
    The ID of the Order to return.
    """
    id: ID!
  ): Order
  """
  List of the shop's order saved searches.
  """
  orderSavedSearches(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): SavedSearchConnection!
  """
  List of orders placed.
  """
  orders(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    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.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    ID of an existing saved search.
    The search’s query string will be used as the query argument.
    """
    savedSearchId: ID
    """
    Sort the underlying list by the given key.
    """
    sortKey: OrderSortKeys = PROCESSED_AT
  ): OrderConnection!
  """
  Lookup a price rule by ID.
  """
  priceRule(
    """
    The ID of the PriceRule to return.
    """
    id: ID!
  ): PriceRule
  """
  List of the shop's price rule saved searches.
  """
  priceRuleSavedSearches(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): SavedSearchConnection!
  """
  List of price rules.
  """
  priceRules(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - created_at
     - discount_type
     - ends_at
     - starts_at
     - status
     - times_used
     - updated_at
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    ID of an existing saved search.
    The search’s query string will be used as the query argument.
    """
    savedSearchId: ID
    """
    Sort the underlying list by the given key.
    """
    sortKey: PriceRuleSortKeys = ID
  ): PriceRuleConnection!
  """
  Returns a Product resource by ID.
  """
  product(
    """
    The ID of the Product to return.
    """
    id: ID!
  ): Product
  """
  Return a product by its handle.
  """
  productByHandle(
    """
    The handle of the product.
    """
    handle: String!
  ): Product
  """
  List of the shop's product saved searches.
  """
  productSavedSearches(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): SavedSearchConnection!
  """
  Returns a ProductVariant resource by ID.
  """
  productVariant(
    """
    The ID of the ProductVariant to return.
    """
    id: ID!
  ): ProductVariant
  """
  List of the product variants.
  """
  productVariants(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - barcode
     - collection
     - delivery_profile_id
     - gift_card
     - inventory_quantity
     - location_id
     - managed
     - managed_by
     - product_id
     - product_type
     - published_status
     - sku
     - tag
     - taxable
     - title
     - updated_at
     - vendor
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    ID of an existing saved search.
    The search’s query string will be used as the query argument.
    """
    savedSearchId: ID
    """
    Sort the underlying list by the given key.
    """
    sortKey: ProductVariantSortKeys = ID
  ): ProductVariantConnection!
  """
  List of products.
  """
  products(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - barcode
     - created_at
     - delivery_profile_id
     - error_feedback
     - gift_card
     - inventory_total
     - out_of_stock_somewhere
     - product_type
     - published_status
     - sku
     - tag
     - title
     - updated_at
     - vendor
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    ID of an existing saved search.
    The search’s query string will be used as the query argument.
    """
    savedSearchId: ID
    """
    Sort the underlying list by the given key.
    """
    sortKey: ProductSortKeys = ID
  ): ProductConnection!
  """
  The list of public Admin API versions, including supported, release candidate and unstable versions.
  """
  publicApiVersions: [ApiVersion!]!
  """
  Lookup a publication by ID.
  """
  publication(
    """
    The ID of the Publication to return.
    """
    id: ID!
  ): Publication
  """
  List of the active publications.
  """
  publications(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): PublicationConnection!
  """
  Returns a Refund resource by ID.
  """
  refund(
    """
    The ID of the Refund to return.
    """
    id: ID!
  ): Refund
  """
  Generated messages for the resource type provided.
  Typically they appear on top of the resource page.
  """
  resourceAlerts(
    """
    The resource type to filter the alerts by.
    """
    type: ResourceType!
  ): [ResourceAlert!]!
  """
  Lookup a script tag resource by ID.
  """
  scriptTag(
    """
    The ID of the ScriptTag to return.
    """
    id: ID!
  ): ScriptTag
  """
  List of script tags.
  """
  scriptTags(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    The source URL of the script tag to filter by.
    """
    src: URL
  ): ScriptTagConnection!
  """
  Returns a Shop resource corresponding to access token used in request.
  """
  shop: Shop!
  """
  Shopify Payments account information, including balances and payouts.
  """
  shopifyPaymentsAccount: ShopifyPaymentsAccount
  """
  List of TenderTransactions associated with the Shop.
  """
  tenderTransactions(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - processed_at
     - test
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): TenderTransactionConnection!
  """
  Returns a webhook subscription by ID.
  """
  webhookSubscription(
    """
    The ID of the WebhookSubscription to return.
    """
    id: ID!
  ): WebhookSubscription
  """
  List of webhook subscriptions.
  """
  webhookSubscriptions(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Callback URL to filter by.
    """
    callbackUrl: URL
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Response format to filter by.
    """
    format: WebhookSubscriptionFormat
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - created_at
     - updated_at
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: WebhookSubscriptionSortKeys = CREATED_AT
    """
    List of webhook subscription topics to filter by.
    """
    topics: [WebhookSubscriptionTopic!]
  ): WebhookSubscriptionConnection!
}

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: true

reverse ( Boolean )

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

sortKey ( AppInstallationSortKeys )

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

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: true

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
  • published_status
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

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

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: true

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: true

sortKey ( CustomerSavedSearchSortKeys )

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

customers (CustomerConnection!)

List of customer accounts.

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: true

sortKey ( CustomerSortKeys )

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

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: true

sortKey ( DeletionEventSortKeys )

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

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: true

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: true

sortKey ( DraftOrderSortKeys )

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

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: true

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: true

includeLegacy ( Boolean )

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

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: true

sortKey ( LocationSortKeys )

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

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: true

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: true

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: true

sortKey ( MarketingEventSortKeys )

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

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: true

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: true

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: true

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: true

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: true

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: true

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: true

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
  • 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: true

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: true

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
  • published_status
  • sku
  • tag
  • title
  • updated_at
  • vendor

See the detailed search syntax.

reverse ( Boolean )

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

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: true

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: true

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: true

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: true

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: true

sortKey ( WebhookSubscriptionSortKeys )

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

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.

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.

resourceAlerts ([ResourceAlert!]!)

Generated messages for the resource type provided. Typically they appear on top of the resource page.

type ( ResourceType! ) required

The resource type to filter the alerts by.

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.

shopifyPaymentsAccount (ShopifyPaymentsAccount)

Shopify Payments account information, including balances and payouts.

webhookSubscription (WebhookSubscription)

Returns a webhook subscription by ID.

id ( ID! ) required

The ID of the WebhookSubscription to return.

Deprecated fields

Show/Hide
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: true

Sign up for a Partner account to get started.

Sign up