# GetCustomer

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Unknown

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

{% tabs %}
{% tab title="Parameter: 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="Parameter: 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="Parameter: 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 %}                     |                                                                                                                                                        |

{% tab title="Result: 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>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| {% endtab %}         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |

{% tab title="Changelog" %}

## Changelog

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

#### Changed

* Initial implementation
  {% endtab %}
  {% endtabs %}
