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 afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
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 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 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

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 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 keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

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

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

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

•String

The elements that come after the specified cursor.

•Int!

required

The first n elements from the paginated list.

required

The search query to filter by.

Anchor to typestypes

•[SearchResultType!]

The search result types to filter by.

•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 afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
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

•FulfillmentOrderAssignmentStatus

•String

The elements that come after the specified cursor.

Anchor to assignmentStatusassignmentStatus

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.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to locationIdslocationIds

•[ID!]

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

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

Anchor to collectionscollections

•CollectionConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
collection_type	string		- `custom` - `smart`
handle	string
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
product_id	id	Filter by collections containing a product by its ID.
product_publication_status	string	Filter by channel approval process
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. For simple visibility checks, use published_status
instead.	- `* {channel_app_id}-approved` - `*
{channel_app_id}-rejected`<br/> -` * {channel_app_id}-needs_action` -
`* {channel_app_id}-awaiting_review` - `*
{channel_app_id}-published`<br/> -` * {channel_app_id}-demoted`<br/> -` *
{channel_app_id}-scheduled`<br/> -` *
{channel_app_id}-provisionally_published`		-
`product_publication_status:189769876-approved`
publishable_status	string	Deprecated: This parameter is deprecated
as of 2025-12 and will be removed in a future API version. Use published_status
for visibility checks. Filter by the publishable status of the resource on a
channel. The value is a composite of the [channel `app`
ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price)
(`Channel.app.id`) and one of the valid status values.	- `*
{channel_app_id}-unset`<br/> -` * {channel_app_id}-pending`<br/> -` *
{channel_app_id}-approved`<br/> -` * {channel_app_id}-not_approved`		-
`publishable_status:580111-unset` - `publishable_status:580111-pending`
published_at	time	Filter by the date and time when the collection was published to the Online Store.
published_status	string	Filter resources by their visibility and
publication state on a channel. Online store channel filtering: -
`online_store_channel`: Returns all resources in the online store channel,
regardless of publication status. - `published`/`visible`: Returns resources
that are published to the online store. - `unpublished`: Returns resources
that are not published to the online store. Channel-specific filtering using
a channel ID, channel handle, [channel `app`
ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price)
(`Channel.app.id`), or app handle with suffixes: -
`{id_or_handle}-published`: Returns resources published to the specified
channel. - `{id_or_handle}-visible`: Same as `{id_or_handle}-published`
(kept for backwards compatibility). - `{id_or_handle}-intended`: Returns
resources added to the channel but not yet published. -
`{id_or_handle}-hidden`: Returns resources not added to the channel or not
published. Other: - `unavailable`: Returns resources not published to any
channel.	- `online_store_channel` - `published` - `visible`

unpublished
- * {channel_id_or_handle}-published
- * {channel_id_or_handle}-visible
- * {channel_id_or_handle}-intended
- * {channel_id_or_handle}-hidden
- * {channel_app_id_or_handle}-published
- * {channel_app_id_or_handle}-visible
- * {channel_app_id_or_handle}-intended
- * {channel_app_id_or_handle}-hidden
- unavailable | | - published_status:online_store_channel
- published_status:published
- published_status:580111-published
published_status:580111-hidden
- published_status:my-channel-handle-published
- published_status:unavailable | | title | string | | updated_at | time | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

Anchor to savedSearchIdsavedSearchId

•ID

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

•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.

Anchor to customerscustomers

•CustomerConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
accepts_marketing	boolean	Filter by whether a customer has consented
to receive marketing material.			- `accepts_marketing:true`
country	string	Filter by the country associated with the customer's
address. Use either the country name or the two-letter country code.			-
`country:Canada` - `country:JP`
customer_date	time	Filter by the date and time when the customer
record was created. This query parameter filters by the `createdAt`
field.			- `customer_date:'2024-03-15T14:30:00Z'` - `customer_date:

='2024-01-01'| | 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](https://shopify.dev/docs/api/usage/search-syntax). | | | -email:gmail.com - email:"bo.wang@example.com" - email:*| | first_name | string | Filter by the customer's first name. | | | -first_name:Jane| | id | id | Filter byidrange. | | | -id:1234 - id:>=1234 - id:<=1234| | 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. | | | -last_abandoned_order_date:'2024-04-01T10:00:00Z' - last_abandoned_order_date: >='2024-01-01'| | last_name | string | Filter by the customer's last name. | | | -last_name:Reeves| | 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. | | | -order_date:'2024-02-20T00:00:00Z' - order_date: >='2024-01-01'`

order_date:'2024-01-01..2024-03-31' | | orders_count | integer | Filter by the total number of orders a customer has placed. | | | - orders_count:5 | | 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. | | | - phone:+18005550100
- phone:* | | 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. | | | - state:ENABLED
- state:INVITED
- state:DISABLED
- state:DECLINED | | tag | string | Filter by the tags that are associated with the customer. This query parameter accepts multiple tags separated by commas. | | | - tag:'VIP' - tag:'Wholesale,Repeat' | | tag_not | string | Filter by the tags that aren't associated with the customer. This query parameter accepts multiple tags separated by commas. | | | - tag_not:'Prospect' - tag_not:'Test,Internal' | | total_spent | float | Filter by the total amount of money a customer has spent across all orders. | | | - total_spent:100.50
- total_spent:50.00
- total_spent:>100.50
- total_spent:>50.00 | | updated_at | time | The date and time, matching a whole day, when the customer's information was last updated. | | | - updated_at:2024-01-01T00:00:00Z
- updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

•FulfillmentOrderConnection!

•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.

Anchor to domainsdomains

•[Domain!]!

non-nullDeprecated

Anchor to fulfillmentOrdersfulfillmentOrders

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

Anchor to includeClosedincludeClosed

Default:false

Whether to include closed fulfillment orders.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
assigned_location_id	id
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
status	string
updated_at	time
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).

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 inventoryItemsinventoryItems

•InventoryItemConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

Anchor to created_at •time
Anchor to id •id: Filter by id range.

Default:false

Reverse the order of the underlying list.

Anchor to limitedPendingOrderCountlimitedPendingOrderCount

•LimitedPendingOrderCount!

non-nullDeprecated

Anchor to locationslocations

•LocationConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

Anchor to includeInactiveincludeInactive

Default:false

Whether to include the locations that are deactivated.

Anchor to includeLegacyincludeLegacy

Default:false

Whether to include the legacy locations of fulfillment services.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
active	string
address1	string
address2	string
city	string
country	string
created_at	time
geolocated	boolean
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
legacy	boolean
location_id	id
name	string
pickup_in_store	string		- `enabled` - `disabled`
province	string
zip	string
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).

Default:false

Reverse the order of the underlying list.

•MetafieldDefinitionConnection!

