Shopify Native Actions

Search for products
Get product information
Get product images
Get product variants
Search for custom collections
Search for smart collections
Get collection information
Get collection products

Now, let’s go over these actions one by one.

Get Products

This action displays the products available in your Shopify store based on parameters such as product ID, title and vendor, among others.

Input

Response Payload

{
"products": [
{
"id": 1413101355074,
"title": "2 in 1 Gold MacBook Riser & Stand",
"body_html": "Número do modelo: Para suporte para Tablet PCMaterial: MetalRecurso: suporte para tablet para iPad e telefone e tabletNúmero do modelo: Para Macbook Pro 13 15Material: Liga de alumínioSuportes para tablet: Para Macbook Retina 12 13 15Suporte para tablet: Para Ipad mini 1 2 3 4 ", "vendor": "hapans", "product_type": "Electronics"

,
"handle": "2-in-1-gold-macbook-riser-stand",
"variants": [
{
"id": 12535571218498,
"product_id": 1413101355074,
"title": "silver",
"price": "47.99",
"sku": "9877410-silver",
"position": 1,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "silver",
"option2": null,
"option3": null,
"created_at": "2018-06-18T08:20:46-04:00",
"updated_at": "2022-10-13T02:39:56-04:00",
"taxable": false,
"barcode": null,
"grams": 0,
"image_id": 3736679678018,
"weight": 0,
"weight_unit": "kg",
"inventory_item_id": 12660409401410,
"inventory_quantity": 989,
"old_inventory_quantity": 989,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/12535571218498"
},
{
"id": 12535571251266,
"product_id": 1413101355074,
"title": "gold",
"price": "47.99",
"sku": "9877410-gold",
"position": 2,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "gold",
"option2": null,
"option3": null,
"created_at": "2018-06-18T08:20:46-04:00",
"updated_at": "2022-09-09T13:26:56-04:00",
"taxable": false,
"barcode": null,
"grams": 0,
"image_id": 3736679678018,
"weight": 0,
"weight_unit": "kg",
"inventory_item_id": 12660409434178,
"inventory_quantity"
: 998, "old_inventory_quantity"
: 998,
"admin_graphql_api_id": "gid://shopify/ProductVariant/12535571251266"
},
{
"id": 12535571284034,
"product_id": 1413101355074,
"title": "rose gold",
"price": "47.99",
"sku": "9877410-rose-gold",
"position": 3,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "rose gold",
"option2": null,
"option3": null,
"created_at": "2018-06-18T08:20:46-04:00",
"updated_at": "2018-09-12T00:53:05-04:00",
"taxable": false,
"barcode": null,
"grams": 0,
"image_id": 3736679710786,
"weight": 0,
"weight_unit": "kg",
"inventory_item_id": 12660409466946,
"inventory_quantity": 999,
"old_inventory_quantity": 999,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/12535571284034"
}
],
"options": [
{
"id": 1864082522178,
"product_id": 1413101355074,
"name": "Color",
"position": 1,
"values": [
"silver",
"gold",
"rose gold"
]
}
],
"images": [
{
"id": 3736679645250,
"product_id": 1413101355074,
"position": 1,
"created_at": "2018-06-18T08:20:46-04:00",
"updated_at": "2019-10-21T23:39:36-04:00",
"alt": null,
"width": 800,
"height": 800,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/macbook_stand.png?v=1571715576 ",
"variant_ids": [
],
"admin_graphql_api_id": "gid://shopify/ProductImage/3736679645250"
},
{
"id": 3736679678018,
"product_id": 1413101355074,
"position": 2,
"created_at": "2018-06-18T08:20:46-04:00",
"updated_at": "2019-10-21T23:39:36-04:00",
"alt": null,
"width": 640,
"height": 640,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004687.jpg?v=1571715576 ",
"variant_ids": [
12535571218498,
12535571251266
],
"admin_graphql_api_id": "gid://shopify/ProductImage/3736679678018"
},
{
"id": 3736679710786,
"product_id": 1413101355074,
"position": 3,
"created_at":"2018-06-18T08:20:46-04:00",
"updated_at": "2019-10-21T23:39:36-04:00",
"alt": null,
"width": 640,
"height": 640,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004689.jpg?v=1571715576 ",
"variant_ids": [
12535571284034
],
"admin_graphql_api_id": "gid://shopify/ProductImage/3736679710786"
},
{
"id": 3736679743554,
"product_id": 1413101355074,
"position": 4,
"created_at": "2018-06-18T08:20:46-04:00",
"updated_at": "2019-10-21T23:39:36-04:00",
"alt": null,
"width": 800,
"height": 800,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004701.jpg?v=1571715576 ",
"variant_ids": [...], // 0 itens
"admin_graphql_api_id": "gid://shopify/ProductImage/3736679743554"
},
{
"id": 3736679776322,
"product_id": 1413101355074,
"position": 5,
"created_at": "2018-06-18T08:20:46-04:00",
"updated_at": "2019-10-21T23:39:36-04:00",
"alt": null,
"width": 800,
"height": 632,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004699.jpg?v=1571715576 ",
"variant_ids": [...], // 0 itens
"admin_graphql_api_id": "gid://shopify/ProductImage/3736679776322"
}
],
"image": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/macbook_stand.png?v=1571715576 "
}
]
}

