8/7/2025, 3:52:43 PM
The webhookSubscriptions query no longer accepts the callbackUrl argument, simplifying subscription filtering. A parentRelationship field has been added to AbandonedCheckoutLineItem along with a new AbandonedCheckoutLineItemParentRelationship type that exposes the parent line item through its parent property. The Publication type now contains an includedProductsCount field, which counts included products and accepts optional filtering and a limit variable. Both the includedProducts and products connection fields on Publication have been extended with sortKey, query, and savedSearchId arguments; products additionally gain the same sortKey as their existing filters. Enumeration ShopifyPaymentsTransactionType now includes four new members for managed markets dispute fee debit/credit and their reversals. Minor description changes on several query return types have been made for consistency.
Returns a DeliveryCarrierService resource by ID.
Returns a DraftOrderTag resource by ID.
Returns a list of webhook subscriptions.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.
The line relationship between two line items in an abandoned checkout.
parentRelationshipThe parent relationship for this line item.
companycompany on FulfillmentTrackingInfoThe name of the tracking company.
For tracking company names from the list below
Shopify will automatically build tracking URLs for all provided tracking numbers,
which will make the tracking numbers clickable in the interface.
Additionally, for the tracking companies listed on the
Shipping Carriers help page
Shopify will automatically update the fulfillment's shipment_status field during the fulfillment process.
The following tracking companies display for shops located in any country:
The following tracking companies are displayed for shops located in specific countries:
StringThe name of the tracking company.
For tracking company names from the list below
Shopify will automatically build tracking URLs for all provided tracking numbers,
which will make the tracking numbers clickable in the interface.
Additionally, for the tracking companies listed on the
Shipping Carriers help page
Shopify will automatically update the fulfillment's shipment_status field during the fulfillment process.
The following tracking companies display for shops located in any country:
The following tracking companies are displayed for shops located in specific countries:
StringincludedProductsincludedProducts on PublicationThe list of products included, but not necessarily published, in the publication.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
The list of products included, but not necessarily published, in the publication.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: ProductSortKeys - 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.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | 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. 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 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. |
- approved- rejected- needs_action- awaiting_review- published- demoted- scheduled- provisionally_published |
- product_publication_status:189769876-approved |
|
| product_type | string | Filter by a comma-separated list of product types. | - 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 | 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. |
- online_store_channel- published- unpublished- visible- unavailable- hidden- intended- visible |
- publishable_status:published- publishable_status:189769876-visible- publishable_status:pos-hidden |
|
| 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 by the published status of the resource on a channel, such as the online store. | - unset- pending- approved- not approved |
- published_status:approved |
|
| 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 |
||
| 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. |
savedSearchId: ID - The ID of a saved search.
The search’s query string is used as the query argument.
includedProductsCountThe count of products included in the publication. Limited to a maximum of 10000 by default.
productsproducts on PublicationThe list of products published to the publication.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
The list of products published to the publication.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: ProductSortKeys - 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.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | 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. 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 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. |
- approved- rejected- needs_action- awaiting_review- published- demoted- scheduled- provisionally_published |
- product_publication_status:189769876-approved |
|
| product_type | string | Filter by a comma-separated list of product types. | - 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 | 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. |
- online_store_channel- published- unpublished- visible- unavailable- hidden- intended- visible |
- publishable_status:published- publishable_status:189769876-visible- publishable_status:pos-hidden |
|
| 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 by the published status of the resource on a channel, such as the online store. | - unset- pending- approved- not approved |
- published_status:approved |
|
| 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 |
||
| 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. |
savedSearchId: ID - The ID of a saved search.
The search’s query string is used as the query argument.
MANAGED_MARKETS_DISPUTE_FEE_DEBITMANAGED_MARKETS_DISPUTE_FEE_CREDITMANAGED_MARKETS_DISPUTE_FEE_DEBIT_REVERSALMANAGED_MARKETS_DISPUTE_FEE_CREDIT_REVERSAL