Shop

non-null

Specifies whether the shop supports checkouts via Checkout API.

Anchor to contactEmailcontactEmail

•ShopCustomerAccountsSetting!

non-null

The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner.

Anchor to countriesInShippingZonescountriesInShippingZones

•CountriesInShippingZones!

non-null

Countries that have been defined in shipping zones for the shop.

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time when the shop was created.

Anchor to currencyCodecurrencyCode

•CurrencyCode!

non-null

The three letter code for the currency that the shop sells in.

Anchor to currencyFormatscurrencyFormats

•CurrencyFormats!

non-null

How currencies are displayed on your store.

Anchor to currencySettingscurrencySettings

•CurrencySettingConnection!

non-null

The presentment currency settings for the shop excluding the shop's own currency.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to customerAccountscustomerAccounts

non-null

Whether customer accounts are required, optional, or disabled for the shop.

Anchor to customerAccountsV2customerAccountsV2

•CustomerAccountsV2!

non-null

Information about the shop's customer accounts.

Anchor to customerTagscustomerTags

non-null

A list of tags that have been added to customer accounts.

Anchor to firstfirst •Int! required: The first n elements from the paginated list.

Anchor to descriptiondescription

•String

The shop's meta description used in search engine results.

Anchor to domainsPaginateddomainsPaginated

•DomainConnection!

non-null

The domains configured for the shop.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to host •string
Anchor to id •id: Filter by id range.

Anchor to draftOrderTagsdraftOrderTags

non-null

A list of tags that have been added to draft orders.

Anchor to firstfirst •Int! required: The first n elements from the paginated list.

Anchor to emailemail

non-null

The shop owner's email address. Shopify will use this email address to communicate with the shop owner.

Anchor to emailSenderConfigurationemailSenderConfiguration

•EmailSenderConfiguration!

non-null

The configuration for the shop email sender.

Anchor to enabledPresentmentCurrenciesenabledPresentmentCurrencies

•[CurrencyCode!]!

non-null

The presentment currencies enabled for the shop.

Anchor to entitlementsentitlements

•EntitlementsType!

non-null

The entitlements for a shop.

Anchor to featuresfeatures

•ShopFeatures!

non-null

The set of features enabled for the shop.

Anchor to fulfillmentServicesfulfillmentServices

•[FulfillmentService!]!

non-null

List of the shop's installed fulfillment services.

Anchor to ianaTimezoneianaTimezone

non-null

The shop's time zone as defined by the IANA.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to marketingSmsConsentEnabledAtCheckoutmarketingSmsConsentEnabledAtCheckout

•[HasMetafieldsIdentifier!]!

non-null

Whether SMS marketing has been enabled on the shop's checkout configuration settings.

Anchor to merchantApprovalSignalsmerchantApprovalSignals

•MerchantApprovalSignals

The approval signals for a shop to support onboarding to channel apps.

Anchor to merchantAppSignalsmerchantAppSignals

•MerchantAppSignals

Merchant signals for apps.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

•[Metafield]!

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

Anchor to myshopifyDomainmyshopifyDomain

non-null

The shop's .myshopify.com domain name.

Anchor to namename

non-null

The shop's name.

Anchor to navigationSettingsnavigationSettings

•[NavigationItem!]!

non-null

The shop's settings related to navigation.

Anchor to orderNumberFormatPrefixorderNumberFormatPrefix

non-null

The prefix that appears before order numbers.

Anchor to orderNumberFormatSuffixorderNumberFormatSuffix

non-null

The suffix that appears after order numbers.

Anchor to orderTagsorderTags

non-null

A list of tags that have been added to orders.

Arguments

•Int!

required

The first n elements from the paginated list.

Anchor to sortsort

•ShopTagSort

Default:ALPHABETICAL

Sort type.

Anchor to paymentSettingspaymentSettings

•PaymentSettings!

non-null

The shop's settings related to payments.

Anchor to planplan

•ShopPlan!

non-null

The shop's billing plan.

