EndPoint Get Products

Name

get_products

Description

Gets a list of products. [API reference]

Parameters

Parameter

Label

Required

Options

Description

ids

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)

since_id

Since Product Id

Restrict results created after the specified product ID.

created_at_max

Created Before

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

created_at_min

Created After

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

updated_at_max

Updated Before

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

updated_at_min

Updated After

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

limit

Page Size

The maximum number of records to show.

fields

Only Fields to Show

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

Option	Value
None
Output Presentment Prices (All Currencies)	include-presentment-prices

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
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`

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:

Get Products using API Source

Shopify

Get Products

SSIS API Source - Read from table or endpoint

Get Products using API Destination

Shopify

Get Products