API

Procurement APIs

GET procurement/distribution-requirements-by-product?locationId={locationId}

List out distribution requirements accumulated

HTTP method GET
URI https://api.rambase.net/procurement/distribution-requirements-by-product?locationId={locationId}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 7235, version 2

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.

locationId Integer, required Location identifier

Minimum: 10000
$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.

DeadlineNext3Months() Named filter Items that have a deadline date earlier than three months in advance Deadline date = Date when you need to place a purchase order to receive it in time for the requirement, calculated by subtracting leadtime from required date.
DeadlineNextMonth() Named filter Items that have a deadline date earlier than one month in advance Deadline date = Date when you need to place a purchase order to receive it in time for the requirement, calculated by subtracting leadtime from required date.
DeadlineNextTwoWeeks() Named filter Items that have a deadline date earlier than two weeks in advance Deadline date = Date when you need to place a purchase order to receive it in time for the requirement, calculated by subtracting leadtime from required date.
DeadlineOverdue() Named filter Items that have a deadline date earlier than today Deadline date = Date when you need to place a purchase order to receive it in time for the requirement, calculated by subtracting leadtime from required date.
SharedProducts() Named filter Specifies the product's sharing status with the shared product repository. Blank indicates a locally managed product with no sharing. Value 1 indicates the product is exported to shared products Value 2 indicates the product is imported from shared products
AdjustedRequirementQuantity Decimal Calculated requirement based on “Net requirement”, but adjusted for package size.
DeadlineDate Date The latest date for placing a distribution order for this product to receive it in time for the requirement. Calculated by subtracting leadtime from required date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
EarliestConsumptionDate Date The date when distribution requirement is needed. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
IsOutsideOfAssignmentWindow Boolean Indicates that this product is outside of assignment window.
LatestProductRevision String Revision number.
MeasurementUnit String Measurement unit (ex. mm, km, dl, kg).
NetRequirementQuantity Decimal Required quantity.
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductStatus Integer Status of the product.
ProductType String Type of product.
SourceLocationId Integer Location identifier.

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

AdjustedRequirementQuantity Decimal Calculated requirement based on “Net requirement”, but adjusted for package size
DeadlineDate Date The latest date for placing a distribution order for this product to receive it in time for the requirement. Calculated by subtracting leadtime from required date.
EarliestConsumptionDate Date The date when distribution requirement is needed
IsOutsideOfAssignmentWindow Boolean Indicates that this product is outside of assignment window
LatestProductRevision String Revision number
MeasurementUnit String Measurement unit (ex. mm, km, dl, kg)
NetRequirementQuantity Decimal Required quantity
ProductDescription String Description of the product
ProductId Integer Product identifier
ProductName String Name of the product
ProductStatus Integer Status of the product
ProductType String Type of product
SourceLocationId Integer Location 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
<DistributionRequirementsByProduct>
2
     <DistributionRequirementByProduct>
3
          <NetRequirementQuantity
NetRequirementQuantity

Required quantity

>{Decimal}</NetRequirementQuantity>
4
          <AdjustedRequirementQuantity
AdjustedRequirementQuantity

Calculated requirement based on “Net requirement”, but adjusted for package size

>{Decimal}</AdjustedRequirementQuantity>
5
          <EarliestConsumptionDate
EarliestConsumptionDate

The date when distribution requirement is needed

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

The latest date for placing a distribution order for this product to receive it in time for the requirement.
Calculated by subtracting leadtime from required date.

>{Date}</DeadlineDate>
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
               <MeasurementUnit
MeasurementUnit

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

>
14
                    <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

>{String}</Unit>
16
                    <Precision
Precision

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

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

Material unit reference

>{String}</MeasurementUnitLink>
18
               </MeasurementUnit>
19
               <LatestProductRevision
LatestProductRevision

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

>
20
                    <Revision
Revision

Revision number

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

>{String}</Revision>
21
               </LatestProductRevision>
22
               <SharedProduct>
23
                    <SharedProductsRelation
SharedProductsRelation

Specifies the product's sharing status with the shared product repository.

Blank indicates a locally managed product with no sharing.
Value 1 indicates the product is exported to shared products
Value 2 indicates the product is imported from shared products

Possible domain values can be found here

>{Integer}</SharedProductsRelation>
24
               </SharedProduct>
25
          </Product>