Get Product Info

This action brings up the information of a specific product based on the product ID.

Input

Response Payload

{
"product": {
"id": 1413101355074,
"title": "2 in 1 Gold MacBook Riser & Stand",
"body_html": "Número do modelo: Para suporte para Tablet PCMaterial: MetalRecurso: suporte para tablet para iPad e telefone Número do modelo do tablet: para Macbook Pro 13 15Material: liga de alumínioSuportes para tablet: Para Macbook Retina 12 13 15Suporte para tablet: Para Ipad mini 1 2 3 4 ", "vendor": "hapans", "product_type": "Electronics"

,
"handle": "2-in-1-gold-macbook-riser-stand",
"variants": [
{
"id": 12535571218498,
"product_id": 1413101355074,
"title": "silver",
"price": "47.99",
"sku": "9877410-silver",
"position": 1,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "silver",
"option2": null,
"option3": null,
"created_at": "2018-06-18T08:20:46-04:00",
"updated_at": "2022-10-13T02:39:56-04:00",
"taxable": false,
"barcode": null,
"grams": 0,
"image_id": 3736679678018,
"weight": 0,
"weight_unit": "kg",
"inventory_item_id": 12660409401410,
"inventory_quantity": 989,
"old_inventory_quantity": 989,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/12535571218498",
"image": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004687.jpg?v=1571715576 " }, { "id": 12535571251266, " product_id
"
:
1413101355074
,
"title": "gold",
"price": "47.99",
"sku": "9877410-gold",
"position": 2,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "gold",
"option2": null,
"option3": null,
"created_at": "2018-06-18T08:20:46-04:00",
"updated_at":"2022-09-09T13:26:56-04:00",
"taxable": false,
"barcode": null,
"grams": 0,
"image_id": 3736679678018,
"weight": 0,
"weight_unit": "kg",
"inventory_item_id": 12660409434178,
"inventory_quantity": 998,
"old_inventory_quantity": 998,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/12535571251266",
"image": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004687.jpg?v=1571715576 "
},
{
"id": 12535571284034,
"product_id": 1413101355074,
"title": "rose gold",
"price": "47.99",
"sku": "9877410-rose-gold",
"position": 3,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "rose gold",
"option2": null,
"option3": null,
"created_at": "2018-06-18T08:20:46-04:00",
"updated_at": "2018-09-12T00:53:05-04:00",
"taxable": false,
"barcode": null,
"grams": 0,
"image_id": 3736679710786,
"weight": 0,
"weight_unit": "kg",
"inventory_item_id": 12660409466946,
"inventory_quantity"
: 999, "old_inventory_quantity": 999, "admin_graphql_api_id": "gid://shopify/ProductVariant/12535571284034", "image": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004689.jpg?v=1571715576 " } ], "options": [ { "id": 1864082522178, "product_id": 1413101355074, "name": "Color", "position": 1, "values": [ "silver", "gold", "rose gold" ] } ], "images": [ { "id": 3736679645250, "product_id": 1413101355074, "position": 1, "created_at": "2018-06-18T08:20:46-04:00", "updated_at": "2019-10-21T23:39:36-04:00", "alt": null, "width": 800, "height": 800, "src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/macbook_stand.png?v=1571715576 ", "variant_ids": [ ], "admin_graphql_api_id": "gid://shopify/ProductImage/3736679645250" }, { "id": 3736679678018, "product_id": 1413101355074, "position": 2, "created_at": "2018-06-18T08:20:46-04:00", "updated_at": "2019-10-21T23:39:36-04:00", "alt": null, "width": 640,"height": 640, "src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004687.jpg?v=1571715576 ", "variant_ids": [ 12535571218498, 12535571251266 ], "admin_graphql_api_id": "gid://shopify/ProductImage/3736679678018" }, { "id": 3736679710786, "product_id": 1413101355074, "position": 3, "created_at": "2018-06-18T08:20:46-04:00", "updated_at": "2019-10-21T23:39:36-04:00", "alt": null, "width": 640,

"height": 640,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004689.jpg?v=1571715576 ",
"variant_ids": [
12535571284034
],
"admin_graphql_api_id": "gid://shopify/ProductImage/3736679710786"
},
{
"id": 3736679743554,
"product_id": 1413101355074,
"position": 4,
"created_at": "2018-06-18T08:20:46-04:00",
"updated_at": "2019-10-21T23:39:36-04:00",
"alt": null,
"width": 800,
"height": 800,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004701.jpg?v=1571715576 ",
"variant_ids": [... ], // 0 itens
"admin_graphql_api_id": "gid://shopify/ProductImage/3736679743554"
},
{
"id": 3736679776322,
"product_id": 1413101355074,
"position": 5,
"created_at": "2018-06-18T08:20:46-04:00",
"updated_at": "2019-10-21T23:39:36-04:00",
"alt": null,
"width": 800,
"height": 632,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004699.jpg?v=1571715576 ",
"variant_ids": [
],
"admin_graphql_api_id": "gid://shopify/ProductImage/3736679776322"
}
],
"image": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/macbook_stand.png?v=1571715576 "
}
}

