FirmhouseHelp CenterStatusPortal / Login

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?: null | string

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

  • before?: null | string

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

  • first?: null | number

    Return the first n elements from the list

  • id?: null | string

    Only list products that match the passed in ID

  • last?: null | number

    Return the last n elements from the list.

  • shopifyVariantId?: null | string

    Only list products that match the passed in Shopify variant ID

  • sku?: null | string

    Only list products that match the passed in SKU

  • updatedSince?: null | string

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

    Example

    2024-01-15T00:00:00+01:00

Returns

Promise<PaginatedResponse<FirmhouseProduct>>

List of products with pagination info

fetchById()

fetchById(id): Promise<FirmhouseProduct>

Retrieve a product by ID

Parameters

• id: string

ID of the product

Returns

Promise<FirmhouseProduct>

Product

Throws

Last updated