orderAttributionDefinitionUpsert

mutation

Upserts an order attribution definition for the calling app on the current shop. Apps can use attribution definitions to label orders they route to a shop, replacing or augmenting any definitions shipped declaratively via the order_attribution_config extension.

If a definition with the same handle exists for this app on the shop, the supplied input fields are merged onto it; fields omitted from the input are left unchanged. Otherwise a new definition is created. To explicitly clear the stored icon on an existing definition, pass icon: null.

Anchor to Arguments

Arguments

Anchor to inputinput

•OrderAttributionDefinitionUpsertInput!

required

The input fields for upserting the order attribution definition.

Was this section helpful?

Anchor to OrderAttributionDefinitionUpsertPayload returnsOrderAttributionDefinitionUpsertPayload returns

Anchor to orderAttributionDefinitionorderAttributionDefinition •OrderAttributionDefinition: The order attribution definition that was upserted.
Anchor to userErrorsuserErrors •[OrderAttributionDefinitionUpsertUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

orderAttributionDefinitionUpsert reference

Mutation Reference

mutation orderAttributionDefinitionUpsert($input: OrderAttributionDefinitionUpsertInput!) {

orderAttributionDefinitionUpsert(input: $input) {

orderAttributionDefinition {

# OrderAttributionDefinition fields

}

userErrors {

field

message

}

Input

{

"input": {

"displayName": "<your-displayName>",

"handle": "<your-handle>",

"icon": "<your-icon>"

}

Variables

{
  "input": {
    "displayName": "<your-displayName>",
    "handle": "<your-handle>",
    "icon": "<your-icon>"
  }
}

Schema

input OrderAttributionDefinitionUpsertInput {
  displayName: String!
  handle: String!
  icon: String
}