Cmdlets for Shopify

Build 24.0.9060

ProductListings

Query and delete product listings.

Table-Specific Information

Select

The cmdlet uses the Shopify API to process search criteria that refer to the ProductId and Handle columns. The supported SQL operators are '=' and 'IN' for ProductId and '=' and 'IN' for Handle column. The cmdlet processes other filters client-side within the cmdlet.

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

SELECT * FROM ProductListings WHERE ProductId = '123'

SELECT * FROM ProductListings WHERE ProductId IN ('123', '456')

SELECT * FROM ProductListings WHERE Handle = 'ipod-nano'

SELECT * FROM ProductListings WHERE Handle IN ('ipod-nano', 'ipod-nano2')

Delete

Delete a product listing to unpublish a product from your app (ProductId is required):

DELETE FROM ProductListings WHERE Productid = 512433520663

Columns

Name Type ReadOnly References Description
ProductId [KEY] Long False

The unique identifer of the product this listing is for. The primary key for this resource.

Title String False

The name of the product.

BodyHtml String False

The description of the product, complete with HTML formatting.

Handle String True

A human-friendly unique string for the Product automatically generated from its title.

Variants String True

A list of variant objects, each one representing a slightly different version of the product.

Images String False

A list of image objects, each one representing an image associated with the product.

ProductType String False

A categorization that a product can be tagged with, commonly used for filtering and searching.

Options String True

Custom product property names like 'Size', 'Color', and 'Material'.

Tags String False

A categorization that a product can be tagged with, commonly used for filtering.

Vendor String False

The name of the vendor of the product.

PublishedAt Datetime True

The date and time when the product was published to the Online Store channel.

CreatedAt Datetime True

The date and time when the product was created.

UpdatedAt Datetime True

The date and time when the product was last modified.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060