RamBase REST APIs
List of products
HTTP method | GET |
URI | https://api.rambase.net/product/products?search={search}&searchMode={searchMode} |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 80 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 415, version 44 |
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.
search String, optional | Keyword to limit result set by searching in product name, product description, customer product name, supplier product name and equivalent product names. |
searchMode String, optional |
Defines how the search query parameter works. Possible values are:
DEFAULT which only searches in product name and description, fastest search mode, but does not allow filtering on custom fields. INCLEQV which includes equivalents in the search. SSDEFAULT which only searches in product name and description, slower, but allows filtering on custom fields. SSINCLEQV which includes equivalents in the search.
Default: DEFAULT |
$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 |
$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. |
$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. |
$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. |
$format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
$showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
$top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
$pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
$filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
$orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
$inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
ActiveProducts() Named filter | Active products. Products that can be sold or produced. |
ExpiredProducts() Named filter | Expired and discontinued products |
NewAndActiveProducts() Named filter | New and active products |
NewProducts() Named filter | Products pending documentation or approval |
AvailableStockQuantity Decimal | 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. |
CountryOfOriginCode String | 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. |
CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
CreatedBy Integer | Employee identifier. Available macros: currentUser() |
CustomField1 String | Custom field for grouping, sorting, categorizing and other purposes. |
CustomField2 String | Custom field for grouping, sorting, categorizing and other purposes. |
CustomField3 String | Custom field for grouping, sorting, categorizing and other purposes. |
Description String | Description of the product. |
ExclusivelyForCustomerId Integer | Customer identifier. |
ExpectedLeadTime Integer | 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.. |
ExternalReference String | External reference of the product. Typically used for storing product identifier for same product in external system. |
IsManufacturedInBatches Boolean | 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. |
IsTraceableMaterialOfProductUnit Boolean | 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. |
ManufacturerId Integer | Manufacturer identifier. |
ManufacturingAreaId Integer | Manufacturing area identifier. |
MinimumGrossMargin Decimal | The minimum gross margin, in percent, for the product. |
Name String | Name of the product. |
PlanningCategory String | Planning category. |
ProductClassificationId String | Product classification identifier. |
ProductCollectionId Integer | Id of the collection grouping the products. |
ProductId Integer | Product identifier. |
PublicProductUri String | Public/external product URI for more information about the product. Will typically be an URL to product details at the manufacturer web site. |
RequireSerialNumberAtGoodsReception Boolean | 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. |
RequireSerialNumberBeforeShipping Boolean | 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. |
SalesType Integer | Defines if an article is of one of the types: Sales, Sales and rental, Rental, Subscription. |
ServiceIntervalId Integer | Service interval identifier. |
StandardLeadTime Integer | The standard lead time, in number of days, from customer places order to delivery. |
Status Integer | Status of the product. |
StockQuantity Decimal | 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. |
Type String | Type of product. |
UpdatedAt Datetime | Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
WarrantyPeriod Integer | 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. |
Weight Decimal | The weight of the product in kilograms. |
Read more about filters and sorting on how to use sortable parameters
AvailableStockQuantity Decimal | 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 |
CountryOfOriginCode String | 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. |
CreatedAt Datetime | Date and time of creation |
CreatedBy Integer | Employee identifier |
CustomField1 String | Custom field for grouping, sorting, categorizing and other purposes. |
CustomField2 String | Custom field for grouping, sorting, categorizing and other purposes. |
CustomField3 String | Custom field for grouping, sorting, categorizing and other purposes |
Description String | Description of the product |
ExclusivelyForCustomerId Integer | Customer identifier |
ExpectedLeadTime Integer | 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. |
ExternalReference String | External reference of the product. Typically used for storing product identifier for same product in external system. |
IsManufacturedInBatches Boolean | 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. |
IsTraceableMaterialOfProductUnit Boolean | 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. |
ManufacturerId Integer | Manufacturer identifier |
ManufacturingAreaId Integer | Manufacturing area identifier |
MinimumGrossMargin Decimal | The minimum gross margin, in percent, for the product |
Name String | Name of the product |
PlanningCategory String | Planning category |
ProductClassificationId String | Product classification identifier |
ProductCollectionId Integer | Id of the collection grouping the products |
ProductId Integer | Product identifier |
PublicProductUri String | Public/external product URI for more information about the product. Will typically be an URL to product details at the manufacturer web site. |
RequireSerialNumberAtGoodsReception Boolean | 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. |
RequireSerialNumberBeforeShipping Boolean | 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. |
SalesType Integer | Defines if an article is of one of the types: Sales, Sales and rental, Rental, Subscription |
ServiceIntervalId Integer | Service interval identifier |
StandardLeadTime Integer | The standard lead time, in number of days, from customer places order to delivery. |
Status Integer | Status of the product |
StockQuantity Decimal | 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. |
Type String | Type of product |
UpdatedAt Datetime | Date and time of update |
WarrantyPeriod Integer | 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. |
Weight Decimal | The weight of the product in kilograms. |
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>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>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>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>Weight
The weight of the product in kilograms.
>{Decimal}</Weight>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>Manufacturer
Manufacturer of the product
>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>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>ProductClassificationId
Product classification identifier
>{String}</ProductClassificationId>ProductClassificationLink
Product classification reference
>{String}</ProductClassificationLink>MinimumGrossMargin
The minimum gross margin, in percent, for the product
>{Decimal}</MinimumGrossMargin>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>StandardLeadTime
The standard lead time, in number of days, from customer places order to delivery.
>{Integer}</StandardLeadTime>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>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>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>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>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>ManufacturingAreaId
Manufacturing area identifier
>{Integer}</ManufacturingAreaId>Name
Name of manufacturing area
>{String}</Name>ManufacturingAreaLink
Manufacturing area reference
>{String}</ManufacturingAreaLink>PlanningCategory
Planning category
Possible domain values can be found here
>{String}</PlanningCategory>ProductId
Product identifier
>{Integer}</ProductId>ProductLink
Product reference
>{String}</ProductLink>ServiceInterval
Service template of the product. This template will be used when performing service for this product.
>ServiceIntervalId
Service interval identifier
>{Integer}</ServiceIntervalId>ProductLink
Product reference
>{String}</ProductLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>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}",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}",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}",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}",Weight
The weight of the product in kilograms.
": "{Decimal}",UpdatedAt
Date and time of update
": "{Datetime}",Manufacturer
Manufacturer of the product
": {ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"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}"ProductClassificationId
Product classification identifier
": "{String}",ProductClassificationLink
Product classification reference
": "{String}"MinimumGrossMargin
The minimum gross margin, in percent, for the product
": "{Decimal}",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}",StandardLeadTime
The standard lead time, in number of days, from customer places order to delivery.
": "{Integer}",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}"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}",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}"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}"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}",ManufacturingAreaId
Manufacturing area identifier
": "{Integer}",Name
Name of manufacturing area
": "{String}",ManufacturingAreaLink
Manufacturing area reference
": "{String}"PlanningCategory
Planning category
Possible domain values can be found here
": "{String}"ProductId
Product identifier
": "{Integer}",ProductLink
Product reference
": "{String}"ServiceInterval
Service template of the product. This template will be used when performing service for this product.
": {ServiceIntervalId
Service interval identifier
": "{Integer}"ProductLink
Product reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 100036 HTTP 400 | Missing required input parameter: {0} |