Reference

Endpoint Get Products

Name

get_products

Description

Gets a list of products. [API reference]

Related Tables

Products

Parameters

Parameter Required Options
Name: ids

Label: Product Id(s) - Comma separated

Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in PaginationParams)
Name: since_id

Label: Since Product Id

Restrict results created after the specified product ID.
Name: created_at_max

Label: Created Before

Restrict results to products created before a specified date. (format: 2014-04-25T16:15:47-04:00)
Name: created_at_min

Label: Created After

Restrict results to products created after a specified date. (format: 2014-04-25T16:15:47-04:00)
Name: updated_at_max

Label: Updated Before

Restrict results to products last updated before a specified date. (format: 2014-04-25T16:15:47-04:00)
Name: updated_at_min

Label: Updated After

Restrict results to products last updated after a specified date. (format: 2014-04-25T16:15:47-04:00)
Name: limit

Label: Page Size

The maximum number of records to show.
Name: fields

Label: Only Fields to Show

Limit data retrieval to only the selected product-related fields.
Option Value
id id
title title
body_html body_html
vendor vendor
product_type product_type
created_at created_at
handle handle
updated_at updated_at
published_at published_at
template_suffix template_suffix
status status
published_scope published_scope
tags tags
admin_graphql_api_id admin_graphql_api_id
variants variants
options options
images images
image image
Name: ExtraApiFeatures

Label: Extra Api Features (** SLOW **)
Option Value
None
Output Presentment Prices (All Currencies) include-presentment-prices

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_I8 bigint
Title DT_WSTR nvarchar(200) 200
BodyHtml DT_NTEXT nvarchar(MAX)
Vendor DT_WSTR nvarchar(200) 200
ProductType DT_WSTR nvarchar(200) 200
CreatedAt DT_DBTIMESTAMP datetime
UrlHandle DT_WSTR nvarchar(200) 200
UpdatedAt DT_DBTIMESTAMP datetime
PublishedAt DT_DBTIMESTAMP datetime
TemplateSuffix DT_WSTR nvarchar(200) 200
Status DT_WSTR nvarchar(200) 200
PublishedScope DT_WSTR nvarchar(200) 200
Tags DT_WSTR nvarchar(4000) 4000
AdminGraphqlApiId DT_WSTR nvarchar(200) 200
Variants DT_NTEXT nvarchar(MAX)
Options DT_WSTR nvarchar(4000) 4000
Images DT_NTEXT nvarchar(MAX) 4000
Image DT_WSTR nvarchar(4000) 4000
ImageId DT_I8 bigint
ImageProductId DT_I8 bigint
ImagePosition DT_I4 int
ImageCreatedAt DT_DBTIMESTAMP datetime
ImageUpdatedAt DT_DBTIMESTAMP datetime
ImageAlt DT_WSTR nvarchar(4000) 4000
ImageWidth DT_I4 int
ImageHeight DT_I4 int
ImageSrc DT_WSTR nvarchar(4000) 4000
ImageVariantIds DT_WSTR nvarchar(500) 500
ImageAdminGraphqlApiId DT_WSTR nvarchar(200) 200
Metafields DT_NTEXT nvarchar(MAX)
If the column you are looking for is missing, consider customizing Shopify Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
ProductId DT_I8 bigint
Required columns that you need to supply are bolded.

Examples

SSIS

Use Shopify Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Products table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Shopify
Read and write Shopify data effortlessly. Integrate, manage, and automate customers, orders, products, and inventory — almost no coding required.
Shopify
Products
Optional Parameters
Product Id(s) - Comma separated
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Products table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get products:

API Destination - Shopify
Read and write Shopify data effortlessly. Integrate, manage, and automate customers, orders, products, and inventory — almost no coding required.
Shopify
Products
Select, Lookup
Optional Parameters
Product Id(s) - Comma separated
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Read products

<p>Gets a list of all products from the <code>Products</code> table. This table corresponds to the Shopify Products API.</p> 

SELECT * FROM Products

Read a product by ID

<p>Gets a specific product by its unique <code>Id</code>. Supply the product ID in the <code>WITH</code> clause or <code>WHERE</code> clause to filter the result.</p> 

SELECT * FROM Products WITH Id=1111111111111

Read multiple products by IDs

<p>Gets multiple products by supplying a comma-separated list of IDs in the <code>ids</code> parameter within the <code>WITH</code> clause.</p> 

SELECT * FROM Products WITH(ids='1111111111111,2222222222222,3333333333333')

get_products endpoint belongs to Products table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Read products

<p>Gets a list of all products from the <code>Products</code> table. This table corresponds to the Shopify Products API.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Products';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Read a product by ID

<p>Gets a specific product by its unique <code>Id</code>. Supply the product ID in the <code>WITH</code> clause or <code>WHERE</code> clause to filter the result.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Products WITH Id=1111111111111';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Read multiple products by IDs

<p>Gets multiple products by supplying a comma-separated list of IDs in the <code>ids</code> parameter within the <code>WITH</code> clause.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Products WITH(ids=''1111111111111,2222222222222,3333333333333'')';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

get_products endpoint belongs to Products table(s), and can therefore be used via those table(s).