Shopify Connector
Documentation
Version: 2
Documentation
Endpoint

Get Product Variants

Name

get_product_variants

Description

Gets a list of products with their variants. [API reference]

Related Tables

ProductVariants

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.
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.
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.
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
ProductId DT_I8 bigint False
Title DT_WSTR nvarchar(100) 100 False
Sku DT_WSTR nvarchar(500) 500 False
Price DT_WSTR nvarchar(100) 100 False
CompareAtPrice DT_WSTR nvarchar(100) 100 False
Position DT_I4 int False
Option1 DT_WSTR nvarchar(500) 500 False
Option2 DT_WSTR nvarchar(500) 500 False
Option3 DT_WSTR nvarchar(500) 500 False
CreatedAt DT_DBTIMESTAMP datetime False
UpdatedAt DT_DBTIMESTAMP datetime False
Taxable DT_BOOL bit False
InventoryItemId DT_I8 bigint False
InventoryQuantity DT_I4 int False
OldInventoryQuantity DT_I4 int False
InventoryPolicy DT_WSTR nvarchar(50) 50 False
InventoryManagement DT_WSTR nvarchar(100) 100 False
FulfillmentService DT_WSTR nvarchar(100) 100 False
Barcode DT_WSTR nvarchar(500) 500 False
Grams DT_I4 int False
ImageId DT_WSTR nvarchar(500) 500 False
Weight DT_R8 float False
WeightUnit DT_WSTR nvarchar(50) 50 False
RequiresShipping DT_BOOL bit False
AdminGraphqlApiId DT_WSTR nvarchar(500) 500 False
PresentmentPrices DT_WSTR nvarchar(4000) 4000 False
ProductTitle DT_WSTR nvarchar(500) 500 False
ProductBodyHtml DT_NTEXT nvarchar(MAX) False
ProductVendor DT_WSTR nvarchar(500) 500 False
ProductType DT_WSTR nvarchar(500) 500 False
ProductCreatedAt DT_DBTIMESTAMP datetime False
ProductHandle DT_WSTR nvarchar(500) 500 False
ProductUpdatedAt DT_DBTIMESTAMP datetime False
ProductPublishedAt DT_DBTIMESTAMP datetime False
ProductTemplateSuffix DT_WSTR nvarchar(500) 500 False
ProductStatus DT_WSTR nvarchar(100) 100 False
ProductPublishedScope DT_WSTR nvarchar(50) 50 False
ProductTags DT_WSTR nvarchar(500) 500 False
ProductAdminGraphqlApiId DT_WSTR nvarchar(500) 500 False
ProductImage DT_WSTR nvarchar(500) 500 False
ProductImageId DT_I8 bigint False
ProductImageProductId DT_I8 bigint False
ProductImagePosition DT_I4 int False
ProductImageCreatedAt DT_DBTIMESTAMP datetime False
ProductImageUpdatedAt DT_DBTIMESTAMP datetime False
ProductImageAlt DT_WSTR nvarchar(500) 500 False
ProductImageWidth DT_I4 int False
ProductImageHeight DT_I4 int False
ProductImageSrc DT_WSTR nvarchar(1000) 1000 False
ProductImageAdminGraphqlApiId DT_WSTR nvarchar(500) 500 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 ProductVariants table using API Destination

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

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

ODBC application

Use these SQL queries in your ODBC application data source:

Get product variants 

SELECT * FROM get_product_variants

Get list of all product variants 

SELECT * FROM ProductVariants

Get all product variants by a specific product ID 

SELECT * FROM ProductVariants Where ProductId='1111111111111'

Get all product variants by multiple specific product IDs 

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

get_product_variants endpoint belongs to ProductVariants 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 product variants 

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

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Get list of all product variants 

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

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Get all product variants by a specific product ID 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM ProductVariants Where ProductId=''1111111111111''';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Get all product variants by multiple specific product IDs 

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

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

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