/base-products | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
base_products_add_inventory | Create a new product catalog. |
base_products_add_inventory_category | Add a category to the product catalog. |
base_products_add_inventory_manufacturer | Add or update a manufacturer. |
base_products_add_inventory_price_group | Add a new price group. |
base_products_add_inventory_product | Add or update a product in the catalog. |
base_products_add_inventory_warehouse | Add a new warehouse. |
base_products_delete_inventory | Delete a product catalog. |
base_products_delete_inventory_category | Delete a category from the product catalog. |
base_products_delete_inventory_manufacturer | Delete a manufacturer. |
base_products_delete_inventory_price_group | Delete a price group. |
base_products_delete_inventory_product | Delete a product from the catalog. |
base_products_delete_inventory_warehouse | Delete a warehouse. |
base_products_get_external_storage_categories | Retrieve categories from an external storage. |
base_products_get_external_storage_products_data | Retrieve detailed product data from an external storage. |
base_products_get_external_storage_products_list | Retrieve product list from an external storage. |
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. |
base_products_get_inventory_extra_fields | Retrieve custom extra field definitions for inventory products. |
base_products_get_inventory_manufacturers | Retrieve the list of manufacturers. |
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. |
base_products_get_inventory_products_data | Retrieve detailed data for specific products. |
base_products_get_inventory_products_list | Retrieve a list of products from a catalog with basic data. |
base_products_get_inventory_products_prices | Retrieve prices for products in a catalog. |
base_products_get_inventory_products_stock | Retrieve stock levels for products in a catalog. |
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. |
base_products_update_inventory_products_stock | Update stock levels for products. Max 1000 products per call. |
base_products_add_inventory
Create a new product catalog. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_id | number | No | — | Catalog ID. Omit to create new, provide to update existing. |
name | string | Yes | — | Catalog name. |
description | string | No | — | Catalog description. |
languages | string[] | No | — | Array of supported language codes (e.g., [‘en’, ‘pl’]). |
default_language | string | No | — | Default language code. |
price_groups | string[] | No | — | Array of price group IDs. |
default_price_group | number | No | — | Default price group ID. |
warehouses | string[] | No | — | Array of warehouse IDs. |
default_warehouse | string | No | — | Default warehouse ID. |
reservations | boolean | No | — | Enable stock reservations. |
base_products_add_inventory_category
Add a category to the product catalog. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_id | number | No | — | Catalog identifier. |
category_id | number | No | — | Category ID. Omit for new, provide to update. |
name | string | Yes | — | Category name. |
parent_id | number | No | — | Parent category ID (0 for root). |
base_products_add_inventory_manufacturer
Add or update a manufacturer. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
manufacturer_id | number | No | — | Manufacturer ID. Omit for new, provide to update. |
manufacturer_name | string | Yes | — | Manufacturer name. |
manufacturer_url | string | No | — | Website URL. |
manufacturer_email | string | No | — | Email address. |
manufacturer_phone | string | No | — | Phone number. |
manufacturer_city | string | No | — | City. |
manufacturer_country_code | string | No | — | Country code. |
base_products_add_inventory_price_group
Add a new price group. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
price_group_id | number | No | — | Price group ID. Omit for new, provide to update. |
name | string | Yes | — | Price group name. |
description | string | No | — | Description. |
currency | string | No | — | ISO currency code. |
base_products_add_inventory_product
Add or update a product in the catalog. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_id | string | Yes | — | Catalog identifier. |
product_id | string | Yes | — | Product ID. Use ‘0’ or ‘new’ to create new. |
is_bundle | boolean | No | — | Whether this is a bundle product. |
sku | string | No | — | Stock keeping unit. |
ean | string | No | — | European article number. |
tax_rate | number | No | — | Tax rate percentage. |
weight | number | No | — | Weight in kg. |
height | number | No | — | Height in cm. |
width | number | No | — | Width in cm. |
length | number | No | — | Length in cm. |
category_id | number | No | — | Category ID. |
manufacturer_id | number | No | — | Manufacturer ID. |
prices | object | No | — | Prices by price group ID, e.g. {“1”: 29.99, “2”: 25.99}. |
stock | object | No | — | Stock levels by warehouse ID, e.g. {“1”: 100, “2”: 50}. |
locations | object | No | — | Warehouse locations by warehouse ID. |
text_fields | object | No | — | Text fields: name, description, features, etc. Keyed by language code. |
images | object | No | — | Image URLs by position number, e.g. {“1”: “https://…”, “2”: “https://…”}. |
tags | string[] | No | — | Array of tag strings. |
base_products_add_inventory_warehouse
Add a new warehouse. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
warehouse_id | number | No | — | Warehouse ID. Omit for new, provide to update. |
name | string | Yes | — | Warehouse name. |
description | string | No | — | Warehouse description. |
stock_edition | boolean | No | — | Allow stock editing. |
base_products_delete_inventory
Delete a product catalog. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_id | number | Yes | — | Catalog identifier. |
base_products_delete_inventory_category
Delete a category from the product catalog. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category_id | number | Yes | — | Category identifier. |
base_products_delete_inventory_manufacturer
Delete a manufacturer. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
manufacturer_id | number | Yes | — | Manufacturer identifier. |
base_products_delete_inventory_price_group
Delete a price group. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
price_group_id | number | Yes | — | Price group identifier. |
base_products_delete_inventory_product
Delete a product from the catalog. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
product_id | number | Yes | — | Product identifier. |
base_products_delete_inventory_warehouse
Delete a warehouse. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
warehouse_id | number | Yes | — | Warehouse identifier. |
base_products_get_external_storage_categories
Retrieve categories from an external storage. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
storage_id | string | Yes | — | Storage identifier (e.g., ‘shop_2445’). |
base_products_get_external_storage_products_data
Retrieve detailed product data from an external storage. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
storage_id | string | Yes | — | Storage identifier. |
products | string[] | Yes | — | Array of product IDs to retrieve. |
base_products_get_external_storage_products_list
Retrieve product list from an external storage. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
storage_id | string | Yes | — | Storage identifier. |
filter_category_id | number | No | — | Filter by category ID. |
filter_sort | string | No | — | Sort field. |
page | number | No | — | Page 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_id | number | No | — | Catalog 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | number | No | — | Page 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
product_id | number | Yes | — | Product identifier. |
date_from | number | Yes | — | Unix timestamp. Retrieve logs from this date. |
date_to | number | No | — | Unix timestamp. Retrieve logs until this date. |
log_type | string[] | No | — | Array of log type IDs to filter. |
sort | number | No | — | Sort order: 0 = ascending, 1 = descending. |
page | number | No | — | Page number. |
base_products_get_inventory_products_data
Retrieve detailed data for specific products. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_id | string | Yes | — | Catalog identifier. |
products | string[] | Yes | — | Array of product IDs to retrieve. |
base_products_get_inventory_products_list
Retrieve a list of products from a catalog with basic data. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_id | number | Yes | — | Catalog identifier. |
filter_id | number | No | — | Filter by product ID. |
filter_category_id | number | No | — | Filter by category ID. |
filter_ean | string | No | — | Filter by EAN code. |
filter_sku | string | No | — | Filter by SKU. |
filter_name | string | No | — | Filter by product name (partial match). |
filter_price_from | number | No | — | Minimum price filter. |
filter_price_to | number | No | — | Maximum price filter. |
filter_stock_from | number | No | — | Minimum stock filter. |
filter_stock_to | number | No | — | Maximum stock filter. |
page | number | No | — | Page number (1000 products per page). |
filter_sort | string | No | — | Sort field (e.g., ‘name ASC’, ‘price DESC’). |
base_products_get_inventory_products_prices
Retrieve prices for products in a catalog. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_id | string | Yes | — | Catalog identifier. |
page | number | No | — | Page number (1000 products per page). |
base_products_get_inventory_products_stock
Retrieve stock levels for products in a catalog. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_id | string | Yes | — | Catalog identifier. |
page | number | No | — | Page 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_id | string | Yes | — | Catalog identifier. |
products | object | Yes | — | Price 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_id | string | Yes | — | Catalog identifier. |
products | object | Yes | — | Stock updates. Object with product IDs as keys, each mapping to warehouse stock levels, e.g. {“123”: {“1”: 50}}. |

