API

Procurement APIs

GET procurement/products?search={search}&objectType={type}&objectId={id}&quantity={qty}&supplierId={sup}

List of all purchase products, with expanded/seperate rows for equivalent product names and supplier product names. The search query parameter searches for hits in product name, product description, equivalent product names and supplier product names.

HTTP method GET
URI https://api.rambase.net/procurement/products?search={search}&objectType={type}&objectId={id}&quantity={qty}&supplierId={sup}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 2848, version 10

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.

search String, optional Keyword to limit result set by searching in product name, product description, customer product name, supplier product name and equivalent product names.
objectType String, optional Type of object
objectId Integer, optional Identifier of the object

Minimum: 100000
quantity Decimal, optional Quantity used to calculate lowest standard price.

Minimum: 0
supplierId Integer, optional RamBase supplier identifier

Minimum: 100
$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"
$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
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.
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.
IsNonStock Boolean True if this is a non-physical product which are no using assignments from the assignment archive.
MeasurementUnitId Integer Measurement unit identifier.
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductInternalNote String Internal note regardig the product. Should not be exposed to customers.
ProductName String Name of the product.
ProductStatus Integer Status of the product.
ProductStockQuantity 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.
ProductType String Type of product.

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

MeasurementUnitId Integer Measurement unit identifier

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
<PurchaseProducts>
2
     <PurchaseProduct>
3
          <PurchaseProductId
PurchaseProductId

Purchase product identifier

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

>{String}</PurchaseProductId>
4
          <Type
Type

Type of purchase product. Possible values: PRODUCT, SUPPLIERPRODUCT or EQUIVALENT.

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

Will be the product name as specified in type. If type is PRODUCT, name will be the product name. If type EQUIVALENT, name will be the equivalent name. If type is SUPPLIERPRODUCT, name will the suppliers product name.

>{String}</Name>
6
          <HasMoreThanOnePurchasePrice
HasMoreThanOnePurchasePrice

True if the lowest price is not the only price

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

>{Boolean}</HasMoreThanOnePurchasePrice>
7
          <Product>
8
               <ProductId
ProductId

Product identifier

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

Status of the product

Possible domain values can be found here

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

>{String}</Description>
13
               <InternalNote
InternalNote

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

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

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

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

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

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

Custom field for grouping, sorting, categorizing and other purposes

>{String}</CustomField3>
17
               <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=PurchaseProduct.Product.MeasurementUnit in your request URI to get this field

>
18
                    <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

>{Integer}</MeasurementUnitId>
19
                    <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=PurchaseProduct.Product.MeasurementUnit in your request URI to get this field

>{String}</Unit>
20
                    <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=PurchaseProduct.Product.MeasurementUnit in your request URI to get this field

>{Integer}</Precision>
21
                    <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

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

>{String}</MeasurementUnitLink>
22
               </MeasurementUnit>
23
               <Manufacturer
Manufacturer

Manufacturer of the product

>
24
                    <ShortName
ShortName

Shortname/code of the manufacturer

>{String}</ShortName>
25
               </Manufacturer>
26
               <ProductLink
ProductLink

Product identifier

>{String}</ProductLink>
27
          </Product>
28
          <SuggestedPurchasePrice
SuggestedPurchasePrice

The suggested price for the purchase product. Unlike the lowest price, the suggested price might prioritizing purchase quotes or other documents before the price from the price list.

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

>
29
               <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=PurchaseProduct.SuggestedPurchasePrice in your request URI to get this field

>{String}</Currency>
30
               <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=PurchaseProduct.SuggestedPurchasePrice in your request URI to get this field

>{Decimal}</GrossPrice>
31
               <AssumingQuantity
AssumingQuantity

Quantity used to calculate price.

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

>{Decimal}</AssumingQuantity>
32
               <BasedOn
BasedOn

Specifies what the price is based on. Ex. STANDARD, QUOTE, QUOTEREQUEST etc.

Possible domain values can be found here

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

>{String}</BasedOn>
33
               <Item
Item

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

>
34
                    <ItemId
ItemId

Item-number of the object

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

>{Integer}</ItemId>
35
                    <ItemType
ItemType

Type of item

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

>{String}</ItemType>
36
                    <Object
Object

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

>
37
                         <ObjectId
ObjectId

Identifier of the object

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

>{Integer}</ObjectId>
38
                         <ObjectType
ObjectType

Type of object

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

>{String}</ObjectType>
39
                         <ObjectLink
ObjectLink

API reference to the object

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

>{String}</ObjectLink>
40
                    </Object>
41
                    <ItemLink
ItemLink

API reference to the item

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

>{String}</ItemLink>
42
               </Item>
43
          </SuggestedPurchasePrice>
44
          <LowestPurchasePrice
