Publications
Returns the list of publications.
Table-Specific Information
Select
The server uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The server processes other filters client-side within the server.
- 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 ID. | |
| AutoPublish | Bool | False |
Whether new products are automatically published to this publication. | |
| SupportsFuturePublishing | Bool | True |
Whether the publication supports future publishing. | |
| CatalogId | String | True |
A globally-unique ID. | |
| AddAllProductsOperationId | String | True |
A globally-unique ID. | |
| AddAllProductsOperationStatus | String | True |
The status of this operation. | |
| AddAllProductsOperationProcessedRowCount | Int | True |
The count of processed rows, summing imported, failed, and skipped rows. | |
| AddAllProductsOperationRowCountCount | Int | True |
Estimated number of rows contained within this background operation. | |
| AddAllProductsOperationRowCountExceedsMax | Bool | True |
Whether the operation exceeds max number of reportable rows. | |
| CatalogCsvOperationId | String | True |
A globally-unique ID. | |
| CatalogCsvOperationStatus | String | True |
The status of this operation. | |
| CatalogCsvOperationProcessedRowCount | Int | True |
The count of processed rows, summing imported, failed, and skipped rows. | |
| CatalogCsvOperationRowCountCount | Int | True |
Estimated number of rows contained within this background operation. | |
| CatalogCsvOperationRowCountExceedsMax | Bool | True |
Whether the operation exceeds max number of reportable rows. | |
| PublicationResourceOperationId | String | True |
A globally-unique ID. | |
| PublicationResourceOperationStatus | String | True |
The status of this operation. | |
| PublicationResourceOperationProcessedRowCount | Int | True |
The count of processed rows, summing imported, failed, and skipped rows. | |
| PublicationResourceOperationRowCountCount | Int | True |
Estimated number of rows contained within this background operation. | |
| PublicationResourceOperationRowCountExceedsMax | Bool | True |
Whether the operation exceeds max number of reportable rows. | |
| CatalogType | String | True |
Filter publications by catalog 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 |
Whether to create an empty publication or prepopulate it with all products. The allowed values are ALL_PRODUCTS, EMPTY. |
| PublishablesToAdd | String |
A simple, comma-separated list of publishable IDs to add. The maximum number of publishables to update simultaneously is 50. |
| PublishablesToRemove | String |
A simple, comma-separated list of publishable IDs to remove. The maximum number of publishables to update simultaneously is 50. |