API

Sales APIs

GET sales/product-search?keywords={keywords}&in={in}&forObjectType={type}&forObjectId={id}&forQuantity={qty}

API resource for searching products. Note that quantity for calculating prices will get the default value 1 if omitted. If you provice forObjectType and forObjectId, you will get prices based on the customer and currency of the document.

HTTP method GET
URI https://api.rambase.net/sales/product-search?keywords={keywords}&in={in}&forObjectType={type}&forObjectId={id}&forQuantity={qty}
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 5354, version 6

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
forObjectType String, optional Type of object
forObjectId Integer, optional Identifier of the object

Minimum: 100000
forQuantity Decimal, optional Quantity used to calculate lowest and suggested prices.

Minimum: 0,
Default: 1
$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
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.
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.
TotalAvailableStockQuantity 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.
TotalStockQuantity 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

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
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
TotalAvailableStockQuantity 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
TotalStockQuantity 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
               <CustomField1
CustomField1

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

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

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

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

Custom field for grouping, sorting, categorizing and other purposes

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

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

>{String}</InternalNote>
15
               <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

>
16
                    <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>
17
                    <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>
18
                    <Precision
Precision

The precision/accuracy of the measurement (number of decimals)

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}</Precision>
19
                    <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>
20
               </MeasurementUnit>
21
               <Manufacturer
Manufacturer

Manufacturer of the product

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

>
22
                    <ManufacturerId
ManufacturerId

Manufacturer identifier

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

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

Shortname/code of the manufacturer

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

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

Manufacturer reference

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

>{String}</ManufacturerLink>
25
               </Manufacturer>
26
               <DefaultManufacturersProduct
DefaultManufacturersProduct

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

>
27
                    <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

>{Integer}</ManufacturersProductId>
28
                    <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 in your request URI to get this field

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

Manufacturers product reference

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

>{String}</ManufacturersProductLink>
30
               </DefaultManufacturersProduct>
31
               <MainImage
MainImage

Main image of the product

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

>
32
                    <FileVersionId
FileVersionId

Version of the file

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

>{Integer}</FileVersionId>
33
                    <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 in your request URI to get this field

>{String}</FileStorageUri>
34
                    <File
File

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

>
35
                         <FileId
FileId

File identifier

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

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

File reference

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

>{String}</FileLink>
37
                    </File>
38
                    <FileVersionLink
FileVersionLink

File version reference

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

>{String}</FileVersionLink>
39
               </MainImage>
40
               <Sales>
41
                    <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>
42
                    <MinimumGrossMargin
MinimumGrossMargin

The minimum gross margin, in percent, for the product

>{Decimal}</MinimumGrossMargin>
43
                    <StandardLeadTime
StandardLeadTime

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

>{Integer}</StandardLeadTime>
44
                    <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>
45
               </Sales>
46
               <Stock>
47
                    <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>
48
                    <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>
49
               </Stock>
50
               <ProductCollection>
51
                    <ProductId
ProductId

Product identifier

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

Product reference

>{String}</ProductLink>
53
               </ProductCollection>
54
               <LatestProductRevision>
55
                    <Revision
Revision

Revision number

>{String}</Revision>
56
               </LatestProductRevision>
57
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
58
          </Product>
59
          <ProductLocation
ProductLocation

When specifying object type and object id, we also have a product location we can show availbable stock quantity from

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

>
60
               <Location
Location

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

>
61
                    <ShortName
ShortName

Unique abbreviation/short name of the location

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

>{String}</ShortName>
62
               </Location>
63
               <Stock
Stock

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

>
64
                    <StockQuantity
StockQuantity

Quantity on hand. The total number of the product that are physically located in this location at the current time. This includes items that are already allocated to fulfilling production needs or sales orders. This number may differ from the available quantity.

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

>{Decimal}</StockQuantity>
65
                    <AvailableStockQuantity
AvailableStockQuantity

Quantity on hand which is not allocated. The total number of the product that are physically located in this location and are currently available for use in filling a new order or for purposes such as production or distribution.

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

>{Decimal}</AvailableStockQuantity>
66
               </Stock>
67
          </ProductLocation>
68
          <LowestPrice
LowestPrice

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

>
69
               <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
70
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

>{Decimal}</GrossPrice>
71
               <Discount
Discount

Discount price

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

>{Decimal}</Discount>
72
               <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

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

>{Decimal}</NetPrice>
73
               <BasedOn
