Choose a version:

channelFullSync

mutation

Requires Access allowed for apps with read_product_listings scope.

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 for the complete catalog. Use this mutation after initial channel setup, after recovering from a prolonged outage, or when the channel's external catalog has drifted from Shopify's state.

The sync can be scoped to a specific country and language. When neither is specified, all country-language combinations covered by the channel's specification are triggered.

Anchor to Arguments

Arguments

Anchor to beforeUpdatedAtbeforeUpdatedAt

•DateTime

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

Anchor to channelIdchannelId

•ID!

required

The ID of the channel to trigger a full sync for. Accepts a Channel or Publication global ID.

Anchor to countrycountry

•CountryCode

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

Anchor to languagelanguage

•LanguageCode

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

Anchor to updatedAtSinceupdatedAtSince

•DateTime

Syncs only products that have changed since the specified timestamp.

Was this section helpful?

Anchor to ChannelFullSyncPayload returnsChannelFullSyncPayload returns

Anchor to fullSyncTraceInfofullSyncTraceInfo •[FullSyncTraceInfo!]: Trace information for each country-language product feed that was triggered. Returns one entry per feed.
Anchor to userErrorsuserErrors •[ChannelFullSyncUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

channelFullSync reference

Mutation Reference

mutation channelFullSync($channelId: ID!, $language: LanguageCode, $country: CountryCode, $beforeUpdatedAt: DateTime, $updatedAtSince: DateTime) {

channelFullSync(channelId: $channelId, language: $language, country: $country, beforeUpdatedAt: $beforeUpdatedAt, updatedAtSince: $updatedAtSince) {

fullSyncTraceInfo {

# FullSyncTraceInfo fields

}

userErrors {

field

message

}

Input

{

"channelId": "gid://shopify/<objectName>/10079785100",

"language": "AF",

"country": "AF",

"beforeUpdatedAt": "2019-09-07T15:50:00Z",

"updatedAtSince": "2019-09-07T15:50:00Z"

}