shopify: appmixer.shopify.products.GetProduct

Basic Information

Name

appmixer.shopify.products.GetProduct

Version

1.0.0

Visibility

Public

Description

Get a product with its variants (up to 250) and media (up to 250).

Input Ports

in

Field	Type	Description
Product ID	text	Pick a product, or enter its ID (gid://shopify/Product/123 or the numeric ID 123).

Output Ports

out

Field	Type	Description
Product ID	string	-
Legacy Resource ID	string	-
Title	string	-
Handle	string	-
Description HTML	string	-
Vendor	string	-
Product Type	string	-
Status	string	-
Tags	array	-
Created At	string	-
Updated At	string	-
Published At	string	-
Template Suffix	string	-
Online Store URL	string	-
Total Inventory	integer	-
Tracks Inventory	boolean	-
Has Only Default Variant	boolean	-
SEO	object	-
Category	object	-
Price Range	object	-
Options	array	-
Variants	array	-
Media	array	-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.shopify.products.GetProduct", "description": "Get a product with its variants (up to 250) and media (up to 250).", "author": "Jimoh Damilola <jimoh@client.io>", "private": false, "auth": { "service": "appmixer:shopify", "scope": [ "read_products" ] }, "quota": { "manager": "appmixer:shopify", "resources": "requests", "scope": { "userId": "{{userId}}" } }, "inPorts": [ { "name": "in", "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "inspector": { "inputs": { "id": { "type": "text", "label": "Product ID", "index": 0, "tooltip": "Pick a product, or enter its ID (gid://shopify/Product/123 or the numeric ID 123).", "source": { "url": "/component/appmixer/shopify/products/FindProducts?outPort=out", "data": { "messages": { "in/outputType": "array" }, "properties": { "isSource": true }, "transform": "./FindProducts#productsToSelectArray" } } } } } } ], "outPorts": [ { "name": "out", "schema": { "type": "object", "required": [ "id", "legacyResourceId", "title", "handle", "descriptionHtml", "vendor", "productType", "status", "tags", "createdAt", "updatedAt", "totalInventory", "tracksInventory", "hasOnlyDefaultVariant", "seo", "priceRangeV2", "options", "variants", "media" ], "properties": { "id": { "type": "string", "title": "Product ID", "example": "gid://shopify/Product/16347478065233" }, "legacyResourceId": { "type": "string", "title": "Legacy Resource ID", "example": "16347478065233" }, "title": { "type": "string", "title": "Title", "example": "Organic Cotton T-Shirt" }, "handle": { "type": "string", "title": "Handle", "example": "organic-cotton-t-shirt" }, "descriptionHtml": { "type": "string", "title": "Description HTML", "example": "<p>Soft, breathable organic cotton.</p>" }, "vendor": { "type": "string", "title": "Vendor", "example": "Acme Apparel" }, "productType": { "type": "string", "title": "Product Type", "example": "T-Shirts" }, "status": { "type": "string", "title": "Status", "example": "ACTIVE" }, "tags": { "type": "array", "title": "Tags", "items": { "type": "string" }, "example": [ "summer", "cotton" ] }, "createdAt": { "type": "string", "format": "date-time", "title": "Created At", "example": "2026-10-05T08:22:31Z" }, "updatedAt": { "type": "string", "format": "date-time", "title": "Updated At", "example": "2026-10-05T08:22:33Z" }, "publishedAt": { "type": "string", "format": "date-time", "title": "Published At", "example": "2026-10-05T08:22:40Z" }, "templateSuffix": { "type": "string", "title": "Template Suffix", "example": "special" }, "onlineStoreUrl": { "type": "string", "title": "Online Store URL", "example": "https://acme.example.com/products/organic-cotton-t-shirt" }, "totalInventory": { "type": "integer", "title": "Total Inventory", "example": 42 }, "tracksInventory": { "type": "boolean", "title": "Tracks Inventory", "example": true }, "hasOnlyDefaultVariant": { "type": "boolean", "title": "Has Only Default Variant", "example": false }, "seo": { "type": "object", "title": "SEO", "properties": { "title": { "type": "string", "title": "SEO.Title", "example": "Organic Cotton T-Shirt | Acme" }, "description": { "type": "string", "title": "SEO.Description", "example": "Soft, breathable organic cotton tee." } } }, "category": { "type": "object", "title": "Category", "required": [ "id", "name", "fullName" ], "properties": { "id": { "type": "string", "title": "Category.ID", "example": "gid://shopify/TaxonomyCategory/aa-1-13-8" }, "name": { "type": "string", "title": "Category.Name", "example": "T-Shirts" }, "fullName": { "type": "string", "title": "Category.Full Name", "example": "Apparel & Accessories > Clothing > Clothing Tops > T-Shirts" } } }, "priceRangeV2": { "type": "object", "title": "Price Range", "required": [ "minVariantPrice", "maxVariantPrice" ], "properties": { "minVariantPrice": { "type": "object", "title": "Price Range.Min Variant Price", "required": [ "amount", "currencyCode" ], "properties": { "amount": { "type": "string", "title": "Price Range.Min Variant Price.Amount", "example": "19.0" }, "currencyCode": { "type": "string", "title": "Price Range.Min Variant Price.Currency Code", "example": "USD" } } }, "maxVariantPrice": { "type": "object", "title": "Price Range.Max Variant Price", "required": [ "amount", "currencyCode" ], "properties": { "amount": { "type": "string", "title": "Price Range.Max Variant Price.Amount", "example": "24.0" }, "currencyCode": { "type": "string", "title": "Price Range.Max Variant Price.Currency Code", "example": "USD" } } } } }, "options": { "type": "array", "title": "Options", "items": { "type": "object", "required": [ "id", "name", "position", "values" ], "properties": { "id": { "type": "string", "title": "Option ID", "example": "gid://shopify/ProductOption/18960245588049" }, "name": { "type": "string", "title": "Name", "example": "Size" }, "position": { "type": "integer", "title": "Position", "example": 1 }, "values": { "type": "array", "title": "Values", "items": { "type": "string" }, "example": [ "S", "M", "L" ] } } }, "example": [ { "id": "gid://shopify/ProductOption/18960245588049", "name": "Size", "position": 1, "values": [ "S", "M", "L" ] } ] }, "variants": { "type": "array", "title": "Variants", "items": { "type": "object", "required": [ "id", "legacyResourceId", "title", "displayName", "price", "position", "inventoryPolicy", "taxable", "availableForSale", "createdAt", "updatedAt", "barcodes", "selectedOptions", "inventoryItem" ], "properties": { "id": { "type": "string", "title": "Variant ID", "example": "gid://shopify/ProductVariant/62809874268241" }, "legacyResourceId": { "type": "string", "title": "Legacy Resource ID", "example": "62809874268241" }, "title": { "type": "string", "title": "Title", "example": "M" }, "displayName": { "type": "string", "title": "Display Name", "example": "Organic Cotton T-Shirt - M" }, "sku": { "type": "string", "title": "SKU", "example": "TS-ORG-M" }, "price": { "type": "string", "title": "Price", "example": "19.00" }, "compareAtPrice": { "type": "string", "title": "Compare At Price", "example": "25.00" }, "position": { "type": "integer", "title": "Position", "example": 1 }, "inventoryPolicy": { "type": "string", "title": "Inventory Policy", "example": "DENY" }, "inventoryQuantity": { "type": "integer", "title": "Inventory Quantity", "example": 14 }, "taxable": { "type": "boolean", "title": "Taxable", "example": true }, "availableForSale": { "type": "boolean", "title": "Available For Sale", "example": true }, "createdAt": { "type": "string", "format": "date-time", "title": "Created At", "example": "2026-10-05T08:22:31Z" }, "updatedAt": { "type": "string", "format": "date-time", "title": "Updated At", "example": "2026-10-05T08:22:31Z" }, "barcodes": { "type": "array", "title": "Barcodes", "items": { "type": "object", "required": [ "value" ], "properties": { "type": { "type": "string", "title": "Type", "example": "EAN_13" }, "value": { "type": "string", "title": "Value", "example": "4006381333931" } } }, "example": [ { "type": "EAN_13", "value": "4006381333931" } ] }, "selectedOptions": { "type": "array", "title": "Selected Options", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "title": "Name", "example": "Size" }, "value": { "type": "string", "title": "Value", "example": "M" } } }, "example": [ { "name": "Size", "value": "M" } ] }, "inventoryItem": { "type": "object", "title": "Inventory Item", "required": [ "id", "tracked", "requiresShipping", "measurement" ], "properties": { "id": { "type": "string", "title": "Inventory Item.ID", "example": "gid://shopify/InventoryItem/64827969437777" }, "tracked": { "type": "boolean", "title": "Inventory Item.Tracked", "example": true }, "requiresShipping": { "type": "boolean", "title": "Inventory Item.Requires Shipping", "example": true }, "measurement": { "type": "object", "title": "Inventory Item.Measurement", "properties": { "weight": { "type": "object", "title": "Inventory Item.Measurement.Weight", "required": [ "unit", "value" ], "properties": { "unit": { "type": "string", "title": "Inventory Item.Measurement.Weight.Unit", "example": "GRAMS" }, "value": { "type": "number", "title": "Inventory Item.Measurement.Weight.Value", "example": 180 } } } } } } } } }, "example": [ { "id": "gid://shopify/ProductVariant/62809874268241", "legacyResourceId": "62809874268241", "title": "M", "displayName": "Organic Cotton T-Shirt - M", "sku": "TS-ORG-M", "price": "19.00", "compareAtPrice": null, "position": 1, "inventoryPolicy": "DENY", "inventoryQuantity": 14, "taxable": true, "availableForSale": true, "createdAt": "2026-10-05T08:22:31Z", "updatedAt": "2026-10-05T08:22:31Z", "barcodes": [], "selectedOptions": [ { "name": "Size", "value": "M" } ], "inventoryItem": { "id": "gid://shopify/InventoryItem/64827969437777", "tracked": true, "requiresShipping": true, "measurement": { "weight": { "unit": "GRAMS", "value": 180 } } } } ] }, "media": { "type": "array", "title": "Media", "items": { "type": "object", "required": [ "id", "mediaContentType", "status" ], "properties": { "id": { "type": "string", "title": "Media ID", "example": "gid://shopify/MediaImage/73881115492433" }, "alt": { "type": "string", "title": "Alt Text", "example": "Front view" }, "mediaContentType": { "type": "string", "title": "Media Content Type", "example": "IMAGE" }, "status": { "type": "string", "title": "Status", "example": "READY" }, "preview": { "type": "object", "title": "Preview", "properties": { "image": { "type": "object", "title": "Preview.Image", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "Preview.Image.URL", "example": "https://cdn.shopify.com/s/files/1/1079/6174/5489/files/front.png?v=1791188552" }, "width": { "type": "integer", "title": "Preview.Image.Width", "example": 480 }, "height": { "type": "integer", "title": "Preview.Image.Height", "example": 480 } } } } } } }, "example": [ { "id": "gid://shopify/MediaImage/73881115492433", "alt": "Front view", "mediaContentType": "IMAGE", "status": "READY", "preview": { "image": { "url": "https://cdn.shopify.com/s/files/1/1079/6174/5489/files/front.png?v=1791188552", "width": 480, "height": 480 } } } ] } } } } ], "icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiA/PjwhRE9DVFlQRSBzdmcgIFBVQkxJQyAnLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4nICAnaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkJz48c3ZnIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDEyOCAxMjgiIGlkPSJTb2NpYWxfSWNvbnMiIHZlcnNpb249IjEuMSIgdmlld0JveD0iMCAwIDEyOCAxMjgiIHhtbDpzcGFjZT0icHJlc2VydmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPjxnIGlkPSJfeDM3X19zdHJva2UiPjxnIGlkPSJTaG9waWZ5Ij48cmVjdCBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGZpbGw9Im5vbmUiIGZpbGwtcnVsZT0iZXZlbm9kZCIgaGVpZ2h0PSIxMjgiIHdpZHRoPSIxMjgiLz48cGF0aCBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik03MC40NSwxOS41NjhjMC0wLjQzNiwwLjAwNC0wLjg2NCwwLjAwNC0xLjMzMiAgICBjMC00LjA4LTAuNTY1LTcuMzY4LTEuNDY5LTkuOTcyYzMuNjM0LDAuNDU2LDYuMDU0LDQuNjEyLDcuNjEsOS4zOTJDNzQuNzczLDE4LjIyNCw3Mi42OTksMTguODY4LDcwLjQ1LDE5LjU2OHogTTYyLjQyNiw2MC4yNDggICAgYzAsMC00LjI1MS0yLjI4LTkuNDYxLTIuMjhjLTcuNjQyLDAtOC4wMjgsNC44Mi04LjAyOCw2LjAzMmMwLDYuNjI4LDE3LjE4Nyw5LjE2OCwxNy4xODcsMjQuNjg4ICAgIGMwLDEyLjIwOC03LjcwNiwyMC4wNzItMTguMDk4LDIwLjA3MmMtMTIuNDcsMC0xOC44NDYtNy44LTE4Ljg0Ni03LjhsMy4zMzktMTEuMDg0YzAsMCw2LjU1NSw1LjY1NiwxMi4wODgsNS42NTYgICAgYzMuNjEsMCw1LjA4My0yLjg2LDUuMDgzLTQuOTQ4YzAtOC42NDQtMTQuMTAyLTkuMDMyLTE0LjEwMi0yMy4yMzZjMC0xMS45NTIsOC41MzgtMjMuNTIsMjUuNzcyLTIzLjUyICAgIGM2LjYzOSwwLDkuOTIzLDEuOTEyLDkuOTIzLDEuOTEyTDYyLjQyNiw2MC4yNDh6IE01OS41OTYsNC40MjhjMC43MTIsMCwxLjQyNSwwLjI0NCwyLjExLDAuNzE2ICAgIGMtNS4yNjYsMi40ODgtMTAuOTA2LDguNzYtMTMuMjksMjEuMjhjLTMuNDgzLDEuMDg0LTYuODg2LDIuMTQ0LTEwLjAzNCwzLjEyNEM0MS4xNzEsMTkuOTk2LDQ3Ljc5OCw0LjQyOCw1OS41OTYsNC40Mjh6ICAgICBNNjYuMTQ3LDIwLjE5MmMwLDAuMjUyLTAuMDA0LDAuNDg0LTAuMDA0LDAuNzE2Yy00LDEuMjQ0LTguMzQzLDIuNTk2LTEyLjY5NywzLjk1MkM1NS44OSwxNS4zOCw2MC40NzIsMTAuOCw2NC40OCw5LjA3MiAgICBDNjUuNDg3LDExLjYxNiw2Ni4xNDcsMTUuMjY4LDY2LjE0NywyMC4xOTJ6IE04NS4wNTgsMTUuMDk3Yy0wLjI2LDAuMDM0LTAuNDg1LDAuMDg1LTAuNjQyLDAuMTMxICAgIGMtMC4wODQsMC4wMjQtMS40ODUsMC40Ni0zLjgwNSwxLjE4Qzc4LjMzOSw5Ljg0LDc0LjMzMSwzLjgwNCw2Ny4yODIsMy44MDRjLTAuMTk1LDAtMC4zOTgsMC4wMDgtMC41OTcsMC4wMiAgICBDNjQuNjc5LDEuMTYsNjIuMTk1LDAsNjAuMDUsMEM0My42MjMsMCwzNS43NzQsMjAuNjQsMzMuMzE0LDMxLjEyNGMtNi4zODQsMS45ODgtMTAuOTE4LDMuNC0xMS40OTUsMy41ODQgICAgYy0zLjU2NiwxLjEyNC0zLjY3OCwxLjIzNi00LjE0Myw0LjYwOEMxNy4zMjIsNDEuODcyLDgsMTE0LjMyNCw4LDExNC4zMjRMODAuNjM5LDEyOGwwLjA3Ny0wLjAxN0w4NS4wNTgsMTUuMDk3eiBNOTAuMjU5LDE4LjY1MiAgICBjMi4wOTcsMi4wOTMsNC40NzUsNC40NjQsNC40NzUsNC40NjRzOS43ODcsMC43MjgsMTAuMjQ5LDAuNzY4YzAuNDY2LDAuMDQsMS4wMjcsMC4zOTYsMS4xMTQsMS4wNCAgICBjMC4wODgsMC42NDQsMTMuOTAzLDk0LjUyLDEzLjkwMyw5NC41MmwtMzMuOTAxLDcuMzY5TDkwLjI1OSwxOC42NTJ6IiBmaWxsPSIjODFCRjM3IiBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGlkPSJTaG9waWZ5XzFfIi8+PC9nPjwvZz48L3N2Zz4=" }