Shopify

Purpose

The Shopify Operator enables integration with the Shopify e-commerce platform. It provides functionality for managing products, orders, inventory, customers, and other Shopify resources through the Shopify API.

Use Cases

• Managing product catalog in Shopify stores
• Processing and fulfilling orders
• Tracking and adjusting inventory levels
• Retrieving customer information
• Automating order workflows
• Synchronizing product data between systems
• Creating and updating product information
• Managing order fulfillment processes
• Retrieving order details and history
• Implementing custom e-commerce workflows

Supported Operations

get-product

Retrieves product information from a Shopify store.

Input Parameters

• shopDomain (string): The Shopify store domain
• productId (string): The ID of the product to retrieve

Output

Returns detailed information about the requested product, including variants, images, and other product attributes.

Example

{
  "shopDomain": "your-store.myshopify.com",
  "productId": "gid://shopify/Product/1234567890"
}

create-product

Creates a new product in a Shopify store.

Input Parameters

• shopDomain (string): The Shopify store domain
• title (string): The product title
• description (string): The product description
• variants (array): Product variants with prices, SKUs, etc.
• images (array, optional): Product images

Output

Returns information about the newly created product, including its ID and other attributes.

Example

{
  "shopDomain": "your-store.myshopify.com",
  "title": "New Product",
  "description": "This is a new product description",
  "variants": [
    {
      "price": "29.99",
      "sku": "NP-001",
      "inventoryQuantity": 100
    }
  ]
}

get-order

Retrieves detailed information about a specific order.

Input Parameters

• shopDomain (string): The Shopify store domain
• orderId (string): The ID of the order to retrieve

Output

Returns detailed information about the requested order, including line items, customer information, shipping details, and payment information.

Example

{
  "shopDomain": "your-store.myshopify.com",
  "orderId": "gid://shopify/Order/1234567890"
}

fulfill-order

Marks an order as fulfilled in Shopify.

Input Parameters

• shopDomain (string): The Shopify store domain
• orderId (string): The ID of the order to fulfill
• trackingNumber (string, optional): The tracking number for the shipment
• trackingCompany (string, optional): The shipping carrier
• notifyCustomer (boolean, optional): Whether to notify the customer about the fulfillment

Output

Returns information about the fulfillment, including its ID and status.

Example

{
  "shopDomain": "your-store.myshopify.com",
  "orderId": "gid://shopify/Order/1234567890",
  "trackingNumber": "1Z999AA10123456789",
  "trackingCompany": "UPS",
  "notifyCustomer": true
}

cancel-order

Cancels an order in Shopify.

Input Parameters

• shopDomain (string): The Shopify store domain
• orderId (string): The ID of the order to cancel
• reason (string, optional): The reason for cancellation

Output

Returns information about the canceled order, including its updated status.

Example

{
  "shopDomain": "your-store.myshopify.com",
  "orderId": "gid://shopify/Order/1234567890",
  "reason": "Customer request"
}

adjust-inventory

Adjusts the inventory level for a product variant.

Input Parameters

• shopDomain (string): The Shopify store domain
• inventoryItemId (string): The ID of the inventory item
• locationId (string): The ID of the location
• adjustment (integer): The quantity to adjust (positive or negative)

Output

Returns information about the updated inventory level.

Example

{
  "shopDomain": "your-store.myshopify.com",
  "inventoryItemId": "gid://shopify/InventoryItem/1234567890",
  "locationId": "gid://shopify/Location/1234567890",
  "adjustment": 10
}

get-inventory-item-id-by-variant-id

Retrieves the inventory item ID for a specific product variant.

Input Parameters

• shopDomain (string): The Shopify store domain
• variantId (string): The ID of the product variant

Output

Returns the inventory item ID associated with the specified product variant.

Example

{
  "shopDomain": "your-store.myshopify.com",
  "variantId": "gid://shopify/ProductVariant/1234567890"
}

get-product-variant-by-sku

Retrieves a product variant by its SKU.

Input Parameters

• shopDomain (string): The Shopify store domain
• sku (string): The SKU of the product variant

Output

Returns information about the product variant with the specified SKU.

Example

{
  "shopDomain": "your-store.myshopify.com",
  "sku": "NP-001"
}

create-order-note-or-tag

Adds a note or tag to an existing order.

Input Parameters

• shopDomain (string): The Shopify store domain
• orderId (string): The ID of the order
• note (string, optional): The note to add to the order
• tags (array, optional): The tags to add to the order

Output

Returns information about the updated order with the new note or tags.

Example

{
  "shopDomain": "your-store.myshopify.com",
  "orderId": "gid://shopify/Order/1234567890",
  "note": "Customer requested express shipping",
  "tags": ["priority", "express-shipping"]
}

get-fulfillment-orders

Retrieves fulfillment orders for a specific order.

Input Parameters

• shopDomain (string): The Shopify store domain
• orderId (string): The ID of the order

Output

Returns information about the fulfillment orders associated with the specified order.

Example

{
  "shopDomain": "your-store.myshopify.com",
  "orderId": "gid://shopify/Order/1234567890"
}

get-order-list

Retrieves a list of orders based on specified criteria.

Input Parameters

• shopDomain (string): The Shopify store domain
• query (string, optional): A query to filter orders
• first (integer, optional): The number of orders to retrieve
• after (string, optional): Cursor for pagination

Output

Returns a list of orders matching the specified criteria.

Example

{
  "shopDomain": "your-store.myshopify.com",
  "query": "created_at:>2023-01-01",
  "first": 10
}

get-customer-by-email

Retrieves customer information by email address.

Input Parameters

• shopDomain (string): The Shopify store domain
• accessToken (string): The Shopify API access token
• email (string): The customer’s email address

Output

Returns information about the customer with the specified email address.

Example

{
  "shopDomain": "your-store.myshopify.com",
  "email": "[email protected]"
}

Notes

• The Shopify operator requires valid Shopify API credentials (shop domain and access token)
• Operations use Shopify’s GraphQL API for efficient data retrieval and manipulation
• Some operations may require specific Shopify API access scopes
• Rate limits apply based on your Shopify plan
• The operator handles authentication and request formatting automatically
• All operations return structured data that can be processed by other operators
• Error handling includes detailed error messages from the Shopify API