Skip to main content

Product attributes for creating or updating products

description
string
required

Short product description displayed in lists

Maximum string length: 150
stock_unit_type_id
integer
required

ID of the stock unit type (defines measurement unit)

code
string | null

Unique product code/SKU

Maximum string length: 50
long_description
string | null

Extended product description

barcode
string | null

Primary product barcode (unit level)

case_barcode
string | null

Barcode for case-level packaging

inner_barcode
string | null

Barcode for inner pack level

outer_barcode
string | null

Barcode for outer case/pallet level

commodity_code
string | null

Harmonized System (HS) commodity code for customs

Maximum string length: 14
country_of_manufacture
string | null

ISO country code of manufacture origin

Maximum string length: 6
customs_description
string | null

Product description for customs declarations

Maximum string length: 255
shelf_life_min
integer | null

Minimum acceptable shelf life in days at receipt

Required range: x >= 1
shelf_life_max
integer | null

Maximum shelf life in days from manufacture

Required range: x >= 1
stop
boolean | null

If true, product is stopped from all operations

obsolete
integer | null

Obsolete status code

specific_gravity
number | null

Specific gravity for liquid products

output_quantity
number | null

Output quantity for bill of materials assembly

Required range: x > 0
assemble_on_pick
boolean | null

If true, assemble components during picking

require_dimensions_on_receipt
boolean | null

If true, require dimension capture at goods in

non_hazardous_for_transport
boolean | null

Override hazardous classification for transport

pick_strategy
enum<string> | null

How orders for this product should be picked

Available options:
pick_by_line,
batch_pick
product_type
enum<string> | null

Whether product is single item or assembly

Available options:
single,
bill_of_materials
serial_number_tracking_setting
enum<string> | null

Serial number tracking level

Available options:
no_tracking,
track_during_pick,
full_tracking
unit_quantity_conversion_strategy
enum<string> | null

How to convert between quantity and unit measurement

Available options:
none,
volume,
weight
default_order_configuration
enum<string> | null

Default packaging level for outbound orders

Available options:
unit,
case,
inner,
outer
default_receipt_configuration
enum<string> | null

Default packaging level for inbound receipts

Available options:
unit,
case,
inner,
outer
external_system_reference1
string | null

Reference ID from external system (e.g., ERP product ID)

external_system_reference2
string | null

Secondary external system reference

external_system_reference3
string | null

Tertiary external system reference

string1
string | null

Custom string field 1

string2
string | null

Custom string field 2

string3
string | null

Custom string field 3

string4
string | null

Custom string field 4

string5
string | null

Custom string field 5

integer1
integer | null

Custom integer field 1

integer2
integer | null

Custom integer field 2

integer3
integer | null

Custom integer field 3

integer4
integer | null

Custom integer field 4

integer5
integer | null

Custom integer field 5

datetime1
string<date-time> | null

Custom datetime field 1

datetime2
string<date-time> | null

Custom datetime field 2

datetime3
string<date-time> | null

Custom datetime field 3

datetime4
string<date-time> | null

Custom datetime field 4

datetime5
string<date-time> | null

Custom datetime field 5

boolean1
boolean | null

Custom boolean field 1

boolean2
boolean | null

Custom boolean field 2

boolean3
boolean | null

Custom boolean field 3

boolean4
boolean | null

Custom boolean field 4

boolean5
boolean | null

Custom boolean field 5