Anchor to primaryDomainprimaryDomain

•Domain!

non-null

The primary domain of the shop's online store.

Anchor to resourceLimitsresourceLimits

•ShopResourceLimits!

non-null

The shop's limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed.

Anchor to richTextEditorUrlrichTextEditorUrl

•URL!

non-null

The URL of the rich text editor that can be used for mobile devices.

Anchor to searchsearch

•SearchResultConnection!

non-null

Fetches a list of admin search results by a specified query.

Arguments

required

The search query to filter by.

Anchor to typestypes

•[SearchResultType!]

The search result types to filter by.

•Int!

required

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•SearchFilterOptions!

non-null

The list of search filter options for the shop. These can be used to filter productvisibility for the shop.

Anchor to setupRequiredsetupRequired

non-null

Whether the shop has outstanding setup steps.

Anchor to shipsToCountriesshipsToCountries

•[CountryCode!]!

non-null

The list of countries that the shop ships to.

Anchor to shopAddressshopAddress

•ShopAddress!

non-null

The shop's address information as it will appear to buyers.

Anchor to shopOwnerNameshopOwnerName

•StorefrontAccessTokenConnection!

non-null

The name of the shop owner.

Anchor to shopPoliciesshopPolicies

•[ShopPolicy!]!

non-null

The list of all legal policies associated with a shop.

Anchor to storefrontAccessTokensstorefrontAccessTokens

non-null

The storefront access token of a private application. These are scoped per-application.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to taxesIncludedtaxesIncluded

non-null

Whether applicable taxes are included in the shop's product prices.

Anchor to taxShippingtaxShipping

non-null

Whether the shop charges taxes for shipping.

Anchor to timezoneAbbreviationtimezoneAbbreviation

non-null

The shop's time zone abbreviation.

Anchor to timezoneOffsettimezoneOffset

non-null

The shop's time zone offset.

Anchor to timezoneOffsetMinutestimezoneOffsetMinutes

•Int!

non-null

The shop's time zone offset expressed as a number of minutes.

Anchor to transactionalSmsDisabledtransactionalSmsDisabled

non-null

Whether transactional SMS sent by Shopify have been disabled for a shop.

Anchor to translationstranslations

•[Translation!]!

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to unitSystemunitSystem

•UnitSystem!

non-null

The shop's unit system for weights and measures.

Anchor to updatedAtupdatedAt

•DateTime!

non-null

The date and time when the shop was last updated.

Anchor to urlurl

•URL!

non-null

The URL of the shop's online store.

Anchor to weightUnitweightUnit

•WeightUnit!

non-null

The shop's primary unit of weight for products and shipping.

Deprecated fields

Anchor to allProductCategoriesallProductCategories

•[ProductCategory!]!

non-nullDeprecated

Anchor to analyticsTokenanalyticsToken

•FulfillmentOrderConnection!

non-nullDeprecated

Anchor to assignedFulfillmentOrdersassignedFulfillmentOrders

non-nullDeprecated

Arguments

Anchor to assignmentStatusassignmentStatus

•FulfillmentOrderAssignmentStatus

The assigment status of the fulfillment orders that should be returned. If assignmentStatus argument is not provided, then the query will return all assigned fulfillment orders, except those that have the CLOSED status.

Anchor to locationIdslocationIds

•[ID!]

Returns fulfillment orders only for certain locations, specified by a list of location IDs.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•FulfillmentOrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to billingAddressbillingAddress

•ShopAddress!

non-nullDeprecated

Anchor to channelschannels

•ChannelConnection!

non-nullDeprecated

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to collectionscollections

•CollectionConnection!

non-nullDeprecated

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CollectionSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to collection_type •string
Anchor to handle •string
Anchor to id •id: Filter by id range.
Anchor to product_id •id: Filter by collections containing a product by its ID.
Anchor to product_publication_status •string: Filter by the publication status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values.
Anchor to publishable_status •string: Filter by the publishable status of the resource on a channel, such as the online store. The value is a composite of either the channel app ID (Channel.app.id) or channel name and one of the valid values.
Anchor to published_at •time: Filter by the date and time when the collection was published to the Online Store.
Anchor to published_status •string: Filter by the published status of the resource on a channel, such as the online store.
Anchor to title •string
Anchor to updated_at •time

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to customerscustomers

