Publications
Returns the list of publications.
Table-Specific Information
Select
The cmdlet uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,IN' comparison operators.
- CatalogType supports the '=' comparison operator.
The cmdlet processes other filters client-side within the cmdlet.
For example, the following queries are processed server-side:
SELECT * FROM Publications WHERE Id='VALUE'
SELECT * FROM Publications WHERE CatalogType='VALUE'
Insert
INSERT statements are mapped to the 'publicationCreate' GraphQL mutation.
The following columns can be used to create a new record:
AutoPublish, CatalogId, DefaultState
UPDATE
UPDATE statements are mapped to the 'publicationUpdate' GraphQL mutation.
The following columns can be updated:
AutoPublish, PublishablesToAdd, PublishablesToRemove
DELETE
DELETE statements are mapped to the 'publicationDelete' GraphQL mutation.
You can delete entries by specifying the 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 column fields are used in the WHERE clause of SELECT statements, to offer a more granular control over the tuples that are returned from the data source, or as parameters in INSERT statements.
Name | Type | Description |
DefaultState | String |
Whether to create an empty publication or prepopulate it with all products. |
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. |