Shopify

Adds a tag to a Shopify order to help organize and track order status or characteristics.

This integration allows you to add custom tags to Shopify orders for better organization and tracking. Tags are useful for categorizing orders by status, special conditions, or business processes – like marking orders as “expedited”, “gift-order”, or “customer-service-handled”.

Parameters

• order_id (String): The unique Shopify order ID number that you want to tag. Example: “8234567891234”.
• tag (String): The tag text you want to add to the order. Example: “priority-shipping”.

Output

Returns confirmation of the tag addition along with the order’s complete list of tags. The response includes the id (the Shopify order ID in GraphQL format), tags (array of all current tags on the order), and userErrors (array that shows any issues, or empty if successful).

Example Output:

{
  "data": {
    "tagsAdd": {
      "node": {
        "id": "gid://shopify/Order/8234567891234",
        "tags": [
          "priority-shipping",
          "customer-requested",
          "express-delivery"
        ]
      },
      "userErrors": []
    }
  },
  "extensions": {
    "cost": {
      "throttleStatus": {
        "restoreRate": 1000.0,
        "maximumAvailable": 20000.0,
        "currentlyAvailable": 19990
      },
      "actualQueryCost": 10,
      "requestedQueryCost": 10
    }
  }
}

Cancels a Shopify order using the order ID and marks it as cancelled in the system.

This integration cancels an existing order in Shopify by sending a cancellation request to the specified order ID. When executed, it changes the order status to cancelled, sets the cancellation timestamp, and may trigger inventory restocking depending on your Shopify settings. This is useful when customers request order cancellations or when you need to cancel orders that cannot be fulfilled.

Parameters

• order_id (String/ID): The unique Shopify order ID that you want to cancel. Example: “7024926130367”.

Output

Returns the complete updated order object showing its cancelled status. Key fields include id (order ID), cancelled_at (cancellation timestamp), cancel_reason (reason for cancellation), financial_status (payment status after cancellation), fulfillment_status (fulfillment status after cancellation), along with all original order details like customer information, line items, pricing, and shipping details. The response also includes a notice field confirming the cancellation.

Example Output:

{
  "order": {
    "id": 8392847205183,
    "name": "#1425678",
    "cancelled_at": "2026-03-25T14:22:18-04:00",
    "cancel_reason": "other",
    "financial_status": "paid",
    "fulfillment_status": null,
    "email": "sarah.martinez@example.com",
    "total_price": "42.67",
    "currency": "USD",
    "customer": {
      "id": 9847362518975,
      "email": "sarah.martinez@example.com",
      "first_name": "Sarah",
      "last_name": "Martinez"
    },
    "line_items": [
      {
        "id": 16284759382847,
        "name": "Snap Grip - Ocean Blue",
        "quantity": 1,
        "price": "29.99"
      }
    ]
  },
  "notice": "Order has been canceled"
}

Creates a draft replacement order in Shopify based on an existing order for easy reordering or order modifications.

This integration creates a new draft order in Shopify using all the details from an existing order. This is useful when customers want to reorder the same items, when you need to create a replacement order for damaged goods, or when you want to modify an order before finalizing it. The draft order can be edited, adjusted, and then converted to a regular order when ready.

Parameters

• orderID (String): The unique identifier of the existing Shopify order to copy. This should be the numeric order ID. Example: “8429157342856”.

Output

Returns a draft order object containing the new draft order’s id (Shopify’s internal GraphQL ID) and name (the draft order number that appears in the Shopify admin). If there are any validation errors, they will appear in the userErrors array with details about what went wrong.

Example Output:

{
  "data": {
    "draftOrderCreateFromOrder": {
      "draftOrder": {
        "id": "gid://shopify/DraftOrder/2847193856492",
        "name": "#D2847659"
      },
      "userErrors": []
    }
  },
  "extensions": {
    "cost": {
      "throttleStatus": {
        "restoreRate": 1000.0,
        "maximumAvailable": 20000.0,
        "currentlyAvailable": 19990
      },
      "actualQueryCost": 10,
      "requestedQueryCost": 10
    }
  }
}

