Skip to main content
Anchor to ErrorsWebPixelUserError

ErrorsWebPixelUserError

object

Requires read_pixels access scope.

An error that occurs during the execution of a web pixel mutation.

Anchor to FieldsFields

Anchor to codecode
•ErrorsWebPixelUserErrorCode

The error code.

Anchor to fieldfield
•[String!]

The path to the input field that caused the error.

Anchor to messagemessage
•String!non-null

The error message.

Was this section helpful?

Anchor to MutationsMutations

Anchor to webPixelCreatewebPixelCreate
•mutation

Activate a web pixel extension by creating a web pixel record on the store where you installed your app.

When you run the webPixelCreate mutation, Shopify validates it against the settings definition in shopify.extension.toml. If the settings input field doesn't match the schema that you defined, then the mutation fails. Learn how to define web pixel settings.

Arguments

Anchor to webPixelwebPixel
•WebPixelInput!required

The web pixel settings in JSON format.

Fields

Anchor to userErrorsuserErrors
•[ErrorsWebPixelUserError!]!non-null

The list of errors that occurred from executing the mutation.

Anchor to webPixelwebPixel
•WebPixel

The created web pixel settings.

Anchor to webPixelDeletewebPixelDelete
•mutation

Deletes the web pixel shop settings.

Arguments

Anchor to idid
•ID!required

The ID of the web pixel to delete.

Fields

Anchor to deletedWebPixelIddeletedWebPixelId
•ID

The ID of the web pixel settings that was deleted.

Anchor to userErrorsuserErrors
•[ErrorsWebPixelUserError!]!non-null

The list of errors that occurred from executing the mutation.

Anchor to webPixelUpdatewebPixelUpdate
•mutation

Activate a web pixel extension by updating a web pixel record on the store where you installed your app.

When you run the webPixelUpdate mutation, Shopify validates it against the settings definition in shopify.extension.toml. If the settings input field doesn't match the schema that you defined, then the mutation fails. Learn how to define web pixel settings.

Arguments

Anchor to idid
•ID!required

The ID of the web pixel to update.

Anchor to webPixelwebPixel
•WebPixelInput!required

The web pixel settings in JSON format.

Fields

Anchor to userErrorsuserErrors
•[ErrorsWebPixelUserError!]!non-null

The list of errors that occurred from executing the mutation.

Anchor to webPixelwebPixel
•WebPixel

The updated web pixel settings.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?