•CustomerConnection!

non-nullDeprecated

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CustomerSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•FulfillmentOrderConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to accepts_marketing •boolean: Filter by whether a customer has consented to receive marketing material.
Anchor to country •string: Filter by the country associated with the customer's address. Use either the country name or the two-letter country code.
Anchor to customer_date •time: Filter by the date and time when the customer record was created. This query parameter filters by the createdAt field.
Anchor to email •string: The customer's email address, used to communicate information about orders and for the purposes of email marketing campaigns. You can use a wildcard value to filter the query by customers who have an email address specified. Please note that email is a tokenized field: To retrieve exact matches, quote the email address (phrase query) as described in Shopify API search syntax.
Anchor to first_name •string: Filter by the customer's first name.
Anchor to id •id: Filter by id range.
Anchor to last_abandoned_order_date •time: Filter by the date and time of the customer's most recent abandoned checkout. An abandoned checkout occurs when a customer adds items to their cart, begins the checkout process, but leaves the site without completing their purchase.
Anchor to last_name •string: Filter by the customer's last name.
Anchor to order_date •time: Filter by the date and time that the order was placed by the customer. Use this query filter to check if a customer has placed at least one order within a specified date range.
Anchor to orders_count •integer: Filter by the total number of orders a customer has placed.
Anchor to phone •string: The phone number of the customer, used to communicate information about orders and for the purposes of SMS marketing campaigns. You can use a wildcard value to filter the query by customers who have a phone number specified.
Anchor to state •string: Filter by the state of the customer's account with the shop. This filter is only valid when Classic Customer Accounts is active.
Anchor to tag •string: Filter by the tags that are associated with the customer. This query parameter accepts multiple tags separated by commas.
Anchor to tag_not •string: Filter by the tags that aren't associated with the customer. This query parameter accepts multiple tags separated by commas.
Anchor to total_spent •float: Filter by the total amount of money a customer has spent across all orders.
Anchor to updated_at •time: The date and time, matching a whole day, when the customer's information was last updated.

Anchor to domainsdomains

•[Domain!]!

non-nullDeprecated

Anchor to fulfillmentOrdersfulfillmentOrders

non-nullDeprecated

Arguments

Anchor to includeClosedincludeClosed

Default:false

Whether to include closed fulfillment orders.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•FulfillmentOrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to assigned_location_id •id
Anchor to id •id: Filter by id range.
Anchor to status •string
Anchor to updated_at •time

Anchor to inventoryItemsinventoryItems

•InventoryItemConnection!

non-nullDeprecated

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to sku •string: Filter by the inventory item sku field. Learn more about SKUs.
Anchor to updated_at •time

Anchor to limitedPendingOrderCountlimitedPendingOrderCount

•LimitedPendingOrderCount!

non-nullDeprecated

Anchor to locationslocations

•LocationConnection!

non-nullDeprecated

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•LocationSortKeys

Default:NAME

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to active •string
Anchor to address1 •string
Anchor to address2 •string
Anchor to city •string
Anchor to country •string
Anchor to created_at •time
Anchor to geolocated •boolean
Anchor to id •id: Filter by id range.
Anchor to legacy •boolean
Anchor to location_id •id
Anchor to name •string
Anchor to pickup_in_store •string
Anchor to province •string
Anchor to zip •string

Anchor to includeLegacyincludeLegacy

Default:false

Whether to include the legacy locations of fulfillment services.

Anchor to includeInactiveincludeInactive

•MetafieldDefinitionConnection!

Default:false

Whether to include the locations that are deactivated.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

•MetafieldDefinitionPinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•MetafieldDefinitionSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to ordersorders

