API

Product APIs

GET product/products/search?keywords={keywords}&in={in}

API resource for searching products.

HTTP method GET
URI https://api.rambase.net/product/products/search?keywords={keywords}&in={in}
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 4986, version 15

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:
1
1

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.

keywords String, optional Space seperater list of keywords to search for.
in String, optional Commalist of fields to search. Possible values are: ProductName, ProductDescription, CustomersProductName, ReplacementName. Default value are: "ProductName,ProductDescription".

Default: ProductName,ProductDescription
$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.
ExpectedPurchaseLeadTime 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.
GlobalTradeItemNumber String 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.
IsNonStock Boolean True if this is a non-physical product which are no using assignments from the assignment archive.
ManufacturerId Integer Manufacturer identifier.
ManufacturerShortName String Shortname/code of the manufacturer.
MeasurementUnitId Integer Measurement unit identifier.
Name String Name of the product.
ProductClassificationId String Product classification identifier.
ProductId Integer Product identifier.
SalesStandardLeadTime Integer The standard lead time, in number of days, from customer places order to delivery.
SalesType Integer Defines if an article is of one of the types: Sales, Sales and rental, Rental, Subscription.
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.
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
ExpectedPurchaseLeadTime 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.
GlobalTradeItemNumber String 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
IsNonStock Boolean True if this is a non-physical product which are no using assignments from the assignment archive
ManufacturerId Integer Manufacturer identifier
ManufacturerShortName String Shortname/code of the manufacturer
MeasurementUnitId Integer Measurement unit identifier
Name String Name of the product
ProductClassificationId String Product classification identifier
ProductId Integer Product identifier
SalesStandardLeadTime Integer The standard lead time, in number of days, from customer places order to delivery.
SalesType Integer Defines if an article is of one of the types: Sales, Sales and rental, Rental, Subscription
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
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.

Format:
1
<SearchResults>
2
     <SearchResult>
3
          <Title
Title

Title of search result. The content of this field is dependent on where the result was matched. If hit was in product name/description, title will be the name of the product. If hit was in customers product name, title will be the customers product name etc.

>{String}</Title>
4
          <In
In

Where this search result was found. Possible values here are PRODUCT, CUSTOMERSPRODUCTNAME, REPLACEMENTNAME and SUPPERLIERSPRODUCTNAME. Note that possible values will be affected by whats speified in the query parameter "in".

>{String}</In>
5
          <Product>
6
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
7
               <Status
Status

Status of the product

Possible domain values can be found here

>{Integer}</Status>
8
               <Name
Name

Name of the product

>{String}</Name>
9
               <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
10
               <Description
Description

Description of the product

>{String}</Description>
11
               <ExternalReference
ExternalReference

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

>{String}</ExternalReference>
12
               <CustomField1
CustomField1

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

>{String}</CustomField1>
13
               <CustomField2
CustomField2

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

>{String}</CustomField2>
14
               <CustomField3
CustomField3

Custom field for grouping, sorting, categorizing and other purposes

>{String}</CustomField3>
15
               <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>
16
               <Weight
Weight

The weight of the product in kilograms.

>{Decimal}</Weight>
17
               <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>
18
               <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>
19
               <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>
20
               <MeasurementUnit
MeasurementUnit

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

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

>
21
                    <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

>{Integer}</MeasurementUnitId>
22
                    <Unit
Unit

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

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

>{String}</Unit>
23
                    <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

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

>{String}</MeasurementUnitLink>
24
               </MeasurementUnit>
25
               <Manufacturer
Manufacturer

Manufacturer of the product

>
26
                    <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
27
                    <ShortName
ShortName

Shortname/code of the manufacturer

>{String}</ShortName>
28
                    <ManufacturerLink
ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>
29
               </Manufacturer>
30
               <DefaultManufacturersProduct>
31
                    <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

>{Integer}</ManufacturersProductId>
32
                    <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=SearchResult.Product.DefaultManufacturersProduct.Name in your request URI to get this field

>{String}</Name>
33
                    <ManufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

>{String}</ManufacturersProductLink>
34
               </DefaultManufacturersProduct>
35
               <MainImage
MainImage

Main image of the product

>
36
                    <FileVersionId
FileVersionId

Version of the file

>{Integer}</FileVersionId>
37
                    <FileStorageUri
FileStorageUri

The url to download a file

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

>{String}</FileStorageUri>
38
                    <File>
39
                         <FileId
FileId

File identifier

>{Integer}</FileId>
40
                         <FileLink
FileLink

File reference

>{String}</FileLink>
41
                    </File>
42
                    <FileVersionLink
FileVersionLink

File version reference

>{String}</FileVersionLink>
43
               </MainImage>
