Choose a version:

draftThemeFilesCommit

mutation

Requires The user needs write_themes and an exemption from Shopify to modify theme files. If you think that your app is eligible for an exemption and should have access to this API, then you can submit an exception request.

Commits staged theme file changes for a caller-provided session. After any attempt other than session lock contention, the session is consumed and scheduled for cleanup. Retry by staging the complete desired snapshot under a new session ID.

Anchor to Arguments

Arguments

Anchor to sessionIdsessionId •String! required: The caller-provided session to commit. A non-contention commit attempt consumes this session, so it must not be reused. Retry with a new session ID after restaging the complete desired snapshot.
Anchor to themeIdthemeId •ID! required: The theme to commit staged updates to.

Was this section helpful?

Anchor to DraftThemeFilesCommitPayload returnsDraftThemeFilesCommitPayload returns

Anchor to deletedThemeFilesdeletedThemeFiles •[OnlineStoreThemeFileOperationResult!]: The theme files committed from staged deletions.

Show fields
Anchor to upsertedThemeFilesupsertedThemeFiles •[OnlineStoreThemeFileOperationResult!]: The theme files committed from staged updates.

Show fields
Anchor to userErrorsuserErrors •[OnlineStoreThemeFilesUserErrors!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

draftThemeFilesCommit reference

Mutation Reference

mutation draftThemeFilesCommit($sessionId: String!, $themeId: ID!) {

draftThemeFilesCommit(sessionId: $sessionId, themeId: $themeId) {

deletedThemeFiles {

# OnlineStoreThemeFileOperationResult fields

}

upsertedThemeFiles {

# OnlineStoreThemeFileOperationResult fields

}

userErrors {

field

message

}

Input

{

"sessionId": "<your-sessionId>",

"themeId": "gid://shopify/<objectName>/10079785100"

}