•OrderConnection!

non-nullDeprecated

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•OrderSortKeys

Default:PROCESSED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to cart_token •string: Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order.
Anchor to channel •string: Filter by the channel information handle (ChannelInformation.channelDefinition.handle) field.
Anchor to channel_id •id: Filter by the channel id field.
Anchor to chargeback_status •string: Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution.
Anchor to checkout_token •string: Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order.
Anchor to confirmation_number •string: Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique.
Anchor to created_at •time: Filter by the date and time when the order was created in Shopify's system.
Anchor to credit_card_last4 •string: Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security.
Anchor to current_total_price •float: Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges.
Anchor to customer_id •id: Filter orders by the customer id field.
Anchor to delivery_method •string: Filter by the delivery methodType field.
Anchor to discount_code •string: Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255.
Anchor to email •string: Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns.
Anchor to financial_status •string: Filter by the order displayFinancialStatus field.
Anchor to fraud_protection_level •string: Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes.
Anchor to fulfillment_location_id •id: Filter by the fulfillment location id (Fulfillment.location.id) field.
Anchor to fulfillment_status •string: Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing.
Anchor to gateway •string: Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways.
Anchor to id •id: Filter by id range.
Anchor to location_id •id: Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to name •string: Filter by the order name field.
Anchor to payment_id •string: Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues.
Anchor to payment_provider_id •id: Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions.
Anchor to po_number •string: Filter by the order poNumber field.
Anchor to processed_at •time: Filter by the order processedAt field.
Anchor to reference_location_id •id: Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location.
Anchor to return_status •string: Filter by the order's returnStatus to monitor returns processing and track which orders have active returns.
Anchor to risk_level •string: Filter by the order risk assessment riskLevel field.
Anchor to sales_channel •string: Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes.
Anchor to shipping_address_validation_result_summary •string: Filter by the validation status of the shipping address. Learn more about validating addresses.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to source_identifier •string: Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order.
Anchor to source_name •string: Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods.
Anchor to status •string: Filter by the order's status to manage workflows or analyze the order lifecycle.
Anchor to subtotal_line_items_quantity •string: Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to test •boolean: Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.
Anchor to total_weight •string: Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz.
Anchor to updated_at •time: Filter by the date and time when the order was last updated in Shopify's system.

Anchor to productImagesproductImages

•ImageConnection!

non-nullDeprecated

Arguments

Anchor to maxWidthmaxWidth

•Int

Deprecated

Anchor to maxHeightmaxHeight

•Int

Deprecated

Anchor to cropcrop

•CropRegion

Deprecated

Anchor to scalescale

•Int

DeprecatedDefault:1

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ProductImageSortKeys

Default:CREATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to productsproducts

•ProductConnection!

non-nullDeprecated

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ProductSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to barcode •string: Filter by the product variant barcode field.
Anchor to bundles •boolean: Filter by a product bundle. A product bundle is a set of two or more related products, which are commonly offered at a discount.
Anchor to category_id •string: Filter by the product category ID (product.category.id). A product category is the category of a product from Shopify's Standard Product Taxonomy.
Anchor to collection_id •id: Filter by the collection id field.
Anchor to combined_listing_role •string: Filter by the role of the product in a combined listing.
Anchor to created_at •time: Filter by the date and time when the product was created.
Anchor to delivery_profile_id •id: Filter by the delivery profile id field.
Anchor to error_feedback •string: Filter by products with publishing errors.
Anchor to gift_card •boolean: Filter by the product isGiftCard field.
Anchor to handle •string: Filter by a comma-separated list of product handles.
Anchor to has_only_composites •boolean: Filter by products that have only composite variants.
Anchor to has_only_default_variant •boolean: Filter by products that have only a default variant. A default variant is the only variant if no other variants are specified.
Anchor to has_variant_with_components •boolean: Filter by products that have variants with associated components.
Anchor to id •id: Filter by id range.
Anchor to inventory_total •integer: Filter by inventory count.
Anchor to is_price_reduced •boolean: Filter by products that have a reduced price. For more information, refer to the CollectionRule object.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to out_of_stock_somewhere •boolean: Filter by products that are out of stock in at least one location.
Anchor to price •bigdecimal: Filter by the product variant price field.
Anchor to product_configuration_owner •string: Filter by the app id field.
Anchor to product_publication_status •string: Filter by the publication status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values.
Anchor to product_type •string: Filter by a comma-separated list of product types.
Anchor to publication_ids •string: Filter by a comma-separated list of publication IDs that are associated with the product.
Anchor to publishable_status •string: Filter by the publishable status of the resource on a channel, such as the online store. The value is a composite of either the channel app ID (Channel.app.id) or channel name and one of the valid values.
Anchor to published_at •time: Filter by the date and time when the product was published to the online store and other sales channels.
Anchor to published_status •string: Filter by the published status of the resource on a channel, such as the online store.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to status •string: Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to title •string: Filter by the product title field.
Anchor to updated_at •time: Filter by the date and time when the product was last updated.
Anchor to variant_id •id: Filter by the product variant id field.
Anchor to variant_title •string: Filter by the product variant title field.
Anchor to vendor •string: Filter by the origin or source of the product. Learn more about vendors and managing vendor information.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to productTagsproductTags