44
               <Accounting>
45
                    <CostingMethod
CostingMethod

Costing method to use in accounting

Possible domain values can be found here

>{String}</CostingMethod>
46
               </Accounting>
47
               <LatestProductRevision>
48
                    <Revision
Revision

Revision number

>{String}</Revision>
49
               </LatestProductRevision>
50
               <ProductClassification
ProductClassification

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

>
51
                    <ProductClassificationId
ProductClassificationId

Product classification identifier

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

>{String}</ProductClassificationId>
52
                    <Name
Name

Name of product classification

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

>{String}</Name>
53
                    <ProductClassificationLink
ProductClassificationLink

Product classification reference

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

>{String}</ProductClassificationLink>
54
               </ProductClassification>
55
               <Production>
56
                    <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>
57
                    <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>
58
                    <PlanningCategory
PlanningCategory

Planning category

Possible domain values can be found here

>{String}</PlanningCategory>
59
                    <ManufacturingArea>
60
                         <ManufacturingAreaId
ManufacturingAreaId

Manufacturing area identifier

>{Integer}</ManufacturingAreaId>
61
                         <Name
Name

Name of manufacturing area

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

>{String}</Name>
62
                         <ManufacturingAreaLink
ManufacturingAreaLink

Manufacturing area reference

>{String}</ManufacturingAreaLink>
63
                    </ManufacturingArea>
64
               </Production>
65
               <Service>
66
                    <ServiceInterval
ServiceInterval

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

>
67
                         <ServiceIntervalId
ServiceIntervalId

Service interval identifier

>{Integer}</ServiceIntervalId>
68
                         <ServiceIntervalLink
ServiceIntervalLink

Service interval reference

>{String}</ServiceIntervalLink>
69
                    </ServiceInterval>
70
               </Service>
71
               <Sales>
72
                    <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>
73
                    <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>
74
                    <MinimumGrossMargin
MinimumGrossMargin

The minimum gross margin, in percent, for the product

>{Decimal}</MinimumGrossMargin>
75
                    <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>
76
                    <StandardLeadTime
StandardLeadTime

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

>{Integer}</StandardLeadTime>
77
                    <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=SearchResult.Product.Sales.ExclusivelyForCustomer in your request URI to get this field

>
78
                         <CustomerId
CustomerId

Customer identifier

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

>{Integer}</CustomerId>
79
                         <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=SearchResult.Product.Sales.ExclusivelyForCustomer in your request URI to get this field

>{String}</Name>
80
                         <CustomerLink
CustomerLink

Customer reference

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

>{String}</CustomerLink>
81
                    </ExclusivelyForCustomer>
82
               </Sales>
83
               <Stock>
84
                    <IsNonStock
IsNonStock

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

>{Boolean}</IsNonStock>
85
                    <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>
86
                    <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>
87
                    <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>
88
               </Stock>
89
               <Procurement>
90
                    <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>
91
               </Procurement>
92
               <ProductCollection>
93
                    <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
94
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
95
               </ProductCollection>
96
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
97
          </Product>
98
     </SearchResult>
99
     <Paging
Paging

Detailed paging information for this list.

>
100
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
101
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
102
          <Page
Page

Page index

>{Integer}</Page>
103
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
104
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
105
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
106
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
107
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
108
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
109
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
110
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
111
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
112
     </Paging>
