Product APIs
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 55 |
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.
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.
ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ExternalReference
External reference of the product. Typically used for storing product identifier for same product in external system.
>{String}</ExternalReference>CustomField1
Custom field for grouping, sorting, categorizing and other purposes.
>{String}</CustomField1>CustomField2
Custom field for grouping, sorting, categorizing and other purposes.
>{String}</CustomField2>CustomField3
Custom field for grouping, sorting, categorizing and other purposes
>{String}</CustomField3>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
The weight of the product in kilograms.
>{Decimal}</Weight>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
Internal note regardig the product. Should not be exposed to customers.
>{String}</InternalNote>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
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
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
Date and time of creation
>{Datetime}</CreatedAt>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>MeasurementUnit
Measurement unit used for this product, both in sales and purchase.
>MeasurementUnitId
Measurement unit identifier
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>Manufacturer
Manufacturer of the product
>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>ManufacturersProductId
Manufacturer product identifier
>{Integer}</ManufacturersProductId>ManufacturersProductLink
Manufacturers product reference
>{String}</ManufacturersProductLink>PalletQuantity
Total quantity of the product that can be on a pallet
>{Integer}</PalletQuantity>PackageQuantity
Total quantity of the product within a package
>{Integer}</PackageQuantity>PackageType
Type of wrapping used for the package
Possible domain values can be found here
>{String}</PackageType>Width
Width of the product in centimetres
>{Decimal}</Width>Height
Height of the product in centimetres
>{Decimal}</Height>Length
Length of the product in centimetres
>{Decimal}</Length>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>MainImage
Main image of the product
>FileVersionId
Version of the file
>{Integer}</FileVersionId>FileId
File identifier
>{Integer}</FileId>FileLink
File reference
>{String}</FileLink>FileVersionLink
File version reference
>{String}</FileVersionLink>CostingMethod
Costing method to use in accounting
Possible domain values can be found here
>{String}</CostingMethod>ProductClassificationId
Product classification identifier
>{String}</ProductClassificationId>ProductClassificationLink
Product classification reference
>{String}</ProductClassificationLink>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
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
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
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
Planning category
Possible domain values can be found here
>{String}</PlanningCategory>ManufacturingAreaId
Manufacturing area identifier
>{Integer}</ManufacturingAreaId>ManufacturingAreaLink
Manufacturing area reference
>{String}</ManufacturingAreaLink>ServiceInterval
Service template of the product. This template will be used when performing service for this product.
>ServiceIntervalId
Service interval identifier
>{Integer}</ServiceIntervalId>ServiceIntervalLink
Service interval reference
>{String}</ServiceIntervalLink>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
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.
MinimumGrossMargin
The minimum gross margin, in percent, for the product
>{Decimal}</MinimumGrossMargin>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>StandardLeadTime
The standard lead time, in number of days, from customer places order to delivery.
>{Integer}</StandardLeadTime>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>NetPrice
Minimum sales price for product
>{Decimal}</NetPrice>IsNonStock
True if this is a non-physical product which are no using assignments from the assignment archive
>{Boolean}</IsNonStock>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>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>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>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>AutoCreateProductUnitAtGoodsReception
When activated, product units are automatically generated when goods are registered to stock.
>{Boolean}</AutoCreateProductUnitAtGoodsReception>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>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>ProductId
Product identifier
>{Integer}</ProductId>ProductLink
Product reference
>{String}</ProductLink>ProductId
Product identifier
": "{Integer}",Status
Status of the product
Possible domain values can be found here
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",Description
Description of the product
": "{String}",ExternalReference
External reference of the product. Typically used for storing product identifier for same product in external system.
": "{String}",CustomField1
Custom field for grouping, sorting, categorizing and other purposes.
": "{String}",CustomField2
Custom field for grouping, sorting, categorizing and other purposes.
": "{String}",CustomField3
Custom field for grouping, sorting, categorizing and other purposes
": "{String}",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}",Weight
The weight of the product in kilograms.
": "{Decimal}",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}",InternalNote
Internal note regardig the product. Should not be exposed to customers.
": "{String}",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
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
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}",CreatedAt
Date and time of creation
": "{Datetime}",UpdatedAt
Date and time of update
": "{Datetime}",MeasurementUnit
Measurement unit used for this product, both in sales and purchase.
": {MeasurementUnitId
Measurement unit identifier
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",MeasurementUnitLink
Material unit reference
": "{String}"Manufacturer
Manufacturer of the product
": {ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"ManufacturersProductId
Manufacturer product identifier
": "{Integer}",ManufacturersProductLink
Manufacturers product reference
": "{String}"PalletQuantity
Total quantity of the product that can be on a pallet
": "{Integer}",PackageQuantity
Total quantity of the product within a package
": "{Integer}",PackageType
Type of wrapping used for the package
Possible domain values can be found here
": "{String}"Width
Width of the product in centimetres
": "{Decimal}",Height
Height of the product in centimetres
": "{Decimal}",Length
Length of the product in centimetres
": "{Decimal}",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
Main image of the product
": {FileVersionId
Version of the file
": "{Integer}",FileId
File identifier
": "{Integer}",FileLink
File reference
": "{String}"FileVersionLink
File version reference
": "{String}"CostingMethod
Costing method to use in accounting
Possible domain values can be found here
": "{String}"ProductClassificationId
Product classification identifier
": "{String}",ProductClassificationLink
Product classification reference
": "{String}"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}",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}",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}",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}",PlanningCategory
Planning category
Possible domain values can be found here
": "{String}",ManufacturingAreaId
Manufacturing area identifier
": "{Integer}",ManufacturingAreaLink
Manufacturing area reference
": "{String}"ServiceInterval
Service template of the product. This template will be used when performing service for this product.
": {ServiceIntervalId
Service interval identifier
": "{Integer}",ServiceIntervalLink
Service interval reference
": "{String}"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
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.
MinimumGrossMargin
The minimum gross margin, in percent, for the product
": "{Decimal}",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}",StandardLeadTime
The standard lead time, in number of days, from customer places order to delivery.
": "{Integer}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",NetPrice
Minimum sales price for product
": "{Decimal}"IsNonStock
True if this is a non-physical product which are no using assignments from the assignment archive
": "{Boolean}",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}",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}",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}",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}",AutoCreateProductUnitAtGoodsReception
When activated, product units are automatically generated when goods are registered to stock.
": "{Boolean}"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}",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}"ProductId
Product identifier
": "{Integer}",ProductLink
Product reference
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 100027 HTTP 400 | Missing mandatory parameter {0} |
| Error 101420 HTTP 404 | Setting definition not found |