Shopify

Description

This module provides a full integration with the Shopify Admin API. It covers all main e-commerce operations: products (full CRUD, variants, images), orders (query, creation, update, cancellation, closing), refunds (calculate, create, detect), fulfillment (create shipment, update tracking), customers (CRUD, search, orders by customer), collections (smart and custom, add/remove products), inventory (levels, locations, adjustments), discounts (codes, price rules), webhooks, and metafields.

The module uses HTTP helper functions (shopifyGet, shopifyPost, shopifyPut, shopifyDelete) and builds pagination and filter parameters automatically. Authentication is handled through the credentials module.

Configuration

Parameter	Type	Required	Description
credentials_id	credentials	Yes	Shopify credential
operation	text	Yes	Operation to perform (over 35 operations available)
limit	number	No	Result limit (max 250)
status	select	No	Status: active, draft, archived
product_id	text	Conditional	Product ID
order_id	text	Conditional	Order ID
customer_id	text	Conditional	Customer ID
collection_id	text	No	Collection ID
product_type	text	No	Product type
vendor	text	No	Vendor
since_id	text	No	ID from which to paginate
created_at_min / created_at_max	datetime	No	Creation date range
financial_status	text	No	Order financial status
fulfillment_status	text	No	Order shipping status

Credentials

Service type: shopify. Stored in the servicecredentials table.

Configuration fields:

• shopDomain: Store domain (e.g.: my-store.myshopify.com)
• accessToken: Private app or custom app access token
• apiVersion: API version (e.g.: 2024-01)

Output

{
  "nextModule": null,
  "data": [
    {
      "id": 1234567890,
      "title": "Camiseta Premium",
      "status": "active",
      "variants": [{ "id": 111, "price": "29.99", "sku": "CAM-001" }]
    }
  ],
  "_meta_": {
    "operation": "getProducts",
    "recordCount": 1,
    "executionTime": "200ms"
  }
}

Usage Example

Basic case - Get products

{
  "credentials_id": 1,
  "operation": "getProducts",
  "limit": 50,
  "status": "active"
}

API Used

• Shopify Admin REST API
• Documentation: https://shopify.dev/docs/api/admin-rest

Notes

• The maximum record limit per request is 250 (imposed by Shopify)
• Products are created in “draft” status by default
• Refund detection (detectOrderRefunds) returns detailed information: amounts, refunded lines, financial status
• Discounts are created in two steps: first a price rule and then the discount code
• Smart and custom collections are handled with different endpoints
• Customer search uses the /customers/search.json endpoint with a query parameter
• Metafields can be associated with any resource (products, orders, customers, etc.)
• The request timeout is 30 seconds
• Shopify errors are automatically parsed from the key:value format

Related Nodes

• Get Products, Get Product, Create Product, Update Product, Delete Product
• Variants: Get, Create, Update, Delete
• Inventory: Levels, Set, Adjust, Locations
• Orders: Get, Create, Update, Cancel, Close
• Refunds: Get, Calculate, Create, Detect
• Fulfillment: Get, Create, Update Tracking
• Customers: Get, Create, Update, Delete, Customer Orders
• Collections, Discounts, Webhooks, Metafields, Store Info