CData Python Connector for Shopify

Build 25.0.9454

Publications

Defines publication targets, representing sales channels or marketplaces where products and collections are visible.

Table-Specific Information

Select

The connector uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The connector processes other filters client-side within the connector.

  • Id supports the '=, IN' comparison operators.
  • CatalogType supports the '=, IN' comparison operators.

For example, the following queries are processed server-side:

  SELECT * FROM Publications WHERE Id = 'Val1'
  SELECT * FROM Publications WHERE CatalogType = 'Val1'

Insert

The following columns can be used to create a new record:

AutoPublish, CatalogId

The following pseudo-column can be used to create a new record:

DefaultState

Update

The following column can be updated:

AutoPublish

The following pseudo-columns can be used to update a record:

PublishablesToAdd, PublishablesToRemove

Delete

You can delete entries by specifying the following column:

Id

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A globally unique identifier for the publication record.

AutoPublish Bool False

Indicates whether new products are automatically published to this publication when they are created.

SupportsFuturePublishing Bool True

Specifies whether this publication allows scheduling products to be published at a future date.

CatalogId String True

The globally unique identifier of the catalog associated with this publication.

AddAllProductsOperationId String True

The globally unique identifier of the background operation responsible for adding all products to this publication.

AddAllProductsOperationStatus String True

The current processing status of the 'Add All Products' operation, such as 'pending', 'in_progress', or 'completed'.

AddAllProductsOperationProcessedRowCount Int True

The total number of rows processed by the 'Add All Products' operation, including successfully imported, failed, and skipped rows.

AddAllProductsOperationRowCountCount Int True

An estimated count of the total number of rows within the 'Add All Products' background operation.

AddAllProductsOperationRowCountExceedsMax Bool True

Indicates whether the 'Add All Products' operation exceeded the maximum allowable number of reportable rows.

CatalogCsvOperationId String True

The globally unique identifier of the background operation responsible for generating or importing catalog data via CSV.

CatalogCsvOperationStatus String True

The current status of the catalog CSV operation, such as 'queued', 'processing', or 'finished'.

CatalogCsvOperationProcessedRowCount Int True

The total number of rows processed during the catalog CSV operation, summing successful, failed, and skipped entries.

CatalogCsvOperationRowCountCount Int True

An estimated total count of rows included in the catalog CSV operation.

CatalogCsvOperationRowCountExceedsMax Bool True

Indicates whether the catalog CSV operation exceeded the maximum number of rows allowed for reporting.

PublicationResourceOperationId String True

The globally unique identifier of the background operation that manages resource publishing for this publication.

PublicationResourceOperationStatus String True

The current status of the publication resource operation, such as 'pending', 'running', or 'complete'.

PublicationResourceOperationProcessedRowCount Int True

The total number of rows processed in the publication resource operation, including imported, failed, and skipped entries.

PublicationResourceOperationRowCountCount Int True

An estimated total count of rows handled by the publication resource operation.

PublicationResourceOperationRowCountExceedsMax Bool True

Indicates whether the publication resource operation exceeded the limit of reportable rows.

CatalogType String True

Specifies the type of catalog this publication is associated with, such as product, collection, or custom type.

Pseudo-Columns

Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.

Name Type Description
DefaultState String

Defines whether the publication should be created empty or prepopulated with all products by default.

The allowed values are ALL_PRODUCTS, EMPTY.

PublishablesToAdd String

A comma-separated list of publishable resource IDs (such as products or collections) to be added to the publication. Supports up to 50 IDs per update.

PublishablesToRemove String

A comma-separated list of publishable resource IDs to be removed from the publication. Supports up to 50 IDs per update.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454