BasedOn

Specifies what the lowest price was based on. Could be QUOTE, STANDARD or IPA.

Possible domain values can be found here

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

>{String}</BasedOn>
74
               <SalesQuoteItem
SalesQuoteItem

If the price is based on a sales quote, a reference to the related quote will be provided.

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

>
75
                    <SalesQuoteItemId
SalesQuoteItemId

Sales quote item identifier

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

>{Integer}</SalesQuoteItemId>
76
                    <SalesQuote
SalesQuote

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

>
77
                         <SalesQuoteId
SalesQuoteId

Sales quote identifier

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

>{Integer}</SalesQuoteId>
78
                         <SalesQuoteLink
SalesQuoteLink

Sales quote reference

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

>{String}</SalesQuoteLink>
79
                    </SalesQuote>
80
                    <SalesQuoteItemLink
SalesQuoteItemLink

Sales quote item referene

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

>{String}</SalesQuoteItemLink>
81
               </SalesQuoteItem>
82
          </LowestPrice>
83
          <Prices
Prices

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

>
84
               <Price
Price

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

>
85
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
86
                    <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

>{Decimal}</GrossPrice>
87
                    <Discount
Discount

Discount price

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

>{Decimal}</Discount>
88
                    <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

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

>{Decimal}</NetPrice>
89
                    <BasedOn
BasedOn

Specifies what the lowest price was based on. Could be QUOTE, STANDARD or IPA.

Possible domain values can be found here

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

>{String}</BasedOn>
90
                    <SalesQuoteItem
SalesQuoteItem

If the price is based on a sales quote, a reference to the related quote will be provided.

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

>
91
                         <SalesQuoteItemId
SalesQuoteItemId

Sales quote item identifier

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

>{Integer}</SalesQuoteItemId>
92
                         <RemainingQuantity
RemainingQuantity

Remaining number of units to be forwarded.

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

>{Decimal}</RemainingQuantity>
93
                         <SalesQuote
SalesQuote

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

>
94
                              <SalesQuoteId
SalesQuoteId

Sales quote identifier

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

>{Integer}</SalesQuoteId>
95
                              <SalesQuoteLink
SalesQuoteLink

Sales quote reference

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

>{String}</SalesQuoteLink>
96
                         </SalesQuote>
97
                         <SalesQuoteItemLink
SalesQuoteItemLink

Sales quote item referene

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

>{String}</SalesQuoteItemLink>
98
                    </SalesQuoteItem>
99
               </Price>
100
          </Prices>
101
     </SearchResult>
102
     <Paging
Paging

Detailed paging information for this list.

>
103
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
106
          <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>
107
          <FirstPage
FirstPage

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

>{String}</FirstPage>
108
          <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>
109
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
110
          <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>
111
          <NextPage
NextPage

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

>{String}</NextPage>
112
          <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>
113
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
115
     </Paging>
116
</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
                    "customField1
CustomField1

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

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

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

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

Custom field for grouping, sorting, categorizing and other purposes

": "{String}",
15
                    "internalNote
InternalNote

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

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

": {
17
                         "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}",
18
                         "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}",
19
                         "precision
Precision

The precision/accuracy of the measurement (number of decimals)

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}",
20
                         "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}"
21
                    },
22
                    "manufacturer
Manufacturer

Manufacturer of the product

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

": {
23
                         "manufacturerId
ManufacturerId

Manufacturer identifier

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

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

Shortname/code of the manufacturer

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

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

Manufacturer reference

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

": "{String}"
26
                    },
27
                    "defaultManufacturersProduct
DefaultManufacturersProduct

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

": {
28
                         "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

": "{Integer}",
29
                         "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 in your request URI to get this field

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

Manufacturers product reference

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

": "{String}"
31
                    },
32
                    "mainImage
MainImage

Main image of the product

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

": {
33
                         "fileVersionId
FileVersionId

Version of the file

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

": "{Integer}",
34
                         "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 in your request URI to get this field

": "{String}",
35
                         "file
File

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

": {
36
                              "fileId
FileId

File identifier

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

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

File reference

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

": "{String}"
38
                         },
39
                         "fileVersionLink
FileVersionLink

File version reference

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

": "{String}"
40
                    },
41
                    "sales": {
42
                         "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}",
43
                         "minimumGrossMargin
MinimumGrossMargin

The minimum gross margin, in percent, for the product

": "{Decimal}",
44
                         "standardLeadTime
StandardLeadTime

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

": "{Integer}",
45
                         "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}"
46
                    },
