Shopify

Integrate Shopify actions with your AI bot

Our Shopify integration involves allowing your bot to access actions to lookup information on your Shopify store.

First, follow the instructions to integrate Shopify.

Then, add in Shopify actions and prompt adjustments to ensure your bot can utilize the integration.

How to Integrate Shopify with your AI

Follow the steps below to create and configure the eesel AI Integration app in your Shopify store so you AI can retrieve orders, fulfilment information, products, and more!

1

Access Shopify App Development Settings

  • Log in to your Shopify admin dashboard.

  • Navigate to Settings > Apps and Sales Channels. ​

  • Click Develop apps at the top of the page.

  • If prompted, enable app development.

2

Create the App

  • Click Create an app.

  • Enter eesel AI Integration as the app name.

  • Proceed to create the app.

3

Configure API Credentials

  • Open the API credentials tab.

  • Click Configure Admin API scopes.

  • Select the following read-only permissions:

    • read_assigned_fulfillment_orders

    • read_customers

    • read_discounts

    • read_fulfillments

    • read_orders

    • read_payment_terms

    • read_products

    • read_returns

    • read_third_party_fulfillment_orders

    • read_custom_fulfillment_services

  • Click Save.

4

Install the App

  • Navigate to the Overview tab.

  • Click the black Install app button in the top-right corner.

  • Confirm the installation.

5

Retrieve and Share API Credentials

  • After installation, you will see a masked API credential

  • Locate the API key field and click to reveal the token.

6

Add the credentials to a new action in the eesel dashboard

  • Open up the eesel dashboard

  • Go to "Customize" in the sidebar

  • Click "Create new action", you'll see the following

  • Choose "Shopify" from the sidebar to see the list of Shopify actions available

  • Select an action, then type in the shop name (not the URL!) and access token. The shop name will be the first part of the URL, for example if the URL is "eesel-ai.myshopify.com", the shop name will be "eesel-ai".

Shopify Actions

Get order by ID

shopify_get_order_by_id

  • Purpose: Fetch details for a specific Shopify order.

  • Key Params: order_id: str

  • When/How to Use: Use when a user asks about the status or details of a specific order and provides an order number or ID. Instruct the AI to ask for the order ID if the user's query requires it but isn't provided initially.

  • Example Prompt Instruction:

    If the user is asking about the status or location of their order, you must ask them for their order number. Once the user provides an order number, you must call shopify_get_order_by_id with the provided order_id as the parameter. Use the information returned by the tool to answer the user's question about their order.

Get customer by email

shopify_get_customer_by_email

  • Purpose: Look up a Shopify customer by their email address.

  • Key Params: email: str

  • When/How to Use: Use when a user asks about their account, order history, or general customer information and provides their email address. Instruct the AI to request the email if needed.

  • Example Prompt Instruction:

    If the user is asking about their customer account or looking for information related to orders associated with their account but has not provided an order number, you must ask for the email address associated with their account for verification. Once the user provides their email address, you must call shopify_get_customer_by_email with the provided email. Use the information returned to help the user with their account-related query.

PreviousWebsiteNextSlack

Last updated