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

GetProduct

Retrieves a product from Shopify

Task version: 1.0.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

ProductId : String

The ID of the product 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: 2023-10

Name
Description

Fields : String[]

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

Default: - Example: id,title,handle,status,variants,images

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 product.

Task Result

Name
Description

Success : Boolean

Indicates whether the retrieval was successful. Example: true

Product : JObject

The product object returned by Shopify. Example: foobar,foobar

Error : Error

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

Error.Message : String

Summary of the error. Example: Unable to join strings.

Error.AdditionalInfo : Exception

Additional information about the error. Example: object { Exception Exception }

Task Changelog

Changelog for Task Frends.Shopify.GetProduct.

[1.0.0] - 2025-07-17

Changed

  • Initial implementation

Last updated

Was this helpful?