Class CatalogDefaultAdapterApi<ProductCustomFields, AttributeCustomFields, ProductVariantCustomFields>

Type Parameters

  • ProductCustomFields = unknown

  • AttributeCustomFields = unknown

  • ProductVariantCustomFields = unknown

Hierarchy

Implements

  • CatalogApi<ProductCustomFields, AttributeCustomFields, ProductVariantCustomFields>

Constructors

  • Type Parameters

    • ProductCustomFields = unknown

    • AttributeCustomFields = unknown

    • ProductVariantCustomFields = unknown

    Parameters

    Returns CatalogDefaultAdapterApi<ProductCustomFields, AttributeCustomFields, ProductVariantCustomFields>

Properties

serviceEndpoint: string
sessionService: SessionService

Methods

  • Perform a POST request to create a new product.

    Parameters

    Returns Promise<Omit<ProductResponse<ProductCustomFields, AttributeCustomFields, ProductVariantCustomFields>, "organization" | "category">>

  • On setup, we can call getRequiredVersion and ping() to confirm that the service exists and that it is of a matching version semantically E.g. if required version is ~2.5 and the api returns 2.6.3, then no issue If returns 3.0.1, should log a warning If returns 1.0.2, should throw error saying it isn't new enough

    Returns string

  • Perform a PATCH request to update a product.

    Parameters

    Returns Promise<Omit<ProductResponse<ProductCustomFields, AttributeCustomFields, ProductVariantCustomFields>, "organization" | "category">>

Generated using TypeDoc