26
          <ProductLocation>
27
               <Location>
28
                    <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
29
                    <Name
Name

Name of warehouse location

>{String}</Name>
30
                    <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
31
                    <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
32
               </Location>
33
          </ProductLocation>
34
          <LocationSupply>
35
               <Source>
36
                    <Location>
37
                         <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
38
                         <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
39
                         <Name
Name

Name of warehouse location

>{String}</Name>
40
                         <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
41
                    </Location>
42
                    <Company>
43
                         <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
44
                         <Name
Name

Name of company

>{String}</Name>
45
                         <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
46
                         <CompanyLink
CompanyLink

Company reference

>{String}</CompanyLink>
47
                    </Company>
48
               </Source>
49
               <TransferLeadTime>
50
                    <HandlingDays
HandlingDays

Internal handling time. The number of days required by the source location, from when a distribution order is received until it is ready for shipment.

>{Integer}</HandlingDays>
51
                    <TransitDays
TransitDays

Transit time. The number of days a shipment takes to move from the source location to the destination location.

>{Integer}</TransitDays>
52
               </TransferLeadTime>
53
               <LocationSupplyLink
LocationSupplyLink

Intercompany relationship reference

>{String}</LocationSupplyLink>
54
          </LocationSupply>
55
     </DistributionRequirementByProduct>
56
     <Paging
Paging

Detailed paging information for this list.

>
57
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
60
          <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>
61
          <FirstPage
FirstPage

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

>{String}</FirstPage>
62
          <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>
63
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
64
          <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>
65
          <NextPage
NextPage

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

>{String}</NextPage>
66
          <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>
67
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
69
     </Paging>
70
</DistributionRequirementsByProduct>
1
{
2
     "distributionRequirementsByProduct": [
3
          {
4
               "netRequirementQuantity
NetRequirementQuantity

Required quantity

": "{Decimal}",
5
               "adjustedRequirementQuantity
AdjustedRequirementQuantity

Calculated requirement based on “Net requirement”, but adjusted for package size

": "{Decimal}",
6
               "earliestConsumptionDate
EarliestConsumptionDate

The date when distribution requirement is needed

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

The latest date for placing a distribution order for this product to receive it in time for the requirement.
Calculated by subtracting leadtime from required date.

": "{Date}",
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
                    "measurementUnit
MeasurementUnit

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

": {
15
                         "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

": "{String}",
17
                         "precision
Precision

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

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

Material unit reference

": "{String}"
19
                    },
20
                    "latestProductRevision
LatestProductRevision

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

": {
21
                         "revision
Revision

Revision number

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

": "{String}"
22
                    },
23
                    "sharedProduct": {
24
                         "sharedProductsRelation
SharedProductsRelation

Specifies the product's sharing status with the shared product repository.

Blank indicates a locally managed product with no sharing.
Value 1 indicates the product is exported to shared products
Value 2 indicates the product is imported from shared products

Possible domain values can be found here

": "{Integer}"
25
                    }
26
               },
27
               "productLocation": {
28
                    "location": {
29
                         "locationId
LocationId

Location identifier

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

Name of warehouse location

": "{String}",
31
                         "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
32
                         "locationLink
LocationLink

Location reference

": "{String}"
33
                    }
34
               },
35
               "locationSupply": {
36
                    "source": {
37
                         "location": {
38
                              "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Name of warehouse location

": "{String}",
41
                              "locationLink
LocationLink

Location reference

": "{String}"
42
                         },
43
                         "company": {
44
                              "companyId
CompanyId

Company identifier

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

Name of company

": "{String}",
46
                              "database
Database

Abbreviation/code to identify the company

": "{String}",
47
                              "companyLink
CompanyLink

Company reference

": "{String}"
48
                         }
49
                    },
50
                    "transferLeadTime": {
51
                         "handlingDays
HandlingDays

Internal handling time. The number of days required by the source location, from when a distribution order is received until it is ready for shipment.

": "{Integer}",
52
                         "transitDays
TransitDays

Transit time. The number of days a shipment takes to move from the source location to the destination location.

": "{Integer}"
53
                    },
54
                    "locationSupplyLink
LocationSupplyLink

Intercompany relationship reference

": "{String}"
55
               }
56
          }
57
     ],
58
     "paging
Paging

Detailed paging information for this list.

": {
59
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
71
     }
72
}

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: