Products
Creates or updates products in bulk.
POST/api/v2/public/products
Retrieves a paginated list of products.
GET/api/v2/public/products
Deletes products by product numbers.
DELETE/api/v2/public/products
Updates a product attribute value across all products matching the old value.
PUT/api/v2/public/products/attributes
Creates or updates product prices.
POST/api/v2/public/products/prices
Creates or updates discount prices for products.
POST/api/v2/public/products/discountprices
ModelsExpand Collapse
ProductItem = object { barcode, product_name, product_number, 73 more } Full product details returned from the products GET endpoint, including units, barcodes, pricing, and store/country assignments.
ProductItem = object { barcode, product_name, product_number, 73 more }
Full product details returned from the products GET endpoint, including units, barcodes, pricing, and store/country assignments.
barcode: string
product_name: string
Display name of the product.
product_number: string
Unique product number.
allow_decimal: optional boolean
attention_code: optional string
average_weight: optional number
formatdouble
barcodes_array: optional string
base_unit_name: optional string
brand_code: optional string
brand_description: optional string
carrier_item_quantity: optional number
formatdouble
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
formatdate-time
edit_min_max_percentage: optional number
formatint32
expiration_min_range: optional number
formatint32
free_fields: optional array of object { key, sort_order, value }
free_fields: optional array of object { key, sort_order, value }
key: optional string
sort_order: optional number
formatint32
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
formatdouble
old_price: optional number
formatdouble
price: optional number
formatdouble
price_compare_multiplier: optional number
formatdouble
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_week: optional string
purchase_price: optional number
formatdouble
purchase_unit_barcode: optional string
purchase_unit_name: optional string
purchase_unit_product_number: optional string
purchase_unit_quantity: optional number
formatdouble
referral_product_id: optional string
reset_store_stock: optional boolean
set_product: optional array of object { set_item_quantity, set_product_number }
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
formatint32
shelf_label_price: optional boolean
shelf_label_quantity: optional number
formatint32
size: optional string
size_code: optional string
smallest_product_number: optional string
smallest_quantity: optional number
formatdouble
special_price: optional number
formatdouble
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_barcode, unit_name, unit_quantity }
units: optional array of object { unit_barcode, unit_name, unit_quantity }
unit_barcode: optional string
unit_name: optional string
unit_quantity: optional number
formatdouble
variant_code: optional string
variant_factor: optional number
formatdouble
variant_family: optional string
volume: optional string