# Products ## Creates or updates products in bulk. **post** `/api/v2/public/products` Creates or updates products in bulk. ### Query Parameters - `flush: optional boolean` When true, removes existing products before inserting. ### Body Parameters - `products: optional array of object { carrier_item_quantity, is_counted, price_compare_multiplier, 79 more }` The products to create or update. - `carrier_item_quantity: number` Quantity per carrier item. - `is_counted: boolean` Whether the product is counted. - `price_compare_multiplier: number` Multiplier used for unit price comparison. - `product_name: string` Display name of the product. - `product_number: string` Unique product number. - `allow_decimal: optional boolean` Whether decimal quantities are allowed. - `attention_code: optional array of string` Attention codes applied to the product. - `average_weight: optional number` Average weight of the product. - `barcode: optional string` Primary barcode for the product. - `barcodes_array: optional array of object { barcode }` Additional barcodes for the product. - `barcode: optional string` Barcode value. - `base_unit_name: optional string` Name of the base unit (e.g. piece, kg). - `brand_code: optional string` Brand code. - `brand_description: optional string` Brand description. - `category_code: optional string` Category code the product belongs to. - `color: optional string` Color name. - `color_code: optional string` Color code. - `countries_allowed: optional array of string` Countries where the product is allowed. - `countries_not_allowed: optional array of string` Countries where the product is excluded. - `country_code: optional string` ISO country code; defaults to "NL". - `default_location_tag: optional string` Default location tag for the product. - `deprecation_date: optional string` Date the product is deprecated. - `expiration_min_range: optional number` Minimum days remaining before expiration triggers an alert. - `free_fields: optional array of object { sort_order, key, value }` Custom free-field key/value pairs. - `sort_order: number` Sort order for display purposes. - `key: optional string` Free-field key. - `value: optional string` Free-field value. - `general_ledger_account_number: optional number` General ledger account number. - `image_url: optional string` URL of the product image. - `ioq: optional number` Initial order quantity. - `is_active: optional boolean` Whether the product is active. - `is_adr: optional boolean` Whether the product is classified as ADR (hazardous goods). - `is_deleted: optional boolean` Whether the product is marked deleted. - `is_edit_min_max: optional boolean` Whether min/max can be edited at store level. - `is_edit_replenishment: optional boolean` Whether replenishment values can be edited at store level. - `is_expiration: optional boolean` Whether expiration tracking is enabled for the product. - `is_markdown_allowed: optional boolean` Whether markdown is allowed for the product. - `is_order_manually: optional boolean` Whether the product is ordered manually. - `is_ordering: optional boolean` Whether the product can be ordered. - `is_promotion: optional boolean` Whether the product is currently in promotion. - `is_reset_store_stock: optional boolean` When true, resets store stock for the product. - `is_set: optional boolean` Whether the product is a set/bundle. - `is_stock: optional boolean` Whether the product is stocked. - `is_store_product: optional boolean` Whether the product is store-specific. - `is_template: optional boolean` Whether the product is a template. - `is_theft: optional boolean` Whether the product is theft-sensitive. - `ledger_dimension_value: optional string` Ledger dimension value used for VC exports. - `margin_category: optional string` Margin category classification. - `moq: optional number` Minimum order quantity. - `price: optional number` Sale price. - `price_compare_unit: optional string` Unit used for price comparison (e.g. per kg). - `price_lines: optional string` Comma-separated price line identifiers. - `product_description: optional string` A description of the product. - `product_details: optional string` Free-form product details. - `product_reference_number: optional string` External product reference number. - `product_status: optional string` Product life-cycle status. - `product_type: optional string` Product type classification. - `product_url: optional string` URL of the product detail page. - `promo_stores_allowed: optional array of string` Stores where the product is allowed for promotion. - `promo_stores_not_allowed: optional array of string` Stores where the product is excluded from promotion. - `promotion_price: optional number` Promotional price. - `promotion_text: optional string` Promotion text shown on shelf labels. - `promotion_week: optional string` Week identifier the promotion applies to. - `purchase_price: optional number` Purchase price from the supplier. - `purchase_unit_barcode: optional string` Barcode of the purchase unit. - `purchase_unit_name: optional string` Name of the purchase unit. - `purchase_unit_product_number: optional string` Product number of the purchase unit. - `purchase_unit_quantity: optional number` Quantity in a purchase unit. - `purchbook_free_txt: optional string` Free text used for purchase book/order exports. - `referral_product_number: optional string` Referral product number used as a substitute. - `set_products: optional array of object { set_item_quantity, set_product_number }` Products bundled within this set. - `set_item_quantity: optional string` Quantity of the bundled item. - `set_product_number: optional string` Product number of the bundled item. - `shelf_labels: optional array of object { shelflabel_1, shelflabel_2, shelflabel_3, 3 more }` Shelf-label text fields for the product. - `shelflabel_1: optional string` Shelf label slot 1. - `shelflabel_2: optional string` Shelf label slot 2. - `shelflabel_3: optional string` Shelf label slot 3. - `shelflabel_4: optional string` Shelf label slot 4. - `shelflabel_5: optional string` Shelf label slot 5. - `shelflabel_6: optional string` Shelf label slot 6. - `size: optional string` Size descriptor. - `size_code: optional string` Size code. - `smallest_product_number: optional string` Product number of the smallest sub-unit. - `smallest_quantity: optional number` Quantity of the smallest sub-unit. - `store_number: optional string` Store number when the product is store-specific. - `stores_allowed: optional array of string` Stores where the product is allowed. - `stores_not_allowed: optional array of string` Stores where the product is excluded. - `supplier_name: optional string` Supplier name. - `supplier_number: optional string` Supplier number. - `supplier_product_number: optional string` Supplier's product number. - `units: optional array of object { unit_barcode, unit_name, unit_quantity }` Units of measure (e.g. box, pallet) the product is sold in. - `unit_barcode: string` Barcode of the unit. - `unit_name: string` Name of the unit. - `unit_quantity: number` Quantity per unit. - `variant_code: optional string` Variant code. - `variant_family: optional string` Variant family. - `volume: optional string` Volume / size descriptor. ### Returns - `success: boolean` Indicates whether the operation completed successfully. - `data: optional string` Optional data payload returned by the operation. - `message: optional string` Human-readable message describing the result. ### Example ```http curl https://api.colleqtive.net/api/v2/public/products \ -X POST \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` #### Response ```json { "success": true, "data": "data", "message": "message" } ``` ## Retrieves a paginated list of products. **get** `/api/v2/public/products` Retrieves a paginated list of products. ### Query Parameters - `page_size: optional string` - `page_start: optional string` - `product_number: optional array of string` ### Returns - `page_number: number` Current page number (1-based). - `page_size: number` Maximum number of records returned per page. - `total_record_count: number` Total number of records matching the query across all pages. - `records: optional array of ProductItem` Collection of records for the current page. - `barcode: string` Primary barcode for the product. - `carrier_item_quantity: number` - `edit_min_max_percentage: number` - `price_compare_multiplier: number` - `product_name: string` Display name of the product. - `product_number: string` Unique product number. - `shelf_label_quantity: number` - `allow_decimal: optional boolean` - `attention_code: optional string` - `average_weight: optional number` - `barcodes_array: optional string` - `base_unit_name: optional string` - `brand_code: optional string` - `brand_description: optional string` - `category_code: optional string` - `color: optional string` - `color_code: optional string` - `countries_allowed: optional array of string` - `countries_not_allowed: optional array of string` - `country_code: optional string` - `deprecation_date: optional string` - `expiration_min_range: optional number` - `free_fields: optional array of object { sort_order, key, value }` - `sort_order: number` - `key: optional string` - `value: optional string` - `general_ledger: optional string` - `image_url: optional string` - `is_active: optional boolean` - `is_counted: optional boolean` - `is_edit_min_max: optional boolean` - `is_edit_replenishment: optional boolean` - `is_expiration: optional boolean` - `is_order_manually: optional boolean` - `is_promotion: optional boolean` - `is_set: optional boolean` - `is_stock: optional boolean` - `is_store_product: optional boolean` - `is_template: optional boolean` - `margin_category: optional string` - `moq: optional number` - `old_price: optional number` - `price: optional number` - `price_compare_unit: optional string` - `price_lines: optional string` - `product_details: optional string` - `product_type: optional string` - `product_url: optional string` - `promo_stores_allowed: optional array of string` - `promo_stores_not_allowed: optional array of string` - `promotion: optional string` - `promotion_price: optional number` - `promotion_week: optional string` - `purchase_price: optional number` - `purchase_unit_barcode: optional string` - `purchase_unit_name: optional string` - `purchase_unit_product_number: optional string` - `purchase_unit_quantity: optional number` - `referral_product_id: optional string` - `reset_store_stock: optional boolean` - `set_product: optional array of object { set_item_quantity, set_product_number }` - `set_item_quantity: optional string` - `set_product_number: optional string` - `shelf_label: optional boolean` - `shelf_label_barcode: optional boolean` - `shelf_label_layout: optional number` - `shelf_label_price: optional boolean` - `size: optional string` - `size_code: optional string` - `smallest_product_number: optional string` - `smallest_quantity: optional number` - `special_price: optional number` - `stores_allowed: optional array of string` - `stores_not_allowed: optional array of string` - `supplier_id: optional string` - `supplier_name: optional string` - `supplier_product_number: optional string` - `units: optional array of object { unit_quantity, unit_barcode, unit_name }` - `unit_quantity: number` - `unit_barcode: optional string` - `unit_name: optional string` - `variant_code: optional string` - `variant_factor: optional number` - `variant_family: optional string` - `volume: optional string` ### Example ```http curl https://api.colleqtive.net/api/v2/public/products \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` #### Response ```json { "page_number": 0, "page_size": 0, "total_record_count": 0, "records": [ { "barcode": "barcode", "carrier_item_quantity": 0, "edit_min_max_percentage": 0, "price_compare_multiplier": 0, "product_name": "product_name", "product_number": "product_number", "shelf_label_quantity": 0, "allow_decimal": true, "attention_code": "attention_code", "average_weight": 0, "barcodes_array": "barcodes_array", "base_unit_name": "base_unit_name", "brand_code": "brand_code", "brand_description": "brand_description", "category_code": "category_code", "color": "color", "color_code": "color_code", "countries_allowed": [ "string" ], "countries_not_allowed": [ "string" ], "country_code": "country_code", "deprecation_date": "2019-12-27T18:11:19.117Z", "expiration_min_range": 0, "free_fields": [ { "sort_order": 0, "key": "key", "value": "value" } ], "general_ledger": "general_ledger", "image_url": "image_url", "is_active": true, "is_counted": true, "is_edit_min_max": true, "is_edit_replenishment": true, "is_expiration": true, "is_order_manually": true, "is_promotion": true, "is_set": true, "is_stock": true, "is_store_product": true, "is_template": true, "margin_category": "margin_category", "moq": 0, "old_price": 0, "price": 0, "price_compare_unit": "price_compare_unit", "price_lines": "price_lines", "product_details": "product_details", "product_type": "product_type", "product_url": "product_url", "promo_stores_allowed": [ "string" ], "promo_stores_not_allowed": [ "string" ], "promotion": "promotion", "promotion_price": 0, "promotion_week": "promotion_week", "purchase_price": 0, "purchase_unit_barcode": "purchase_unit_barcode", "purchase_unit_name": "purchase_unit_name", "purchase_unit_product_number": "purchase_unit_product_number", "purchase_unit_quantity": 0, "referral_product_id": "referral_product_id", "reset_store_stock": true, "set_product": [ { "set_item_quantity": "set_item_quantity", "set_product_number": "set_product_number" } ], "shelf_label": true, "shelf_label_barcode": true, "shelf_label_layout": 0, "shelf_label_price": true, "size": "size", "size_code": "size_code", "smallest_product_number": "smallest_product_number", "smallest_quantity": 0, "special_price": 0, "stores_allowed": [ "string" ], "stores_not_allowed": [ "string" ], "supplier_id": "supplier_id", "supplier_name": "supplier_name", "supplier_product_number": "supplier_product_number", "units": [ { "unit_quantity": 0, "unit_barcode": "unit_barcode", "unit_name": "unit_name" } ], "variant_code": "variant_code", "variant_factor": 0, "variant_family": "variant_family", "volume": "volume" } ] } ``` ## Deletes products by product numbers. **delete** `/api/v2/public/products` Deletes products by product numbers. ### Body Parameters - `product_number: optional array of string` The product numbers to target. ### Returns - `success: boolean` Indicates whether the operation completed successfully. - `data: optional string` Optional data payload returned by the operation. - `message: optional string` Human-readable message describing the result. ### Example ```http curl https://api.colleqtive.net/api/v2/public/products \ -X DELETE \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` #### Response ```json { "success": true, "data": "data", "message": "message" } ``` ## Updates a product attribute value across all products matching the old value. **put** `/api/v2/public/products/attributes` Updates a product attribute value across all products matching the old value. ### Body Parameters - `attribute: string` The attribute name to update. - `new_value: string` The new value to set. - `old_value: string` The current value to match. ### Example ```http curl https://api.colleqtive.net/api/v2/public/products/attributes \ -X PUT \ -H 'Content-Type: application/json' \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" \ -d '{ "attribute": "x", "new_value": "x", "old_value": "x" }' ``` ## Creates or updates product prices. **post** `/api/v2/public/products/prices` Creates or updates product prices. ### Body Parameters - `prices: optional array of object { price, price_id, price_type, 8 more }` The product prices to create or update. - `price: number` Price value. - `price_id: string` Unique price identifier. - `price_type: number` Numeric price type. - `product_number: string` The product number this price applies to. - `valid_from: string` Start of the price's validity period. - `valid_to: string` End of the price's validity period. - `country_code: optional string` Optional ISO country code restricting the price. - `price_group: optional string` Optional price group identifier. - `price_quantity: optional number` Quantity for which the price applies. - `price_unit: optional string` Unit of measure the price applies to. - `store_number: optional string` Optional store number restricting the price. ### Returns - `success: boolean` Indicates whether the operation completed successfully. - `data: optional string` Optional data payload returned by the operation. - `message: optional string` Human-readable message describing the result. ### Example ```http curl https://api.colleqtive.net/api/v2/public/products/prices \ -X POST \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` #### Response ```json { "success": true, "data": "data", "message": "message" } ``` ## Creates or updates discount prices for products. **post** `/api/v2/public/products/discountprices` Creates or updates discount prices for products. ### Header Parameters - `is_expire_discounts: optional boolean` - `is_flush: optional boolean` ### Body Parameters - `discounts: optional array of object { is_delete, discount_description, discount_group, 7 more }` The list of discount price entries. - `is_delete: boolean` When true, removes the existing discount entry. - `discount_description: optional string` Human-readable description of the discount. - `discount_group: optional string` Optional discount group identifier. - `discount_id: optional string` Unique discount identifier. - `discount_type: optional number` Numeric discount type. - `line_number: optional number` Line number on the discount. - `price: optional number` Discounted price value. - `product_number: optional string` The product number this discount applies to. - `valid_from: optional string` Start of the discount's validity period. - `valid_to: optional string` End of the discount's validity period. ### Returns - `success: boolean` Indicates whether the operation completed successfully. - `data: optional string` Optional data payload returned by the operation. - `message: optional string` Human-readable message describing the result. ### Example ```http curl https://api.colleqtive.net/api/v2/public/products/discountprices \ -X POST \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` #### Response ```json { "success": true, "data": "data", "message": "message" } ``` ## Creates or updates submitted product free fields. Existing keys not included in the request are unchanged. **post** `/api/v2/public/products/freefields` Creates or updates submitted product free fields. Existing keys not included in the request are unchanged. ### Body Parameters - `free_fields: optional array of object { country_code, free_fields, product_number, entity_type }` The product free fields to create or update. - `country_code: string` - `free_fields: array of object { key, sort_order, value }` - `key: optional string` - `sort_order: optional number` - `value: optional string` - `product_number: string` - `entity_type: optional string` ### Returns - `success: boolean` Indicates whether the operation completed successfully. - `data: optional string` Optional data payload returned by the operation. - `message: optional string` Human-readable message describing the result. ### Example ```http curl https://api.colleqtive.net/api/v2/public/products/freefields \ -X POST \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` #### Response ```json { "success": true, "data": "data", "message": "message" } ``` ## Domain Types ### Product Item - `ProductItem object { barcode, carrier_item_quantity, edit_min_max_percentage, 74 more }` Full product details returned from the products GET endpoint, including units, barcodes, pricing, and store/country assignments. - `barcode: string` Primary barcode for the product. - `carrier_item_quantity: number` - `edit_min_max_percentage: number` - `price_compare_multiplier: number` - `product_name: string` Display name of the product. - `product_number: string` Unique product number. - `shelf_label_quantity: number` - `allow_decimal: optional boolean` - `attention_code: optional string` - `average_weight: optional number` - `barcodes_array: optional string` - `base_unit_name: optional string` - `brand_code: optional string` - `brand_description: optional string` - `category_code: optional string` - `color: optional string` - `color_code: optional string` - `countries_allowed: optional array of string` - `countries_not_allowed: optional array of string` - `country_code: optional string` - `deprecation_date: optional string` - `expiration_min_range: optional number` - `free_fields: optional array of object { sort_order, key, value }` - `sort_order: number` - `key: optional string` - `value: optional string` - `general_ledger: optional string` - `image_url: optional string` - `is_active: optional boolean` - `is_counted: optional boolean` - `is_edit_min_max: optional boolean` - `is_edit_replenishment: optional boolean` - `is_expiration: optional boolean` - `is_order_manually: optional boolean` - `is_promotion: optional boolean` - `is_set: optional boolean` - `is_stock: optional boolean` - `is_store_product: optional boolean` - `is_template: optional boolean` - `margin_category: optional string` - `moq: optional number` - `old_price: optional number` - `price: optional number` - `price_compare_unit: optional string` - `price_lines: optional string` - `product_details: optional string` - `product_type: optional string` - `product_url: optional string` - `promo_stores_allowed: optional array of string` - `promo_stores_not_allowed: optional array of string` - `promotion: optional string` - `promotion_price: optional number` - `promotion_week: optional string` - `purchase_price: optional number` - `purchase_unit_barcode: optional string` - `purchase_unit_name: optional string` - `purchase_unit_product_number: optional string` - `purchase_unit_quantity: optional number` - `referral_product_id: optional string` - `reset_store_stock: optional boolean` - `set_product: optional array of object { set_item_quantity, set_product_number }` - `set_item_quantity: optional string` - `set_product_number: optional string` - `shelf_label: optional boolean` - `shelf_label_barcode: optional boolean` - `shelf_label_layout: optional number` - `shelf_label_price: optional boolean` - `size: optional string` - `size_code: optional string` - `smallest_product_number: optional string` - `smallest_quantity: optional number` - `special_price: optional number` - `stores_allowed: optional array of string` - `stores_not_allowed: optional array of string` - `supplier_id: optional string` - `supplier_name: optional string` - `supplier_product_number: optional string` - `units: optional array of object { unit_quantity, unit_barcode, unit_name }` - `unit_quantity: number` - `unit_barcode: optional string` - `unit_name: optional string` - `variant_code: optional string` - `variant_factor: optional number` - `variant_family: optional string` - `volume: optional string` ### Product Create Products Response - `ProductCreateProductsResponse object { success, data, message }` Standard success response returned by mutation endpoints. - `success: boolean` Indicates whether the operation completed successfully. - `data: optional string` Optional data payload returned by the operation. - `message: optional string` Human-readable message describing the result. ### Product List Products Response - `ProductListProductsResponse object { page_number, page_size, total_record_count, records }` Lightweight paginated result set. - `page_number: number` Current page number (1-based). - `page_size: number` Maximum number of records returned per page. - `total_record_count: number` Total number of records matching the query across all pages. - `records: optional array of ProductItem` Collection of records for the current page. - `barcode: string` Primary barcode for the product. - `carrier_item_quantity: number` - `edit_min_max_percentage: number` - `price_compare_multiplier: number` - `product_name: string` Display name of the product. - `product_number: string` Unique product number. - `shelf_label_quantity: number` - `allow_decimal: optional boolean` - `attention_code: optional string` - `average_weight: optional number` - `barcodes_array: optional string` - `base_unit_name: optional string` - `brand_code: optional string` - `brand_description: optional string` - `category_code: optional string` - `color: optional string` - `color_code: optional string` - `countries_allowed: optional array of string` - `countries_not_allowed: optional array of string` - `country_code: optional string` - `deprecation_date: optional string` - `expiration_min_range: optional number` - `free_fields: optional array of object { sort_order, key, value }` - `sort_order: number` - `key: optional string` - `value: optional string` - `general_ledger: optional string` - `image_url: optional string` - `is_active: optional boolean` - `is_counted: optional boolean` - `is_edit_min_max: optional boolean` - `is_edit_replenishment: optional boolean` - `is_expiration: optional boolean` - `is_order_manually: optional boolean` - `is_promotion: optional boolean` - `is_set: optional boolean` - `is_stock: optional boolean` - `is_store_product: optional boolean` - `is_template: optional boolean` - `margin_category: optional string` - `moq: optional number` - `old_price: optional number` - `price: optional number` - `price_compare_unit: optional string` - `price_lines: optional string` - `product_details: optional string` - `product_type: optional string` - `product_url: optional string` - `promo_stores_allowed: optional array of string` - `promo_stores_not_allowed: optional array of string` - `promotion: optional string` - `promotion_price: optional number` - `promotion_week: optional string` - `purchase_price: optional number` - `purchase_unit_barcode: optional string` - `purchase_unit_name: optional string` - `purchase_unit_product_number: optional string` - `purchase_unit_quantity: optional number` - `referral_product_id: optional string` - `reset_store_stock: optional boolean` - `set_product: optional array of object { set_item_quantity, set_product_number }` - `set_item_quantity: optional string` - `set_product_number: optional string` - `shelf_label: optional boolean` - `shelf_label_barcode: optional boolean` - `shelf_label_layout: optional number` - `shelf_label_price: optional boolean` - `size: optional string` - `size_code: optional string` - `smallest_product_number: optional string` - `smallest_quantity: optional number` - `special_price: optional number` - `stores_allowed: optional array of string` - `stores_not_allowed: optional array of string` - `supplier_id: optional string` - `supplier_name: optional string` - `supplier_product_number: optional string` - `units: optional array of object { unit_quantity, unit_barcode, unit_name }` - `unit_quantity: number` - `unit_barcode: optional string` - `unit_name: optional string` - `variant_code: optional string` - `variant_factor: optional number` - `variant_family: optional string` - `volume: optional string` ### Product Delete Products Response - `ProductDeleteProductsResponse object { success, data, message }` Standard success response returned by mutation endpoints. - `success: boolean` Indicates whether the operation completed successfully. - `data: optional string` Optional data payload returned by the operation. - `message: optional string` Human-readable message describing the result. ### Product Create Prices Response - `ProductCreatePricesResponse object { success, data, message }` Standard success response returned by mutation endpoints. - `success: boolean` Indicates whether the operation completed successfully. - `data: optional string` Optional data payload returned by the operation. - `message: optional string` Human-readable message describing the result. ### Product Create Discount Prices Response - `ProductCreateDiscountPricesResponse object { success, data, message }` Standard success response returned by mutation endpoints. - `success: boolean` Indicates whether the operation completed successfully. - `data: optional string` Optional data payload returned by the operation. - `message: optional string` Human-readable message describing the result. ### Product Create Product Free Fields Response - `ProductCreateProductFreeFieldsResponse object { success, data, message }` Standard success response returned by mutation endpoints. - `success: boolean` Indicates whether the operation completed successfully. - `data: optional string` Optional data payload returned by the operation. - `message: optional string` Human-readable message describing the result.