Creates or updates products in bulk.

products.create_products() -> ProductCreateProductsResponse

POST/api/v2/public/products

ParametersExpand Collapse

flush: Optional[bool]

When true, removes existing products before inserting.

products: Optional[Iterable[Product]]

The products to create or update.

carrier_item_quantity: float

Quantity per carrier item.

formatdouble

is_counted: bool

Whether the product is counted.

price_compare_multiplier: float

Multiplier used for unit price comparison.

formatdouble

product_name: str

Display name of the product.

minLength1

product_number: str

Unique product number.

minLength1

allow_decimal: Optional[bool]

Whether decimal quantities are allowed.

attention_code: Optional[Sequence[str]]

Attention codes applied to the product.

average_weight: Optional[float]

Average weight of the product.

formatdouble

barcode: Optional[str]

Primary barcode for the product.

barcodes_array: Optional[Iterable[ProductBarcodesArray]]

Additional barcodes for the product.

barcode: Optional[str]

Barcode value.

base_unit_name: Optional[str]

Name of the base unit (e.g. piece, kg).

brand_code: Optional[str]

Brand code.

brand_description: Optional[str]

Brand description.

category_code: Optional[str]

Category code the product belongs to.

color: Optional[str]

Color name.

color_code: Optional[str]

Color code.

countries_allowed: Optional[Sequence[str]]

Countries where the product is allowed.

countries_not_allowed: Optional[Sequence[str]]

Countries where the product is excluded.

country_code: Optional[str]

ISO country code; defaults to “NL”.

default_location_tag: Optional[str]

Default location tag for the product.

deprecation_date: Optional[Union[str, datetime, null]]

Date the product is deprecated.

formatdate-time

expiration_min_range: Optional[int]

Minimum days remaining before expiration triggers an alert.

formatint32

free_fields: Optional[Iterable[ProductFreeField]]

Custom free-field key/value pairs.

sort_order: int

Sort order for display purposes.

formatint32

key: Optional[str]

Free-field key.

value: Optional[str]

Free-field value.

general_ledger_account_number: Optional[int]

General ledger account number.

formatint32

image_url: Optional[str]

URL of the product image.

ioq: Optional[int]

Initial order quantity.

formatint32

is_active: Optional[bool]

Whether the product is active.

is_adr: Optional[bool]

Whether the product is classified as ADR (hazardous goods).

is_deleted: Optional[bool]

Whether the product is marked deleted.

is_edit_min_max: Optional[bool]

Whether min/max can be edited at store level.

is_edit_replenishment: Optional[bool]

Whether replenishment values can be edited at store level.

is_expiration: Optional[bool]

Whether expiration tracking is enabled for the product.

is_markdown_allowed: Optional[bool]

Whether markdown is allowed for the product.

is_order_manually: Optional[bool]

Whether the product is ordered manually.

is_ordering: Optional[bool]

Whether the product can be ordered.

is_promotion: Optional[bool]

Whether the product is currently in promotion.

is_reset_store_stock: Optional[bool]

When true, resets store stock for the product.

is_set: Optional[bool]

Whether the product is a set/bundle.

is_stock: Optional[bool]

Whether the product is stocked.

is_store_product: Optional[bool]

Whether the product is store-specific.

is_template: Optional[bool]

Whether the product is a template.

is_theft: Optional[bool]

Whether the product is theft-sensitive.

ledger_dimension_value: Optional[str]

Ledger dimension value used for VC exports.

margin_category: Optional[str]

Margin category classification.

moq: Optional[float]

Minimum order quantity.

formatdouble

price: Optional[float]

Sale price.

formatdouble

price_compare_unit: Optional[str]

Unit used for price comparison (e.g. per kg).

price_lines: Optional[str]

Comma-separated price line identifiers.

product_description: Optional[str]

A description of the product.

product_details: Optional[str]

Free-form product details.

product_reference_number: Optional[str]

External product reference number.

product_status: Optional[str]

Product life-cycle status.

product_type: Optional[str]

Product type classification.

product_url: Optional[str]

URL of the product detail page.

promo_stores_allowed: Optional[Sequence[str]]

Stores where the product is allowed for promotion.

promo_stores_not_allowed: Optional[Sequence[str]]

Stores where the product is excluded from promotion.

promotion_price: Optional[float]

Promotional price.

formatdouble

promotion_text: Optional[str]

Promotion text shown on shelf labels.

promotion_week: Optional[str]

Week identifier the promotion applies to.

purchase_price: Optional[float]

Purchase price from the supplier.

formatdouble

purchase_unit_barcode: Optional[str]

Barcode of the purchase unit.

purchase_unit_name: Optional[str]

Name of the purchase unit.

purchase_unit_product_number: Optional[str]

Product number of the purchase unit.

purchase_unit_quantity: Optional[float]

Quantity in a purchase unit.

formatdouble

purchbook_free_txt: Optional[str]

Free text used for purchase book/order exports.

referral_product_number: Optional[str]

Referral product number used as a substitute.

set_products: Optional[Iterable[ProductSetProduct]]

Products bundled within this set.

set_item_quantity: Optional[str]

Quantity of the bundled item.

set_product_number: Optional[str]

Product number of the bundled item.

shelf_labels: Optional[Iterable[ProductShelfLabel]]

Shelf-label text fields for the product.

shelflabel_1: Optional[str]

Shelf label slot 1.

shelflabel_2: Optional[str]

Shelf label slot 2.

shelflabel_3: Optional[str]

Shelf label slot 3.

shelflabel_4: Optional[str]

Shelf label slot 4.

shelflabel_5: Optional[str]

Shelf label slot 5.

shelflabel_6: Optional[str]

Shelf label slot 6.

size: Optional[str]

Size descriptor.

size_code: Optional[str]

Size code.

smallest_product_number: Optional[str]

Product number of the smallest sub-unit.

smallest_quantity: Optional[float]

Quantity of the smallest sub-unit.

formatdouble

store_number: Optional[str]

Store number when the product is store-specific.

stores_allowed: Optional[Sequence[str]]

Stores where the product is allowed.

stores_not_allowed: Optional[Sequence[str]]

Stores where the product is excluded.

supplier_name: Optional[str]

Supplier name.

supplier_number: Optional[str]

Supplier number.

supplier_product_number: Optional[str]

Supplier’s product number.

units: Optional[Iterable[ProductUnit]]

Units of measure (e.g. box, pallet) the product is sold in.

unit_barcode: str

Barcode of the unit.

minLength1

unit_name: str

Name of the unit.

minLength1

unit_quantity: float

Quantity per unit.

formatdouble

variant_code: Optional[str]

Variant code.

variant_family: Optional[str]

Variant family.

volume: Optional[str]

Volume / size descriptor.

ReturnsExpand Collapse

class ProductCreateProductsResponse: …

Standard success response returned by mutation endpoints.

success: bool

Indicates whether the operation completed successfully.

data: Optional[str]

Optional data payload returned by the operation.

message: Optional[str]

Human-readable message describing the result.

Creates or updates products in bulk.

import os
from colleqtive_sdk import Colleqtive

client = Colleqtive(
    bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"),  # This is the default and can be omitted
)
response = client.products.create_products()
print(response.success)

{
  "success": true,
  "data": "data",
  "message": "message"
}

Returns Examples

{
  "success": true,
  "data": "data",
  "message": "message"
}