Shopify Connector
Documentation
Version: 2
Documentation
Endpoint

Get Products

Name

get_products

Description

Gets a list of products. [API reference]

Related Tables

Products

Parameters

Parameter Label Required Options Description
ids Product Id(s) - Comma separated NO Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in PaginationParams)
since_id Since Product Id NO Restrict results created after the specified product ID.
created_at_max Created Before NO Restrict results to products created before a specified date. (format: 2014-04-25T16:15:47-04:00)
created_at_min Created After NO Restrict results to products created after a specified date. (format: 2014-04-25T16:15:47-04:00)
updated_at_max Updated Before NO Restrict results to products last updated before a specified date. (format: 2014-04-25T16:15:47-04:00)
updated_at_min Updated After NO Restrict results to products last updated after a specified date. (format: 2014-04-25T16:15:47-04:00)
limit Page Size NO The maximum number of records to show.
fields Only Fields to Show NO
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
Limit data retrieval to only the selected product-related fields.
ExtraApiFeatures Extra Api Features (** SLOW **) NO
Option Value
None
Output Presentment Prices (All Currencies) include-presentment-prices

Output Columns

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

Input Columns

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

Examples

SSIS

Use Shopify Connector in API Source component to read data or in API Destination component to read/write data:

Read from Products table using API Destination

This Endpoint belongs to Products table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Shopify
Products
Select, Lookup
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get products 

SELECT * FROM get_products

Get list of products 

SELECT * FROM Products

Get a specific product by its ID 

SELECT * FROM Products WITH Id=1111111111111

Get multiple specific products by their IDs 

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:

Get products 

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

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Get list of products 

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

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Get a specific product by its ID 

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

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Get multiple specific products by their IDs 

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).