Get Product Images

This action fetches the images of the product and its variants based on the product IDs.

Input

Response Payload

{
"images": [
{
"id": 3736679645250,
"product_id": 1413101355074,
"position": 1,
"width": 800,
"height": 800,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/macbook_stand.png?v=1571715576 "
},
{
"id": 3736679678018,
"product_id": 1413101355074,
"position": 2,
"width": 640,
"height": 640,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004687.jpg?v=1571715576 "
},
{
"id": 3736679710786,
"product_id": 1413101355074,
"position": 3,
"width": 640,
"height": 640,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004689.jpg?v=1571715576 "
},
{
"id": 3736679743554,
"product_id": 1413101355074,
"position": 4,
"width": 800,
"height": 800,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004701.jpg?v=1571715576 "
},
{
"id": 3736679776322,
"product_id": 1413101355074,
"position": 5,
"width": 800,
"height": 632,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/product-image-421004699.jpg?v=1571715576 "
}
]
}

Get Product Variants

This action displays the information of the variants of a product based on the product ID.

Input

Response Payload

{
"variants": [
{
"id": 12535571218498,
"product_id": 1413101355074,
"title": "silver",
"price": "47.99",
"sku": "9877410-silver",
"position": 1,
"compare_at_price": null,
"option1": "silver",
"option2": null,
"option3": null,
"barcode": null,
"grams": 0,
"image_id": 3736679678018,
"weight": 0,
"weight_unit": "kg",
"inventory_quantity": 989
}
]
}

Search For Custom Collections

This action searches the custom collections available for your products in your Shopify store.

Input

Response Payload

{
"custom_collections": [
{
"id": 34403156034,
"handle": "frontpage",
"title": "Produtos mais vendidos",
"body_html": "<p>Aqui estão nossos produtos mais vendidos.</p> <p>As dicas e truques irão potencializar sua loja Shopify com MUITO mais dados INCRÍVEIS!</p>",
"sort_order": "best-selling",
"image": {
"created_at": "2022-08-17T00:24:01-04:00",
"alt": null,
"width": 900,
"height": 900,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/collections/Custom_dimensions_900x900_px_8.jpg?v=1660710241 "
}
}
]
}

Search For Smart Collections

This action displays the smart collections of the products you have in your Shopify stores.

Input

Response Payload

{
"smart_collections": [
{
"id": 264802598978,
"handle": "backpack-collection",
"title": "Coleção de mochilas",
"body_html": "pegue sua mochila e comece a aproveitar sua vida ao ar livre!",
"sort_order": "best-selling",
"rules": [
{
"column": "tag",
"relation": "equals",
"condition": "backpack"
}
],
"image": {
"created_at": "2022-08-17T00:23:00-04:00",
"alt": null,
"width": 900,
"height": 900,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/collections/Custom_dimensions_900x900_px_7.jpg?v=1660710180 "
}
},
{
"id": 264802631746,
"handle": "electronics",
"title": "Electronics",
"body_html": "Procura o gadget digital com o qual você não consegue conviver. mais informações aqui.",
"sort_order": "best-selling",
"rules": [
{
"column": "tag",
"relation": "equals",
"condition": "Electronics"
}
],
"image": {
"created_at": "2022-08-17T00:21:47-04:00",
"alt": null,
"width": 900,
"height": 900,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/collections/Custom_dimensions_900x900_px_6.jpg?v=1660710107 "
}
}
]
}

Get Collection Info

This action brings up the information of a collection based on the collection ID.

Input

Response Payload

