Skip to main content
Server path: /base-products | Type: Application | PCID required: Yes

Tools

ToolDescription
base_products_add_inventoryCreate a new product catalog.
base_products_add_inventory_categoryAdd a category to the product catalog.
base_products_add_inventory_manufacturerAdd or update a manufacturer.
base_products_add_inventory_price_groupAdd a new price group.
base_products_add_inventory_productAdd or update a product in the catalog.
base_products_add_inventory_warehouseAdd a new warehouse.
base_products_delete_inventoryDelete a product catalog.
base_products_delete_inventory_categoryDelete a category from the product catalog.
base_products_delete_inventory_manufacturerDelete a manufacturer.
base_products_delete_inventory_price_groupDelete a price group.
base_products_delete_inventory_productDelete a product from the catalog.
base_products_delete_inventory_warehouseDelete a warehouse.
base_products_get_external_storage_categoriesRetrieve categories from an external storage.
base_products_get_external_storage_products_dataRetrieve detailed product data from an external storage.
base_products_get_external_storage_products_listRetrieve product list from an external storage.
base_products_get_external_storages_listRetrieve the list of connected external storages (e.g., shops, marketplaces).
base_products_get_inventoriesRetrieve the list of product catalogs.
base_products_get_inventory_categoriesRetrieve product categories from the catalog.
base_products_get_inventory_extra_fieldsRetrieve custom extra field definitions for inventory products.
base_products_get_inventory_manufacturersRetrieve the list of manufacturers.
base_products_get_inventory_price_groupsRetrieve the list of price groups.
base_products_get_inventory_product_logsRetrieve event logs for a specific product.
base_products_get_inventory_products_dataRetrieve detailed data for specific products.
base_products_get_inventory_products_listRetrieve a list of products from a catalog with basic data.
base_products_get_inventory_products_pricesRetrieve prices for products in a catalog.
base_products_get_inventory_products_stockRetrieve stock levels for products in a catalog.
base_products_get_inventory_warehousesRetrieve the list of warehouses.
base_products_update_inventory_products_pricesUpdate prices for products. Max 1000 products per call.
base_products_update_inventory_products_stockUpdate stock levels for products. Max 1000 products per call.

base_products_add_inventory

Create a new product catalog. Parameters:
ParameterTypeRequiredDefaultDescription
inventory_idnumberNoCatalog ID. Omit to create new, provide to update existing.
namestringYesCatalog name.
descriptionstringNoCatalog description.
languagesstring[]NoArray of supported language codes (e.g., [‘en’, ‘pl’]).
default_languagestringNoDefault language code.
price_groupsstring[]NoArray of price group IDs.
default_price_groupnumberNoDefault price group ID.
warehousesstring[]NoArray of warehouse IDs.
default_warehousestringNoDefault warehouse ID.
reservationsbooleanNoEnable stock reservations.

base_products_add_inventory_category

Add a category to the product catalog. Parameters:
ParameterTypeRequiredDefaultDescription
inventory_idnumberNoCatalog identifier.
category_idnumberNoCategory ID. Omit for new, provide to update.
namestringYesCategory name.
parent_idnumberNoParent category ID (0 for root).

base_products_add_inventory_manufacturer

Add or update a manufacturer. Parameters:
ParameterTypeRequiredDefaultDescription
manufacturer_idnumberNoManufacturer ID. Omit for new, provide to update.
manufacturer_namestringYesManufacturer name.
manufacturer_urlstringNoWebsite URL.
manufacturer_emailstringNoEmail address.
manufacturer_phonestringNoPhone number.
manufacturer_citystringNoCity.
manufacturer_country_codestringNoCountry code.

base_products_add_inventory_price_group

Add a new price group. Parameters:
ParameterTypeRequiredDefaultDescription
price_group_idnumberNoPrice group ID. Omit for new, provide to update.
namestringYesPrice group name.
descriptionstringNoDescription.
currencystringNoISO currency code.

base_products_add_inventory_product