47
                    "stock": {
48
                         "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}",
49
                         "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}"
50
                    },
51
                    "productCollection": {
52
                         "productId
ProductId

Product identifier

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

Product reference

": "{String}"
54
                    },
55
                    "latestProductRevision": {
56
                         "revision
Revision

Revision number

": "{String}"
57
                    },
58
                    "productLink
ProductLink

Product reference

": "{String}"
59
               },
60
               "productLocation
ProductLocation

When specifying object type and object id, we also have a product location we can show availbable stock quantity from

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

": {
61
                    "location
Location

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

": {
62
                         "shortName
ShortName

Unique abbreviation/short name of the location

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

": "{String}"
63
                    },
64
                    "stock
Stock

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

": {
65
                         "stockQuantity
StockQuantity

Quantity on hand. The total number of the product that are physically located in this location at the current time. This includes items that are already allocated to fulfilling production needs or sales orders. This number may differ from the available quantity.

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

": "{Decimal}",
66
                         "availableStockQuantity
AvailableStockQuantity

Quantity on hand which is not allocated. The total number of the product that are physically located in this location and are currently available for use in filling a new order or for purposes such as production or distribution.

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

": "{Decimal}"
67
                    }
68
               },
69
               "lowestPrice
LowestPrice

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

": {
70
                    "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
71
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

": "{Decimal}",
72
                    "discount
Discount

Discount price

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

": "{Decimal}",
73
                    "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

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

": "{Decimal}",
74
                    "basedOn
BasedOn

Specifies what the lowest price was based on. Could be QUOTE, STANDARD or IPA.

Possible domain values can be found here

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

": "{String}",
75
                    "salesQuoteItem
SalesQuoteItem

If the price is based on a sales quote, a reference to the related quote will be provided.

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

": {
76
                         "salesQuoteItemId
SalesQuoteItemId

Sales quote item identifier

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

": "{Integer}",
77
                         "salesQuote
SalesQuote

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

": {
78
                              "salesQuoteId
SalesQuoteId

Sales quote identifier

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

": "{Integer}",
79
                              "salesQuoteLink
SalesQuoteLink

Sales quote reference

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

": "{String}"
80
                         },
81
                         "salesQuoteItemLink
SalesQuoteItemLink

Sales quote item referene

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

": "{String}"
82
                    }
83
               },
84
               "prices
Prices

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

": [
85
                    {
86
                         "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
87
                         "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

": "{Decimal}",
88
                         "discount
Discount

Discount price

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

": "{Decimal}",
89
                         "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

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

": "{Decimal}",
90
                         "basedOn
BasedOn

Specifies what the lowest price was based on. Could be QUOTE, STANDARD or IPA.

Possible domain values can be found here

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

": "{String}",
91
                         "salesQuoteItem
SalesQuoteItem

If the price is based on a sales quote, a reference to the related quote will be provided.

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

": {
92
                              "salesQuoteItemId
SalesQuoteItemId

Sales quote item identifier

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

": "{Integer}",
93
                              "remainingQuantity
RemainingQuantity

Remaining number of units to be forwarded.

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

": "{Decimal}",
94
                              "salesQuote
SalesQuote

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

": {
95
                                   "salesQuoteId
SalesQuoteId

Sales quote identifier

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

": "{Integer}",
96
                                   "salesQuoteLink
SalesQuoteLink

Sales quote reference

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

": "{String}"
97
                              },
98
                              "salesQuoteItemLink
SalesQuoteItemLink

Sales quote item referene

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

": "{String}"
99
                         }
100
                    }
101
               ]
102
          }
103
     ],
104
     "paging
Paging

Detailed paging information for this list.

": {
105
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
108
          "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}",
109
          "firstPage
FirstPage

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

": "{String}",
110
          "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}",
111
          "previousPage
PreviousPage

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

": "{String}",
112
          "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}",
113
          "nextPage
NextPage

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

": "{String}",
114
          "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}",
115
          "lastPage
LastPage

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

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

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

": "{Integer}"
117
     }
118
}

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 101013 HTTP 404 Sub-module not found
Error 102704 HTTP 404 Formula parameter was not found
Error 101420 HTTP 404 Setting definition not found
Error 102747 HTTP 400 Error in formula: {0}