EndPoint Get Product

Contents

Name

get_product

Gets a specific product. [API reference]

Parameter

Label

Required

Options

Description

Product Id

YES

The ID of the product for which data should be read.

fields

Only Fields to Show

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

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

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.