Add or update a product in the catalog. Parameters:
ParameterTypeRequiredDefaultDescription
inventory_idstringYesCatalog identifier.
product_idstringYesProduct ID. Use ‘0’ or ‘new’ to create new.
is_bundlebooleanNoWhether this is a bundle product.
skustringNoStock keeping unit.
eanstringNoEuropean article number.
tax_ratenumberNoTax rate percentage.
weightnumberNoWeight in kg.
heightnumberNoHeight in cm.
widthnumberNoWidth in cm.
lengthnumberNoLength in cm.
category_idnumberNoCategory ID.
manufacturer_idnumberNoManufacturer ID.
pricesobjectNoPrices by price group ID, e.g. {“1”: 29.99, “2”: 25.99}.
stockobjectNoStock levels by warehouse ID, e.g. {“1”: 100, “2”: 50}.
locationsobjectNoWarehouse locations by warehouse ID.
text_fieldsobjectNoText fields: name, description, features, etc. Keyed by language code.
imagesobjectNoImage URLs by position number, e.g. {“1”: “https://…”, “2”: “https://…”}.
tagsstring[]NoArray of tag strings.

base_products_add_inventory_warehouse

Add a new warehouse. Parameters:
ParameterTypeRequiredDefaultDescription
warehouse_idnumberNoWarehouse ID. Omit for new, provide to update.
namestringYesWarehouse name.
descriptionstringNoWarehouse description.
stock_editionbooleanNoAllow stock editing.

base_products_delete_inventory

Delete a product catalog. Parameters:
ParameterTypeRequiredDefaultDescription
inventory_idnumberYesCatalog identifier.

base_products_delete_inventory_category

Delete a category from the product catalog. Parameters:
ParameterTypeRequiredDefaultDescription
category_idnumberYesCategory identifier.

base_products_delete_inventory_manufacturer

Delete a manufacturer. Parameters:
ParameterTypeRequiredDefaultDescription
manufacturer_idnumberYesManufacturer identifier.

base_products_delete_inventory_price_group

Delete a price group. Parameters:
ParameterTypeRequiredDefaultDescription
price_group_idnumberYesPrice group identifier.

base_products_delete_inventory_product

Delete a product from the catalog. Parameters:
ParameterTypeRequiredDefaultDescription
product_idnumberYesProduct identifier.

base_products_delete_inventory_warehouse

Delete a warehouse. Parameters:
ParameterTypeRequiredDefaultDescription
warehouse_idnumberYesWarehouse identifier.

base_products_get_external_storage_categories

Retrieve categories from an external storage. Parameters:
ParameterTypeRequiredDefaultDescription
storage_idstringYesStorage identifier (e.g., ‘shop_2445’).

base_products_get_external_storage_products_data

Retrieve detailed product data from an external storage. Parameters:
ParameterTypeRequiredDefaultDescription
storage_idstringYesStorage identifier.
productsstring[]YesArray of product IDs to retrieve.

base_products_get_external_storage_products_list

Retrieve product list from an external storage. Parameters:
ParameterTypeRequiredDefaultDescription
storage_idstringYesStorage identifier.
filter_category_idnumberNoFilter by category ID.
filter_sortstringNoSort field.
pagenumberNoPage number.

base_products_get_external_storages_list

Retrieve the list of connected external storages (e.g., shops, marketplaces).

base_products_get_inventories

Retrieve the list of product catalogs.

base_products_get_inventory_categories

Retrieve product categories from the catalog. Parameters:
ParameterTypeRequiredDefaultDescription
inventory_idnumberNoCatalog identifier.

base_products_get_inventory_extra_fields

Retrieve custom extra field definitions for inventory products.

base_products_get_inventory_manufacturers

Retrieve the list of manufacturers. Parameters:
ParameterTypeRequiredDefaultDescription
pagenumberNoPage number (1000 per page).

base_products_get_inventory_price_groups

Retrieve the list of price groups.

base_products_get_inventory_product_logs

Retrieve event logs for a specific product. Parameters:
ParameterTypeRequiredDefaultDescription
product_idnumberYesProduct identifier.
date_fromnumberYesUnix timestamp. Retrieve logs from this date.
date_tonumberNoUnix timestamp. Retrieve logs until this date.
log_typestring[]NoArray of log type IDs to filter.
sortnumberNoSort order: 0 = ascending, 1 = descending.
pagenumberNoPage number.

base_products_get_inventory_products_data

Retrieve detailed data for specific products. Parameters:
ParameterTypeRequiredDefaultDescription
inventory_idstringYesCatalog identifier.
productsstring[]YesArray of product IDs to retrieve.

base_products_get_inventory_products_list

Retrieve a list of products from a catalog with basic data. Parameters:
ParameterTypeRequiredDefaultDescription
inventory_idnumberYesCatalog identifier.
filter_idnumberNoFilter by product ID.
filter_category_idnumberNoFilter by category ID.
filter_eanstringNoFilter by EAN code.
filter_skustringNoFilter by SKU.
filter_namestringNoFilter by product name (partial match).
filter_price_fromnumberNoMinimum price filter.
filter_price_tonumberNoMaximum price filter.
filter_stock_fromnumberNoMinimum stock filter.
filter_stock_tonumberNoMaximum stock filter.
pagenumberNoPage number (1000 products per page).
filter_sortstringNoSort field (e.g., ‘name ASC’, ‘price DESC’).

base_products_get_inventory_products_prices

Retrieve prices for products in a catalog. Parameters:
ParameterTypeRequiredDefaultDescription
inventory_idstringYesCatalog identifier.
pagenumberNoPage number (1000 products per page).

base_products_get_inventory_products_stock

Retrieve stock levels for products in a catalog. Parameters:
ParameterTypeRequiredDefaultDescription
inventory_idstringYesCatalog identifier.
pagenumberNoPage number (1000 products per page).

base_products_get_inventory_warehouses

Retrieve the list of warehouses.

base_products_update_inventory_products_prices

Update prices for products. Max 1000 products per call. Parameters:
ParameterTypeRequiredDefaultDescription
inventory_idstringYesCatalog identifier.
productsobjectYesPrice updates. Object with product IDs as keys, each mapping to price group values, e.g. {“123”: {“1”: 29.99}}.

base_products_update_inventory_products_stock

Update stock levels for products. Max 1000 products per call. Parameters:
ParameterTypeRequiredDefaultDescription
inventory_idstringYesCatalog identifier.
productsobjectYesStock updates. Object with product IDs as keys, each mapping to warehouse stock levels, e.g. {“123”: {“1”: 50}}.