Shopify

1. Overview

Shopify is a leading e-commerce platform that enables businesses to create online stores, manage products, process orders, and handle customer relationships. Through Shopify's comprehensive Admin API, businesses can programmatically manage their entire e-commerce operations.

Through GoInsight's Shopify node, you can seamlessly integrate e-commerce operations into your automated workflows. You can perform complete lifecycle management of your online store, including:

• Order Management: Create, retrieve, update, and delete orders with customer information, line items, and fulfillment details.
• Product Catalog Management: Create, update, delete, and retrieve product information including variants, images, pricing, and inventory.

2. Prerequisites

Before using this node, you need to meet the following conditions:

• Account Requirements: You need to have a valid Shopify store with admin access to create and manage API credentials.
• Permission Requirements: You may need admin or specific permissions to create and manage API credentials, and authorize the application to access your store data.

3. Credentials

For detailed guidance on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.

4. Supported Operations

Summary

This node primarily operates around two core resources: Orders and Products. It provides comprehensive management capabilities for e-commerce operations.

Operation Details

Shopify Create Order

Create a new Shopify order programmatically using the Shopify Admin API. Supports custom line items, customer information, billing/shipping addresses, discount codes, fulfillment status, and financial status. Ideal for e-commerce integrations and automated order creation.

Input Parameters:

• ShopName: The Shopify shop name (e.g., your-store, without .myshopify.com) - string parameter
• LineItems: Object array of order line items - Required Each item should contain: title, quantity, price, variant_id, sku (optional), taxable (optional) Example: [{"title": "Product Name", "quantity": 1, "price": 10.00, "variant_id": "12345"}]

Options:

• BillingAddress: Should contain: first_name, last_name, address1, city, country, province (optional), zip (optional), address2 (optional), company (optional), phone (optional) Example: {"first_name": "John", "last_name": "Doe", "address1": "123 Main St", "city": "NYC", "country": "US"}
• ShippingAddress: Should contain: first_name, last_name, address1, city, country, province (optional), zip (optional), address2 (optional), company (optional), phone (optional) Example: {"first_name": "John", "last_name": "Doe", "address1": "456 Oak Ave", "city": "Boston", "country": "US"}
• DiscountCodes: Discount code object - Optional Should contain: code Example: {"code": "SAVE10"} (Note: GraphQL only supports one discount code)
• FulfillmentStatus: Fulfillment status: fulfilled, partial, unfulfilled (optional) - string parameter
• FinancialStatus: Financial status: pending, authorized, paid, partially_paid, refunded, voided (optional) - string parameter
• Tags: Comma-separated tags for the order (optional) - string parameter with comma-separated multiple tags
• Note: Order note (optional) - string parameter
• Currency: Currency code (e.g., USD, EUR, CNY) (optional) - string parameter
• BuyerAcceptsMarketing: Whether customer accepts marketing emails (optional) - boolean parameter

Output:

• OrderId (string): The ID of the created order
• OrderNumber (string): The order number of the created order
• TotalPrice (string): The total price of the created order
• IsSuccess (bool): Boolean indicating whether the order creation was successful
• StatusCode (number): HTTP status code indicating the result of the operation
• ErrorMessage (string): Error message if the operation failed

Shopify Create Product

Create a new Shopify product with comprehensive product information using the Shopify Admin API. Supports product title, description, variants, images, pricing, inventory management, custom fields, and SEO metadata. Essential for product catalog management and automation.

Input Parameters:

• ShopName: The Shopify shop name (e.g., your-store, without .myshopify.com) - string parameter
• Title: The name of the product (required) - string parameter

Options:

• BodyHtml: A description of the product with HTML formatting (optional) - string parameter with HTML format support
• Vendor: The name of the product's vendor (optional) - string parameter
• ProductType: A categorization for the product used for filtering and searching (optional) - string parameter
• Variants: Array of product variants (optional) - object array containing option1, price, inventory_quantity, inventory_management fields
• Images: Array of product images (optional) - object array containing src field
• Options: Array of custom product properties like Size, Color, Material (optional) - object array containing name, values fields
• Tags: Comma-separated tags for filtering and search (optional) - string parameter with comma-separated multiple tags
• Status: Product status: active, draft, archived (optional) - string parameter
• PublishedScope: Published scope: web, global (optional) - string parameter
• TemplateSuffix: Suffix of the Liquid template for the product page (optional) - string parameter
• Handle: A unique human-friendly string for the product (optional) - string parameter

Output:

• ProductId (string): The ID of the created product
• ProductTitle (string): The title of the created product
• ProductHandle (string): The handle (URL slug) of the created product
• ProductType (string): The type/category of the created product
• ProductVendor (string): The vendor/manufacturer of the created product
• ProductStatus (string): The status of the created product (active, draft, archived)
• IsSuccess (bool): Boolean indicating whether the product creation was successful
• StatusCode (number): HTTP status code indicating the result of the operation
• ErrorMessage (string): Error message if the operation failed