{
"collection": {
"id": 264802598978,
"handle": "backpack-collection",
"title": "Coleção de mochilas",
"updated_at": "2023-02-25T07:42:25-05:00",
"body_html": "pegue sua mochila e comece a aproveitar sua vida ao ar livre!",
"published_at": "2022-07-28T21:07:11-04:00",
"sort_order": "best-selling",
"template_suffix": "",
"products_count": 7,
"disjunctive": false,
"collection_type": "smart",
"rules": [
{
"column": "tag",
"relation": "equals",
"condition": "backpack"
}
],
"published_scope": "web",
"admin_graphql_api_id": "gid://shopify/Collection/264802598978",
"image": {
"created_at": "2022-08-17T00:23:00-04:00",
"alt": null,
"width": 900,
"height": 900,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/collections/Custom_dimensions_900x900_px_7.jpg?v=1660710180 "
}
}
}

Get Collection Products

This action fetches the products related to a specific collection based on the collection ID.

Input

Response Payload

{
"products": [
{
"id": 1413104205890,
"title": "Mochila Backpack",
"body_html": " ★ MUITO ESPAÇO DE ARMAZENAMENTO E BOLSOS: Um compartimento separado para laptop comporta laptop de 15,6 polegadas, bem como laptop de 15 polegadas, 14 Macbook/laptop de polegadas e 13 polegadas. Um compartimento de embalagem espaçoso, espaçoso para necessidades diárias, acessórios eletrônicos de tecnologia. Compartimento frontal com muitos bolsos, bolsos para canetas e gancho para chaveiro, deixa seus itens organizados e mais fáceis de encontrar ★CONFORTÁVEL E RESISTENTE: Fluxo de ar confortável na parte traseira design com acolchoamento ventilado de vários painéis espesso, mas macio, oferece suporte máximo para as costas. Alças de ombro respiráveis e ajustáveis aliviam o estresse do ombro. Alça superior acolchoada de espuma para transporte por muito tempo ★ FUNCIONAL E SEGURO: Uma alça de bagagem permite o ajuste da mochila bagagem/mala, deslize sobre o tubo da alça vertical da bagagem para facilitar o transporte. Com um bolso antirroubo oculto na parte traseira, proteja seus itens valiosos contra ladrões. Bem feito para viagens internacionais de avião e viagens de um dia ★ DESIGN DA PORTA USB: Com carregador USB integrado por fora e cabo de carregamento embutido por dentro, esta mochila USB oferece uma maneira mais conveniente de carregar seu telefone enquanto caminha. Observe que esta mochila não se alimenta sozinha, a porta de carregamento USB oferece apenas um acesso fácil para carregar ★MATERIAL DURÁVEL E SÓLIDO: Feito de tecido de poliéster resistente à água e durável com zíperes de metal. uso duradouro todos os dias e no fim de semana. Servir bem como bolsa de trabalho de escritório profissional, mochila fina de carregamento USB, mochila grande de estudante para meninos, meninas, adolescentes, adultos ", "vendor": "hapans", "product_type": "mochila"
,
"
handle": "mochila-backpack",
"options": [
{
"id": 1864085733442,
"product_id": 1413104205890,
"name": "Color",
"position": 1
},
{
"id": 1864085766210,
"product_id": 1413104205890,
"name": "Size",
"position": 2
}
],
"images": [
{
"id": 3736686919746,
"product_id": 1413104205890,
"position": 1,
"created_at": "2018-06-18T08:22:39-04:00",
"updated_at": "2019-10-21T23:39:37-04:00",
"alt": null,
"width": 800,
"height": 800,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/Mochila_Backpack.png?v=1571715577 ",
"variant_ids": [
12535580164162
],
"admin_graphql_api_id": "gid://shopify/ProductImage/3736686919746"
},
{
"id": 3736686952514,
"product_id": 1413104205890,
"position": 2,
"created_at": "2018-06-18T08:22:39-04:00",
"updated_at": "2019-10-21T23:39:37-04:00", "alt": null,
"width": 430,
"height": 430,
"src": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/Backpack_black.png?v=1571715577 ",
"variant_ids": [...], // 1 item
"admin_graphql_api_id": "gid://shopify/ProductImage/3736686952514"
}
],
"image": " https://cdn.shopify.com/s/files/1/0017/6367/2130/products/Mochila_Backpack.png?v=1571715577 "
}
]
}

Shopify Native Actions - Products

Get Products

Input

Response Payload

Get Product Info

Input

Response Payload

Get Product Images

Input

Response Payload

Get Product Variants

Input

Response Payload

Search For Custom Collections

Input

Response Payload

Search For Smart Collections

Input

Response Payload

Get Collection Info

Input

Response Payload

Get Collection Products

Input

Response Payload