non-nullDeprecated

Anchor to firstfirst •Int! required: The first n elements from the paginated list.

Anchor to productTypesproductTypes

non-nullDeprecated

Anchor to firstfirst •Int! required: The first n elements from the paginated list.

Anchor to productVariantsproductVariants

•ProductVariantConnection!

non-nullDeprecated

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ProductVariantSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to barcode •string: Filter by the product variant barcode field.
Anchor to collection •string: Filter by the ID of the collection that the product variant belongs to.
Anchor to delivery_profile_id •id: Filter by the product variant delivery profile ID (ProductVariant.deliveryProfile.id).
Anchor to exclude_composite •boolean: Filter by product variants that aren't composites.
Anchor to exclude_variants_with_components •boolean: Filter by whether there are components that are associated with the product variants in a bundle.
Anchor to gift_card •boolean: Filter by the product isGiftCard field.
Anchor to id •id: Filter by id range.
Anchor to inventory_quantity •integer: Filter by an aggregate of inventory across all locations where the product variant is stocked.
Anchor to location_id •id: Filter by the location ID for the product variant.
Anchor to managed •boolean: Filter by whether there is fulfillment service tracking associated with the product variants.
Anchor to managed_by •string: Filter by the fulfillment service that tracks the number of items in stock for the product variant.
Anchor to option1 •string: Filter by a custom property that a shop owner uses to define product variants.
Anchor to option2 •string: Filter by a custom property that a shop owner uses to define product variants.
Anchor to option3 •string: Filter by a custom property that a shop owner uses to define product variants.
Anchor to product_id •id: Filter by the product id field.
Anchor to product_ids •string: Filter by a comma-separated list of product IDs.
Anchor to product_publication_status •string: Filter by the publication status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values.
Anchor to product_status •string: Filter by a comma-separated list of product statuses.
Anchor to product_type •string: Filter by the product type that's associated with the product variants.
Anchor to publishable_status •string: Filter by the publishable status of the resource on a channel, such as the online store. The value is a composite of either the channel app ID (Channel.app.id) or channel name and one of the valid values.
Anchor to published_status •string: Filter by the published status of the resource on a channel, such as the online store.
Anchor to requires_components •boolean: Filter by whether the product variant can only be purchased with components. Learn more.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to taxable •boolean: Filter by the product variant taxable field.
Anchor to title •string: Filter by the product variant title field.
Anchor to updated_at •time: Filter by date and time when the product variant was updated.
Anchor to vendor •string: Filter by the origin or source of the product variant. Learn more about vendors and managing vendor information.

Anchor to productVendorsproductVendors

Anchor to collectionDelete collectionDelete

non-nullDeprecated

Anchor to firstfirst •Int! required: The first n elements from the paginated list.