Shopify Delete Order

Delete a specific Shopify order using the Shopify Admin API. Permanently removes the order from the system. Use with caution as this action cannot be undone. Returns deletion status and confirmation.

Input Parameters:

• ShopName: The Shopify shop name (e.g., your-store, without .myshopify.com)
• OrderId: The ID of the order to delete

Output:

• IsDeleted (bool): Boolean indicating whether the order was successfully deleted
• StatusCode (number): HTTP status code indicating the result of the operation
• ErrorMessage (string): Error message if the operation failed

Shopify Delete Product

Remove a specific Shopify product from the catalog using the Shopify Admin API. Permanently deletes the product and all associated variants. Use with caution as this action cannot be undone. Returns deletion status and confirmation.

Input Parameters:

• ShopName: The Shopify shop name (e.g., your-store, without .myshopify.com)
• ProductId: The ID of the product to delete

Output:

• IsDeleted (bool): Boolean indicating whether the product was successfully deleted
• StatusCode (number): HTTP status code indicating the result of the operation
• ErrorMessage (string): Error message if the operation failed

Shopify Get Many Orders

Retrieve multiple Shopify orders with filtering and pagination support using the Shopify Admin API. Supports filtering by status (open, closed, cancelled), limiting results (max 250), and returns order arrays with metadata. Ideal for bulk order processing and reporting.

Input Parameters:

• ShopName: The Shopify shop name (e.g., your-store, without .myshopify.com)

Options:

• Limit: Maximum number of orders to return (default: 50, max: 250)
• Status: Filter orders by status (open, closed, cancelled, any)

Output:

• OrdersData (object-array): Array of order data retrieved from Shopify
• TotalCount (number): Total number of orders returned
• StatusCode (number): HTTP status code indicating the result of the operation
• ErrorMessage (string): Error message if the operation failed

Shopify Get Many Products

Fetch multiple Shopify products with filtering capabilities using the Shopify Admin API. Supports filtering by status (active, archived, draft), limiting results (max 250), and returns product arrays with complete product information. Useful for product catalog management and bulk operations.

Input Parameters:

• ShopName: The Shopify shop name (e.g., your-store, without .myshopify.com)

Options:

• Limit: Maximum number of products to return (default: 50, max: 250)
• Status: Filter products by status (active, archived, draft)

Output:

• ProductsData (object-array): Array of product data retrieved from Shopify
• TotalCount (number): Total number of products returned
• StatusCode (number): HTTP status code indicating the result of the operation
• ErrorMessage (string): Error message if the operation failed

Shopify Get Order

Get a specific Shopify order by ID using the Shopify Admin API. Returns complete order information including customer details, line items, shipping addresses, financial status, and fulfillment information. Supports order lookup by unique order ID.

Input Parameters:

• ShopName: The Shopify shop name (e.g., your-store, without .myshopify.com)
• OrderId: The ID of the order to retrieve

Output:

• OrderData (object): The order data retrieved from Shopify (object)
• StatusCode (number): HTTP status code indicating the result of the operation
• ErrorMessage (string): Error message if the operation failed

Shopify Get Product

Retrieve detailed information about a specific Shopify product using the Shopify Admin API. Returns product data including title, description, variants, images, pricing, inventory status, and custom fields. Supports product lookup by unique product ID.

Input Parameters:

• ShopName: The Shopify shop name (e.g., your-store, without .myshopify.com)
• ProductId: The ID of the product to retrieve

Output:

• ProductData (object): The product data retrieved from Shopify (object)
• StatusCode (number): HTTP status code indicating the result of the operation
• ErrorMessage (string): Error message if the operation failed

Shopify Update Order

Update existing Shopify order details using the Shopify Admin API. Can modify customer information, shipping addresses, order tags, notes, fulfillment status, and financial status. Supports partial updates and maintains order history.

Input Parameters:

• ShopName: The Shopify shop name (e.g., your-store, without .myshopify.com) - String parameter
• OrderId: The ID of the order to update (required) - String parameter

Options:

• Tags: Comma-separated tags for the order (optional) - String parameter, comma-separated multiple tags
• Note: Order note (optional) - String parameter
• BuyerAcceptsMarketing: Whether customer accepts marketing emails (optional) - Boolean parameter
• Metafields: JSON string for metafields array (optional) - JSON string containing namespace, key, value, type fields

Output:

• IsUpdated (bool): Boolean indicating whether the order was successfully updated
• StatusCode (number): HTTP status code indicating the result of the operation
• ErrorMessage (string): Error message if the operation failed

Shopify Update a Product

Modify existing Shopify product information using the Shopify Admin API. Supports updating product title, description, variants, images, pricing, inventory, custom fields, and SEO settings. Enables product catalog maintenance and updates.

Input Parameters:

• ShopName: The Shopify shop name (e.g., your-store, without .myshopify.com) - String parameter
• ProductId: The ID of the product to update (required) - String parameter

