removeExistingVariantsboolean nullable
If true, existing variants will be deleted and only variants in the variant patch will be added. 'False' by default.
siblingsstring[] nullable
List of sibling product IDs
categoryIdsToRemovestring[] nullable
List of CategoryIds to remove from the product. This removes the categories from both CategoryIds and ProductCategories
mainCategoryIdstring nullable
mainCategoryNamestring nullable
supplierLeadTimeinteger nullable
Supplier lead time in days
isLocalProductboolean nullable
Only relevant when IsLocalProductsEnabled is enabled in productSettings. When enabled, both 'IsLocalProduct' must be activated and the user must have access to a selected store in order to edit the product
publishedstring date-time nullable
Date product is published
stopPublishedstring date-time nullable
Product activation end date. Can be null
discontinuedstring date-time nullable
Product discontinuation date. If discontinued date has passed, it should not be reordered from supplier
isActiveboolean nullable
True if product is active. False if it should be hidden from customers.
mainImageUrlstring nullable
keepExistingAssetsboolean nullable
Set to 'false' if you want to update the whole 'Assets' list. If true, new assets will be added to the existing list of assets. 'True' by default.
expectedDeliveryDatestring date-time nullable
isSkuboolean nullable
True if product is stock keeping unit / product or variant that can be sold
isBundleboolean nullable
True if product is a bundle of other products (unlike package, price is sum of components)
isPackageboolean nullable
True if product is package of other products (unlike bundle, price is specified for package)
preventPackageSplitboolean nullable
Controls whether this package/bundle's components may be allocated to different warehouses.
True: components always ship together. False: components may be split, though components linked
via ShipTogetherWithComponentId still stay together. Null: the allocation flow's default applies.
isKitboolean nullable
True if product is a kit (product composed of other products, assembled at fulfillment)
isWriteProtectedboolean nullable
True if product is write protected by user. PIM integrations should not override product information.
isInStockboolean nullable
True if product is in stock
catalogNodesstring[] nullable
Catalog nodes (if multiple)
minQuantitynumber nullable
Minimum inventory quantity (point of reordering)
maxQuantitynumber nullable
Max inventory quantity (what should be in stock after new supply)
weightnumber double nullable
taxCategorystring nullable
taxGroupCodestring nullable
References a TaxGroup.Code in the tenant's chart of tax groups.
When null, the tenant's DefaultTaxGroupCode applies (if feature is enabled).
Has no effect when AccountingSettings.TaxGroupsEnabled = false.
taxRatenumber nullable
Per-product VAT rate used as a fallback when tax groups are not configured.
Applied to any price that has no TaxRate of its own at save time.
Tax-group resolution takes precedence when enabled.
associatedProductsstring[] nullable
pricesMergeMode'UpdateOnly' | 'AddOrUpdate' | 'Replace'
Controls how a list on an Omnium.Public.Orders.Models.Patch.OmniumOrderPatch (e.g. Payments, Shipments) is merged into the target.
keepExistingCustomPropertiesboolean nullable
Set to 'false' if you want to update the whole 'properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.
dontOverwriteExistingPropertyValuesboolean nullable
Set to 'true' if you want to skip updating properties that already exists and has a value. If you want to add values to a list/multiselect property, make sure this option is set to 'true' along with valueType: 'List' or 'DropDown'. Otherwise the list property will be overwritten.
marketIdsstring[] nullable
List of available market IDs
storeIdsstring[] nullable
List of available store IDs
marketGroupIdsstring[] nullable
List of available market group IDs
locationstring nullable
The location of the product in the warehouse.
shortDescriptionstring nullable
Short product description
descriptionstring nullable
specificationstring nullable
supplierNamestring nullable
Name of main product supplier
supplierIdstring nullable
supplierSkuIdstring nullable
External product ID from supplier, used when creating purchase orders
supplierColorstring nullable
supplierPackagingUnitstring nullable
Supplier packaging quantity
supplierPackagingQuantitynumber nullable
Supplier packaging quantity
allowSupplierPackageBreakboolean nullable
Indicates if supplier packages can be split to order quantities smaller than the full package size.
unitstring nullable
Product unit, used for describing what unit the quantities are in
sortIndexBoostinteger nullable
Sort index set by API / GUI
isBackorderboolean nullable
If true, the product have no reorder level, and will usually not be in stock
isPriceLockedboolean nullable
When true, the price on order lines created from this product will be locked and not recalculated.
isMainProductVariantboolean nullable
If true, this variant should represent the product in flattened variant lists
isSerializableProductboolean nullable
If true, the product is serializable, and order line should contain serial number when completed
alternativeProductNamestring nullable
costCurrencystring nullable
Currency code. E.g. USD, EUR, NOK
productTypestring nullable
isNotRatableboolean nullable
Set to true if this product should be excluded from rating emails/forms
excludeFromPromotionsboolean nullable
Set to true if this product should be excluded from promotions
salesStartDatestring date-time nullable
Embargo date: product cannot be sold before this date
fixedPriceCodestring nullable
Price protection category (e.g. book law)
fixedPriceEndDatestring date-time nullable
Discounts are blocked until this date
discountBlockedboolean nullable
Permanent discount prohibition
countryOfOriginstring nullable
isVirtualboolean nullable
Virtual products will not affect inventory.
fieldsToForceNullstring[] nullable
Force nullable product fields to null. Use the property path, e.g. "SeoInfo.Description".
freightClassstring nullable
customsCodestring nullable
Customs code for the product