11/20/2026, 12:00:57 AM
Returns a batch for the shop.
Returns a batch workflow for the shop.
Returns a paginated list of batches for the shop.
Returns the event subscription that the authenticated app set on the shop with eventSubscriptionsSet,
matched by handle, or null when the app set none with that handle. A subscription the app's
configuration declares is not set on the shop and isn't returned here.
Returns a paginated list of non-closed batches that can be filtered by fulfillment order attributes.
Returns the Menu that the shop's published theme uses as its main navigation menu, with its nested menu items.
The menu is the one the merchant selected for the main menu setting of the theme's header section. Returns null when the shop has no published theme, when the theme's header section doesn't have exactly one main menu setting, when the theme doesn't store a menu for that setting, or when no menu has the selected handle.
Each item's url is the link as the merchant saved it, so links to the shop's own resources, such as products and collections, are relative paths.
Returns the main navigation menu for the shop.
Retrieves a list of collections
in a store. Collections are groups of products
that merchants can organize for display in their online store and
other sales channels.
For example, an athletics store might create different collections for running attire, shoes, and accessories.
Use the collections query when you need to:
The collections query supports pagination
for large catalogs and saved searches
for frequently used collection queries.
The collections query returns collections with their associated metadata, including:
Learn more about using metafields with collection conditions.
Count of collections. Limited to a maximum of 10000 by default.
Adds items to the first step of an existing batch.
Supports an optional idempotency key using the @idempotent directive. For more information, see the idempotency documentation.
Adds items to the most recent open or in-progress batch with the given name. An item goes to a different batch with the same name when that batch is full or when the batch workflow's steps don't allow the item in that batch alongside the items it already has. A full batch's overflow goes to a new batch with the same name, never an older one. Concurrent requests with the same name don't create duplicate batches.
Supports an optional idempotency key using the @idempotent directive. For more information, see the idempotency documentation.
Closes a batch. Every item must be in the batch workflow's Done step. An empty batch can be closed at any time. Closing a batch cancels any actions that are still running.
Creates a batch.
Deletes a batch.
Moves items between steps within a batch.
Supports an optional idempotency key using the @idempotent directive. Retrying with the same key returns the original move outcome without moving items again.
Removes items from a batch.
Reopens a closed batch.
Assigns a staff member to a batch step. Pass a null staffMemberId to unassign.
Transfers items from one batch to another. Items land in the target batch's first step.
Updates a batch.
Asynchronously reorders the products of a manually sorted collection. Instead of returning an updated collection, this mutation returns a job, which should be polled. The Collection.sortOrder must be MANUAL.
Positions are zero-based indexes in the collection's list of products. Products that the request doesn't list keep their relative order, and the reorder leaves no gaps. The description of each argument that reorders products says how it places them.
A group of items being processed through a batch workflow.
Return type for batchAddItemsByName mutation.
An error that occurs during the execution of BatchAddItemsByName.
Possible error codes that can be returned by BatchAddItemsByNameUserError.
Return type for batchAddItems mutation.
An error that occurs during the execution of BatchAddItems.
Possible error codes that can be returned by BatchAddItemsUserError.
Return type for batchClose mutation.
An error that occurs during the execution of BatchClose.
Possible error codes that can be returned by BatchCloseUserError.
An auto-generated type for paginating through multiple Batches.
Return type for batchCreate mutation.
An error that occurs during the execution of BatchCreate.
Possible error codes that can be returned by BatchCreateUserError.
Return type for batchDelete mutation.
An error that occurs during the execution of BatchDelete.
Possible error codes that can be returned by BatchDeleteUserError.
An auto-generated type which holds one Batch and a cursor during pagination.
A group of items rejected from a batch for the same reason.
A finer-grained batch item rejection detail produced by a batch workflow step action.
The reason an item was rejected from a batch operation.
Return type for batchMoveItems mutation.
An error that occurs during the execution of BatchMoveItems.
Possible error codes that can be returned by BatchMoveItemsUserError.
Return type for batchRemoveItems mutation.
Specifies what to remove from a batch. Provide exactly one of stepId (bulk-remove all items currently in the step) or itemIds (remove specific items regardless of which step they belong to).
An error that occurs during the execution of BatchRemoveItems.
Possible error codes that can be returned by BatchRemoveItemsUserError.
Return type for batchReopen mutation.
An error that occurs during the execution of BatchReopen.
Possible error codes that can be returned by BatchReopenUserError.
The set of valid sort keys for the Batch query.
A batch's current status.
A step within a batch, representing a stage of processing.
A single execution of a batch workflow action within a batch step.
An auto-generated type for paginating through multiple BatchStepActions.
An auto-generated type which holds one BatchStepAction and a cursor during pagination.
The result of a specific item within a batch step action execution.
An auto-generated type for paginating through multiple BatchStepActionItems.
An auto-generated type which holds one BatchStepActionItem and a cursor during pagination.
The status of an individual item within a batch step action execution.
A batch workflow step action's readiness for the current items in a batch step.
The status of a batch step action execution.
Return type for batchStepAssign mutation.
An error that occurs during the execution of BatchStepAssign.
Possible error codes that can be returned by BatchStepAssignUserError.
An auto-generated type for paginating through multiple BatchSteps.
A generated document produced by a successful batch step action.
An auto-generated type which holds one BatchStep and a cursor during pagination.
The direction to move items between batch steps.
A resource produced by a batch step action, with metadata about its kind and associated item.
An auto-generated type for paginating through multiple BatchStepResources.
An auto-generated type which holds one BatchStepResource and a cursor during pagination.
A union of underlying resource types produced by batch step actions.
Return type for batchTransferItems mutation.
An error that occurs during the execution of BatchTransferItems.
Possible error codes that can be returned by BatchTransferItemsUserError.
Return type for batchUpdate mutation.
An error that occurs during the execution of BatchUpdate.
Possible error codes that can be returned by BatchUpdateUserError.
A batch workflow. Its configurations define the steps and actions that batches go through.
An action that can run on the items in a batch workflow step.
A versioned configuration of a batch workflow, defining steps and actions for processing batches.
A step in a batch workflow configuration.
An action configuration for a batch workflow step.
An auto-generated type for paginating through multiple BatchWorkflowStepActions.
An auto-generated type which holds one BatchWorkflowStepAction and a cursor during pagination.
An auto-generated type for paginating through multiple BatchWorkflowSteps.
An auto-generated type which holds one BatchWorkflowStep and a cursor during pagination.
An entity that can be added to a batch.
A union of types that can be added as items to a batch.
An auto-generated type for paginating through multiple BatchableItems.
An auto-generated type which holds one BatchableItem and a cursor during pagination.
An end of a collection's product list, where toPosition can place a block of products.
The input fields for the final index of one product in the collection.
The input fields for a declarative reorder: the request says where products end up, not how to move them
one at a time. Specify exactly one of toPosition or toIndexes.
The reorder is resolved against the collection's order when the job runs.
The input fields for the place where toPosition puts its block of products. Specify exactly one.
The input fields for moving a block of products to one place in the collection.
The block keeps the order of productIds. Products that the request doesn't list keep their relative order
around the block. Products that aren't in the collection are skipped.
The top level navigation menu for the shop.
A menu item to send in Admin GraphQL response.
A menu item type.
DUPLICATE_PRODUCTPOSITION_COLLISIONINVALID_POSITIONCREATED_ATBATCHBATCH_STEPcollectionscollectionsBATCH_ACTION_CREATEDBATCH_ACTION_COMPLETEDBATCH_CLOSEDBATCH_CREATEDBATCH_DELETEDBATCH_ITEM_ADDEDBATCH_ITEM_MOVEDBATCH_ITEM_REMOVEDBATCH_ITEM_TRANSFERREDBATCH_ITEM_VERIFIEDBATCH_ITEM_UNVERIFIEDBATCH_RENAMEDBATCH_REOPENEDBATCH_STEP_ASSIGNEDBATCH_STEP_UNASSIGNEDBATCH_WORKFLOW_CREATEDBATCH_WORKFLOW_VERSION_PUBLISHED