API

Procurement APIs

GET procurement/order-suggestions/{purchaseOrderSuggestionId}

Purchase order suggestions details for provided identifier

HTTP method GET
URI https://api.rambase.net/procurement/order-suggestions/{purchaseOrderSuggestionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {purchaseOrderSuggestionId} Purchase order suggestion identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 3407, version 8

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.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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
<PurchaseOrderSuggestion>
2
     <PurchaseOrderSuggestionId
PurchaseOrderSuggestionId

Purchase order suggestion identifier

>{Integer}</PurchaseOrderSuggestionId>
3
     <Status
Status

Status of purchase order suggestion

Possible domain values can be found here

>{Integer}</Status>
4
     <RequestedDeliveryDate
RequestedDeliveryDate

Requested delivery date

>{Date}</RequestedDeliveryDate>
5
     <DeadlineDate
DeadlineDate

Deadline for purchasing product from supplier. Calculated by subtracting leadtime from requested delivery date

>{Date}</DeadlineDate>
6
     <LeadTime
LeadTime

Lead time for product and suggested supplier

>{Integer}</LeadTime>
7
     <SuppliersProductName
SuppliersProductName

Suppliers product name

>{String}</SuppliersProductName>
8
     <Quantity
Quantity

Quantity suggested to purchase

>{Decimal}</Quantity>
9
     <Requirement>
10
          <GrossQuantity
GrossQuantity

The gross demand for supplier, product and requested delivery date.

>{Decimal}</GrossQuantity>
11
          <SubtractedQuantity
SubtractedQuantity

Quantity from open purchase orders and purchase order responses subtracted from the gross demand quantity to get the net demand quantity.

>{Decimal}</SubtractedQuantity>
12
          <NetQuantity
NetQuantity

Net demand quantity for this product, supplier and requested delivery date. The net quantity is the current demand, and will be the base for creating the quantity of the purchase order suggestion.

>{Decimal}</NetQuantity>
13
     </Requirement>
14
     <Supplier>
15
          <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
16
          <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>{String}</Name>
17
          <MinimumOrderQuantity
MinimumOrderQuantity

A minimum order quantity (MOQ) is the lowest set amount of stock that a supplier is willing to sell. If you can’t purchase the MOQ of a specific product, then the supplier won’t sell it to you. Also note that if purchase quantity exceeds the MOQ, the purchase quantity should always be in multiple of the MOQ.

>{Integer}</MinimumOrderQuantity>
18
          <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
19
     </Supplier>
20
     <SOPProcess>
21
          <SOPProcessId
SOPProcessId

S&OP (sales and operation planning) process identifier

>{Integer}</SOPProcessId>
22
          <SOPProcessLink
SOPProcessLink

S&OP (salse and operation planning) process reference

>{String}</SOPProcessLink>
23
     </SOPProcess>
24
     <Product>
25
          <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
26
          <Type
Type

Type of product

Possible domain values can be found here

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

Name of the product

>{String}</Name>
28
          <Description
Description

Description of the product

>{String}</Description>
29
          <Procurement>
30
               <BlockedForPurchase
BlockedForPurchase

If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.

>{Boolean}</BlockedForPurchase>
31
          </Procurement>
32
          <MeasurementUnit
MeasurementUnit

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

>
33
               <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
36
          </MeasurementUnit>
37
          <Package>
38
               <PalletQuantity
PalletQuantity

Total quantity of the product that can be on a pallet

>{Integer}</PalletQuantity>
39
               <PackageQuantity
PackageQuantity

Total quantity of the product within a package

>{Integer}</PackageQuantity>
40
               <PackageType
PackageType

Type of wrapping used for the package

Possible domain values can be found here

>{String}</PackageType>
41
          </Package>
42
          <LatestProductRevision>
43
               <Revision
Revision

Revision number

>{String}</Revision>
44
          </LatestProductRevision>
45
          <Production>
46
               <PlanningCategory
PlanningCategory

Planning category

Possible domain values can be found here

>{String}</PlanningCategory>
47
               <ProduceInMultipleOf
ProduceInMultipleOf

Quantity to procude in multiple of. Ex. if set to 2, you can only produce 2, 4, 6 etc.

>{Integer}</ProduceInMultipleOf>
48
               <ManufacturingArea>
49
                    <Name
Name

Name of manufacturing area

>{String}</Name>
50
               </ManufacturingArea>
51
          </Production>
52
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
53
     </Product>
54
     <ProductLocation>
55
          <Location>
56
               <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
57
               <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
58
          </Location>
59
          <Procurement>
60
               <ReorderQuantity
ReorderQuantity

Preferred quantity to use when reordering to this location. Is also used as order quantity when stock gets below reorder point.

>{Decimal}</ReorderQuantity>
61
               <ReorderPoint
ReorderPoint

A minimum amount of quantity which a location holds in stock, such that, when stock falls to this amount, the product must be reordered.

>{Decimal}</ReorderPoint>
62
          </Procurement>
63
          <Production>
64
               <MinimumWorkOrderQuantity
MinimumWorkOrderQuantity

Minimum ProductionOrder quantity to a production

>{Decimal}</MinimumWorkOrderQuantity>
65
          </Production>
66
     </ProductLocation>
67
     <Manufacturer>
68
          <ManufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
71
     </Manufacturer>
72
     <ManufacturersProduct
ManufacturersProduct

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

>
73
          <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

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

Manufacturers product reference

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

