Choose a version:

OrderAttributionDefinition

object

An attribution definition that an app can use to label orders it routes to a shop. Definitions can be supplied declaratively via the order_attribution_config extension or created dynamically per-shop via the Admin API.

Anchor to FieldsFields

Anchor to displayNamedisplayName •String! non-null: A human-readable name for the definition, displayed in Shopify Admin and on order details.
Anchor to handlehandle •String! non-null: A unique identifier for the definition, scoped to the calling app on a single shop. Used as the attribution_handle value when an app attributes an order to this definition.
Anchor to iconicon •String: Sanitized SVG content used as the icon for orders attributed to this definition. May be null when no icon is provided.
Anchor to idid •ID! non-null: A globally-unique ID.

Was this section helpful?

Anchor to QueriesQueries

Anchor to orderAttributionDefinitions orderAttributionDefinitions

•query

Returns approved order attribution definitions for the calling app on the current shop.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Was this section helpful?

Anchor to MutationsMutations

Anchor to orderAttributionDefinitionUpsert 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.

Arguments

Anchor to inputinput

•OrderAttributionDefinitionUpsertInput!

required

The input fields for upserting the order attribution definition.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?