API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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

Creates or updates submitted product free fields. Existing keys not included in the request are unchanged.

POST/api/v2/public/products/freefields

ModelsExpand Collapse

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

formatdouble

edit_min_max_percentage: number

formatint32

price_compare_multiplier: number

formatdouble

product_name: string

Display name of the product.

product_number: string

Unique product number.

shelf_label_quantity: number

formatint32

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

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

expiration_min_range: optional number

formatint32

free_fields: optional array of object { sort_order, key, value }

sort_order: number

formatint32

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

formatdouble

old_price: optional number

formatdouble

price: 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_price: optional number

formatdouble

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_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

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_quantity, unit_barcode, unit_name }

unit_quantity: number

formatdouble

unit_barcode: optional string

unit_name: optional string

variant_code: optional string

variant_factor: optional number

formatdouble

variant_family: optional string

volume: optional string

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.

ProductListProductsResponse object { page_number, page_size, total_record_count, records }

Lightweight paginated result set.

page_number: number

Current page number (1-based).

formatint64

page_size: number

Maximum number of records returned per page.

formatint32

total_record_count: number

Total number of records matching the query across all pages.

formatint64

records: optional array of ProductItem { barcode, carrier_item_quantity, edit_min_max_percentage, 74 more }

Collection of records for the current page.

barcode: string

Primary barcode for the product.

carrier_item_quantity: number

formatdouble

edit_min_max_percentage: number

formatint32

price_compare_multiplier: number

formatdouble

product_name: string

Display name of the product.

product_number: string

Unique product number.

shelf_label_quantity: number

formatint32

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

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

expiration_min_range: optional number

formatint32

free_fields: optional array of object { sort_order, key, value }

sort_order: number

formatint32

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

formatdouble

old_price: optional number

formatdouble

price: 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_price: optional number

formatdouble

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_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

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_quantity, unit_barcode, unit_name }

unit_quantity: number

formatdouble

unit_barcode: optional string

unit_name: optional string

variant_code: optional string

variant_factor: optional number

formatdouble

variant_family: optional string

volume: optional string

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.

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.

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.

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.