Anchor to publicationCountpublicationCount

•Int!

non-nullDeprecated

Anchor to staffMembersstaffMembers

•StaffMemberConnection!

non-nullDeprecated

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to storefrontUrlstorefrontUrl

•URL!

non-nullDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to shop shop •query: Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop.

Was this section helpful?

Anchor to MutationsMutations

•mutation

Deletes a collection and removes it permanently from the store. This operation cannot be undone and will remove the collection from all sales channels where it was published.

For example, when merchants discontinue seasonal promotions or reorganize their catalog structure, they can delete outdated collections like "Back to School 2023" to keep their store organized.

Use CollectionDelete to:

Remove outdated or unused collections from stores
Clean up collection structures during catalog reorganization
Implement collection management tools with deletion capabilities

Products within the deleted collection remain in the store but are no longer grouped under that collection.

Learn more about collection management.

Arguments

Anchor to customerDelete customerDelete

•CollectionDeleteInput!

required

The collection to delete.

•mutation

Deletes a Customer from the store. You can only delete customers who haven't placed any orders.

Apps using protected customer data must meet Shopify's protected customer data requirements.

Arguments

Anchor to delegateAccessTokenCreate delegateAccessTokenCreate

•CustomerDeleteInput!

required

Specifies the customer to delete.

•mutation

Creates a DelegateAccessToken with a subset of the parent token's permissions.

Delegate access tokens enable secure permission delegation to subsystems or services that need limited access to shop resources. Each token inherits only the scopes you specify, ensuring subsystems operate with minimal required permissions rather than full app access.

Learn more about delegating access tokens to subsystems.

Arguments

Anchor to delegateAccessTokenDestroy delegateAccessTokenDestroy

•DelegateAccessTokenInput!

required

The input fields for creating a delegate access token.

•mutation

Destroys a delegate access token.

Anchor to accessTokenaccessToken •String! required: Provides the delegate access token to destroy.

Anchor to productCreate productCreate

•mutation

Creates a product with attributes such as title, description, vendor, and media.

The productCreate mutation helps you create many products at once, avoiding the tedious or time-consuming process of adding them one by one in the Shopify admin. Common examples include creating products for a new collection, launching a new product line, or adding seasonal products.

You can define product options and values, allowing you to create products with different variations like sizes or colors. You can also associate media files to your products, including images and videos.

The productCreate mutation only supports creating a product with its initial product variant. To create multiple product variants for a single product and manage prices, use the productVariantsBulkCreate mutation.

Note

The productCreate mutation has a throttle that takes effect when a store has 50,000 product variants. After this threshold is reached, no more than 1,000 new product variants can be created per day.

After you create a product, you can make subsequent edits to the product using one of the following mutations:

publishablePublish: Used to publish the product and make it available to customers. The productCreate mutation creates products in an unpublished state by default, so you must perform a separate operation to publish the product.
productUpdate: Used to update a single product, such as changing the product's title, description, vendor, or associated media.
productSet: Used to perform multiple operations on products, such as creating or modifying product options and variants.

Learn more about the product model and adding product data.

Arguments

Anchor to productPreferencesproductPreferences

•ProductPreferencesInput

The default preferences in the product create form.

Anchor to productDelete productDelete

•ProductInput

Deprecated

Anchor to productproduct

•ProductCreateInput

The attributes of the new product.

Anchor to mediamedia

•[CreateMediaInput!]

The media to add to the product.

•mutation

Permanently deletes a product and all its associated data, including variants, media, publications, and inventory items.

Use the productDelete mutation to programmatically remove products from your store when they need to be permanently deleted from your catalog, such as when removing discontinued items, cleaning up test data, or synchronizing with external inventory management systems.

The productDelete mutation removes the product from all associated collections, and removes all associated data for the product, including:

All product variants and their inventory items
Product media (images, videos) that are not referenced by other products
Product options and option values
Product publications across all sales channels
Product tags and metadata associations

The productDelete mutation also has the following effects on existing orders and transactions:

Draft orders: Existing draft orders that reference this product will retain the product information as stored data, but the product reference will be removed. Draft orders can still be completed with the stored product details.
Completed orders and refunds: Previously completed orders that included this product aren't affected. The product information in completed orders is preserved for record-keeping, and existing refunds for this product remain valid and processable.

Caution

Product deletion is irreversible. After a product is deleted, it can't be recovered. Consider archiving or unpublishing products instead if you might need to restore them later.

If you need to delete a large product, such as one that has many variants that are active at several locations, you might encounter timeout errors. To avoid these timeout errors, you can set the synchronous parameter to false to run the deletion asynchronously, which returns a ProductDeleteOperation that you can monitor for completion status.

If you need more granular control over product cleanup, consider using these alternative mutations:

productUpdate: Update the product status to archived or unpublished instead of deleting.
productVariantsBulkDelete: Delete specific variants while keeping the product.
productOptionsDelete: Delete the choices available for a product, such as size, color, or material.

Learn more about the product model.

Arguments

•ProductDeleteInput!

required

Specifies the product to delete by its ID.

Anchor to synchronoussynchronous

Anchor to productDuplicate productDuplicate

Default:true

Specifies whether or not to run the mutation synchronously.

•mutation

Duplicates a product.

If you need to duplicate a large product, such as one that has many variants that are active at several locations, you might encounter timeout errors.

To avoid these timeout errors, you can instead duplicate the product asynchronously.

In API version 2024-10 and higher, include synchronous: false argument in this mutation to perform the duplication asynchronously.

In API version 2024-07 and lower, use the asynchronous ProductDuplicateAsyncV2.

Metafield values are not duplicated if the unique values capability is enabled.

Arguments

Anchor to productIdproductId

•ID!

required

The ID of the product to be duplicated.

Anchor to newTitlenewTitle

required

The new title of the product.

Anchor to newStatusnewStatus

•ProductStatus

The new status of the product. If no value is provided the status will be inherited from the original product.

Anchor to includeImagesincludeImages

Default:false

Specifies whether or not to duplicate images.

Anchor to includeTranslationsincludeTranslations

Default:false

Specifies whether or not to duplicate translations.

Anchor to synchronoussynchronous

Anchor to publishablePublish publishablePublish

Default:true

Specifies whether or not to run the mutation synchronously.

•mutation

Publishes a resource, such as a Product or Collection, to one or more publications.

For products to be visible in a channel, they must have an active ProductStatus. Products sold exclusively on subscription (requiresSellingPlan: true) can only be published to online stores.

You can schedule future publication by providing a publish date. Only online store channels support scheduled publishing.

Arguments

Anchor to idid

•ID!

required

The resource to create or update publications for.

Anchor to publishablePublishToCurrentChannel publishablePublishToCurrentChannel

•[PublicationInput!]!

required

Specifies the input fields required to publish a resource.

•mutation

Publishes a resource to the current Channel associated with the requesting app. The system determines the current channel by the app's API client ID. Resources include Product and Collection objects that implement the Publishable interface.

For products to be visible in the channel, they must have an active ProductStatus. Products sold exclusively on subscription (requiresSellingPlan: true) can only be published to online stores.

Anchor to idid •ID! required: The resource to create or update publications for.

Anchor to publishableUnpublish publishableUnpublish

•mutation

Unpublishes a resource, such as a Product or Collection, from one or more publications. The resource remains in your store but becomes unavailable to customers.

For products to be visible in a channel, they must have an active ProductStatus.

Arguments

Anchor to idid

•ID!

required

The resource to delete or update publications for.

Anchor to publishableUnpublishToCurrentChannel publishableUnpublishToCurrentChannel

•[PublicationInput!]!

required

Specifies the input fields required to unpublish a resource.

•mutation

Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Anchor to idid •ID! required: The resource to delete or update publications for.

Anchor to savedSearchDelete savedSearchDelete

•mutation

Delete a saved search.

Arguments