•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.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•MetafieldDefinitionPinnedStatus

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
created_at	time	Filter by the date and time when the metafield
definition was created.			- `created_at:>2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
key	string	Filter by the metafield definition `key`
field.			- `key:some-key`
namespace	string	Filter by the metafield definition `namespace`
field.			- `namespace:some-namespace`
owner_type	string	Filter by the metafield definition `ownerType`
field.			- `owner_type:PRODUCT`
type	string	Filter by the metafield definition `type`
field.			- `type:single_line_text_field`
updated_at	time	Filter by the date and time when the metafield
definition was last updated.			- `updated_at:>2020-10-21T23:39:20Z`

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

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.

Anchor to ordersorders

•OrderConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
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.			-
`cart_token:abc123`
channel	string	Filter by the channel information `handle`
(`ChannelInformation.channelDefinition.handle`) field.			-
`channel:web` - `channel:web,pos`
channel_id	id	Filter by the channel `id`
field.			- `channel_id:123`
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.	- `accepted` - `charge_refunded` -
`lost` - `needs_response` - `under_review` - `won`		-
`chargeback_status:accepted`
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.			-
`checkout_token:abc123`
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.			- `confirmation_number:ABC123`
created_at	time	Filter by the date and time when the order was created
in Shopify's system.			- `created_at:2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
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.			-
`credit_card_last4:1234`
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.			-
`current_total_price:10` - `current_total_price:>=5.00
current_total_price:<=20.99`
customer_id	id	Filter orders by the customer `id`
field.			- `customer_id:123`
delivery_method	string	Filter by the delivery `methodType`
field.	- `shipping` - `pick-up` - `retail` - `local` -
`pickup-point` - `none`		- `delivery_method:shipping`
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.			- `discount_code:ABC123`
email	string	Filter by the email address that's associated with the
order to provide customer support or analyze purchasing patterns.			-
`email:example@shopify.com`
financial_status	string	Filter by the order `displayFinancialStatus`
field.	- `paid` - `pending` - `authorized` -
`partially_paid` - `partially_refunded` - `refunded` -
`voided` - `expired`		- `financial_status:authorized`
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.	- `fully_protected` - `partially_protected` -
`not_protected` - `pending` - `not_eligible` -
`not_available`		- `fraud_protection_level:fully_protected`
fulfillment_location_id	id	Filter by the fulfillment location `id`
(`Fulfillment.location.id`) field.			- `fulfillment_location_id:123`
fulfillment_status	string	Filter by the `displayFulfillmentStatus`
field to prioritize shipments or monitor order processing.	-
`unshipped` - `shipped` - `fulfilled` - `partial` -
`scheduled` - `on_hold` - `unfulfilled` - `request_declined`
	- `fulfillment_status:fulfilled`
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.			- `gateway:shopify_payments`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
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.			- `location_id:123`
metafields.{namespace}.{key}	mixed	Filters resources by metafield
value. Format: `metafields.{namespace}.{key}:{value}`. Learn more about
querying by metafield value.
		- `metafields.custom.on_sale:true` -
`metafields.product.material:"gid://shopify/Metaobject/43458085"`
name	string	Filter by the order `name`
field.			- `name:1001-A`
payment_id	string	Filter by the payment ID that's associated with the
order to reconcile financial records or troubleshoot payment issues.			-
`payment_id:abc123`
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.			- `payment_provider_id:123`
po_number	string	Filter by the order `poNumber`
field.			- `po_number:P01001`
processed_at	time	Filter by the order `processedAt`
field.			- `processed_at:2021-01-01T00:00:00Z`
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.			- `reference_location_id:123`
return_status	string	Filter by the order's `returnStatus`
to monitor returns processing and track which orders have active returns.

return_requested
- in_progress
- inspection_complete
returned
- return_failed
- no_return | | - return_status:in_progress | | risk_level | string | Filter by the order risk assessment riskLevel field. | - high
- medium
- low
- none
- pending | | - risk_level:high | | sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | | | - sales_channel: some_sales_channel | | sku | string | Filter by the product variant sku field. Learn more about SKUs. | | | - sku:ABC123 | | 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. | | | - source_identifier:1234-12-1000 | | 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. | | | - source_name:web
- source_name:shopify_draft_order | | status | string | Filter by the order's status to manage workflows or analyze the order lifecycle. | - open
- closed
- cancelled
- not_closed | | - status:open | | 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. | | | - subtotal_line_items_quantity:10
- subtotal_line_items_quantity:5..20 | | tag | string | Filter objects by the tag field. | | | - tag:my_tag | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - tag_not:my_tag | | test | boolean | Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. | | | - test:true | | 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. | | | - total_weight:10.5kg
- total_weight:>=5g total_weight:<=20g
total_weight:.5 lb | | updated_at | time | Filter by the date and time when the order was last updated in Shopify's system. | | | - updated_at:2020-10-21T23:39:20Z
updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

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.

Anchor to productImagesproductImages

•ImageConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

Anchor to cropcrop

•CropRegion