>{String}</ManufacturersProductLink>
76
     </ManufacturersProduct>
77
     <Price>
78
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

Gross price for the purchase order suggestion

>{Decimal}</GrossPrice>
80
     </Price>
81
     <Totals>
82
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
83
          <GrossAmount
GrossAmount

Gross amount for the purchase order suggestion

>{Decimal}</GrossAmount>
84
     </Totals>
85
</PurchaseOrderSuggestion>
1
{
2
     "purchaseOrderSuggestion": {
3
          "purchaseOrderSuggestionId
PurchaseOrderSuggestionId

Purchase order suggestion identifier

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

Status of purchase order suggestion

Possible domain values can be found here

": "{Integer}",
5
          "requestedDeliveryDate
RequestedDeliveryDate

Requested delivery date

": "{Date}",
6
          "deadlineDate
DeadlineDate

Deadline for purchasing product from supplier. Calculated by subtracting leadtime from requested delivery date

": "{Date}",
7
          "leadTime
LeadTime

Lead time for product and suggested supplier

": "{Integer}",
8
          "suppliersProductName
SuppliersProductName

Suppliers product name

": "{String}",
9
          "quantity
Quantity

Quantity suggested to purchase

": "{Decimal}",
10
          "requirement": {
11
               "grossQuantity
GrossQuantity

The gross demand for supplier, product and requested delivery date.

": "{Decimal}",
12
               "subtractedQuantity
SubtractedQuantity

Quantity from open purchase orders and purchase order responses subtracted from the gross demand quantity to get the net demand quantity.

": "{Decimal}",
13
               "netQuantity
NetQuantity

Net demand quantity for this product, supplier and requested delivery date. The net quantity is the current demand, and will be the base for creating the quantity of the purchase order suggestion.

": "{Decimal}"
14
          },
15
          "supplier": {
16
               "supplierId
SupplierId

RamBase supplier identifier

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

Name of supplier (name of company or surname/familyname/lastname of a person)

": "{String}",
18
               "minimumOrderQuantity
MinimumOrderQuantity

A minimum order quantity (MOQ) is the lowest set amount of stock that a supplier is willing to sell. If you can’t purchase the MOQ of a specific product, then the supplier won’t sell it to you. Also note that if purchase quantity exceeds the MOQ, the purchase quantity should always be in multiple of the MOQ.

": "{Integer}",
19
               "supplierLink
SupplierLink

Supplier reference

": "{String}"
20
          },
21
          "sOPProcess": {
22
               "sOPProcessId
SOPProcessId

S&OP (sales and operation planning) process identifier

": "{Integer}",
23
               "sOPProcessLink
SOPProcessLink

S&OP (salse and operation planning) process reference

": "{String}"
24
          },
25
          "product": {
26
               "productId
ProductId

Product identifier

": "{Integer}",
27
               "type
Type

Type of product

Possible domain values can be found here

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

Name of the product

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

Description of the product

": "{String}",
30
               "procurement": {
31
                    "blockedForPurchase
BlockedForPurchase

If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.

": "{Boolean}"
32
               },
33
               "measurementUnit
MeasurementUnit

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

": {
34
                    "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

Material unit reference

": "{String}"
37
               },
38
               "package": {
39
                    "palletQuantity
PalletQuantity

Total quantity of the product that can be on a pallet

": "{Integer}",
40
                    "packageQuantity
PackageQuantity

Total quantity of the product within a package

": "{Integer}",
41
                    "packageType
PackageType

Type of wrapping used for the package

Possible domain values can be found here

": "{String}"
42
               },
43
               "latestProductRevision": {
44
                    "revision
Revision

Revision number

": "{String}"
45
               },
46
               "production": {
47
                    "planningCategory
PlanningCategory

Planning category

Possible domain values can be found here

": "{String}",
48
                    "produceInMultipleOf
ProduceInMultipleOf

Quantity to procude in multiple of. Ex. if set to 2, you can only produce 2, 4, 6 etc.

": "{Integer}",
49
                    "manufacturingArea": {
50
                         "name
Name

Name of manufacturing area

": "{String}"
51
                    }
52
               },
53
               "productLink
ProductLink

Product reference

": "{String}"
54
          },
55
          "productLocation": {
56
               "location": {
57
                    "locationId
LocationId

Location identifier

": "{Integer}",
58
                    "locationLink
LocationLink

Location reference

": "{String}"
59
               },
60
               "procurement": {
61
                    "reorderQuantity
ReorderQuantity

Preferred quantity to use when reordering to this location. Is also used as order quantity when stock gets below reorder point.

": "{Decimal}",
62
                    "reorderPoint
ReorderPoint

A minimum amount of quantity which a location holds in stock, such that, when stock falls to this amount, the product must be reordered.

": "{Decimal}"
63
               },
64
               "production": {
65
                    "minimumWorkOrderQuantity
MinimumWorkOrderQuantity

Minimum ProductionOrder quantity to a production

": "{Decimal}"
66
               }
67
          },
68
          "manufacturer": {
69
               "manufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
72
          },
73
          "manufacturersProduct
ManufacturersProduct

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

": {
74
               "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

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

Manufacturers product reference

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

": "{String}"
77
          },
78
          "price": {
79
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

Gross price for the purchase order suggestion

": "{Decimal}"
81
          },
82
          "totals": {
83
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
84
               "grossAmount
GrossAmount

Gross amount for the purchase order suggestion

": "{Decimal}"
85
          }
86
     }
87
}

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