Integration library
Integration

Shopify

Use approved Shopify customer and order data during service calls.

Description

AIM AI can be configured to retrieve or update selected Shopify commerce records in a customer-service workflow. Store access, write permissions, and the exact order operations are confirmed before implementation.

Authentication

  • A Shopify Admin API access token is required.
  • Exact store permissions and approved actions are confirmed during workflow scoping.

Supported Actions (11)

These are the operations this integration can perform after the required credentials and permissions are approved.

  • List products
  • Create/find/update/cancel orders
  • Get order status
  • Manage fulfillments (create, update tracking, cancel, hold, release)
  • Get fulfillment orders
  • List/find customers
  • List customer orders
  • Update order shipping address and status
  • Draft order operations
  • Order edit operations (begin, add variant, commit)
  • List price lists (B2B)

Examples

Use these representative payloads as a technical starting point, then replace the sample values with the approved workflow data.

Shopify - List Products

Representative workflow configuration for Shopify - List Products.

JSON
{
  "automationType": "shopify",
  "nodeId": "shopify-products-001",
  "nodeParams": {
    "action": "list_products",
    "params": {
      "shop": "aim-ai-integrations.myshopify.com",
      "limit": 50,
      "sortBy": "updated_at",
      "order": "desc",
      "vendor": "Acme",
      "title": "Widget"
    }
  }
}
Shopify - Get Order Status

Representative workflow configuration for Shopify - Get Order Status.

JSON
{
  "automationType": "shopify",
  "nodeId": "shopify-order-status-001",
  "nodeParams": {
    "action": "get_order_status",
    "params": {
      "shop": "aim-ai-integrations.myshopify.com",
      "orderId": "6343986868334"
    }
  }
}
Shopify - Create Fulfillment

Representative workflow configuration for Shopify - Create Fulfillment.

JSON
{
  "automationType": "shopify",
  "nodeId": "shopify-create-fulfillment-001",
  "nodeParams": {
    "action": "create_fulfillment",
    "params": {
      "shop": "aim-ai-integrations.myshopify.com",
      "fulfillmentOrderId": "gid://shopify/FulfillmentOrder/111111111",
      "lineItems": [
        { "fulfillmentOrderLineItemId": "gid://shopify/FulfillmentOrderLineItem/22222222", "quantity": 1 }
      ],
      "trackingNumber": "1Z999AA10123456784",
      "trackingUrl": "https://carrier/track/1Z999AA10123456784",
      "trackingCompany": "UPS",
      "notifyCustomer": true
    }
  }
}
Shopify - Hold Fulfillment Order

Representative workflow configuration for Shopify - Hold Fulfillment Order.

JSON
{
  "automationType": "shopify",
  "nodeId": "shopify-hold-fo-001",
  "nodeParams": {
    "action": "hold_fulfillment",
    "params": {
      "shop": "aim-ai-integrations.myshopify.com",
      "fulfillmentOrderId": "gid://shopify/FulfillmentOrder/111111111",
      "holdReason": "OTHER"
    }
  }
}
Shopify - List Customers

Representative workflow configuration for Shopify - List Customers.

JSON
{
  "automationType": "shopify",
  "nodeId": "shopify-list-customers-001",
  "nodeParams": {
    "action": "list_customers",
    "params": {
      "shop": "aim-ai-integrations.myshopify.com",
      "limit": 50
    }
  }
}
Shopify - Update Order Status

Representative workflow configuration for Shopify - Update Order Status.

JSON
{
  "automationType": "shopify",
  "nodeId": "shopify-update-order-status-001",
  "nodeParams": {
    "action": "update_order_status",
    "params": {
      "shop": "aim-ai-integrations.myshopify.com",
      "orderId": "6343986868334",
      "financialStatus": "paid",
      "fulfillmentStatus": "fulfilled"
    }
  }
}
Shopify - Order Edit Add Variant

Representative workflow configuration for Shopify - Order Edit Add Variant.

JSON
{
  "automationType": "shopify",
  "nodeId": "shopify-edit-add-001",
  "nodeParams": {
    "action": "order_edit_add_variant",
    "params": {
      "shop": "aim-ai-integrations.myshopify.com",
      "editId": "gid://shopify/CalculatedOrder/123",
      "variantId": "gid://shopify/ProductVariant/447654529",
      "quantity": 1
    }
  }
}
Shopify - List Price Lists (B2B)

Representative workflow configuration for Shopify - List Price Lists (B2B).

JSON
{
  "automationType": "shopify",
  "nodeId": "shopify-list-pricelists-001",
  "nodeParams": {
    "action": "list_price_lists",
    "params": {
      "shop": "aim-ai-integrations.myshopify.com",
      "limit": 50
    }
  }
}