EndPoint Get Products
Name
get_products
Description
Gets a list of products.
[API Help]
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.
|
| 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.
|
Output Columns
| Label |
DataType |
Length |
Raw |
Description |
| Id |
DT_I8 |
0 |
False |
|
| Title |
DT_WSTR |
200 |
False |
|
| BodyHtml |
DT_NTEXT |
0 |
False |
|
| Vendor |
DT_WSTR |
200 |
False |
|
| ProductType |
DT_WSTR |
200 |
False |
|
| CreatedAt |
DT_DBTIMESTAMP |
0 |
False |
|
| UrlHandle |
DT_WSTR |
200 |
False |
|
| UpdatedAt |
DT_DBTIMESTAMP |
0 |
False |
|
| PublishedAt |
DT_DBTIMESTAMP |
0 |
False |
|
| TemplateSuffix |
DT_WSTR |
200 |
False |
|
| Status |
DT_WSTR |
200 |
False |
|
| PublishedScope |
DT_WSTR |
200 |
False |
|
| Tags |
DT_WSTR |
4000 |
False |
|
| AdminGraphqlApiId |
DT_WSTR |
200 |
False |
|
| Variants |
DT_NTEXT |
0 |
False |
|
| Options |
DT_WSTR |
4000 |
False |
|
| Images |
DT_NTEXT |
4000 |
False |
|
| Image |
DT_WSTR |
4000 |
False |
|
| ImageId |
DT_I8 |
0 |
False |
|
| ImageProductId |
DT_I8 |
0 |
False |
|
| ImagePosition |
DT_I4 |
0 |
False |
|
| ImageCreatedAt |
DT_DBTIMESTAMP |
0 |
False |
|
| ImageUpdatedAt |
DT_DBTIMESTAMP |
0 |
False |
|
| ImageAlt |
DT_WSTR |
4000 |
False |
|
| ImageWidth |
DT_I4 |
0 |
False |
|
| ImageHeight |
DT_I4 |
0 |
False |
|
| ImageSrc |
DT_WSTR |
4000 |
False |
|
| ImageVariantIds |
DT_WSTR |
500 |
False |
|
| ImageAdminGraphqlApiId |
DT_WSTR |
200 |
False |
|
| Metafields |
DT_NTEXT |
0 |
False |
|
Input Columns
| Label |
DataType |
Length |
Raw |
Description |
| ProductId |
DT_I8 |
0 |
False |
|
