Product APIs
Stock by period specified in the groupBy parameter. Default period is week.
| HTTP method | GET |
| URI | https://api.rambase.net/product/products/{productId}/stock-by-period?groupBy={groupBy}&locationId={locationId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productId} |
Product identifier
Integer, minimum 10000 |
| Successful HTTP status code | 200 |
| API resource identifier | 4879, version 3 |
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.
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.
| groupBy String, optional |
Can be day, week or month.
Default: WEEK |
| locationId Integer, optional |
Location identifier
Minimum: 10000 |
| $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.
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.
Period
What the stock forecast is grouped by. Can be date, week or month. The forecasts is by default grouped by week.
>{String}</Period>AvailableStockQuantity
Available stock quantity at the end of the period. Calculated by subtracting total supply quantity from total demand quantity. This quantity might be negative, which indicates that you have more demands than supplies.
>{Decimal}</AvailableStockQuantity>SalesOrderQuantity
Quantity demanded from sales order items in status 2 to 8
>{Decimal}</SalesOrderQuantity>ServiceOrderQuantity
Quantity demanded by service orders in status 2 to 8
>{Decimal}</ServiceOrderQuantity>GoodsTransferQuantity
Quantity demanded for sending (or sent) goods transfers (status less than 9)
>{Decimal}</GoodsTransferQuantity>ShippingAdviceQuantity
Quantity demanded for unsent shipping advices (status 3 or lower)
>{Decimal}</ShippingAdviceQuantity>SupplierReturnQuantity
Quantity demanded for unsent supplier returns (status 3 or lower)
>{Decimal}</SupplierReturnQuantity>StockAdjustmentQuantity
Quantity demanded for unregistered stock adjustments reducing the stock (status less than 9)
>{Decimal}</StockAdjustmentQuantity>SalesQuoteBufferStockQuantity
Quantity demanded as buffer stock quantity in sales quotes
>{Decimal}</SalesQuoteBufferStockQuantity>UnpickedQuantity
Unpicked quantity demanded for production work orders
>{Decimal}</UnpickedQuantity>PickedQuantity
Picked quantity demanded for production work orders
>{Decimal}</PickedQuantity>ReservedQuantity
Quantity demanded by reserving quantity in purchase orders, purchase order responses or goods receptions.
>{Decimal}</ReservedQuantity>BlockedStockQuantity
Quantity demanded by blocking stock quantity in stock locations (blocked for assignments)
>{Decimal}</BlockedStockQuantity>TotalDemandQuantity
Sum of demanded quantities for this period.
>{Decimal}</TotalDemandQuantity>StockQuantity
Quantity supplied from stock. Calculated stock balance at the start of the period. This calculation initially reads stock quantity from goods receptions and then adds available quantity from earlier stock periods.
>{Decimal}</StockQuantity>UnregisteredQuantity
Quantity supplied by purchase orders pending registration
>{Decimal}</UnregisteredQuantity>RegisteredQuantity
Quantity supplied by registered purchase orders (status 3 or higher)
>{Decimal}</RegisteredQuantity>UnconfirmedQuantity
Quantity supplied by purchase order responses without confirmed delivery date
>{Decimal}</UnconfirmedQuantity>ConfirmedQuantity
Quantity supplier by purchase order responses with confirmed delivery date
>{Decimal}</ConfirmedQuantity>UnconfirmedQuantity
Quantity supplier by production work orders without confirmed delivery date
>{Decimal}</UnconfirmedQuantity>ConfirmedQuantity
Quantity supplier by production work orders with confirmed delivery date
>{Decimal}</ConfirmedQuantity>TotalSupplyQuantity
Sum of supplied quantities for this period.
>{Decimal}</TotalSupplyQuantity>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>Period
What the stock forecast is grouped by. Can be date, week or month. The forecasts is by default grouped by week.
": "{String}",AvailableStockQuantity
Available stock quantity at the end of the period. Calculated by subtracting total supply quantity from total demand quantity. This quantity might be negative, which indicates that you have more demands than supplies.
": "{Decimal}",SalesOrderQuantity
Quantity demanded from sales order items in status 2 to 8
": "{Decimal}",ServiceOrderQuantity
Quantity demanded by service orders in status 2 to 8
": "{Decimal}",GoodsTransferQuantity
Quantity demanded for sending (or sent) goods transfers (status less than 9)
": "{Decimal}",ShippingAdviceQuantity
Quantity demanded for unsent shipping advices (status 3 or lower)
": "{Decimal}",SupplierReturnQuantity
Quantity demanded for unsent supplier returns (status 3 or lower)
": "{Decimal}",StockAdjustmentQuantity
Quantity demanded for unregistered stock adjustments reducing the stock (status less than 9)
": "{Decimal}",SalesQuoteBufferStockQuantity
Quantity demanded as buffer stock quantity in sales quotes
": "{Decimal}",UnpickedQuantity
Unpicked quantity demanded for production work orders
": "{Decimal}",PickedQuantity
Picked quantity demanded for production work orders
": "{Decimal}"ReservedQuantity
Quantity demanded by reserving quantity in purchase orders, purchase order responses or goods receptions.
": "{Decimal}",BlockedStockQuantity
Quantity demanded by blocking stock quantity in stock locations (blocked for assignments)
": "{Decimal}",TotalDemandQuantity
Sum of demanded quantities for this period.
": "{Decimal}"StockQuantity
Quantity supplied from stock. Calculated stock balance at the start of the period. This calculation initially reads stock quantity from goods receptions and then adds available quantity from earlier stock periods.
": "{Decimal}",UnregisteredQuantity
Quantity supplied by purchase orders pending registration
": "{Decimal}",RegisteredQuantity
Quantity supplied by registered purchase orders (status 3 or higher)
": "{Decimal}"UnconfirmedQuantity
Quantity supplied by purchase order responses without confirmed delivery date
": "{Decimal}",ConfirmedQuantity
Quantity supplier by purchase order responses with confirmed delivery date
": "{Decimal}"UnconfirmedQuantity
Quantity supplier by production work orders without confirmed delivery date
": "{Decimal}",ConfirmedQuantity
Quantity supplier by production work orders with confirmed delivery date
": "{Decimal}"TotalSupplyQuantity
Sum of supplied quantities for this period.
": "{Decimal}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 100089 HTTP 404 | Product not found |
| Error 100199 HTTP 404 | Location not found |