Interface CatalogApi<ProductCustomFields, AttributeCustomFields, ProductVariantCustomFields>

interface CatalogApi {
    createAttachment(input): Promise<CatalogAttachmentResponse>;
    createProduct(input): Promise<Omit<ProductResponse<ProductCustomFields, AttributeCustomFields, ProductVariantCustomFields>, "organization" | "category">>;
    deleteAttachment(input): Promise<void>;
    getAttachmentUploadUrl(input): Promise<GetCatalogAttachmentUploadUrlResponse>;
    getProduct(input): Promise<ProductResponse<ProductCustomFields, AttributeCustomFields, ProductVariantCustomFields>>;
    getRequiredVersion(): string;
    listAttributes(input): Promise<PaginatedResponse<AttributeResponse<AttributeCustomFields>>>;
    listCategories(input): Promise<PaginatedResponse<CategoryResponse>>;
    listProductsForActiveStatus(input): Promise<PaginatedResponse<ProductResponse<ProductCustomFields, AttributeCustomFields, ProductVariantCustomFields>>>;
    listProductsForOrganization(input): Promise<PaginatedResponse<ProductResponse<ProductCustomFields, AttributeCustomFields, ProductVariantCustomFields>>>;
    ping(): Promise<PingResponse>;
    updateProduct(input): Promise<Omit<ProductResponse<unknown, unknown, unknown>, "organization" | "category">>;
}

Type Parameters

  • ProductCustomFields = unknown

  • AttributeCustomFields = unknown

  • ProductVariantCustomFields = unknown

Hierarchy

Implemented by

Methods

createAttachment createProduct deleteAttachment getAttachmentUploadUrl getProduct getRequiredVersion listAttributes listCategories listProductsForActiveStatus listProductsForOrganization ping updateProduct

Methods

createAttachment

createProduct

  • createProduct(input): Promise<Omit<ProductResponse<ProductCustomFields, AttributeCustomFields, ProductVariantCustomFields>, "organization" | "category">>

  • Perform a POST request to create a new product.

    Parameters

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

deleteAttachment

getAttachmentUploadUrl

getProduct

getRequiredVersion

  • getRequiredVersion(): string

  • 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

listAttributes

listCategories

listProductsForActiveStatus

listProductsForOrganization

ping

updateProduct

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc