RamBase REST APIs

GET product/products/{productId}

Product details for the provided identifier

HTTP method	GET
URI	https://api.rambase.net/product/products/{productId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {productId}	Product identifier Integer, minimum 10000
Custom fields	Custom fields supported
Successful HTTP status code	200
API resource identifier	416, version 50

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional	Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$showCustomFields Boolean, optional	Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <Product>
                                    

<ProductId

ProductId

Product identifier

>{Integer}</ProductId>

<Status

Status

Status of the product

Possible domain values can be found here

>{Integer}</Status>

<Name

Name

Name of the product

>{String}</Name>

<Type

Type

Type of product

Possible domain values can be found here

>{String}</Type>

<Description

Description

Description of the product

>{String}</Description>

<ExternalReference

ExternalReference

External reference of the product. Typically used for storing product identifier for same product in external system.

>{String}</ExternalReference>

<CustomField1

CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</CustomField1>

<CustomField2

CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</CustomField2>

<CustomField3

CustomField3

Custom field for grouping, sorting, categorizing and other purposes

>{String}</CustomField3>

<GlobalTradeItemNumber

GlobalTradeItemNumber

Global Trade Item Number (GTIN) is a 14 digit identifier for trade items (comprising among others of the former EAN International and Uniform Code Council). Examples of types of GTIN are UPC, EAN, JAN, ISBN

>{String}</GlobalTradeItemNumber>

<Weight

Weight

The weight of the product in kilograms.

>{Decimal}</Weight>

<CountryOfOriginCode

CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.

>{String}</CountryOfOriginCode>

<InternalNote

InternalNote

Internal note regardig the product. Should not be exposed to customers.

>{String}</InternalNote>

<MoistureSensitivityLevel

MoistureSensitivityLevel

Moisture sensitivity level is an electronic standard for the time period in which a moisture sensitive device can be exposed to ambient room conditions.

Possible domain values can be found here

>{String}</MoistureSensitivityLevel>

<PublicProductUri

PublicProductUri

Public/external product URI for more information about the product. Will typically be an URL to product details at the manufacturer web site.

>{String}</PublicProductUri>

<RequireSerialNumberBeforeShipping

RequireSerialNumberBeforeShipping

If all units of this product should have a serial number before shipping, you should require serial number to be specified before shipping this product. Shipping includes supplier returns, shipping advices and stock transfers.

>{Boolean}</RequireSerialNumberBeforeShipping>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<UpdatedAt

UpdatedAt

Date and time of update

>{Datetime}</UpdatedAt>

<CreatedBy

CreatedBy

User which created the product

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy in your request URI to get this field

<UserId

UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy in your request URI to get this field

>{Integer}</UserId>

<Name

Name

Name of the user

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy in your request URI to get this field

>{String}</Name>

<FirstName

FirstName

First name of the user

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy in your request URI to get this field

>{String}</FirstName>

<UserLink

UserLink

User reference

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy in your request URI to get this field

>{String}</UserLink>

                                             </CreatedBy>
                                    

<MeasurementUnit

MeasurementUnit

Measurement unit used for this product, both in sales and purchase.

<MeasurementUnitId

MeasurementUnitId

Measurement unit identifier

>{Integer}</MeasurementUnitId>

<Unit

Unit

Measurement unit (ex. mm, km, dl, kg)

>{String}</Unit>

<MeasurementUnitLink

MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>

                                             </MeasurementUnit>
                                    

<Manufacturer

Manufacturer

Manufacturer of the product

<ManufacturerId

ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>

<ShortName

ShortName

Shortname/code of the manufacturer

>{String}</ShortName>

<ManufacturerLink

ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>

                                             </Manufacturer>
                                    

                                             <DefaultManufacturersProduct>
                                    

<ManufacturersProductId

ManufacturersProductId

Manufacturer product identifier

>{Integer}</ManufacturersProductId>

<Name

Name

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

This field is greyed out because it is an expandable field. You have to add $expand=DefaultManufacturersProduct.Name in your request URI to get this field

>{String}</Name>

<ManufacturersProductLink

ManufacturersProductLink

Manufacturers product reference

>{String}</ManufacturersProductLink>

                                             </DefaultManufacturersProduct>
                                    

                                             <Package>
                                    

<PalletQuantity

PalletQuantity

Total quantity of the product that can be on a pallet

>{Integer}</PalletQuantity>

<PackageQuantity

PackageQuantity

Total quantity of the product within a package

>{Integer}</PackageQuantity>

<PackageType

PackageType

Type of wrapping used for the package

Possible domain values can be found here

>{String}</PackageType>

                                             </Package>
                                    

                                             <Dimensions>
                                    

<Width

Width

Width of the product in centimetres

>{Decimal}</Width>

<Height

Height

Height of the product in centimetres

>{Decimal}</Height>

<Length

Length

Length of the product in centimetres

>{Decimal}</Length>

<Volume

Volume

Volume of the product in cubic centimetres. Volume is calculated automatically as L* W* H (when the volume field is empty and L,W ,H have values). Volume can also be changed manually

>{Decimal}</Volume>

                                             </Dimensions>
                                    

<MainImage

MainImage

Main image of the product

<FileVersionId

FileVersionId

Version of the file

>{Integer}</FileVersionId>

<FileStorageUri

FileStorageUri

The url to download a file

This field is greyed out because it is an expandable field. You have to add $expand=MainImage.FileStorageUri in your request URI to get this field

>{String}</FileStorageUri>

                                                  <File>
                                    

<FileId

FileId

File identifier

>{Integer}</FileId>

<FileLink

FileLink

File reference

>{String}</FileLink>

                                                  </File>
                                    

<FileVersionLink

FileVersionLink

File version reference

>{String}</FileVersionLink>

                                             </MainImage>
                                    

                                             <Accounting>
                                    

<CostingMethod

CostingMethod

Costing method to use in accounting

Possible domain values can be found here

>{String}</CostingMethod>

                                             </Accounting>
                                    

                                             <ProductClassification>
                                    

<ProductClassificationId

ProductClassificationId

Product classification identifier

>{String}</ProductClassificationId>

<TreeLevel

TreeLevel

Level in product classification tree (0 is root)

This field is greyed out because it is an expandable field. You have to add $expand=ProductClassification.TreeLevel in your request URI to get this field

>{Integer}</TreeLevel>

<Name

Name

Name of product classification

This field is greyed out because it is an expandable field. You have to add $expand=ProductClassification.Name in your request URI to get this field

>{String}</Name>

<ProductClassificationLink

ProductClassificationLink

Product classification reference

>{String}</ProductClassificationLink>

                                             </ProductClassification>
                                    

<ParentProductClassifications

ParentProductClassifications

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

<ParentProductClassification

ParentProductClassification

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

<ProductClassificationId

ProductClassificationId

Product classification identifier

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

>{String}</ProductClassificationId>

<TreeLevel

TreeLevel

Level in product classification tree (0 is root)

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

>{Integer}</TreeLevel>

<Name

Name

Name of product classification

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

>{String}</Name>

<ProductClassificationLink

ProductClassificationLink

Product classification reference

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

>{String}</ProductClassificationLink>

                                                  </ParentProductClassification>
                                    

                                             </ParentProductClassifications>
                                    

                                             <Production>
                                    

<HasExternalMaterialOwners

HasExternalMaterialOwners

If true, this product has external material owners specified, with both the customer and a supplier that represents the same customer. During the manufacturing process it will automatically be created a purchase order to request shipment of this material from the external owner.

>{Boolean}</HasExternalMaterialOwners>

<IsTraceableMaterialOfProductUnit

IsTraceableMaterialOfProductUnit

During production of a product structure, each produced unit generates a list of tracable materials included in the finished unit. When this value is true, this product is included in the list of tracable materials.

>{Boolean}</IsTraceableMaterialOfProductUnit>

<IsManufacturedInBatches

IsManufacturedInBatches

Products is either manufactured in batch product units, or single product units. When manufactured as single, each production unit of a production work order should result in seperate product units. When manufactured in batches, all production units from one production work order should result in one common product unit.

>{Boolean}</IsManufacturedInBatches>

<NeedsMaterialReplacementToRelease

NeedsMaterialReplacementToRelease

You can add a dummy article in productions which you replace with the actual product before production starts. This function is used in situations where it is undecided which product will be used in the final production.

>{Boolean}</NeedsMaterialReplacementToRelease>

<PlanningCategory

PlanningCategory

Planning category

Possible domain values can be found here

>{String}</PlanningCategory>

                                                  <ManufacturingArea>
                                    

<ManufacturingAreaId

ManufacturingAreaId

Manufacturing area identifier

>{Integer}</ManufacturingAreaId>

<Name

Name

Name of manufacturing area

This field is greyed out because it is an expandable field. You have to add $expand=Production.ManufacturingArea.Name in your request URI to get this field

>{String}</Name>

<ManufacturingAreaLink

ManufacturingAreaLink

Manufacturing area reference

>{String}</ManufacturingAreaLink>

                                                  </ManufacturingArea>
                                    

                                             </Production>
                                    

                                             <Service>
                                    

<ServiceInterval

ServiceInterval

Service template of the product. This template will be used when performing service for this product.

<ServiceIntervalId

ServiceIntervalId

Service interval identifier

>{Integer}</ServiceIntervalId>

<ServiceIntervalLink

ServiceIntervalLink

Service interval reference

>{String}</ServiceIntervalLink>

                                                  </ServiceInterval>
                                    

                                             </Service>
                                    

                                             <Sales>
                                    

<Type

Type

Defines if an article is of one of the types: Sales, Sales and rental, Rental, Subscription

Possible domain values can be found here

>{Integer}</Type>

<AssignInMultipleOf

AssignInMultipleOf

Sometimes the products are packed together in a way that makes it preferrable to keep them together when selling. When RamBase starts the process of assigning sales to stock or purchase backlog, this field is taken into consideration. If the available quantity is not in this multiple, the rest quantity will be requested for procurement.

Ex. a product is set up to be assigned in multiple of 3. When selling 7 pcs of this product, 6 is assigned to stock or purchase backlog, while the last one is always requested for procurement (even though you have 100 in stock). Note that you can still manually override this behaviour and assign everything to stock or purchase backlog.

>{Integer}</AssignInMultipleOf>

<MinimumGrossMargin

MinimumGrossMargin

The minimum gross margin, in percent, for the product

>{Decimal}</MinimumGrossMargin>

100

<DomesticVATPercent

DomesticVATPercent

jasdasld

This field is greyed out because it is an expandable field. You have to add $expand=Sales.DomesticVATPercent in your request URI to get this field

>{Decimal}</DomesticVATPercent>

101

<WarrantyPeriod

WarrantyPeriod

The time period (in months) in which the product may be returned or exchanged. The warranty period starts at the date of shipment to customer.

>{Integer}</WarrantyPeriod>

102

<StandardLeadTime

StandardLeadTime

The standard lead time, in number of days, from customer places order to delivery.

>{Integer}</StandardLeadTime>

                                                  <MinimumSalesPrice>
                                    

104

<Currency

Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>

105

<NetPrice

NetPrice

Minimum sales price for product

>{Decimal}</NetPrice>

                                                  </MinimumSalesPrice>
                                    

107

<ExclusivelyForCustomer

ExclusivelyForCustomer

If customer is specified, only this customer can place orders for this product.

This field is greyed out because it is an expandable field. You have to add $expand=Sales.ExclusivelyForCustomer in your request URI to get this field

108

<CustomerId

CustomerId

Customer identifier

This field is greyed out because it is an expandable field. You have to add $expand=Sales.ExclusivelyForCustomer in your request URI to get this field

>{Integer}</CustomerId>

109

<Name

Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=Sales.ExclusivelyForCustomer in your request URI to get this field

>{String}</Name>

110

<CustomerLink

CustomerLink

Customer reference

This field is greyed out because it is an expandable field. You have to add $expand=Sales.ExclusivelyForCustomer in your request URI to get this field

>{String}</CustomerLink>

                                                  </ExclusivelyForCustomer>
                                    

                                             </Sales>
                                    

                                             <Stock>
                                    

114

<IsNonStock

IsNonStock

True if this is a non-physical product which are no using assignments from the assignment archive

>{Boolean}</IsNonStock>

115

<StockQuantity

StockQuantity

Quantity on hand. The total number of units that are physically located at all locations at the current time. This includes items already assigned to fulfilling production needs or sales orders. So, this number may differ from the available quantity.

>{Decimal}</StockQuantity>

116

<AvailableStockQuantity

AvailableStockQuantity

Quantity on hand which is not assigned. The total number of the product that are physically located in all warehouse locations and are currently available for new orders or fulfilling production needs

>{Decimal}</AvailableStockQuantity>

117

<AvailablePurchasedQuantity

AvailablePurchasedQuantity

Quantity of the purchase backlog which is not allocated. The quantity only exists in the purchase backlog, and is not physically located in the warehouse location. The products are currently available for use in filling a new order or for purposes such as production or distribution.

>{Decimal}</AvailablePurchasedQuantity>

118

<RequireSerialNumberAtGoodsReception

RequireSerialNumberAtGoodsReception

If all units of this product should have a serial number in stock, you should require serial number to be required at goods reception. This will ensure that serial number is specified before goods receptions with this product is registered.

>{Boolean}</RequireSerialNumberAtGoodsReception>

                                             </Stock>
                                    

                                             <Procurement>
                                    

121

<ExpectedLeadTime

ExpectedLeadTime

The expected lead time, in number of days, from ordering from supplier to delivery. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers.

>{Integer}</ExpectedLeadTime>

122

<AutoGenerateSerialNumbersForPurchaseOrders

AutoGenerateSerialNumbersForPurchaseOrders

Serial numbers can be added to all newly created purchase order items. The serial number is specified in the company setting ProductionSerialNumberCounter, which will increase afterwards. If the company setting AutoProductionSerialNumberPrefix is specified, the serial number will be prefixed by this value.

>{Boolean}</AutoGenerateSerialNumbersForPurchaseOrders>

                                             </Procurement>
                                    

                                             <ProductCollection>
                                    

125

<ProductId

ProductId

Product identifier

>{Integer}</ProductId>

126

<ProductLink

ProductLink

Product reference

>{String}</ProductLink>

                                             </ProductCollection>
                                    

128

<LatestProductRevision

LatestProductRevision

This field is greyed out because it is an expandable field. You have to add $expand=LatestProductRevision in your request URI to get this field

129

<ProductRevisionId

ProductRevisionId

Product revision identifier

This field is greyed out because it is an expandable field. You have to add $expand=LatestProductRevision in your request URI to get this field

>{Integer}</ProductRevisionId>

130

<Status

Status

Status of product revision

This field is greyed out because it is an expandable field. You have to add $expand=LatestProductRevision in your request URI to get this field

>{Integer}</Status>

131

<Revision

Revision

Revision number

This field is greyed out because it is an expandable field. You have to add $expand=LatestProductRevision in your request URI to get this field

>{String}</Revision>

132

<ProductRevisionLink

ProductRevisionLink

Product revision reference

This field is greyed out because it is an expandable field. You have to add $expand=LatestProductRevision in your request URI to get this field

>{String}</ProductRevisionLink>

                                             </LatestProductRevision>
                                    

                                        </Product>
                                    

{

                                             "product": {
                                    

"productId

ProductId

Product identifier

": "{Integer}",

"status

Status

Status of the product

Possible domain values can be found here

": "{Integer}",

"name

Name

Name of the product

": "{String}",

"type

Type

Type of product

Possible domain values can be found here

": "{String}",

"description

Description

Description of the product

": "{String}",

"externalReference

ExternalReference

External reference of the product. Typically used for storing product identifier for same product in external system.

": "{String}",

"customField1

CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

": "{String}",

"customField2

CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

": "{String}",

"customField3

CustomField3

Custom field for grouping, sorting, categorizing and other purposes

": "{String}",

"globalTradeItemNumber

GlobalTradeItemNumber

": "{String}",

"weight

Weight

The weight of the product in kilograms.

": "{Decimal}",

"countryOfOriginCode

CountryOfOriginCode

": "{String}",

"internalNote

InternalNote

Internal note regardig the product. Should not be exposed to customers.

": "{String}",

"moistureSensitivityLevel

MoistureSensitivityLevel

Moisture sensitivity level is an electronic standard for the time period in which a moisture sensitive device can be exposed to ambient room conditions.

Possible domain values can be found here

": "{String}",

"publicProductUri

PublicProductUri

Public/external product URI for more information about the product. Will typically be an URL to product details at the manufacturer web site.

": "{String}",

"requireSerialNumberBeforeShipping

RequireSerialNumberBeforeShipping

": "{Boolean}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"updatedAt

UpdatedAt

Date and time of update

": "{Datetime}",

"createdBy

CreatedBy

User which created the product

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy in your request URI to get this field

": {

"userId

UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy in your request URI to get this field

": "{Integer}",

"name

Name

Name of the user

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy in your request URI to get this field

": "{String}",

"firstName

FirstName

First name of the user

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy in your request URI to get this field

": "{String}",

"userLink

UserLink

User reference

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy in your request URI to get this field

": "{String}"

},

"measurementUnit

MeasurementUnit

Measurement unit used for this product, both in sales and purchase.

": {

"measurementUnitId

MeasurementUnitId

Measurement unit identifier

": "{Integer}",

"unit

Unit

Measurement unit (ex. mm, km, dl, kg)

": "{String}",

"measurementUnitLink

MeasurementUnitLink

Material unit reference

": "{String}"

},

"manufacturer

Manufacturer

Manufacturer of the product

": {

"manufacturerId

ManufacturerId

Manufacturer identifier

": "{Integer}",

"shortName

ShortName

Shortname/code of the manufacturer

": "{String}",

"manufacturerLink

ManufacturerLink

Manufacturer reference

": "{String}"

},

                                                  "defaultManufacturersProduct": {
                                    

"manufacturersProductId

ManufacturersProductId

Manufacturer product identifier

": "{Integer}",

"name

Name

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

This field is greyed out because it is an expandable field. You have to add $expand=DefaultManufacturersProduct.Name in your request URI to get this field

": "{String}",

"manufacturersProductLink

ManufacturersProductLink

Manufacturers product reference

": "{String}"

},

                                                  "package": {
                                    

"palletQuantity

PalletQuantity

Total quantity of the product that can be on a pallet

": "{Integer}",

"packageQuantity

PackageQuantity

Total quantity of the product within a package

": "{Integer}",

"packageType

PackageType

Type of wrapping used for the package

Possible domain values can be found here

": "{String}"

},

                                                  "dimensions": {
                                    

"width

Width

Width of the product in centimetres

": "{Decimal}",

"height

Height

Height of the product in centimetres

": "{Decimal}",

"length

Length

Length of the product in centimetres

": "{Decimal}",

"volume

Volume

Volume of the product in cubic centimetres. Volume is calculated automatically as L* W* H (when the volume field is empty and L,W ,H have values). Volume can also be changed manually

": "{Decimal}"

},

"mainImage

MainImage

Main image of the product

": {

"fileVersionId

FileVersionId

Version of the file

": "{Integer}",

"fileStorageUri

FileStorageUri

The url to download a file

This field is greyed out because it is an expandable field. You have to add $expand=MainImage.FileStorageUri in your request URI to get this field

": "{String}",

                                                       "file": {
                                    

"fileId

FileId

File identifier

": "{Integer}",

"fileLink

FileLink

File reference

": "{String}"

},

"fileVersionLink

FileVersionLink

File version reference

": "{String}"

},

                                                  "accounting": {
                                    

"costingMethod

CostingMethod

Costing method to use in accounting

Possible domain values can be found here

": "{String}"

},

                                                  "productClassification": {
                                    

"productClassificationId

ProductClassificationId

Product classification identifier

": "{String}",

"treeLevel

TreeLevel

Level in product classification tree (0 is root)

This field is greyed out because it is an expandable field. You have to add $expand=ProductClassification.TreeLevel in your request URI to get this field

": "{Integer}",

"name

Name

Name of product classification

This field is greyed out because it is an expandable field. You have to add $expand=ProductClassification.Name in your request URI to get this field

": "{String}",

"productClassificationLink

ProductClassificationLink

Product classification reference

": "{String}"

},

"parentProductClassifications

ParentProductClassifications

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

": [

{

"productClassificationId

ProductClassificationId

Product classification identifier

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

": "{String}",

"treeLevel

TreeLevel

Level in product classification tree (0 is root)

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

": "{Integer}",

"name

Name

Name of product classification

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

": "{String}",

"productClassificationLink

ProductClassificationLink

Product classification reference

This field is greyed out because it is an expandable field. You have to add $expand=ParentProductClassifications in your request URI to get this field

": "{String}"

}

],

                                                  "production": {
                                    

"hasExternalMaterialOwners

HasExternalMaterialOwners

": "{Boolean}",

"isTraceableMaterialOfProductUnit

IsTraceableMaterialOfProductUnit

": "{Boolean}",

"isManufacturedInBatches

IsManufacturedInBatches

": "{Boolean}",

"needsMaterialReplacementToRelease

NeedsMaterialReplacementToRelease

": "{Boolean}",

"planningCategory

PlanningCategory

Planning category

Possible domain values can be found here

": "{String}",

                                                       "manufacturingArea": {
                                    

"manufacturingAreaId

ManufacturingAreaId

Manufacturing area identifier

": "{Integer}",

"name

Name

Name of manufacturing area

This field is greyed out because it is an expandable field. You have to add $expand=Production.ManufacturingArea.Name in your request URI to get this field

": "{String}",

"manufacturingAreaLink

ManufacturingAreaLink

Manufacturing area reference

": "{String}"

}

},

                                                  "service": {
                                    

"serviceInterval

ServiceInterval

Service template of the product. This template will be used when performing service for this product.

": {

"serviceIntervalId

ServiceIntervalId

Service interval identifier

": "{Integer}",

"serviceIntervalLink

ServiceIntervalLink

Service interval reference

": "{String}"

}

},

                                                  "sales": {
                                    

"type

Type

Defines if an article is of one of the types: Sales, Sales and rental, Rental, Subscription

Possible domain values can be found here

": "{Integer}",

"assignInMultipleOf

AssignInMultipleOf

": "{Integer}",

100

"minimumGrossMargin

MinimumGrossMargin

The minimum gross margin, in percent, for the product

": "{Decimal}",

101

"domesticVATPercent

DomesticVATPercent

jasdasld

This field is greyed out because it is an expandable field. You have to add $expand=Sales.DomesticVATPercent in your request URI to get this field

": "{Decimal}",

102

"warrantyPeriod

WarrantyPeriod

The time period (in months) in which the product may be returned or exchanged. The warranty period starts at the date of shipment to customer.

": "{Integer}",

103

"standardLeadTime

StandardLeadTime

The standard lead time, in number of days, from customer places order to delivery.

": "{Integer}",

                                                       "minimumSalesPrice": {
                                    

105

"currency

Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",

106

"netPrice

NetPrice

Minimum sales price for product

": "{Decimal}"

},

108

"exclusivelyForCustomer

ExclusivelyForCustomer

If customer is specified, only this customer can place orders for this product.

This field is greyed out because it is an expandable field. You have to add $expand=Sales.ExclusivelyForCustomer in your request URI to get this field

": {

109

"customerId

CustomerId

Customer identifier

This field is greyed out because it is an expandable field. You have to add $expand=Sales.ExclusivelyForCustomer in your request URI to get this field

": "{Integer}",

110

"name

Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=Sales.ExclusivelyForCustomer in your request URI to get this field

": "{String}",

111

"customerLink

CustomerLink

Customer reference

This field is greyed out because it is an expandable field. You have to add $expand=Sales.ExclusivelyForCustomer in your request URI to get this field

": "{String}"

}

},

                                                  "stock": {
                                    

115

"isNonStock

IsNonStock

True if this is a non-physical product which are no using assignments from the assignment archive

": "{Boolean}",

116

"stockQuantity

StockQuantity

": "{Decimal}",

117

"availableStockQuantity

AvailableStockQuantity

": "{Decimal}",

118

"availablePurchasedQuantity

AvailablePurchasedQuantity

": "{Decimal}",

119

"requireSerialNumberAtGoodsReception

RequireSerialNumberAtGoodsReception

": "{Boolean}"

},

                                                  "procurement": {
                                    

122

"expectedLeadTime

ExpectedLeadTime

": "{Integer}",

123

"autoGenerateSerialNumbersForPurchaseOrders

AutoGenerateSerialNumbersForPurchaseOrders

": "{Boolean}"

},

                                                  "productCollection": {
                                    

126

"productId

ProductId

Product identifier

": "{Integer}",

127

"productLink

ProductLink

Product reference

": "{String}"

},