Options:

• Title: The name of the product (optional) - String parameter
• BodyHtml: A description of the product with HTML formatting (optional) - String parameter, supports HTML format
• Vendor: The name of the product's vendor (optional) - String parameter
• ProductType: A categorization for the product used for filtering and searching (optional) - String parameter
• Variants: Array of product variants (optional) - Object array containing option1, price, inventory_quantity, inventory_management fields
• Images: Array of product images (optional) - Object array containing src, position, alt fields
• Options: Array of custom product properties like Size, Color, Material (optional) - Object array containing name, values fields
• Tags: Comma-separated tags for filtering and search (optional) - String parameter, comma-separated multiple tags
• Status: Product status: active, draft, archived (optional) - String parameter
• PublishedScope: Published scope: web, global (optional) - String parameter
• TemplateSuffix: Suffix of the Liquid template for the product page (optional) - String parameter
• Handle: A unique human-friendly string for the product (optional) - String parameter
• Metafields: Array of metafields (optional) - Object array containing namespace, key, value, type fields
• Published: Published status (optional) - Boolean value, true for published, false for draft

Output:

• ProductData (object): The object of the updated product
• StatusCode (number): HTTP status code indicating the result of the operation
• ErrorMessage (string): Error message if the operation failed

5. Example Usage

This section will guide you through creating a simple workflow to create a new product in your Shopify store using the Shopify Create Product operation.

Scenario: Let's create a workflow that adds a new product called "Premium T-Shirt" to your Shopify catalog with basic product information.

Workflow Overview: This example workflow consists of Start → Shopify Create Product → Answer nodes.

Step-by-Step Guide:

1. Add Tool Node:
   • In the workflow canvas, click the "+" button to add a new node.
   • In the popup panel, select the "Tools" tab.
   • Find and select Shopify from the tools list.
   • In the Shopify supported operations list, click and select Shopify Create Product, which will add the corresponding node to the canvas.
2. Configure Node:
   • Click on the newly added Shopify Create Product node, and the configuration panel will expand on the right side.
   • Credentials Configuration: At the top of the panel, find the credentials field. Click the dropdown menu and select your pre-configured Shopify credentials.
   • Parameter Configuration: Fill in the required and optional parameters:
   • ShopName: Enter your Shopify store name (without .myshopify.com), for example: my-awesome-store
   • Title: Enter the product title, for example: Premium T-Shirt
   • BodyHtml (optional): Enter a product description, for example:

     High-quality cotton t-shirt perfect for everyday wear.

   • Vendor (optional): Enter the vendor name, for example: Premium Clothing Co
   • ProductType (optional): Enter a product category, for example: Clothing
   • Status (optional): Set to active to make the product immediately available
   • Tags (optional): Enter comma-separated tags, for example: t-shirt,cotton,premium
3. Run and Validate:
   • After all required parameters are correctly filled, the error indicators in the upper right corner of the workflow canvas will disappear.
   • Click the "Test Run" button in the upper right corner of the canvas to execute the workflow.
   • After successful execution, you can click the log icon in the upper right corner to view detailed input and output of the node, verifying that the operation was successful.

Final Workflow Summary: After completing the above steps, your entire workflow is configured. When you click "Test Run", a new product will be successfully created in your Shopify store with the specified details, and you'll receive the product ID, title, and other relevant information in the response.

6. FAQs

Q: I'm getting a 401 Unauthorized error when trying to create products or orders. What should I check?

A: Please verify the following:

• Ensure your Shopify API credentials are correctly configured and not expired
• Check that your API access token has the necessary permissions for the operations you're trying to perform
• Verify that your shop name is correct and doesn't include the .myshopify.com domain

Q: Why am I getting validation errors when creating orders?

A: Order creation requires specific data formats:

• LineItems must be a properly formatted object array with required fields: title, quantity, price, and variant_id
• Address objects must contain required fields: first_name, last_name, address1, city, and country
• Check that price values are numeric and variant IDs exist in your store

Q: How do I handle product variants when creating or updating products?

A: Product variants should be structured as object arrays:

• Each variant object should contain: option1, price, inventory_quantity, and inventory_management
• If you're not using variant options, you can create a single default variant
• Inventory management can be set to shopify, null, or a third-party service

Q: What's the difference between draft and active product status?

A: Product status determines visibility:

• draft: Product is saved but not visible to customers on your storefront
• active: Product is live and visible to customers
• archived: Product is hidden but can be restored later

Q: I'm hitting rate limits when making multiple API calls. How can I avoid this?

A: Shopify has API rate limits to ensure system stability:

• Use the Limit parameter in "Get Many" operations to control batch sizes
• Implement delays between successive API calls in your workflows
• Consider using bulk operations when available for large-scale updates

7. Official Documentation

For more detailed information about all available API endpoints and advanced features, please consult the Shopify Official API Documentation