> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/shopify/getcustomer.md).

# GetCustomer

Retrieves a customer from Shopify

Task version: 1.0.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Source code: <https://github.com/FrendsPlatform/Frends.Shopify/tree/main/Frends.Shopify.GetCustomer>

## Task Parameters

{% tabs %}
{% tab title="Input" %}

| Name                  | Description                                                                                                         |
| --------------------- | ------------------------------------------------------------------------------------------------------------------- |
| CustomerId : `String` | <p>The ID of the customer to retrieve.</p><p><br>Default: <code>-</code><br>Example: <code>1234567890123</code></p> |
| {% endtab %}          |                                                                                                                     |

{% tab title="Connection" %}

| Name                     | Description                                                                                                                                                                                                                   |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ShopName : `String`      | <p>The subdomain of the Shopify store (e.g., myshop for myshop.myshopify.com).</p><p><br>Default: <code>-</code><br>Example: <code>myshop</code></p>                                                                          |
| 🗝AccessToken : `String` | <p>Shopify Admin API access token for authenticating requests.</p><p><br>Default: <code>-</code><br>Example: <code>Private: shpat\_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx OAuth: shpca\_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</code></p> |
| ApiVersion : `String`    | <p>The version of Shopify API to use</p><p><br>Default: <code>-</code><br>Example: <code>2025-07</code></p>                                                                                                                   |
| {% endtab %}             |                                                                                                                                                                                                                               |

{% tab title="Options" %}

| Name                             | Description                                                                                                                                            |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Fields : `String[]`              | <p>Optional. List of specific fields to include in the response.</p><p><br>Default: <code>-</code><br>Example: <code>"id,email,first\_name"</code></p> |
| ThrowErrorOnFailure : `Boolean`  | <p>Whether to throw an error on failure. True by default.</p><p><br>Default: <code>True</code><br>Example: <code>false</code></p>                      |
| ErrorMessageOnFailure : `String` | <p>Overrides the error message on failure.</p><p><br>Default: <code>-</code><br>Example: <code>Failed to retrieve customer.</code></p>                 |
| {% endtab %}                     |                                                                                                                                                        |
| {% endtabs %}                    |                                                                                                                                                        |

## Task Result

| Name                               | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Success : `Boolean`                | <p>Indicates whether the retrieval was successful.<br>Example: <code>true</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Customer : `JObject`               | <p>The customer object returned by Shopify.<br>Example: <code>{ "id": 1234567890123, "email": "<test@email.com>", "created\_at": "2025-07-17T15:27:48+03:00", "updated\_at": "2025-07-17T15:27:48+03:00", "first\_name": "Test", "last\_name": "User", "orders\_count": 0, "state": "disabled", "total\_spent": "0.00", "last\_order\_id": null, "note": "", "verified\_email": true, "multipass\_identifier": null, "tax\_exempt": false, "tags": "", "last\_order\_name": null, "currency": "EUR", "phone": null, "addresses": \[ { "id": 1234567890123, "customer\_id": 1234567890123, "first\_name": "Test", "last\_name": "User", "company": "", "address1": "", "address2": "", "city": "", "province": "", "country": "Finland", "zip": "", "phone": "", "name": "Test User", "province\_code": null, "country\_code": "FI", "country\_name": "Finland", "default": true } ], }</code></p> |
| Error : `Error`                    | <p>Error that occurred during task execution.<br>Example: <code>object { string Message, object { Exception Exception } AdditionalInfo }</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Error.Message : `String`           | <p>Summary of the error.<br>Example: <code>Unable to retrieve a customer.</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Error.AdditionalInfo : `Exception` | <p>Additional information about the error.<br>Example: <code>object { Exception Exception }</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

## Task Changelog

Changelog for Task Frends.Shopify.GetCustomer.

### \[1.0.0] - 2025-07-22

#### Changed

* Initial implementation


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.frends.com/tasks/tasks/shopify/getcustomer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