Creates a percentage-based refund for a Shopify order with calculated refund amounts and automatic customer notifications.

This integration processes refunds for Shopify orders using a percentage-based calculation system. It creates an official refund record in Shopify, automatically notifies the customer via email, and processes the transaction through the original payment gateway. The tool calculates the exact refund amount based on your specified percentage of the original order value.

Parameters

• order_id_to_refund (String): The Shopify order ID that needs to be refunded, in Shopify’s Global ID format. Example: “gid://shopify/Order/7456123789012”.
• transaction_id (String): The ID of the original payment transaction, used to link the refund to the correct payment. Example: “gid://shopify/OrderTransaction/9876543210123”.
• total_amount_to_be_refunded_based_on_tool_oficial_calculation (String or Number): The calculated refund amount in the order’s currency. Example: “45.75”.
• gateway_of_refund (String): The payment gateway that will process the refund (must match the original payment method). Example: “shopify_payments”.
• refund_note (String, Optional): Internal note explaining the reason for the refund. Example: “Customer satisfaction refund for product quality issue”.

Output

Returns a refund confirmation object containing the new refund ID, totalRefundedSet with amount and currency details, and any userErrors if the refund failed. The response also includes Shopify’s API cost information for rate limiting purposes.

Example Output:

{
  "data": {
    "refundCreate": {
      "refund": {
        "id": "gid://shopify/Refund/2047891456789",
        "totalRefundedSet": {
          "presentmentMoney": {
            "amount": "0.0",
            "currencyCode": "USD"
          }
        }
      },
      "userErrors": []
    }
  },
  "extensions": {
    "cost": {
      "throttleStatus": {
        "restoreRate": 1000.0,
        "maximumAvailable": 20000.0,
        "currentlyAvailable": 19980
      },
      "actualQueryCost": 20,
      "requestedQueryCost": 20
    }
  }
}

Looks up a Shopify customer record using an email address to retrieve their complete profile and account information.

This integration searches your Shopify store for a customer that matches the email address you provide. It returns the customer’s complete profile including their name, contact information, order history, account status, marketing preferences, addresses, and spending details. This is essential for customer service teams who need to quickly access customer information during support interactions or account inquiries.

Parameters

• email (String (email)): The customer’s email address to search for. Must be a valid email format. Example: “sarah.martinez@example.com”.

Output

Returns a complete Shopify customer object containing id, email, first_name, last_name, phone, state (enabled/disabled), currency, total_spent, orders_count, tags, addresses array with full address details, default_address, verified_email status, tax_exempt status, last_order_id, last_order_name, email_marketing_consent and sms_marketing_consent preferences, plus timestamps for created_at and updated_at.

Example Output:

{
  "id": 8555064426592,
  "email": "sarah.martinez@example.com",
  "first_name": "Sarah",
  "last_name": "Martinez",
  "phone": null,
  "state": "enabled",
  "currency": "USD",
  "total_spent": "74.83",
  "orders_count": 1,
  "tags": "Active product subscription, Login with Shop, Placed Order, Shop",
  "verified_email": true,
  "tax_exempt": false,
  "last_order_id": 6311912472672,
  "last_order_name": "#1521851",
  "created_at": "2024-02-28T06:45:22-08:00",
  "updated_at": "2024-03-22T15:10:27-07:00",
  "default_address": {
    "id": 8918595993696,
    "name": "Sarah Martinez",
    "first_name": "Sarah",
    "last_name": "Martinez",
    "address1": "456 Oak Street",
    "city": "Portland",
    "province": "Oregon",
    "country": "United States",
    "zip": "97205",
    "phone": "+1-555-234-5678",
    "country_code": "US",
    "province_code": "OR",
    "default": true
  },
  "email_marketing_consent": {
    "state": "subscribed",
    "opt_in_level": "single_opt_in",
    "consent_updated_at": "2024-02-28T06:45:27-08:00"
  },
  "sms_marketing_consent": {
    "state": "not_subscribed",
    "opt_in_level": "single_opt_in",
    "consent_updated_at": null
  }
}

Searches for a Shopify customer using their email address and returns their profile information including order history.