113
</SearchResults>
1
{
2
     "searchResults": [
3
          {
4
               "title
Title

Title of search result. The content of this field is dependent on where the result was matched. If hit was in product name/description, title will be the name of the product. If hit was in customers product name, title will be the customers product name etc.

": "{String}",
5
               "in
In

Where this search result was found. Possible values here are PRODUCT, CUSTOMERSPRODUCTNAME, REPLACEMENTNAME and SUPPERLIERSPRODUCTNAME. Note that possible values will be affected by whats speified in the query parameter "in".

": "{String}",
6
               "product": {
7
                    "productId
ProductId

Product identifier

": "{Integer}",
8
                    "status
Status

Status of the product

Possible domain values can be found here

": "{Integer}",
9
                    "name
Name

Name of the product

": "{String}",
10
                    "type
Type

Type of product

Possible domain values can be found here

": "{String}",
11
                    "description
Description

Description of the product

": "{String}",
12
                    "externalReference
ExternalReference

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

": "{String}",
13
                    "customField1
CustomField1

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

": "{String}",
14
                    "customField2
CustomField2

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

": "{String}",
15
                    "customField3
CustomField3

Custom field for grouping, sorting, categorizing and other purposes

": "{String}",
16
                    "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}",
17
                    "weight
Weight

The weight of the product in kilograms.

": "{Decimal}",
18
                    "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}",
19
                    "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}",
20
                    "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}",
21
                    "measurementUnit
MeasurementUnit

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

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

": {
22
                         "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

": "{Integer}",
23
                         "unit
Unit

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

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

": "{String}",
24
                         "measurementUnitLink
MeasurementUnitLink

Material unit reference

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

": "{String}"
25
                    },
26
                    "manufacturer
Manufacturer

Manufacturer of the product

": {
27
                         "manufacturerId
ManufacturerId

Manufacturer identifier

": "{Integer}",
28
                         "shortName
ShortName

Shortname/code of the manufacturer

": "{String}",
29
                         "manufacturerLink
ManufacturerLink

Manufacturer reference

": "{String}"
30
                    },
31
                    "defaultManufacturersProduct": {
32
                         "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

": "{Integer}",
33
                         "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=SearchResult.Product.DefaultManufacturersProduct.Name in your request URI to get this field

": "{String}",
34
                         "manufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

": "{String}"
35
                    },
36
                    "mainImage
MainImage

Main image of the product

": {
37
                         "fileVersionId
FileVersionId

Version of the file

": "{Integer}",
38
                         "fileStorageUri
FileStorageUri

The url to download a file

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

": "{String}",
39
                         "file": {
40
                              "fileId
FileId

File identifier

": "{Integer}",
41
                              "fileLink
FileLink

File reference

": "{String}"
42
                         },
43
                         "fileVersionLink
FileVersionLink

File version reference

": "{String}"
44
                    },
45
                    "accounting": {
46
                         "costingMethod
CostingMethod

Costing method to use in accounting

Possible domain values can be found here

": "{String}"
47
                    },
48
                    "latestProductRevision": {
49
                         "revision
Revision

Revision number

": "{String}"
50
                    },
51
                    "productClassification
ProductClassification

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

": {
52
                         "productClassificationId
ProductClassificationId

Product classification identifier

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

": "{String}",
53
                         "name
Name

Name of product classification

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

": "{String}",
54
                         "productClassificationLink
ProductClassificationLink

Product classification reference

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

": "{String}"
55
                    },
56
                    "production": {
57
                         "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}",
58
                         "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}",
59
                         "planningCategory
PlanningCategory

Planning category

Possible domain values can be found here

": "{String}",
60
                         "manufacturingArea": {
61
                              "manufacturingAreaId
ManufacturingAreaId

Manufacturing area identifier

": "{Integer}",
62
                              "name
Name

Name of manufacturing area

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

": "{String}",
63
                              "manufacturingAreaLink
ManufacturingAreaLink

Manufacturing area reference

": "{String}"
64
                         }
65
                    },
66
                    "service": {
67
                         "serviceInterval
ServiceInterval

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

": {
68
                              "serviceIntervalId
ServiceIntervalId

Service interval identifier

": "{Integer}",
69
                              "serviceIntervalLink
ServiceIntervalLink

Service interval reference

": "{String}"
70
                         }
71
                    },
72
                    "sales": {
73
                         "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}",
74
                         "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}",
75
                         "minimumGrossMargin
MinimumGrossMargin

The minimum gross margin, in percent, for the product

": "{Decimal}",
76
                         "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}",
77
                         "standardLeadTime
StandardLeadTime

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

": "{Integer}",
78
                         "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=SearchResult.Product.Sales.ExclusivelyForCustomer in your request URI to get this field

": {
79
                              "customerId
CustomerId

Customer identifier

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

": "{Integer}",
80
                              "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=SearchResult.Product.Sales.ExclusivelyForCustomer in your request URI to get this field

": "{String}",
81
                              "customerLink
CustomerLink

Customer reference

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

": "{String}"
82
                         }
83
                    },
84
                    "stock": {
85
                         "isNonStock
IsNonStock

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

": "{Boolean}",
86
                         "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}",
87
                         "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}",
88
                         "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}"
89
                    },
90
                    "procurement": {
91
                         "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}"
92
                    },
93
                    "productCollection": {
94
                         "productId
ProductId

Product identifier

": "{Integer}",
95
                         "productLink
ProductLink

Product reference

": "{String}"
96
                    },
97
                    "productLink
ProductLink

Product reference

": "{String}"
98
               }
99
          }
100
     ],
101
     "paging
Paging

Detailed paging information for this list.

": {
102
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
103
          "position
Position

Position of the first element in the list

": "{Integer}",
104
          "page
Page

Page index

": "{Integer}",
105
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
106
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
107
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
108
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
109
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
110
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
111
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
112
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
113
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
114
     }
115
}

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 100204 HTTP 404 Manufacturer not found
Error 100055 HTTP 403 You have only admittance to your own objects