Skip to main content

SyncProductsInput

Autogenerated input type of SyncProducts

input SyncProductsInput {
  brandId: ID
  clientMutationId: String
  createMissing: Boolean
  direction: SyncDirectionEnum
  integrationId: ID
  productIds: [ID!]
}

Fields​

SyncProductsInput.brandId ● ID scalar​

The ID of the brand to sync products with. If not provided, the system will use the brand specified in the current context. If no brand is specified in the context, the operation will fail returning a BadRequest error.

SyncProductsInput.clientMutationId ● String scalar​

A unique identifier for the client performing the mutation.

SyncProductsInput.createMissing ● Boolean scalar​

If set to true, missing products will be created locally or in the external source based on the direction of the sync operation. Be careful when using this option, it can lead to data inconsistency.

SyncProductsInput.direction ● SyncDirectionEnum enum​

The direction of the sync operation. Possible values are: FROM_EXTERNAL, TO_EXTERNAL. Default value is BIDIRECTIONAL.

SyncProductsInput.integrationId ● ID scalar​

The ID of the integration to sync products with. If not provided, all integrations will be used.

SyncProductsInput.productIds ● [ID!] list scalar​

The list of product IDs to sync. If not provided, all products will be synced.

Member Of​

syncProducts mutation