This integration searches your Shopify store for a customer that matches the email address you provide. It returns comprehensive customer profile information including contact details, order history, spending totals, and default shipping address, making it easy for your team to quickly access complete customer information.

Parameters

• email (String (email)): Customer email address to search for. Example: “sarah.johnson@example.com”.

Output

Returns an array containing the matching customer’s complete profile with fields including customer_id, email, first_name, last_name, phone, default_address (with address1, city, province, zip, country), orders_count, total_spent, last_order_name, created_at, updated_at, and customer_graphql_api_id.

Example Output:

[{
  "email": "sarah.johnson@example.com",
  "phone": "+1-555-0123",
  "last_name": "Johnson",
  "created_at": "2024-03-15T10:30:45-08:00",
  "first_name": "Sarah",
  "updated_at": "2024-11-20T14:22:10-08:00",
  "customer_id": 7234567890123,
  "total_spent": "425.50",
  "orders_count": 5,
  "default_address": {
    "zip": "10001",
    "city": "New York",
    "country": "United States",
    "address1": "123 Broadway Ave",
    "province": "New York"
  },
  "last_order_name": "#9456789",
  "customer_graphql_api_id": "gid://shopify/Customer/7234567890123"
}]

Retrieves a complete Shopify customer profile using their unique customer ID.

This integration fetches detailed information about a specific Shopify customer when you provide their unique customer ID. It returns the customer’s complete profile including personal information, contact details, purchase history, addresses, marketing preferences, and account tags. This is useful when you need to access comprehensive customer data for support cases, account management, or order assistance.

Parameters

• customer_id (String): The unique Shopify customer ID number. Example: “8124567584853”.

Output

Returns a complete Shopify customer object containing id, email, first_name, last_name, phone, tags, total_spent, orders_count, last_order_id, last_order_name, default_address, addresses array, created_at, updated_at, verified_email, tax_exempt, currency, state, and marketing consent preferences including sms_marketing_consent and email_marketing_consent.

Example Output:

{
  "customer": {
    "id": 8124567584853,
    "email": "sarah.johnson@example.com",
    "first_name": "Sarah",
    "last_name": "Johnson",
    "phone": "+15551234567",
    "tags": "Active Subscriber, VIP Customer, Purchaser, Standard",
    "state": "enabled",
    "currency": "USD",
    "total_spent": "742.98",
    "orders_count": 7,
    "last_order_id": 6421209579605,
    "last_order_name": "BB-2651571",
    "created_at": "2025-09-17T21:59:28-07:00",
    "updated_at": "2026-01-31T07:27:07-08:00",
    "tax_exempt": false,
    "verified_email": true,
    "default_address": {
      "id": 9454452080725,
      "name": "Sarah Johnson",
      "address1": "1234 Main Street",
      "address2": null,
      "city": "Portland",
      "province": "Oregon",
      "zip": "97201",
      "country": "United States",
      "phone": "+15551234567",
      "country_code": "US",
      "province_code": "OR"
    },
    "sms_marketing_consent": {
      "state": "subscribed",
      "opt_in_level": "confirmed_opt_in"
    },
    "email_marketing_consent": {
      "state": "subscribed",
      "opt_in_level": "confirmed_opt_in"
    }
  }
}

Retrieves all Shopify orders for a customer email address with payment status, fulfillment details, and shipping tracking information.

This integration searches Shopify for all orders associated with a customer’s email address and returns a comprehensive order history. It’s perfect for customer support teams who need to quickly view a customer’s complete purchase history, check payment status, track shipments, and access order details without logging into Shopify’s admin panel.

Parameters

• email (String (email)): The customer’s email address to search for orders. Example: “maria.rodriguez@example.com”.

Output

