Product
The class to describe the Product business object.
| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderComment |
Gets or sets the OrderComment. |
string |
Max length: 2147483647 |
| MainImageChangedTimestamp |
Gets the changed timestamp of the Main Image. |
date |
None. |
| SyncEnabled |
Gets or sets a value indicating whether [synchronize enabled]. |
boolean |
Required |
| Properties |
A collection of translatable Product Properties. Following property codes are system properties which can be used: "Name", "Description", "Published", "DescriptionLong", "MetaTitle", "MetaKeywords", "MetaDescription", "NameTemplate", "DescriptionTemplate", "DescriptionLongTemplate" |
Collection of ProductProperty |
None. |
| ShopGroupId |
Gets or sets the shop group identifier. |
integer |
Required |
| Note |
Gets or sets the note. |
string |
Max length: 2147483647 |
| RefCode |
An optional reference for the Product. |
string |
Max length: 500 |
| ProductBrand |
Optionally contains Brand information for the Product. |
ProductBrand |
None. |
| ProductVariantParentId |
The Id to the ProductVariant parent. The Type of the product should be ProductVariant (2) when used. |
integer |
None. |
| VariantInfo |
This field contains a summary of the values of the Variation properties. This field is only used when the Type = ProductVariant (2). Eg: 'Black | XL' |
string |
Max length: 100 |
| CreationDate |
Gets the creation date. |
date |
Required |
| KeepStock |
Gets or sets a value indicating whether [keep stock]. |
boolean |
Required |
| IsShippable |
Gets or sets a value indicating whether [is shippable]. Note: when a product is not shippable, you can not manage stock for the product. |
boolean |
Required |
| MinimumStock |
Gets or sets the minimum stock. |
decimal number |
Required |
| MainImageFileId |
Gets or sets the main image file identifier. |
integer |
None. |
| QtyAvailable |
Gets or sets the qty available. |
decimal number |
Required |
| QtyOnHand |
Gets or sets the qty on hand. |
decimal number |
Required |
| QtyReserved |
Gets or sets the qty reserved. |
decimal number |
Required |
| Published |
Gets or sets a value indicating whether this |
boolean |
Required |
| Weight |
Gets or sets the weight. |
decimal number |
None. |
| WeightUOMId |
Gets or sets the weight uom identifier. |
integer |
None. |
| Height |
Gets or sets the height. |
decimal number |
None. |
| SizeUOMId |
Gets or sets the Size (used for length/height/width/diameter) uom identifier. |
integer |
None. |
| Length |
Gets or sets the length. |
decimal number |
None. |
| Width |
Gets or sets the width. |
decimal number |
None. |
| Diameter |
Gets or sets the Diameter. |
decimal number |
None. |
| VolumeUOMId |
Gets or sets the Volume uom identifier. |
integer |
None. |
| Volume |
Gets or sets the Volume. |
decimal number |
None. |
| PriceExVat |
Gets or sets the price ex vat. |
decimal number |
Required |
| ProductPropertyDefSetId |
Gets or sets the product property definition set identifier. |
integer |
None. |
| TransportCategoryId |
The Transport Category assigned to the Product. |
integer |
None. |
| ProductGroups |
Gets or sets the product groups. |
Collection of integer |
None. |
| Resources |
Gets a list of all Product Resources. Resources can be additional images, documents, etc. |
Collection of ProductResource |
None. |
| ProductRelations |
Gets a list of all Product Relations. Relations can exist for cross-sell, up-sell, etc. |
Collection of ProductRelation |
None. |
| ProductVariantPropertyDefIds |
This collection holds the Id's of ProductPropertyDefinitions which are used to create Product Variants for. This collection is only used when the Product is of the Type ProductVariantParent. |
Collection of integer |
None. |
| ProductVariantIds |
This collection holds the Id's of the (child) Product Variants. This collection is only used when the Product is of the Type ProductVariantParent. |
Collection of integer |
None. |
| OriginCountryId |
Gets or sets the Country of Origin. |
integer |
None. |
| OriginCountryCode |
Gets or sets the country code (ISO2) for the Country of Origin. |
string |
None. |
| Id |
Gets or sets the identifier. |
integer |
Required |
| Code |
Gets or sets the code. |
string |
Required Max length: 100 |
| Name |
Gets or sets the name. |
string |
Max length: 400 |
| Hscode |
Gets or sets the Harmonized System Code. |
string |
Max length: 20 |
| EAN |
Gets or sets the European Article Number. |
string |
Max length: 20 |
| Type |
The ProductType, available: SimpleProduct = 0, ProductVariantParent = 1, ProductVariant = 2 |
integer |
None. |
| ChangedTimestamp |
Gets the changed timestamp. |
date |
None. |