> ## Documentation Index
> Fetch the complete documentation index at: https://www.voiceflow.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Shopify tool

> Look up products and orders, update orders, and cancel orders in your Shopify store.

## What it connects

Look up products and orders, update orders, or cancel an order in your connected Shopify store.

### Run independently through code
You can also run this integration’s actions through code without an agent conversation. Independent execution uses the project’s Draft connection and can perform real actions in the connected service. See [Run tools without a conversation (Developers)](/docs/developers/tools/execute) for schema discovery, inputs, permissions, and results.

## Before you connect

A Shopify store you can connect to Voiceflow. For order actions, collect the customer’s email and an additional order lookup value.

## Set up and test

<a id="using-the-shopify-tool"></a>
<a id="connect-your-account"></a>

The steps below use a workflow so you can provide explicit inputs and check the result of one action.

<Steps>
<Step title="Add the integration">
Open a workflow and add an [Integration step](/docs/documentation/build/steps/integration). Connect it to the preceding step, open its configuration, and choose **Shopify**.
</Step>
<Step title="Connect your account">
Complete the Shopify connection flow for the store you want the agent to use. If the account is already connected, check that it is the account you intend to test.
</Step>
<Step title="Choose an action">
Select **Get order** for this first test. The tool shows the inputs for that action. You can find the other available actions in the reference below.
</Step>
<Step title="Configure the inputs">
Use a test order’s customer `email` and `orderNumber`. You can alternatively use the email with `postalCode` or `creditCardLast4`.

Use fixed test values first. When the test works, you can map the inputs to [variables](/docs/documentation/build/data/variables) collected earlier in the conversation.
</Step>
<Step title="Run a test and check the result">
Use **Run** to test the workflow and follow the conversation path that reaches the Integration step.

Compare the returned order name and line items with the test order in Shopify. This first test uses a lookup, so it does not change or cancel the order.
</Step>
</Steps>

To let the agent choose when to call the tool, add it to a [playbook](/docs/documentation/build/playbooks) instead and describe when to use it and what information to collect. Manage existing connections in **Settings → Integrations**.

## Supported actions

<a id="actions"></a>

The table names the connector’s inputs; optional inputs are marked where listed. Select an action to see its complete configuration.

| Action | Inputs | Result |
| --- | --- | --- |
| Get products | Product filters such as title, handle, SKU, tags and product type; optional limit. | Matching product data. |
| Get order | `email` and at least one of `orderNumber`, `postalCode`, or `creditCardLast4`. | First matching order. |
| Update order | Order lookup values plus `note` or `shippingAddress`. | Result of updating the order. |
| Cancel order | Order lookup values; optional `restock`. | Result of cancelling the order. |

Use **Capture response** in an Integration step to save the result, or an object path within it, to a variable. Base the path on the actual returned result.

## Look up an order

These are example input values, not a live execution.

```json
{
  "email": "CUSTOMER_EMAIL",
  "orderNumber": "ORDER_NUMBER"
}
```

Replace both placeholders with values from a test order in the connected store. Run **Get order** and compare the returned order name and line items with Shopify before using them in a customer response.

## Limitations & troubleshooting

Order lookup requires the email plus at least one additional lookup value. Updating an order note replaces the existing note. Use a test order when trying update or cancellation actions. Customer record editing is not an action exposed by this connector.

## Related guides

[Integration walkthrough](/docs/courses/integrate-with-third-party-tools) · [Integration step](/docs/documentation/build/steps/integration) · [All integrations](/docs/documentation/build/tools/overview)

### Importing Shopify products into your Knowledge Base

You can import your Shopify product catalog into Voiceflow's [Knowledge base](/docs/documentation/build/importing-data-sources). This lets your agent answer questions about your products, including details like descriptions, pricing, and availability, without needing to call the Shopify API for every query.

To import your Shopify products, go to **Knowledge base** → **Add data source** → **Shopify** inside your project.