Deprecated

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to maxHeightmaxHeight

•Int

Deprecated

Anchor to maxWidthmaxWidth

•Int

Deprecated

Default:false

Reverse the order of the underlying list.

Anchor to scalescale

•Int

DeprecatedDefault:1

•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

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
barcode	string	Filter by the product variant `barcode`
field.			- `barcode:ABC-abc-1234`
bundles	boolean	Filter by a [product
bundle](https://shopify.dev/docs/apps/build/product-merchandising/bundles).
A product bundle is a set of two or more related products, which are
commonly offered at a discount.			- `bundles:true`
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.
		- `category_id:sg-4-17-2-17`
collection_id	id	Filter by the collection `id`
field.			- `collection_id:108179161409`
combined_listing_role	string	Filter by the role of the product in a combined listing.
- `parent` - `child` - `no_role`		-
`combined_listing_role:parent`
created_at	time	Filter by the date and time when the product was
created.			- `created_at:>'2020-10-21T23:39:20Z'` -
`created_at:<now` - `created_at:<='2024'`
delivery_profile_id	id	Filter by the delivery profile `id`
field.			- `delivery_profile_id:108179161409`
error_feedback	string	Filter by products with publishing errors.
gift_card	boolean	Filter by the product `isGiftCard`
field.			- `gift_card:true`
handle	string	Filter by a comma-separated list of product handles.
		- `handle:the-minimal-snowboard`
has_only_composites	boolean	Filter by products that have only
composite variants.			- `has_only_composites:true`
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.			- `has_only_default_variant:true`
has_variant_with_components	boolean	Filter by products that have
variants with associated components.			-
`has_variant_with_components:true`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
inventory_total	integer	Filter by inventory count.		-
`inventory_total:0` - `inventory_total:>150` -
`inventory_total:>=200`
is_price_reduced	boolean	Filter by products that have a reduced price.
For more information, refer to the `CollectionRule`
object.			- `is_price_reduced:true`
metafields.{namespace}.{key}	mixed	Filters resources by metafield
value. Format: `metafields.{namespace}.{key}:{value}`. Learn more about
querying by metafield value.
		- `metafields.custom.on_sale:true` -
`metafields.product.material:"gid://shopify/Metaobject/43458085"`
out_of_stock_somewhere	boolean	Filter by products that are out of
stock in at least one location.			- `out_of_stock_somewhere:true`
price	bigdecimal	Filter by the product variant `price`
field.			- `price:100.57`
product_configuration_owner	string	Filter by the app
`id`
field.			- `product_configuration_owner:10001`
product_publication_status	string	Filter by channel approval process
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. For simple visibility checks, use published_status
instead.	- `* {channel_app_id}-approved` - `*
{channel_app_id}-rejected`<br/> -` * {channel_app_id}-needs_action` -
`* {channel_app_id}-awaiting_review` - `*
{channel_app_id}-published`<br/> -` * {channel_app_id}-demoted`<br/> -` *
{channel_app_id}-scheduled`<br/> -` *
{channel_app_id}-provisionally_published`		-
`product_publication_status:189769876-approved`
product_type	string	Filter by a comma-separated list of [product
types](https://help.shopify.com/manual/products/details/product-type).

product_type:snowboard | | publication_ids | string | Filter by a comma-separated list of publication IDs that are associated with the product. | | | - publication_ids:184111530305,184111694145 | | publishable_status | string | Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values. | - * {channel_app_id}-unset
- * {channel_app_id}-pending
- * {channel_app_id}-approved
- * {channel_app_id}-not_approved | | - publishable_status:580111-unset
- publishable_status:580111-pending | | published_at | time | Filter by the date and time when the product was published to the online store and other sales channels. | | | - published_at:>2020-10-21T23:39:20Z
- published_at:<now
- published_at:<=2024 | | published_status | string | Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. | - online_store_channel
- published
- visible
unpublished
- * {channel_id_or_handle}-published
- * {channel_id_or_handle}-visible
- * {channel_id_or_handle}-intended
- * {channel_id_or_handle}-hidden
- * {channel_app_id_or_handle}-published
- * {channel_app_id_or_handle}-visible
- * {channel_app_id_or_handle}-intended
- * {channel_app_id_or_handle}-hidden
- unavailable | | - published_status:online_store_channel
- published_status:published
- published_status:580111-published
published_status:580111-hidden
- published_status:my-channel-handle-published
- published_status:unavailable | | sku | string | Filter by the product variant sku field. Learn more about SKUs. | | | - sku:XYZ-12345 | | 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. | - active
- archived
- draft | active | - status:active,draft | | tag | string | Filter objects by the tag field. | | | - tag:my_tag | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - tag_not:my_tag | | title | string | Filter by the product title field. | | | - title:The Minimal Snowboard | | tracks_inventory | boolean | Filter by products that have inventory tracking enabled. | | | - tracks_inventory:true | | updated_at | time | Filter by the date and time when the product was last updated. | | | - updated_at:>'2020-10-21T23:39:20Z'
- updated_at:<now
- updated_at:<='2024' | | variant_id | id | Filter by the product variant id field. | | | - variant_id:45779434701121 | | variant_title | string | Filter by the product variant title field. | | | - variant_title:'Special ski wax' | | vendor | string | Filter by the origin or source of the product. Learn more about vendors and managing vendor information. | | | - vendor:Snowdevil
- vendor:Snowdevil OR vendor:Icedevil | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

Anchor to savedSearchIdsavedSearchId

•ID

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

•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.

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

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
barcode	string	Filter by the product variant `barcode`
field.			- `barcode:ABC-abc-123`
collection	string	Filter by the ID of the collection
that the product variant belongs to.			- `collection:465903092033`
delivery_profile_id	id	Filter by the product variant delivery profile ID
(`ProductVariant.deliveryProfile.id`).			-
`delivery_profile_id:108179161409`
exclude_composite	boolean	Filter by product variants that aren't composites.		- `exclude_composite:true`
exclude_variants_with_components	boolean	Filter by whether there are components
that are associated with the product variants in a bundle.			-
`exclude_variants_with_components:true`
gift_card	boolean	Filter by the product `isGiftCard`
field.			- `gift_card:true`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
inventory_quantity	integer	Filter by an aggregate of inventory across
all locations where the product variant is stocked.			-
`inventory_quantity:10`
location_id	id	Filter by the [location
ID](https://shopify.dev/api/admin-graphql/latest/objects/Location#field-id)
for the product variant.			- `location_id:88511152449`
managed	boolean	Filter by whether there is fulfillment service
tracking associated with the product variants.			- `managed:true`
managed_by	string	Filter by the fulfillment service that tracks the
number of items in stock for the product variant.			-
`managed_by:shopify`
option1	string	Filter by a custom property that a shop owner uses to
define product variants.			- `option1:small`
option2	string	Filter by a custom property that a shop owner uses to
define product variants.			- `option2:medium`
option3	string	Filter by a custom property that a shop owner uses to
define product variants.			- `option3:large`
product_id	id	Filter by the product `id`
field.			- `product_id:8474977763649`
product_ids	string	Filter by a comma-separated list of product IDs.
		- `product_ids:8474977763649,8474977796417`
product_publication_status	string	Filter by channel approval process
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. For simple visibility checks, use published_status
instead.	- `* {channel_app_id}-approved` - `*
{channel_app_id}-rejected`<br/> -` * {channel_app_id}-needs_action` -
`* {channel_app_id}-awaiting_review` - `*
{channel_app_id}-published`<br/> -` * {channel_app_id}-demoted`<br/> -` *
{channel_app_id}-scheduled`<br/> -` *
{channel_app_id}-provisionally_published`		-
`product_publication_status:189769876-approved`
product_status	string	Filter by a comma-separated list of product statuses.
		- `product_status:ACTIVE,DRAFT`
product_type	string	Filter by the product type that's associated with
the product variants.			- `product_type:snowboard` -
`product_type:snowboard,skis` - `product_type:snowboard OR
product_type:skis`
publishable_status	string	Deprecated: This parameter is deprecated
as of 2025-12 and will be removed in a future API version. Use published_status
for visibility checks. Filter by the publishable status of the resource on a
channel. The value is a composite of the [channel `app`
ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price)
(`Channel.app.id`) and one of the valid status values.	- `*
{channel_app_id}-unset`<br/> -` * {channel_app_id}-pending`<br/> -` *
{channel_app_id}-approved`<br/> -` * {channel_app_id}-not_approved`		-
`publishable_status:580111-unset` - `publishable_status:580111-pending`
published_status	string	Filter resources by their visibility and
publication state on a channel. Online store channel filtering: -
`online_store_channel`: Returns all resources in the online store channel,
regardless of publication status. - `published`/`visible`: Returns resources
that are published to the online store. - `unpublished`: Returns resources
that are not published to the online store. Channel-specific filtering using
a channel ID, channel handle, [channel `app`
ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price)
(`Channel.app.id`), or app handle with suffixes: -
`{id_or_handle}-published`: Returns resources published to the specified
channel. - `{id_or_handle}-visible`: Same as `{id_or_handle}-published`
(kept for backwards compatibility). - `{id_or_handle}-intended`: Returns
resources added to the channel but not yet published. -
`{id_or_handle}-hidden`: Returns resources not added to the channel or not
published. Other: - `unavailable`: Returns resources not published to any
channel.	- `online_store_channel` - `published` - `visible`

unpublished
- * {channel_id_or_handle}-published
- * {channel_id_or_handle}-visible
- * {channel_id_or_handle}-intended
- * {channel_id_or_handle}-hidden
- * {channel_app_id_or_handle}-published
- * {channel_app_id_or_handle}-visible
- * {channel_app_id_or_handle}-intended
- * {channel_app_id_or_handle}-hidden
- unavailable | | - published_status:online_store_channel
- published_status:published
- published_status:580111-published
published_status:580111-hidden
- published_status:my-channel-handle-published
- published_status:unavailable | | requires_components | boolean | Filter by whether the product variant can only be purchased with components. Learn more. | | | - requires_components:true | | sku | string | Filter by the product variant sku field. Learn more about SKUs. | | | - sku:XYZ-12345 | | tag | string | Filter objects by the tag field. | | | - tag:my_tag | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - tag_not:my_tag | | taxable | boolean | Filter by the product variant taxable field. | | | - taxable:false | | title | string | Filter by the product variant title field. | | | - title:ice | | updated_at | time | Filter by date and time when the product variant was updated. | | | - updated_at:>2020-10-21T23:39:20Z
- updated_at:<now
- updated_at:<=2024 | | vendor | string | Filter by the origin or source of the product variant. Learn more about vendors and managing vendor information. | | | - vendor:Snowdevil
- vendor:Snowdevil,Icedevil
- vendor:Snowdevil OR vendor:Icedevil | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

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.

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 afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
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 productDelete productDelete

•ProductInput

Deprecated

Anchor to mediamedia

•[CreateMediaInput!]

The media to add to the product.

Anchor to productproduct

•ProductCreateInput

The attributes of the new 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 includeImagesincludeImages

Default:false

Specifies whether or not to duplicate images.

Anchor to includeTranslationsincludeTranslations

Default:false

Specifies whether or not to duplicate translations.

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 newTitlenewTitle

required

The new title of the product.

Anchor to productIdproductId

•ID!

required

The ID of the product to be duplicated.

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 publishableUnpublish publishableUnpublish

•[PublicationInput!]!

required

Specifies the input fields required to publish a resource.

•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 savedSearchDelete savedSearchDelete

•[PublicationInput!]!

required

Specifies the input fields required to unpublish a resource.

•mutation

Delete a saved search.

Arguments