API

Procurement APIs

GET procurement/products/{purchaseProductId}

Details for purchase product, including a list of all purchase prices available for this purchase product.

HTTP method GET
URI https://api.rambase.net/procurement/products/{purchaseProductId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {purchaseProductId} Expanded product identifier
String
Successful HTTP status code 200
API resource identifier 2850, version 1

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.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

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

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<PurchaseProduct>
2
     <PurchaseProductId
PurchaseProductId

Purchase product identifier

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

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

>{String}</Type>
4
     <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>
5
     <HasMoreThanOnePurchasePrice
HasMoreThanOnePurchasePrice

True if the lowest price is not the only price

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

Product identifier

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

Status of the product

Possible domain values can be found here

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

Name of the product

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

Type of product

Possible domain values can be found here

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

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

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

Description of the product

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

Manufacturer of the product

>
14
               <ShortName
ShortName

Shortname/code of the manufacturer

>{String}</ShortName>
15
          </Manufacturer>
16
          <ProductLink
ProductLink

Product identifier

>{String}</ProductLink>
17
     </Product>
18
     <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=SuggestedPurchasePrice in your request URI to get this field

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

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

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

Quantity used to calculate price.

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

>{Decimal}</AssumingQuantity>
22
          <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=SuggestedPurchasePrice in your request URI to get this field

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

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

>
24
               <ItemId
ItemId

Item-number of the object

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

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

Type of item

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

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

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

>
27
                    <ObjectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

API reference to the object

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

>{String}</ObjectLink>
30
               </Object>
31
               <ItemLink
ItemLink

API reference to the item

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

>{String}</ItemLink>
32
          </Item>
33
     </SuggestedPurchasePrice>
34
     <LowestPurchasePrice
LowestPurchasePrice

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

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

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

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

Quantity used to calculate price.

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

>{Decimal}</AssumingQuantity>
38
          <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=LowestPurchasePrice in your request URI to get this field

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

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

>
40
               <ItemId
ItemId

Item-number of the object

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

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

Type of item

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

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

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

>
43
                    <ObjectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

API reference to the object

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

>{String}</ObjectLink>
46
               </Object>
47
               <ItemLink
ItemLink

API reference to the item

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

>{String}</ItemLink>
48
          </Item>
49
     </LowestPurchasePrice>
50
     <PurchasePrices>
51
          <PurchasePrice>
52
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

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

Quantity used to calculate price.

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

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

Possible domain values can be found here

>{String}</BasedOn>
56
               <Item>
57
                    <ItemId
ItemId

Item-number of the object

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

Type of item

>{String}</ItemType>
59
                    <Object>
60
                         <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

>{String}</ObjectLink>
63
                    </Object>
64
                    <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
65
               </Item>
66
          </PurchasePrice>
67
     </PurchasePrices>
68
</PurchaseProduct>
1
{
2
     "purchaseProduct": {
3
          "purchaseProductId
PurchaseProductId

Purchase product identifier

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

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

": "{String}",
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}",
6
          "hasMoreThanOnePurchasePrice
HasMoreThanOnePurchasePrice

True if the lowest price is not the only price

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

Product identifier

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

Status of the product

Possible domain values can be found here

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

Name of the product

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

Type of product

Possible domain values can be found here

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

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

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

Description of the product

": "{String}",
14
               "manufacturer
Manufacturer

Manufacturer of the product

": {
15
                    "shortName
ShortName

Shortname/code of the manufacturer

": "{String}"
16
               },
17
               "productLink
ProductLink

Product identifier

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

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

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

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

Quantity used to calculate price.

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

": "{Decimal}",
23
               "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=SuggestedPurchasePrice in your request URI to get this field

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

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

": {
25
                    "itemId
ItemId

Item-number of the object

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

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

Type of item

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

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

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

": {
28
                         "objectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

API reference to the object

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

": "{String}"
31
                    },
32
                    "itemLink
ItemLink

API reference to the item

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

": "{String}"
33
               }
34
          },
35
          "lowestPurchasePrice
LowestPurchasePrice

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

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

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

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

Quantity used to calculate price.

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

": "{Decimal}",
39
               "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=LowestPurchasePrice in your request URI to get this field

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

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

": {
41
                    "itemId
ItemId

Item-number of the object

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

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

Type of item

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

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

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

": {
44
                         "objectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

API reference to the object

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

": "{String}"
47
                    },
48
                    "itemLink
ItemLink

API reference to the item

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

": "{String}"
49
               }
50
          },
51
          "purchasePrices": [
52
               {
53
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

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

Quantity used to calculate price.

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

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

Possible domain values can be found here

": "{String}",
57
                    "item": {
58
                         "itemId
ItemId

Item-number of the object

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

Type of item

": "{String}",
60
                         "object": {
61
                              "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

": "{String}"
64
                         },
65
                         "itemLink
ItemLink

API reference to the item

": "{String}"
66
                    }
67
               }
68
          ]
69
     }
70
}

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