For the complete documentation index, see llms.txt. This page is also available as Markdown.

GetCustomer

Retrieves a customer from Shopify

Task version: 1.0.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

CustomerId : String

The ID of the customer to retrieve.

Default: - Example: 1234567890123

Name
Description

ShopName : String

The subdomain of the Shopify store (e.g., myshop for myshop.myshopify.com).

Default: - Example: myshop

🗝AccessToken : String

Shopify Admin API access token for authenticating requests.

Default: - Example: Private: shpat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx OAuth: shpca_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

ApiVersion : String

The version of Shopify API to use

Default: - Example: 2025-07

Name
Description

Fields : String[]

Optional. List of specific fields to include in the response.

Default: - Example: "id,email,first_name"

ThrowErrorOnFailure : Boolean

Whether to throw an error on failure. True by default.

Default: True Example: false

ErrorMessageOnFailure : String

Overrides the error message on failure.

Default: - Example: Failed to retrieve customer.

Task Result

Name
Description

Success : Boolean

Indicates whether the retrieval was successful. Example: true

Customer : JObject

The customer object returned by Shopify. Example: { "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 } ], }

Error : Error

Error that occurred during task execution. Example: object { string Message, object { Exception Exception } AdditionalInfo }

Task Changelog

Changelog for Task Frends.Shopify.GetCustomer.

[1.0.0] - 2025-07-22

Changed

  • Initial implementation

Last updated

Was this helpful?