11/10/2026, 12:00:37 AM
Shopify’s GraphQL API now includes a new automationWorkflowRuns query that returns a paginated page of an automation’s production or test runs, allowing filtering by kind (defaults to production), status, hasErrors, and an inclusive timeRange. The query supports up to 30 rows per page, uses a continuation cursor for paging, and returns run summaries plus any unresolved runs. Minor corrections have updated argument descriptions: fulfillmentOrderReportProgress.id now reads "targeting", and mobilePlatformApplicationUpdate.input description has been fixed. The previously public inventoryHistory query is now marked private; users should retrieve inventory change data via ShopifyQL instead. A typo in multiple descriptions has been corrected: nftSalesEligibility now says "eligible" and pendingOrdersCount removes the extra “s”. Comment queries on Article, Blog, Comments, and numerous other types now support filtering by article_id to limit comments to a specific article. Other query and mutation documents have minor description updates and capitalization fixes, but their functionality remains unchanged. Overall, developers should add the new automation workflow query, adjust for argument name changes, and switch to ShopifyQL for inventory history access.
Returns a page of an automation's production or test runs, newest first, with their run-level fields. Each call examines at most first runs, so a page can have fewer results, or none, and still return a continuation. Returns null when no automation with the ID exists or it isn't readable.
The paginated list of fulfillment orders assigned to the shop locations owned by the app.
Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations
managed by
fulfillment services
that are registered by the app.
One app (api_client) can host multiple fulfillment services on a shop.
Each fulfillment service manages a dedicated location on a shop.
Assigned fulfillment orders can have associated
fulfillment requests,
or might currently not be requested to be fulfilled.
The app must have the read_assigned_fulfillment_orders
access scope
to be able to retrieve the fulfillment orders assigned to its locations.
All assigned fulfillment orders (except those with the CLOSED status) will be returned by default.
Perform filtering with the assignmentStatus argument
to receive only fulfillment orders that have been requested to be fulfilled.
List of the shop's comments.
A paginated list of events that chronicle activities in the store. Event is an interface implemented by types such as BasicEvent and CommentEvent that track actions such as creating Article objects, fulfilling Order objects, adding Product objects, or staff comments on timelines.
The query supports filtering and sorting to help you find specific events or audit store activity over time.
Count of events. Limited to a maximum of 10000.
A list of historical changes to inventory. Exactly one of inventoryItemId or variantId is required. This query is not available to the public, instead use ShopifyQL to get inventory history.
Determine if a shop is eligible to sell NFTs.
The number of pending orders. Limited to a maximum of 10000.
Reports the progress of an open or in-progress fulfillment order.
Update a mobile platform application.
Creates or updates existing quantity rules on a price list.
You can use the quantityRulesAdd mutation to set order level minimums, maximums and increments for specific product variants.
Generates the URL and signed parameters needed to upload an asset to Shopify.
A bounded page of an automation's run summaries, read live. The continuation doesn't pin a snapshot of the results.
The run-level fields of an automation run, without its step runs.
The input fields for an inclusive range of automation run start times.
The reason a rollout change couldn't be applied to the store.
The outcome of applying a rollout change to the store when its rollout was applied. Applying a rollout makes a treatment's changes permanent for every buyer.
The status of applying a rollout change to the store when its rollout is applied.
lineTypelineType on AdditionalFeeSaleThe line type assocated with the sale.
SaleLineType!The line type associated with the sale.
SaleLineType!lineTypelineType on AdjustmentSaleThe line type assocated with the sale.
SaleLineType!The line type associated with the sale.
SaleLineType!commentscomments on ArticleList of the article's comments.
CommentConnection!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.
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 |
||
| created_at | time | Filter by the date and time when the comment 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 |
||
| published_at | time | Filter by the date and time when the comment was published. | - published_at:>'2020-10-21T23:39:20Z'- published_at:<now- published_at:<=2024 |
||
| published_status | string | Filter by published status | - any- published- unpublished |
- published_status:any- published_status:published- published_status:unpublished |
|
| status | string | ||||
| updated_at | time | Filter by the date and time when the comment 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. |
List of the article's comments.
CommentConnection!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.
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 |
||
| article_id | id | Filter by the ID of the article the comment belongs to. | - article_id:123456789- article_id:>=123456789- article_id:<=123456789 |
||
| created_at | time | Filter by the date and time when the comment 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 |
||
| published_at | time | Filter by the date and time when the comment was published. | - published_at:>'2020-10-21T23:39:20Z'- published_at:<now- published_at:<=2024 |
||
| published_status | string | Filter by published status | - any- published- unpublished |
- published_status:any- published_status:published- published_status:unpublished |
|
| status | string | ||||
| updated_at | time | Filter by the date and time when the comment 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. |
commentsCountcommentsCount on ArticleCount of comments. Limited to a maximum of 10000 by default.
Countquery: 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 |
||
| created_at | time | Filter by the date and time when the comment 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 |
||
| published_at | time | Filter by the date and time when the comment was published. | - published_at:>'2020-10-21T23:39:20Z'- published_at:<now- published_at:<=2024 |
||
| published_status | string | Filter by published status | - any- published- unpublished |
- published_status:any- published_status:published- published_status:unpublished |
|
| status | string | ||||
| updated_at | time | Filter by the date and time when the comment 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. |
limit: Int - The upper bound on count value before returning a result. Use null to have no limit.
Count of comments. Limited to a maximum of 10000 by default.
Countquery: 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 |
||
| article_id | id | Filter by the ID of the article the comment belongs to. | - article_id:123456789- article_id:>=123456789- article_id:<=123456789 |
||
| created_at | time | Filter by the date and time when the comment 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 |
||
| published_at | time | Filter by the date and time when the comment was published. | - published_at:>'2020-10-21T23:39:20Z'- published_at:<now- published_at:<=2024 |
||
| published_status | string | Filter by published status | - any- published- unpublished |
- published_status:any- published_status:published- published_status:unpublished |
|
| status | string | ||||
| updated_at | time | Filter by the date and time when the comment 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. |
limit: Int - The upper bound on count value before returning a result. Use null to have no limit.
eventsevents on ArticleThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
actionaction on BasicEventThe action that occured.
String!The action that occurred.
String!eventsevents on BlogThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
taxLinestaxLines on CalculatedDraftOrderThe list of of taxes lines charged for each line item and shipping line.
[TaxLine!]!The list of taxes lines charged for each line item and shipping line.
[TaxLine!]!eventsevents on CollectionThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on CommentThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
actionaction on CommentEventThe action that occured.
String!The action that occurred.
String!eventsevents on CompanyThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on CompanyLocationThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on CustomerA list of events associated with the customer.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
A list of events associated with the customer.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on DiscountAutomaticBxgyThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on DiscountAutomaticNodeThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on DiscountCodeNodeThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on DiscountNodeThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on DraftOrderThe list of events associated with the draft order.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The list of events associated with the draft order.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
taxLinestaxLines on DraftOrderThe list of of taxes lines charged for each line item and shipping line.
[TaxLine!]!The list of taxes lines charged for each line item and shipping line.
[TaxLine!]!lineTypelineType on DutySaleThe line type assocated with the sale.
SaleLineType!The line type associated with the sale.
SaleLineType!actionaction on EventThe action that occured.
String!The action that occurred.
String!giftCardgiftCard on ExchangeV2LineItemIndiciates if this line item is a gift card.
Boolean!Indicates if this line item is a gift card.
Boolean!lineTypelineType on FeeSaleThe line type assocated with the sale.
SaleLineType!The line type associated with the sale.
SaleLineType!lineTypelineType on GiftCardSaleThe line type assocated with the sale.
SaleLineType!The line type associated with the sale.
SaleLineType!eventsevents on HasEventsThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
incotermincoterm on IncotermInformationThe incoterm representing when duties and international taxes will be payed.
IncotermConfigurationThe incoterm representing when duties and international taxes will be paid.
IncotermConfigurationinventoryBinItemsinventoryBinItems on InventoryBinA paginated list of the inventory items stored in this bin and their quantities.
InventoryBinItemConnectionfirst: 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: InventoryBinItemSortKeys - 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 |
|---|---|---|---|---|---|
| bin_name | string | Filter by the bin name. | - bin_name:"Aisle 1" |
||
| is_available_for_sale | boolean | Filter by whether inventory in the bin is available for sale. | - is_available_for_sale:true |
||
| is_default_bin | boolean | Filter by whether the bin is the default bin for its location. | - is_default_bin:false |
||
| quantity | integer | Filter by the on-hand quantity of the inventory item in the bin. | - quantity:0- quantity:>10 |
||
| updated_at | time | Filter by when the on-hand quantity of the inventory item in the bin last changed. | - updated_at:>2025-01-01 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
A paginated list of the inventory items stored in this bin and their quantities.
InventoryBinItemConnectionfirst: 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: InventoryBinItemSortKeys - 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 |
|---|---|---|---|---|---|
| bin_name | string | Filter by the bin name. End the value with * to match names that start with it. |
- bin_name:"Aisle 1"- bin_name:Aisle* |
||
| is_available_for_sale | boolean | Filter by whether inventory in the bin is available for sale. | - is_available_for_sale:true |
||
| is_default_bin | boolean | Filter by whether the bin is the default bin for its location. | - is_default_bin:false |
||
| quantity | integer | Filter by the on-hand quantity of the inventory item in the bin. | - quantity:0- quantity:>10 |
||
| updated_at | time | Filter by when the on-hand quantity of the inventory item in the bin last changed. | - updated_at:>2025-01-01 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
quantityquantity on InventoryBinItemThe on-hand quantity of the inventory item in the bin.
Int!The on-hand quantity of the inventory item in the bin.null if the inventory item doesn't track quantity.
IntinventoryBinThe bin associated with this inventory change.
inventoryBinItemsinventoryBinItems on InventoryItemA paginated list of the inventory item's on-hand quantities in each bin across every location,
including each location's default bin.
Note:
This query is available only in the unstable API version and to development stores
that have enabled the Physical inventory feature preview.
InventoryBinItemConnection!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: InventoryBinItemSortKeys - 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 |
|---|---|---|---|---|---|
| bin_name | string | Filter by the bin name. | - bin_name:"Aisle 1" |
||
| is_available_for_sale | boolean | Filter by whether inventory in the bin is available for sale. | - is_available_for_sale:true |
||
| is_default_bin | boolean | Filter by whether the bin is the default bin for its location. | - is_default_bin:false |
||
| quantity | integer | Filter by the on-hand quantity of the inventory item in the bin. | - quantity:0- quantity:>10 |
||
| updated_at | time | Filter by when the on-hand quantity of the inventory item in the bin last changed. | - updated_at:>2025-01-01 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
A paginated list of the inventory item's on-hand quantities in each bin across every location,
including each location's default bin.
Note:
This query is available only in the unstable API version and to development stores
that have enabled the Physical inventory feature preview.
InventoryBinItemConnection!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: InventoryBinItemSortKeys - 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 |
|---|---|---|---|---|---|
| bin_name | string | Filter by the bin name. End the value with * to match names that start with it. |
- bin_name:"Aisle 1"- bin_name:Aisle* |
||
| is_available_for_sale | boolean | Filter by whether inventory in the bin is available for sale. | - is_available_for_sale:true |
||
| is_default_bin | boolean | Filter by whether the bin is the default bin for its location. | - is_default_bin:false |
||
| quantity | integer | Filter by the on-hand quantity of the inventory item in the bin. | - quantity:0- quantity:>10 |
||
| updated_at | time | Filter by when the on-hand quantity of the inventory item in the bin last changed. | - updated_at:>2025-01-01 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
availableavailable on InventoryLocationItemThe quantity available for sale at the location: on-hand in bins that are available for sale, minus committed.
Int!The quantity available for sale at the location: on-hand in bins that are available for sale, minus committed.null if the inventory item doesn't track quantity.
Intcommittedcommitted on InventoryLocationItemThe quantity committed to orders at the location. Location-level and not tracked per bin.
Int!The quantity committed to orders at the location. Location-level and not tracked per bin.null if the inventory item doesn't track quantity.
Intincomingincoming on InventoryLocationItemThe quantity on its way to the location. Location-level and not tracked per bin.
Int!The quantity on its way to the location. Location-level and not tracked per bin.null if the inventory item doesn't track quantity.
IntinventoryBinItemsinventoryBinItems on InventoryLocationItemA paginated list of the inventory item's on-hand quantities in each bin at the location,
including the location's default bin.
Note:
This query is available only in the unstable API version and to development stores
that have enabled the Physical inventory feature preview.
InventoryBinItemConnection!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: InventoryBinItemSortKeys - 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 |
|---|---|---|---|---|---|
| bin_name | string | Filter by the bin name. | - bin_name:"Aisle 1" |
||
| is_available_for_sale | boolean | Filter by whether inventory in the bin is available for sale. | - is_available_for_sale:true |
||
| is_default_bin | boolean | Filter by whether the bin is the default bin for its location. | - is_default_bin:false |
||
| quantity | integer | Filter by the on-hand quantity of the inventory item in the bin. | - quantity:0- quantity:>10 |
||
| updated_at | time | Filter by when the on-hand quantity of the inventory item in the bin last changed. | - updated_at:>2025-01-01 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
A paginated list of the inventory item's on-hand quantities in each bin at the location,
including the location's default bin.
Note:
This query is available only in the unstable API version and to development stores
that have enabled the Physical inventory feature preview.
InventoryBinItemConnection!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: InventoryBinItemSortKeys - 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 |
|---|---|---|---|---|---|
| bin_name | string | Filter by the bin name. End the value with * to match names that start with it. |
- bin_name:"Aisle 1"- bin_name:Aisle* |
||
| is_available_for_sale | boolean | Filter by whether inventory in the bin is available for sale. | - is_available_for_sale:true |
||
| is_default_bin | boolean | Filter by whether the bin is the default bin for its location. | - is_default_bin:false |
||
| quantity | integer | Filter by the on-hand quantity of the inventory item in the bin. | - quantity:0- quantity:>10 |
||
| updated_at | time | Filter by when the on-hand quantity of the inventory item in the bin last changed. | - updated_at:>2025-01-01 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
onHandonHand on InventoryLocationItemThe on-hand quantity summed across every bin at the location, including the default bin.
Int!The on-hand quantity summed across every bin at the location, including the default bin.null if the inventory item doesn't track quantity.
Inteventsevents on InventoryTransferThe list of events associated with the inventory transfer.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The list of events associated with the inventory transfer.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
countcount on LimitedPendingOrderCountThe number of pendings orders on the shop.
Limited to a maximum of 10000.
Int!The number of pending orders on the shop.
Limited to a maximum of 10000.
Int!isCumulativeisCumulative on MarketingEngagementSpecifies how the provided metrics have been aggregated. Cumulative metrics are aggregated from the first day of reporting up to and including occuredOn. Non-cumulative metrics are aggregated over the single day indicated in occuredOn. Cumulative metrics will monotonically increase in time as each record includes the previous day's values, and so on. Non-cumulative metrics are required going forward; cumulative metrics are deprecated.
Boolean!Specifies how the provided metrics have been aggregated. Cumulative metrics are aggregated from the first day of reporting up to and including occurredOn. Non-cumulative metrics are aggregated over the single day indicated in occurredOn. Cumulative metrics will monotonically increase in time as each record includes the previous day's values, and so on. Non-cumulative metrics are required going forward; cumulative metrics are deprecated.
Boolean!hexhex on MetaobjectThumbnailThe hexadecimal color code to be used for respresenting this metaobject.
StringThe hexadecimal color code to be used for representing this metaobject.
StringCREATED_ATreapplyDatereapplyDate on NftSalesEligibilityResultThe date and time when the shop can reappy for attestation.
DateTimeThe date and time when the shop can reapply for attestation.
DateTimeeventsevents on OrderA list of events associated with the order. Events track significant changes and activities related to the order, such as creation, payment, fulfillment, and cancellation.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
A list of events associated with the order. Events track significant changes and activities related to the order, such as creation, payment, fulfillment, and cancellation.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
happenedAthappenedAt on OrderAgreementThe date and time at which the agreement occured.
DateTime!The date and time at which the agreement occurred.
DateTime!reasonreason on OrderAgreementThe reason the agremeent was created.
OrderActionType!The reason the agreement was created.
OrderActionType!happenedAthappenedAt on OrderEditAgreementThe date and time at which the agreement occured.
DateTime!The date and time at which the agreement occurred.
DateTime!reasonreason on OrderEditAgreementThe reason the agremeent was created.
OrderActionType!The reason the agreement was created.
OrderActionType!successMessagessuccessMessages on OrderEditCommitPayloadMessages to display to the user after the staged changes are commmitted.
[String!]Messages to display to the user after the staged changes are committed.
[String!]eventsevents on PageThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
cashDrawercashDrawer on PointOfSaleDevicePaymentSessionThe cash drawer associated with the point of sale device payment session. The session's sales andcash tracking activity will affect the cash drawer's balance.
CashDrawer!The cash drawer associated with the point of sale device payment session. The session's sales and cash tracking activity will affect the cash drawer's balance.
CashDrawer!eventsevents on ProductThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
lineTypelineType on ProductSaleThe line type assocated with the sale.
SaleLineType!The line type associated with the sale.
SaleLineType!eventsevents on ProductVariantThe paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!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: EventSortKeys - 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 |
|---|---|---|---|---|---|
| action | string | The action that occurred. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
priceprice on QuantityPriceBreakThe price of variant after reaching the minimum quanity.
MoneyV2!The price of variant after reaching the minimum quantity.
MoneyV2!happenedAthappenedAt on RefundAgreementThe date and time at which the agreement occured.
DateTime!The date and time at which the agreement occurred.
DateTime!reasonreason on RefundAgreementThe reason the agremeent was created.
OrderActionType!The reason the agreement was created.
OrderActionType!happenedAthappenedAt on ReturnAgreementThe date and time at which the agreement occured.
DateTime!The date and time at which the agreement occurred.
DateTime!reasonreason on ReturnAgreementThe reason the agremeent was created.
OrderActionType!The reason the agreement was created.
OrderActionType!applyResultThe outcome of the most recent attempt to apply this change to the store. Changes that are stored and applied as one unit, such as discount or catalog changes saved together, share one result. Changes from different units can have different results, even in the same apply. Returns null if the change hasn't been applied, or if the staff member can't read the resource it changes.
applyResultThe outcome of the most recent attempt to apply this change to the store. Changes that are stored and applied as one unit, such as discount or catalog changes saved together, share one result. Changes from different units can have different results, even in the same apply. Returns null if the change hasn't been applied, or if the staff member can't read the resource it changes.
applyResultThe outcome of the most recent attempt to apply this change to the store. Changes that are stored and applied as one unit, such as discount or catalog changes saved together, share one result. Changes from different units can have different results, even in the same apply. Returns null if the change hasn't been applied, or if the staff member can't read the resource it changes.
applyResultThe outcome of the most recent attempt to apply this change to the store. Changes that are stored and applied as one unit, such as discount or catalog changes saved together, share one result. Changes from different units can have different results, even in the same apply. Returns null if the change hasn't been applied, or if the staff member can't read the resource it changes.
applyResultThe outcome of the most recent attempt to apply this change to the store. Changes that are stored and applied as one unit, such as discount or catalog changes saved together, share one result. Changes from different units can have different results, even in the same apply. Returns null if the change hasn't been applied, or if the staff member can't read the resource it changes.
applyResultThe outcome of the most recent attempt to apply this change to the store. Changes that are stored and applied as one unit, such as discount or catalog changes saved together, share one result. Changes from different units can have different results, even in the same apply. Returns null if the change hasn't been applied, or if the staff member can't read the resource it changes.
applyResultThe outcome of the most recent attempt to apply this change to the store. Changes that are stored and applied as one unit, such as discount or catalog changes saved together, share one result. Changes from different units can have different results, even in the same apply. Returns null if the change hasn't been applied, or if the staff member can't read the resource it changes.
applyResultThe outcome of the most recent attempt to apply this change to the store. Changes that are stored and applied as one unit, such as discount or catalog changes saved together, share one result. Changes from different units can have different results, even in the same apply. Returns null if the change hasn't been applied, or if the staff member can't read the resource it changes.
applyResultThe outcome of the most recent attempt to apply this change to the store. Changes that are stored and applied as one unit, such as discount or catalog changes saved together, share one result. Changes from different units can have different results, even in the same apply. Returns null if the change hasn't been applied, or if the staff member can't read the resource it changes.
applyResultThe outcome of the most recent attempt to apply this change to the store. Changes that are stored and applied as one unit, such as discount or catalog changes saved together, share one result. Changes from different units can have different results, even in the same apply. Returns null if the change hasn't been applied, or if the staff member can't read the resource it changes.
applyResultThe outcome of the most recent attempt to apply this change to the store. Changes that are stored and applied as one unit, such as discount or catalog changes saved together, share one result. Changes from different units can have different results, even in the same apply. Returns null if the change hasn't been applied, or if the staff member can't read the resource it changes.
lineTypelineType on SaleThe line type assocated with the sale.
SaleLineType!The line type associated with the sale.
SaleLineType!happenedAthappenedAt on SalesAgreementThe date and time at which the agreement occured.
DateTime!The date and time at which the agreement occurred.
DateTime!reasonreason on SalesAgreementThe reason the agremeent was created.
OrderActionType!The reason the agreement was created.
OrderActionType!typetype on SellingPlanAnchorRepresents the anchor type, it can be one one of WEEKDAY, MONTHDAY, YEARDAY.
SellingPlanAnchorType!Represents the anchor type, it can be one of WEEKDAY, MONTHDAY, YEARDAY.
SellingPlanAnchorType!lineTypelineType on ShippingLineSaleThe line type assocated with the sale.
SaleLineType!The line type associated with the sale.
SaleLineType!assignedFulfillmentOrdersassignedFulfillmentOrders on ShopThe paginated list of fulfillment orders assigned to the shop locations owned by the app.
Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations
managed by
fulfillment services
that are registered by the app.
One app (api_client) can host multiple fulfillment services on a shop.
Each fulfillment service manages a dedicated location on a shop.
Assigned fulfillment orders can have associated
fulfillment requests,
or might currently not be requested to be fulfilled.
The app must have read_assigned_fulfillment_orders
access scope
to be able to retrieve fulfillment orders assigned to its locations.
All assigned fulfillment orders (except those with the CLOSED status) will be returned by default.
Perform filtering with the assignmentStatus argument
to receive only fulfillment orders that have been requested to be fulfilled.
FulfillmentOrderConnection!assignmentStatus: 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.
locationIds: [ID!] - Returns fulfillment orders only for certain locations, specified by a list of location IDs.
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: FulfillmentOrderSortKeys - 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.
The paginated list of fulfillment orders assigned to the shop locations owned by the app.
Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations
managed by
fulfillment services
that are registered by the app.
One app (api_client) can host multiple fulfillment services on a shop.
Each fulfillment service manages a dedicated location on a shop.
Assigned fulfillment orders can have associated
fulfillment requests,
or might currently not be requested to be fulfilled.
The app must have read_assigned_fulfillment_orders
access scope
to be able to retrieve fulfillment orders assigned to its locations.
All assigned fulfillment orders (except those with the CLOSED status) will be returned by default.
Perform filtering with the assignmentStatus argument
to receive only fulfillment orders that have been requested to be fulfilled.
FulfillmentOrderConnection!assignmentStatus: FulfillmentOrderAssignmentStatus - The assignment 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.
locationIds: [ID!] - Returns fulfillment orders only for certain locations, specified by a list of location IDs.
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: FulfillmentOrderSortKeys - 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.
limitedPendingOrderCountlimitedPendingOrderCount on ShopThe number of pendings orders on the shop.
Limited to a maximum of 10000.
LimitedPendingOrderCount!The number of pending orders on the shop.
Limited to a maximum of 10000.
LimitedPendingOrderCount!resourceLimitsresourceLimits on ShopThe shop's limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed.
ShopResourceLimits!The shop's limits for specific resources. For example, the maximum number of variants allowed per product, or the maximum number of locations allowed.
ShopResourceLimits!searchFilterssearchFilters on ShopThe list of search filter options for the shop. These can be used to filter productvisibility for the shop.
SearchFilterOptions!The list of search filter options for the shop. These can be used to filter product visibility for the shop.
SearchFilterOptions!balanceTransactionsbalanceTransactions on ShopifyPaymentsAccountA list of balance transactions associated with the shop.
ShopifyPaymentsBalanceTransactionConnection!hideTransfers: Boolean - Determines if returned transactions contain transaction type transfer.
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: BalanceTransactionSortKeys - 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 |
||
| available_on | time | ||||
| credit_card_last4 | string | ||||
| currency | string | ||||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| payment_method_name | string | ||||
| payments_transfer_id | id | ||||
| payout_date | time | ||||
| payout_status | string | ||||
| processed_at | time | ||||
| tax_reporting_exempt | boolean | ||||
| transaction_type | string | ||||
| 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.
A list of balance transactions associated with the shop.
ShopifyPaymentsBalanceTransactionConnection!hideTransfers: Boolean - Determines if returned transactions contain transaction type transfer.
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: BalanceTransactionSortKeys - 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 |
||
| available_on | time | ||||
| created_at | time | Filter by creation date and time. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<='2024' |
||
| credit_card_last4 | string | ||||
| currency | string | ||||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| payment_method_name | string | ||||
| payments_transfer_id | id | ||||
| payout_date | time | ||||
| payout_status | string | ||||
| processed_at | time | ||||
| tax_reporting_exempt | boolean | ||||
| transaction_type | string | ||||
| 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.
associatedPayoutassociatedPayout on ShopifyPaymentsBalanceTransactionPayout assoicated with the transaction.
ShopifyPaymentsBalanceTransactionAssociatedPayout!Payout associated with the transaction.
ShopifyPaymentsBalanceTransactionAssociatedPayout!testtest on ShopifyPaymentsBalanceTransactionWether the tranaction was created in test mode.
Boolean!Whether the transaction was created in test mode.
Boolean!remainingAmountremainingAmount on StoreCreditAccountCreditTransactionThe remaining amount of the credit.
The remaining amount will decrease when a debit spends this credit. It may also increase if that debit is subsequently reverted.
In the event that the credit expires, the remaining amount will represent the amount that remained as the expiry ocurred.
MoneyV2!The remaining amount of the credit.
The remaining amount will decrease when a debit spends this credit. It may also increase if that debit is subsequently reverted.
In the event that the credit expires, the remaining amount will represent the amount that remained as the expiry occurred.
MoneyV2!categoriescategories on TaxonomyReturns the categories of the product taxonomy based on the arguments provided.
If a search argument is provided, then all categories that match the search query globally are returned.
If a children_of argument is provided, then all children of the specified category are returned.
If a siblings_of argument is provided, then all siblings of the specified category are returned.
If a decendents_of argument is provided, then all descendents of the specified category are returned.
If no arguments are provided, then all the top-level categories of the taxonomy are returned.
TaxonomyCategoryConnection!search: String - Searches the product taxonomy for matching categories.
childrenOf: ID - The ID of the category associated with the child categories to return.
siblingsOf: ID - The ID of the category associated with the sibling categories to return.
descendantsOf: ID - The ID of the category associated with the descendant categories to return.
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.
Returns the categories of the product taxonomy based on the arguments provided.
If a search argument is provided, then all categories that match the search query globally are returned.
If a children_of argument is provided, then all children of the specified category are returned.
If a siblings_of argument is provided, then all siblings of the specified category are returned.
If a descendants_of argument is provided, then all descendents of the specified category are returned.
If no arguments are provided, then all the top-level categories of the taxonomy are returned.
TaxonomyCategoryConnection!search: String - Searches the product taxonomy for matching categories.
childrenOf: ID - The ID of the category associated with the child categories to return.
siblingsOf: ID - The ID of the category associated with the sibling categories to return.
descendantsOf: ID - The ID of the category associated with the descendant categories to return.
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.
lineTypelineType on TipSaleThe line type assocated with the sale.
SaleLineType!The line type associated with the sale.
SaleLineType!lineTypelineType on UnknownSaleThe line type assocated with the sale.
SaleLineType!The line type associated with the sale.
SaleLineType!