channelFullSync

Triggers a full product resync for the specified Channel. All published products are added to the channel's product feed attention set, causing the next poll or event-triggered consumption to receive current state…

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the channelFullSync action (under Channel).
Fill in the fields below, then reference the result from later steps as {{channelfullsync.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation ChannelFullSync($channelId: ID!, $language: LanguageCode, $country: CountryCode, $beforeUpdatedAt: DateTime, $updatedAtSince: DateTime) {
  channelFullSync(
    channelId: $channelId
    language: $language
    country: $country
    beforeUpdatedAt: $beforeUpdatedAt
    updatedAtSince: $updatedAtSince
  ) {
    fullSyncTraceInfo {
      country
      language
      operationId
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

channelIdstringrequired

The ID of the channel to trigger a full sync for. Accepts a [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) or [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) global ID.

languagestring

The language to scope the sync to. When omitted, all languages for the targeted countries are synced.

One ofAFAKAMARASAZBEBGBMBNBOBRBSCACECKBCSCYDADEDZEEELENEOESETEUFAFFFIFILFOFRFYGAGDGLGUGV

countrystring

The country to scope the sync to. When omitted, all countries covered by the channel's specification are synced.

One ofAFAXALDZADAOAIAGARAMAWACAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCACVBQKY

beforeUpdatedAtstring

Syncs only products that haven't changed since the specified timestamp.

updatedAtSincestring

Syncs only products that have changed since the specified timestamp.

json

{
  "channelId": "string",
  "language": "AF",
  "country": "AF",
  "beforeUpdatedAt": "string",
  "updatedAtSince": "string"
}

Response

Read the result with {{channelfullsync.response.data.data.channelFullSync}}. If the API returns errors, the step fails and they are at {{channelfullsync.response.data.errors}}.

fullSyncTraceInfoarray<object>

countryobject

languageobject

operationIdobject

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?