129

"latestProductRevision

LatestProductRevision

This field is greyed out because it is an expandable field. You have to add $expand=LatestProductRevision in your request URI to get this field

": {

130

"productRevisionId

ProductRevisionId

Product revision identifier

This field is greyed out because it is an expandable field. You have to add $expand=LatestProductRevision in your request URI to get this field

": "{Integer}",

131

"status

Status

Status of product revision

This field is greyed out because it is an expandable field. You have to add $expand=LatestProductRevision in your request URI to get this field

": "{Integer}",

132

"revision

Revision

Revision number

This field is greyed out because it is an expandable field. You have to add $expand=LatestProductRevision in your request URI to get this field

": "{String}",

133

"productRevisionLink

ProductRevisionLink

Product revision reference

This field is greyed out because it is an expandable field. You have to add $expand=LatestProductRevision in your request URI to get this field

": "{String}"

}

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Set product status to 4

AOP/100863

POST

Send for approval

Sets the product to status 3

AOP/101230

POST

Send for review

Sets the product to status 2

AOP/101231

POST

Flag for change

Sets the product to status 5

AOP/101232

POST

Flag with issue

Sets the product to status 6

AOP/101233

POST

Announce end of life

Sets the product to status 7

AOP/101234

POST

Start end of life period

Sets the product to status 8

AOP/101235

POST

Expire / discontinue product

Sets the product to status 9

AOP/101236

POST

Rename product

This operation change the name of a product that has a status higher than 1 and lower than 9

AOP/101273

POST

Re-activate product

Set product status to review (st:2) if the product has expired, else it is setting the product status to active (st:4)

AOP/101296

POST

Copy product

Copy product and create a new product

AOP/101535

POST

For draft

Sets the product to status 1

AOP/101538

Possible error codes the response might return:

Error 100027 HTTP 400	Missing mandatory parameter {0}
Error 101420 HTTP 404	Setting definition not found