LowestPurchasePrice

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

>
45
               <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=PurchaseProduct.LowestPurchasePrice in your request URI to get this field

>{String}</Currency>
46
               <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=PurchaseProduct.LowestPurchasePrice in your request URI to get this field

>{Decimal}</GrossPrice>
47
               <AssumingQuantity
AssumingQuantity

Quantity used to calculate price.

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

>{Decimal}</AssumingQuantity>
48
               <BasedOn
BasedOn

Specifies what the price is based on. Ex. STANDARD, QUOTE, QUOTEREQUEST etc.

Possible domain values can be found here

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

>{String}</BasedOn>
49
          </LowestPurchasePrice>
50
     </PurchaseProduct>
51
     <Paging
Paging

Detailed paging information for this list.

>
52
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
55
          <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>
56
          <FirstPage
FirstPage

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

>{String}</FirstPage>
57
          <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>
58
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
59
          <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>
60
          <NextPage
NextPage

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

>{String}</NextPage>
61
          <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>
62
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
64
     </Paging>
65
</PurchaseProducts>
1
{
2
     "purchaseProducts": [
3
          {
4
               "purchaseProductId
PurchaseProductId

Purchase product identifier

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

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

Type of purchase product. Possible values: PRODUCT, SUPPLIERPRODUCT or EQUIVALENT.

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

Will be the product name as specified in type. If type is PRODUCT, name will be the product name. If type EQUIVALENT, name will be the equivalent name. If type is SUPPLIERPRODUCT, name will the suppliers product name.

": "{String}",
7
               "hasMoreThanOnePurchasePrice
HasMoreThanOnePurchasePrice

True if the lowest price is not the only price

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

": "{Boolean}",
8
               "product": {
9
                    "productId
ProductId

Product identifier

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

Status of the product

Possible domain values can be found here

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

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

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

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

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

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

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

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

Custom field for grouping, sorting, categorizing and other purposes

": "{String}",
18
                    "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=PurchaseProduct.Product.MeasurementUnit in your request URI to get this field

": {
19
                         "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

": "{Integer}",
20
                         "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=PurchaseProduct.Product.MeasurementUnit in your request URI to get this field

": "{String}",
21
                         "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=PurchaseProduct.Product.MeasurementUnit in your request URI to get this field

": "{Integer}",
22
                         "measurementUnitLink
MeasurementUnitLink

Material unit reference

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

": "{String}"
23
                    },
24
                    "manufacturer
Manufacturer

Manufacturer of the product

": {
25
                         "shortName
ShortName

Shortname/code of the manufacturer

": "{String}"
26
                    },
27
                    "productLink
ProductLink

Product identifier

": "{String}"
28
               },
29
               "suggestedPurchasePrice
SuggestedPurchasePrice

The suggested price for the purchase product. Unlike the lowest price, the suggested price might prioritizing purchase quotes or other documents before the price from the price list.

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

": {
30
                    "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=PurchaseProduct.SuggestedPurchasePrice in your request URI to get this field

": "{String}",
31
                    "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=PurchaseProduct.SuggestedPurchasePrice in your request URI to get this field

": "{Decimal}",
32
                    "assumingQuantity
AssumingQuantity

Quantity used to calculate price.

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

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

Specifies what the price is based on. Ex. STANDARD, QUOTE, QUOTEREQUEST etc.

Possible domain values can be found here

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

": "{String}",
34
                    "item
Item

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

": {
35
                         "itemId
ItemId

Item-number of the object

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

": "{Integer}",
36
                         "itemType
ItemType

Type of item

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

": "{String}",
37
                         "object
Object

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

": {
38
                              "objectId
ObjectId

Identifier of the object

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

": "{Integer}",
39
                              "objectType
ObjectType

Type of object

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

": "{String}",
40
                              "objectLink
ObjectLink

API reference to the object

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

": "{String}"
41
                         },
42
                         "itemLink
ItemLink

API reference to the item

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

": "{String}"
43
                    }
44
               },
45
               "lowestPurchasePrice
LowestPurchasePrice

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

": {
46
                    "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=PurchaseProduct.LowestPurchasePrice in your request URI to get this field

": "{String}",
47
                    "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=PurchaseProduct.LowestPurchasePrice in your request URI to get this field

": "{Decimal}",
48
                    "assumingQuantity
AssumingQuantity

Quantity used to calculate price.

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

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

Specifies what the price is based on. Ex. STANDARD, QUOTE, QUOTEREQUEST etc.

Possible domain values can be found here

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

": "{String}"
50
               }
51
          }
52
     ],
53
     "paging
Paging

Detailed paging information for this list.

": {
54
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
66
     }
67
}

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 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}
Error 101420 HTTP 404 Setting definition not found