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

Class: ProductsResource

You can use products to access all products in your project

Methods

fetchAll()

fetchAll(params?): Promise<PaginatedResponse<FirmhouseProduct>>;

Retrieve products

Parameters

params?

Parameters to filter products by

after?

string | null

Return the elements in the list that come after the specified cursor.

before?

string | null

Return the elements in the list that come before the specified cursor

first?

number | null

Return the first n elements from the list

id?

string | null

Only list products that match the passed in ID

last?

number | null

Return the last n elements from the list.

shopifyVariantId?

string | null

Only list products that match the passed in Shopify variant ID

sku?

string | null

Only list products that match the passed in SKU

updatedSince?

string | null

Filter products to those that where updated since the given datetime.

Example

Returns

Promise<PaginatedResponse<FirmhouseProduct>>

List of products with pagination info


fetchById()

Retrieve a product by ID

Parameters

id

string

ID of the product

Returns

Promise<FirmhouseProduct>

Product

Throws

Last updated

Was this helpful?