Returns an array of order objects, each containing essential order information including order_id, name (order display name like #1234), order_number, created_at (order date in YYYY-MM-DD format), total_price, financial_status (paid/pending/refunded), fulfillment_status (fulfilled/partial/unfulfilled), order_status_url (customer order tracking page), and fulfillments object containing detailed shipping information including tracking numbers, carrier details, delivery status, and tracking URLs when available.

Example Output:

[
  {
    "order_id": 7234567890123,
    "name": "#ABC-US-SX-18945671",
    "created_at": "2026-03-15",
    "fulfillment_status": "fulfilled",
    "financial_status": "paid",
    "order_number": 18945671,
    "order_status_url": "https://mystore.myshopify.com/orders/authenticate?key=def456ghi789",
    "total_price": "24.99",
    "fulfillments": {
      "tracking_company": "usps flats",
      "tracking_number": "9361289012345678901234",
      "tracking_url": "https://tracking.mystore.com/track/9361289012345678901234",
      "tracking_numbers": ["9361289012345678901234"],
      "tracking_urls": ["https://tracking.mystore.com/track/9361289012345678901234"],
      "fulfillment_status": "success",
      "shipment_status": "delivered",
      "fulfillment_created_at": "2026-03-16T09:15:30-08:00"
    }
  },
  {
    "order_id": 7198765432109,
    "name": "#1456789",
    "created_at": "2026-02-28",
    "fulfillment_status": null,
    "financial_status": "paid",
    "order_number": 1456789,
    "order_status_url": "https://shop.example.com/orders/authenticate?key=abc123xyz456",
    "total_price": "67.50",
    "fulfillments": "No fulfillments"
  }
]

Retrieves comprehensive product details from Shopify including variants, inventory levels, pricing, and product images.

This integration fetches complete product information from your Shopify store using a product ID. It provides detailed product data including all available variants, inventory quantities, pricing information, product images, vendor details, and availability status. This is useful when you need to access full product specifications, check stock levels across variants, or display comprehensive product information in your support tools.

Parameters

• product_id (String (numeric)): The unique Shopify product ID number used to retrieve the product information. Example: “8529473162845”.

Output

Returns a comprehensive product object containing product_id, title, handle, status, vendor, total_inventory, has_only_default_variant, has_out_of_stock_variants, onlineStorePreviewUrl, plus arrays of variants (with variant_id, title, price, available_for_sale, inventory_quantity, selected_options) and images (with product_image_id, url, alt_text, width, height).

Example Output:

{
  "product_id": "8529473162845",
  "title": "Wireless Gaming Headset",
  "handle": "wireless-gaming-headset-pro",
  "status": "ACTIVE",
  "vendor": "TechGear Solutions",
  "total_inventory": 47,
  "has_only_default_variant": false,
  "has_out_of_stock_variants": true,
  "onlineStorePreviewUrl": "https://mystore.myshopify.com/products/wireless-gaming-headset-pro",
  "variants": [
    {
      "variant_id": "42863951873024",
      "title": "Black / USB",
      "price": "129.99",
      "available_for_sale": true,
      "inventory_quantity": 15,
      "selected_options": [
        {"name": "Color", "value": "Black"},
        {"name": "Connection type", "value": "USB"}
      ]
    },
    {
      "variant_id": "42863951905792", 
      "title": "White / Bluetooth",
      "price": "149.99",
      "available_for_sale": false,
      "inventory_quantity": 0,
      "selected_options": [
        {"name": "Color", "value": "White"},
        {"name": "Connection type", "value": "Bluetooth"}
      ]
    }
  ],
  "images": [
    {
      "product_image_id": "gid://shopify/ProductImage/35924267184197",
      "url": "https://cdn.shopify.com/s/files/1/0123/4567/8901/files/headset-black.jpg",
      "alt_text": "Wireless Gaming Headset in Black",
      "width": 1200,
      "height": 1200
    }
  ]
}

Retrieves a Shopify order by searching with its unique confirmation number to access order details, customer info, and line items.

This integration searches your Shopify store for an order using its confirmation number, allowing you to quickly access complete order information including customer details, order status, line items, pricing, and fulfillment status. This is useful when customers reference their confirmation number in support inquiries.

Parameters

• order_confirmation_number (String): The unique confirmation number associated with the Shopify order. This is typically an alphanumeric code provided to customers after purchase. Example: “XYZ123ABC”.

Output

Returns a structured order object containing the order_name (order number) and comprehensive order_details including customer email, creation date, line items with SKUs and quantities, pricing information, cancellation status, and fulfillment status. If no order is found, returns a message indicating no data was found.

Example Output:

{
  "order": {
    "order_name": "1001234567",
    "order_details": {
      "email": "sarah.johnson@example.com",
      "closed": false,
      "createdAt": "2024-01-15T10:30:45Z",
      "lineItems": {
        "edges": [
          {
            "node": {
              "sku": "PROD-4567",
              "name": "Premium Wireless Headphones",
              "quantity": 2
            }
          }
        ]
      },
      "cancelledAt": null,
      "cancelReason": null,
      "totalPriceSet": {
        "shopMoney": {
          "amount": "159.98",
          "currencyCode": "USD"
        }
      },
      "order_graphql_id": "gid://shopify/Order/1234567890123",
      "confirmationNumber": "ABC123XYZ",
      "displayFulfillmentStatus": "FULFILLED"
    }
  }
}

Retrieves a complete Shopify order record using the order’s display name or number.

This integration searches your Shopify store for orders that match a specific order name (like “#1234” or just “1234”). It returns comprehensive order details including customer information, products purchased, pricing, shipping details, fulfillment tracking, and refund history. The search includes all order statuses by default, so you can find cancelled or closed orders as well as active ones.

Parameters

• name_of_the_order (String): The order name or number to search for. Can include or exclude the “#” prefix. Example: “9373620” or “#9373620”.

Output

Returns an orders array containing matching order objects (typically one result). Each order includes comprehensive details: order_id, name, order_number, email, total_price, financial_status, fulfillment_status, created_at, line_items (products with SKUs, quantities, prices), shipping_address, billing_address, fulfillments (with tracking numbers and URLs), shipping_lines (shipping method and costs), refunds, discounts_applied, and promo_codes_applied.

Example Output:

{
  "orders": [
    {
      "order_id": 7484458336328,
      "name": "#9373620",
      "order_number": 9373620,
      "email": "sarah.mitchell@example.com",
      "total_price": "58.53",
      "currency": "USD",
      "financial_status": "paid",
      "fulfillment_status": "partial",
      "created_at": "2024-03-08T07:39:10-07:00",
      "line_items": [
        {
          "line_item_id": 18500231757896,
          "name": "Light Gray Stretch Oxford Long Sleeve Button Up Shirt - S",
          "sku": "TCT4236LGRYS",
          "price": "24.99",
          "quantity": 1,
          "current_quantity": 1,
          "product_id": 6766109622344
        }
      ],
      "shipping_address": {
        "first_name": "Sarah",
        "last_name": "Mitchell",
        "address1": "742 Oak Street",
        "city": "Portland",
        "province": "Oregon",
        "zip": "97205",
        "country": "United States",
        "phone": "5031234567"
      },
      "fulfillments": [
        {
          "status": "success",
          "tracking_company": "USPS",
          "tracking_numbers": ["9261290140407415487497"],
          "tracking_urls": ["https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9261290140407415487497"],
          "created_at": "2024-03-10T09:22:50-07:00"
        }
      ],
      "tags": "nofraud_pass, rivo-cashback-opt-in"
    }
  ]
}

Retrieves the return status for a specific Shopify order using its Admin GraphQL API ID.

This integration looks up a specific order in your Shopify store and returns its current return status. This helps customer service teams quickly determine whether an order has any returns associated with it, such as pending returns, completed returns, or no returns at all. It’s particularly useful for handling customer inquiries about order returns and refunds.

Parameters

• admin_graphql_api_id (String): The unique Shopify Admin GraphQL API identifier for the order. This ID follows the format “gid://shopify/Order/[order_number]”. Example: “gid://shopify/Order/8234567890”.

Output

Returns order information including the order_id (the same GraphQL ID you provided), name (the order number without the # prefix), and return_status (the current return status for this order).

Example Output:

{
  "order_id": "gid://shopify/Order/8234567890",
  "name": "10098765",
  "return_status": "NO_RETURN"
}

Retrieves product variant IDs from a Shopify order by searching with the order name or number.

This integration searches Shopify for a specific order using its name or number, then extracts the product variant IDs for each item in that order. This is useful when you need to identify the exact product variants that were purchased, which can be essential for inventory management, reordering, or product analysis.

Parameters

• order_name (String): The exact order name or number used to locate the Shopify order. This can include the hash symbol or be just the numeric portion. Example: “#1234567” or “1234567”.

Output

Returns an object containing the order_id (Shopify’s global ID for the order) and a products array with details for each line item. Each product entry includes the product_title, variant_title (which may show pricing for services or “Default Title” for single-variant products), and shopify_variantID (the global variant identifier).

Example Output:

{
  "order_id": "gid://shopify/Order/6243857492841",
  "products": [
    {
      "product_title": "Water Filter Cartridge",
      "variant_title": "Default Title", 
      "shopify_variantID": "gid://shopify/ProductVariant/8429563847"
    },
    {
      "product_title": "Shipping Protection by Route",
      "variant_title": "$2.25",
      "shopify_variantID": "gid://shopify/ProductVariant/43856291847529"
    }
  ]
}

Retrieves recent Shopify orders for a customer using their phone number.

This integration searches Shopify for a customer that matches the phone number you provide and returns their recent order history (up to 5 most recent orders). This allows your team to quickly view a customer’s purchase history, order details, and line items without needing to manually search through the Shopify admin.

Parameters

• customer_phone (String): Customer’s phone number in international format. Example: “+1-555-123-4567”.

Output

Returns an orders array containing up to 5 recent orders for the customer. Each order includes order_id, name (order number), created_at, total_price, currency, financial_status, fulfillment_status, email, tags, and a line_items array with product details including name, quantity, price, and SKU. Additional fields include shipping/billing addresses, fulfillment tracking, refunds, and applied discounts when available.

Example Output:

{
  "orders": [
    {
      "order_id": "gid://shopify/Order/7849203847392",
      "name": "#892456",
      "created_at": "2024-03-16T20:02:38Z",
      "total_price": "247.89",
      "currency": "USD",
      "financial_status": "paid",
      "fulfillment_status": "fulfilled",
      "email": "sarah.johnson@example.com",
      "tags": "VIP Customer, First Purchase",
      "line_items": [
        {
          "line_item_id": "gid://shopify/LineItem/18394857362847",
          "name": "Summer Floral Dress in Blue - Medium",
          "quantity": 1,
          "price": "129.00",
          "sku": "SFD-BLUE-M"
        },
        {
          "line_item_id": "gid://shopify/LineItem/18394857395615",
          "name": "Matching Belt - Blue",
          "quantity": 1,
          "price": "45.00",
          "sku": "BELT-BLUE"
        }
      ],
      "shipping_address": {
        "first_name": "Sarah",
        "last_name": "Johnson",
        "address1": "789 Oak Street",
        "city": "Portland",
        "province": "OR",
        "country": "US",
        "zip": "97205"
      }
    }
  ]
}

Retrieves product images from Shopify using a product ID to display visual content for customer support or order management.

This integration fetches product images from your Shopify store using a specific product ID. It’s useful when you need to quickly view or display product photos during customer support conversations, order reviews, or inventory management. The tool returns the product’s media images with URLs that can be displayed directly in your workflow.

Parameters

• all_product_id_to_image_search (String): The unique Shopify product ID to retrieve images for. This should be the numeric product ID from Shopify. Example: “8786436030705”.

Output

Returns product information including the product_id, title, and an array of media objects. Each media object contains a media_id, alt text description, and the url where the image is hosted. The tool also provides final_html for easy display of the images.

Example Output:

{
  "products": [
    {
      "product_id": "gid://shopify/Product/8786436030705",
      "title": "Premium Wireless Headphones",
      "media": [
        {
          "media_id": "gid://shopify/MediaImage/35616403194097",
          "alt": "Premium wireless headphones in black",
          "url": "https://cdn.shopify.com/s/files/1/0668/1116/6961/files/headphones.png?v=1744225410"
        }
      ]
    }
  ],
  "final_html": "

Premium Wireless Headphones

” }