export = Catalog; declare class Catalog { constructor(config: any); config: any; /** * @param {CatalogPlatformValidator.AddInventoryParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name addInventory * @summary: Create Inventory * @description: Allows add Inventory for particular size and selling location. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/addInventory/). */ addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.AllSizesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name allSizes * @summary: Get product sizes * @description: Retrieve all available sizes for a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/allSizes/). */ allSizes({ itemId, requestHeaders }?: CatalogPlatformValidator.AllSizesParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.BulkHsnCodeParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name bulkHsnCode * @summary: Create Bulk update HSN * @description: Execute bulk updates for HSN codes across multiple products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/bulkHsnCode/). */ bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createBulkInventory * @summary: Create bulk inventory * @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createBulkInventory/). */ createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateBulkInventoryJobParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createBulkInventoryJob * @summary: Create bulk inventory upload job * @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createBulkInventoryJob/). */ createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateBulkProductUploadJobParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createBulkProductUploadJob * @summary: Create products bulk upload * @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createBulkProductUploadJob/). */ createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateHsCodeParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createHsCode * @summary: Create HS/SAC code * @description: Create a new Harmonized System (HS) or Service Accounting Code (SAC). These codes are used for product and service identification in taxation and compliance processes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createHsCode/). */ createHsCode({ body, requestHeaders }?: CatalogPlatformValidator.CreateHsCodeParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name createInventoryExport * @summary: Create inventory export * @description: creates export job for inventory data associated with a company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createInventoryExport/). */ createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateInventoryExportJobParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name createInventoryExportJob * @summary: Create inventory export job * @description: Helps to create a Inventory export job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createInventoryExportJob/). */ createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateMarketplaceOptinParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name createMarketplaceOptin * @summary: Create or Update opt-in infomation * @description: Allows to create opt-in information for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createMarketplaceOptin/). */ createMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createProduct * @summary: Create product * @description: Users can create a product using this API, associating it with the provided company ID - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProduct/). */ createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createProductAssetsInBulk * @summary: Create product assets in bulk * @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductAssetsInBulk/). */ createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name createProductExportJob * @summary: Create product export job * @description: Allows to create a product export job for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductExportJob/). */ createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateProductsInBulkParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createProductsInBulk * @summary: Create products in bulk * @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductsInBulk/). */ createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateSizeGuideParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createSizeGuide * @summary: Create size guide * @description: Allows to create a size guide associated to a seller - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createSizeGuide/). */ createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateTaxParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createTax * @summary: Create Tax Rule * @description: Create a tax rule in a company, including its initial (live) version. The API supports both default (country-level) and region-specific versions by using optional parameters such as 'region_type' and 'areas'. This enables granular taxation rules scoped to different geographic regions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTax/). */ createTax({ body, requestHeaders }?: CatalogPlatformValidator.CreateTaxParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateTaxComponentNameParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createTaxComponentName * @summary: Create tax component name * @description: Tax components represent different types of taxes that may be applied to products or transactions, * such as sales tax, value-added tax (VAT), goods and services tax, consumption tax, * or other region-specific taxation systems. This endpoint allows companies to define and * customize the names of tax components according to their local tax regulations and business requirements. * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxComponentName/). */ createTaxComponentName({ body, requestHeaders }?: CatalogPlatformValidator.CreateTaxComponentNameParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.CreateTaxVersionParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createTaxVersion * @summary: Create a tax version * @description: Creates a tax version using the provided rule_id with support for scheduled applicability and optional region-level overrides. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxVersion/). */ createTaxVersion({ ruleId, body, requestHeaders }?: CatalogPlatformValidator.CreateTaxVersionParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.DeleteBulkInventoryJobParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name deleteBulkInventoryJob * @summary: Delete inventory bulk upload job * @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteBulkInventoryJob/). */ deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.DeleteProductParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name deleteProduct * @summary: Delete product * @description: Users can delete a product by providing the item_id and company_id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteProduct/). */ deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.DeleteProductBulkJobParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name deleteProductBulkJob * @summary: Delete product bulk-upload job * @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteProductBulkJob/). */ deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.DeleteRealtimeInventoryParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name deleteRealtimeInventory * @summary: Delete an inventory * @description: You can use this API to delete inventory linked to a particular product size. When you make the API call, the inventory associated with that size will be removed as part of api process. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteRealtimeInventory/). */ deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.DeleteSizeParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name deleteSize * @summary: Delete product size * @description: Allows to delete size associated with product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteSize/). */ deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.DeleteTaxRuleParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name deleteTaxRule * @summary: Delete a tax rule * @description: Deletes a tax rule and all its associated versions. Note: A rule cannot be deleted if it is set as the default or is currently assigned to any product. * To proceed with deletion, ensure you first assign another rule as the default and unlink this rule from all products. * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteTaxRule/). */ deleteTaxRule({ ruleId, requestHeaders }?: CatalogPlatformValidator.DeleteTaxRuleParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.DeleteTaxVersionParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name deleteTaxVersion * @summary: Delete a tax version * @description: Deletes a tax rule using the provided rule_id. Only future/scheduled version can be deleted. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/deleteTaxVersion/). */ deleteTaxVersion({ ruleId, versionId, requestHeaders }?: CatalogPlatformValidator.DeleteTaxVersionParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.DownloadInventoryTemplateViewParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name downloadInventoryTemplateView * @summary: Download inventory template data * @description: Allows you to download inventory product template data for a specific company in formats like csv and excel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/downloadInventoryTemplateView/). */ downloadInventoryTemplateView({ schemaType, type, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.DownloadProductTemplateViewsParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name downloadProductTemplateViews * @summary: Download product template view * @description: Allows you to download product template data by its slug for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/downloadProductTemplateViews/). */ downloadProductTemplateViews({ slug, itemType, type, requestHeaders }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.EditProductParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name editProduct * @summary: Update a product * @description: Modify the details and settings of an existing product in the catalog. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/editProduct/). */ editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.ExportInventoryConfigParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name exportInventoryConfig * @summary: Get export inventory configuration * @description: Retrieve List of different filters like brand, store, and type for inventory export. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/exportInventoryConfig/). */ exportInventoryConfig({ filterType, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetAllProductHsnCodesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name getAllProductHsnCodes * @summary: List product HSN codes * @description: Retrieve all HSN codes associated with company products and provide search capabilities based on HSN code, reporting HSN, etc - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAllProductHsnCodes/). */ getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetAllTaxRulesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getAllTaxRules * @summary: Get all tax rules of a company * @description: Retrieves a list of all tax rules defined for a company, along with their details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAllTaxRules/). */ getAllTaxRules({ q, statuses, page, limit, versionStatus, requestHeaders }?: CatalogPlatformValidator.GetAllTaxRulesParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetAttributeParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getAttribute * @summary: Get attribute detail by slug * @description: Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getAttribute/). */ getAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetAttributeParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getCategoryData * @summary: Get category by uid * @description: Retrieve detailed information about a specific category by its uid for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCategoryData/). */ getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetCompanyBrandDetailParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getCompanyBrandDetail * @summary: list Company Brand of Optin * @description: Get the details of the Brands associated with the given company_id passed which has opt-in. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCompanyBrandDetail/). */ getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetCompanyDetailParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getCompanyDetail * @summary: Get Company * @description: Get the details of the company associated with the given company_id passed which has opt-in. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCompanyDetail/). */ getCompanyDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetCompanyMetricsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getCompanyMetrics * @summary: Get company metrics * @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCompanyMetrics/). */ getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetDepartmentDataParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getDepartmentData * @summary: Get department by uid * @description: Retrieve detailed information about a specific department for a specific company by uid. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getDepartmentData/). */ getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetHsCodesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getHsCodes * @summary: Get HS/SAC codes * @description: Retrieve a list of Harmonized System (HS)) or Service Accounting Code (SAC)) codes for a company. * HS codes are used to classify goods in international trade, while SAC codes classify services for taxation purposes. * Supports optional filtering and pagination. * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getHsCodes/). */ getHsCodes({ page, limit, type, q, requestHeaders }?: CatalogPlatformValidator.GetHsCodesParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getHsnCode * @summary: List HSN code * @description: Retrieve the HSN code for a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getHsnCode/). */ getHsnCode({ id, requestHeaders }?: CatalogPlatformValidator.GetHsnCodeParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetInventoriesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getInventories * @summary: List Inventory * @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventories/). */ getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers, qtyGt, qtyLt, qtyType, fromDate, toDate, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise; /** * @param {Object} arg - Arg object. * @param {string} [arg.itemId] - Item code of the product of which size is to be get. * @param {string} [arg.size] - Size of which inventory is to get. * @param {number} [arg.pageSize] - Number of items to retrieve in each * page. Default is 12. * @param {string} [arg.q] - Search with help of store code. * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not. * @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory. * @param {number[]} [arg.brandIds] - The Brand Id of products to fetch inventory. * @param {string[]} [arg.sellerIdentifiers] - The Seller Identifier or * Primary Identifier of the inventory. * @param {number} [arg.qtyGt] - This field allows you to filter for * inventories that have quantity greater than to the specified value * based on qty_type filter. * @param {number} [arg.qtyLt] - This field allows you to filter for * inventories that have a quantity less than to the specified value based * on qty_type filter. * @param {string} [arg.qtyType] - This field provides flexibility in * selecting filter for inventory quantity counts and date queries. For * example, you might use this field to specify "total" or "sellable" quantity. * @param {string} [arg.fromDate] - Inventory updated on filter to get * inventories greater then or equal to provided date based on qty_type value. * @param {string} [arg.toDate] - Inventory updated on filter to get * inventories less then or equal to provided date based on qty_type value. * @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier * or Primary Identifier) of which inventory is to get. * @returns {Paginator} * @summary: List Inventory * @description: Allows to get Inventories data for particular company. */ getInventoriesPaginator({ itemId, size, pageSize, q, sellable, storeIds, brandIds, sellerIdentifiers, qtyGt, qtyLt, qtyType, fromDate, toDate, sizeIdentifier, }?: { itemId?: string; size?: string; pageSize?: number; q?: string; sellable?: boolean; storeIds?: number[]; brandIds?: number[]; sellerIdentifiers?: string[]; qtyGt?: number; qtyLt?: number; qtyType?: string; fromDate?: string; toDate?: string; sizeIdentifier?: string; }): Paginator; /** * @param {CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getInventoryBulkUploadHistory * @summary: List bulk inventory upload history * @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryBulkUploadHistory/). */ getInventoryBulkUploadHistory({ pageNo, pageSize, search, startDate, endDate, stage, tags, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise; /** * @param {Object} arg - Arg object. * @param {number} [arg.pageSize] - Number of items to retrieve in each * page. Default is 12. * @param {string} [arg.search] - Search string to filter the results by batch id * @param {string} [arg.startDate] - Filter results by the job's start date. * @param {string} [arg.endDate] - Filter results by the job's end date. * @param {string} [arg.stage] - Filter results by the current stage of the * import job. * @param {string} [arg.tags] - Filter results by the tags of the import job. * @returns {Paginator} * @summary: List bulk inventory upload history * @description: Helps to get bulk Inventory upload jobs status. */ getInventoryBulkUploadHistoryPaginator({ pageSize, search, startDate, endDate, stage, tags, }?: { pageSize?: number; search?: string; startDate?: string; endDate?: string; stage?: string; tags?: string; }): Paginator; /** * @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getInventoryBySize * @summary: List inventory by size * @description: Retrieve inventory data for a specific company, item ID, and size. The API supports search capabilities based on selling location (store) code and product availability (in stock or not)." - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryBySize/). */ getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, requestHeaders }?: CatalogPlatformValidator.GetInventoryBySizeParam, { responseHeaders }?: object): Promise; /** * @param {Object} arg - Arg object. * @param {number} arg.itemId - Item code of the product of which size is to be get. * @param {string} arg.size - Size of which inventory is to get. * @param {number} [arg.pageSize] - Number of items to retrieve in each * page. Default is 12. * @param {string} [arg.q] - Search with help of store code. * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not. * @returns {Paginator} * @summary: List inventory by size * @description: Retrieve inventory data for a specific company, item ID, and size. The API supports search capabilities based on selling location (store) code and product availability (in stock or not)." */ getInventoryBySizePaginator({ itemId, size, pageSize, q, sellable }?: { itemId: number; size: string; pageSize?: number; q?: string; sellable?: boolean; }): Paginator; /** * @param {CatalogPlatformValidator.GetInventoryBySizeIdentifierParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name getInventoryBySizeIdentifier * @summary: List inventory by size * @description: Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryBySizeIdentifier/). */ getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise; /** * @param {Object} arg - Arg object. * @param {number} arg.itemId - Item code of the product of which size is to be get. * @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier * or Primary Identifier) of which inventory is to get. * @param {number} [arg.pageSize] - Number of items to retrieve in each * page. Default is 12. * @param {string} [arg.q] - Search with help of store code. * @param {number[]} [arg.locationIds] - Search by store ids. * @returns {Paginator} * @summary: List inventory by size * @description: Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs. */ getInventoryBySizeIdentifierPaginator({ itemId, sizeIdentifier, pageSize, q, locationIds, }?: { itemId: number; sizeIdentifier: string; pageSize?: number; q?: string; locationIds?: number[]; }): Paginator; /** * @param {CatalogPlatformValidator.GetInventoryExportParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getInventoryExport * @summary: list product inventory * @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryExport/). */ getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetMarketplaceOptinDetailParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getMarketplaceOptinDetail * @summary: Get opt-in * @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getMarketplaceOptinDetail/). */ getMarketplaceOptinDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetMarketplacesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getMarketplaces * @summary: List marketplaces * @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getMarketplaces/). */ getMarketplaces({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetProductParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getProduct * @summary: Get a product * @description: Retrieve data associated to a particular product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProduct/). */ getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetProductAssetsInBulkParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getProductAssetsInBulk * @summary: Get product assets * @description: Helps to retrieve bulk asset jobs data associated to a particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductAssetsInBulk/). */ getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise; /** * @param {Object} arg - Arg object. * @param {number} [arg.pageSize] - Number of items to retrieve in each * page. Default is 12. * @returns {Paginator} * @summary: Get product assets * @description: Helps to retrieve bulk asset jobs data associated to a particular company. */ getProductAssetsInBulkPaginator({ pageSize }?: { pageSize?: number; }): Paginator; /** * @param {CatalogPlatformValidator.GetProductAttributesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name getProductAttributes * @summary: List product attributes * @description: Retrieve attributes attached to products based on their L3 category. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductAttributes/). */ getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetProductBulkUploadHistoryParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getProductBulkUploadHistory * @summary: List product bulk upload history * @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductBulkUploadHistory/). */ getProductBulkUploadHistory({ search, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { responseHeaders }?: object): Promise; /** * @param {Object} arg - Arg object. * @param {string} [arg.search] - Search string to filter the results by batch id * @param {number} [arg.pageSize] - Number of items to retrieve in each * page. Default is 12. * @returns {Paginator} * @summary: List product bulk upload history * @description: Helps to get bulk product upload jobs data. */ getProductBulkUploadHistoryPaginator({ search, pageSize }?: { search?: string; pageSize?: number; }): Paginator; /** * @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name getProductExportJobs * @summary: Get product export jobs * @description: Get product export jobs specific to a company based on queries like query param, date range and status. View details including trigger data, task id , etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductExportJobs/). */ getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetProductSizeParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getProductSize * @summary: List product size * @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductSize/). */ getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetProductTagsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getProductTags * @summary: List product tags * @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductTags/). */ getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetProductValidationParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getProductValidation * @summary: Get valid products * @description: Retrieve validation data for products at company level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductValidation/). */ getProductValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetProductsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getProducts * @summary: List products * @description: Retrieve a list of available products - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProducts/). */ getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageNo, pageSize, pageType, sortOn, pageId, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise; /** * @param {Object} arg - Arg object. * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids * @param {number[]} [arg.categoryIds] - Get multiple products filtered by * Category Ids * @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids * @param {number[]} [arg.departmentIds] - Get multiple products filtered by * Department Ids * @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code * @param {string} [arg.name] - Get multiple products filtered by Name (Pattern Match) * @param {string} [arg.slug] - Get multiple products filtered by Slug * @param {string[]} [arg.allIdentifiers] - Get multiple products filtered * by All Identifiers * @param {string} [arg.q] - Get multiple products filtered by q string * @param {string[]} [arg.tags] - Get multiple products filtered by tags * @param {number} [arg.pageSize] - Number of items to retrieve in each * page. Default is 10. * @param {string} [arg.sortOn] - Field which is to be used for sorting, * default is latest. Value can be latest (modified_on) or created (record id) * @returns {Paginator} * @summary: List products * @description: Retrieve a list of available products */ getProductsPaginator({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageSize, sortOn, }?: { brandIds?: number[]; categoryIds?: number[]; itemIds?: number[]; departmentIds?: number[]; itemCode?: string[]; name?: string; slug?: string; allIdentifiers?: string[]; q?: string; tags?: string[]; pageSize?: number; sortOn?: string; }): Paginator; /** * @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getSellerInsights * @summary: Get seller catalog counts * @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSellerInsights/). */ getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetSingleProductHSNCodeParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getSingleProductHSNCode * @summary: Get product HSN code * @description: Retrieve HSN details associated with company ID and reporting HSN - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSingleProductHSNCode/). */ getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetSizeGuideParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getSizeGuide * @summary: Get size guide * @description: Retrieve data associated about a specific size guide. It contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSizeGuide/). */ getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetSizeGuidesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getSizeGuides * @summary: List size guides * @description: Allows to view all the size guides associated to the seller. Each size guide contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getSizeGuides/). */ getSizeGuides({ active, q, tag, pageNo, pageSize, brandId, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetStoreDetailParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getStoreDetail * @summary: Get selling location * @description: Retrieve the details of the selling location (store) associated with a specific company passed. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getStoreDetail/). */ getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise; /** * @param {Object} arg - Arg object. * @param {string} [arg.q] - The search related the store for the company id. * @param {number} [arg.pageSize] - Number of records that can be seen on * the page for the company id. * @returns {Paginator} * @summary: Get selling location * @description: Retrieve the details of the selling location (store) associated with a specific company passed. */ getStoreDetailPaginator({ q, pageSize }?: { q?: string; pageSize?: number; }): Paginator; /** * @param {CatalogPlatformValidator.GetTaxComponentNamesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getTaxComponentNames * @summary: Get component names * @description: Retrieve the list of all tax component names for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getTaxComponentNames/). */ getTaxComponentNames({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetTaxVersionDetailsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getTaxVersionDetails * @summary: Get tax versions for a tax rule * @description: Retrieve the versions of a tax rule. You can filter results by version status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getTaxVersionDetails/). */ getTaxVersionDetails({ ruleId, versionStatus, q, limit, page, requestHeaders }?: CatalogPlatformValidator.GetTaxVersionDetailsParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getVariantsOfProducts * @summary: Get variants * @description: Retrieve variants of a specific product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getVariantsOfProducts/). */ getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise; /** * @param {Object} arg - Arg object. * @param {number} arg.itemId - Get list of variants of item Id * @param {string} arg.variantType - Get multiple products filtered by variant type * @param {number} [arg.pageSize] - Number of items to retrieve in each * page. Default is 10. * @returns {Paginator} * @summary: Get variants * @description: Retrieve variants of a specific product. */ getVariantsOfProductsPaginator({ itemId, variantType, pageSize }?: { itemId: number; variantType: string; pageSize?: number; }): Paginator; /** * @param {CatalogPlatformValidator.ListCategoriesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name listCategories * @summary: List categories * @description: Retrieve a list of categories data associated to a specific company and queries passed in the request. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listCategories/). */ listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise; /** * @param {Object} arg - Arg object. * @param {number[]} [arg.level] - Get category for multiple levels * @param {number} [arg.department] - Get category for multiple departments filtered * @param {string} [arg.q] - Get multiple categories filtered by search string * @param {number} [arg.pageSize] - Number of items to retrieve in each * page. Default is 10. * @param {number[]} [arg.uids] - Get multiple categories filtered by category uids. * @param {string} [arg.slug] - Get category by slug * @returns {Paginator} * @summary: List categories * @description: Retrieve a list of categories data associated to a specific company and queries passed in the request. */ listCategoriesPaginator({ level, department, q, pageSize, uids, slug }?: { level?: number[]; department?: number; q?: string; pageSize?: number; uids?: number[]; slug?: string; }): Paginator; /** * @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name listDepartmentsData * @summary: List company department * @description: Allows you to list all departments data for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listDepartmentsData/). */ listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise; /** * @param {Object} arg - Arg object. * @param {string} [arg.itemType] - A `item_type` is a type of product eg. * set, standard, digital * @param {number} [arg.pageSize] - Number of items to retrieve in each * page. Default is 10. * @param {string} [arg.name] - Can search departments by passing name. * @param {string} [arg.search] - Can search departments by passing name of * the department in search parameter. * @param {boolean} [arg.isActive] - Can query for departments based on * whether they are active or inactive. * @param {string} [arg.slug] - Can filter by slug * @returns {Paginator} * @summary: List company department * @description: Allows you to list all departments data for a specific company. */ listDepartmentsDataPaginator({ itemType, pageSize, name, search, isActive, slug, }?: { itemType?: string; pageSize?: number; name?: string; search?: string; isActive?: boolean; slug?: string; }): Paginator; /** * @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name listHSNCodes * @summary: List HSN codes * @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listHSNCodes/). */ listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.ListInventoryExportParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name listInventoryExport * @summary: List inventory export jobs * @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listInventoryExport/). */ listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.ListProductTemplateParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name listProductTemplate * @summary: List product templates * @description: Allows you to list all product templates for a specific company. also can filter by department. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listProductTemplate/). */ listProductTemplate({ department, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.ListProductTemplateCategoriesParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name listProductTemplateCategories * @summary: List product template categories * @description: Allows you to list all product template categories values for the departments specified for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listProductTemplateCategories/). */ listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.ListProductTemplateExportDetailsParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name listProductTemplateExportDetails * @summary: List export product templates * @description: Retrieve export details related to product templates for a specific company. Can view details including trigger data, task id , etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listProductTemplateExportDetails/). */ listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.ListTemplateBrandTypeValuesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name listTemplateBrandTypeValues * @summary: List template brand * @description: Retrieve values related to template brand types for a specific company. The filter type query parameter defines what type of data to return. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listTemplateBrandTypeValues/). */ listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.PartialUpdateProductParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name partialUpdateProduct * @summary: Patch a product * @description: Partially update an existing product in the catalog using PATCH method. This operation allows you to modify specific fields of a product without affecting other attributes. Only the fields provided in the request body will be updated, while all other existing product data remains unchanged. * For objects (e.g. attributes), merge keys shallowly: any key in the patch overrides the existing value. * For arrays of primitives (e.g. tags): replaced wholesale when present. * For arrays of objects (e.g. sizes): match on a unique identifier (seller_identifier) and apply the merge-patch per element; unmentioned elements remain unchanged. * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/partialUpdateProduct/). */ partialUpdateProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.PartialUpdateProductParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.UpdateHsnCodeParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateHsnCode * @summary: Update HSN code * @description: Modify the HSN code associated with a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateHsnCode/). */ updateHsnCode({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateHsnCodeParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name updateInventories * @summary: Update inventories * @description: Allows to add Inventory for particular size and selling location. for associated companies - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateInventories/). */ updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.UpdateLocationPriceParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name updateLocationPrice * @summary: Update an Article Price * @description: enables you to update article price for a specific size and selling location (store). The price updates will be reflected instantly after the API call. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateLocationPrice/). */ updateLocationPrice({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationPriceParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.UpdateLocationQuantityParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name updateLocationQuantity * @summary: Update an Article Quantity * @description: enables you to update article quantity for a specific size and selling location (store). The quantity updates will be reflected instantly after the API call. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateLocationQuantity/). */ updateLocationQuantity({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationQuantityParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.UpdateMarketplaceOptinParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name updateMarketplaceOptin * @summary: Update marketplace optin * @description: Allows to update marketplace optin for a company by marketplace_slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateMarketplaceOptin/). */ updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.UpdateRealtimeInventoryParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name updateRealtimeInventory * @summary: Update an inventory * @description: enables you to add inventory for a specific size and selling location (store). The inventory updates will be reflected instantly after the API call. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateRealtimeInventory/). */ updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.UpdateSizeGuideParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateSizeGuide * @summary: Update size guide * @description: Allows to edit a specific size guide. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateSizeGuide/). */ updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.UpdateTaxRuleParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateTaxRule * @summary: Update Tax Rule * @description: Update the details of an existing tax rule for a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateTaxRule/). */ updateTaxRule({ ruleId, body, requestHeaders }?: CatalogPlatformValidator.UpdateTaxRuleParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.UpdateTaxVersionParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateTaxVersion * @summary: Update a tax version * @description: When updating a tax version, the rules differ depending on whether it is a live version (that is, its applicable_date is now or in the past) or a scheduled version (with an applicable_date in the future). * For live versions, only the component names may be modified and only when the corresponding _id also matches, while changes to fields such as applicable_date, scope, store_ids, areas, region_type, and any other properties are not allowed. * In contrast, for scheduled (future) versions, you may change the applicable_date using an ISO datetime representing the date and time the version takes effect (at the start of the local day); to avoid changing it, simply pass the current applicable_date value. * Components can be added, updated, or removed: new components may omit _id, and omitting a known _id from the request will remove that component. The scope (COUNTRY by default, or STORE or REGION) can be set; for STORE scope, store_ids are required—if not specified, the existing store_ids are used. * For REGION scope, areas are required and region_type can be provided or will default to the current setting. In all cases, component names are validated, and only one version per rule may exist for each local day. * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateTaxVersion/). */ updateTaxVersion({ ruleId, versionId, body, requestHeaders }?: CatalogPlatformValidator.UpdateTaxVersionParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.ValidateProductGlobalTemplateParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name validateProductGlobalTemplate * @summary: Validate product template * @description: Allows you to list all product templates global validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/validateProductGlobalTemplate/). */ validateProductGlobalTemplate({ itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductGlobalTemplateParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.ValidateProductTemplateParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name validateProductTemplate * @summary: Validate product template * @description: Allows you to list all product templates validation values by its slug for all the fields present in the database for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/validateProductTemplate/). */ validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise; /** * @param {CatalogPlatformValidator.ValidateProductTemplateSchemaParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name validateProductTemplateSchema * @summary: Validate product template schema * @description: Allows you to list all product templates validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/validateProductTemplateSchema/). */ validateProductTemplateSchema({ itemType, schemaType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise; } import CatalogPlatformValidator = require("./CatalogPlatformValidator"); import CatalogPlatformModel = require("./CatalogPlatformModel"); import Paginator = require("../../common/Paginator");