Procurement APIs
Details of provided S&OP (sales and operation planning) process
| HTTP method | GET |
| URI | https://api.rambase.net/procurement/sop-processes/{sopProcessId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {sopProcessId} |
S&OP (sales and operation planning) process identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 3377, version 30 |
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.
| $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. |
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.
SOPProcessId
S&OP (sales and operation planning) process identifier
>{Integer}</SOPProcessId>Status
Status of S&OP (sales and production planning) process
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Name
Name of S&OP (Sales and operation planning) process
>{String}</Name>Description
Description of S&OP (Sales and operations planning) process
>{String}</Description>Granularity
Granularity used to present the different plans in the S&OP process. Week or month.
Possible domain values can be found here
>{String}</Granularity>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>Name
Name of warehouse location
>{String}</Name>LocationLink
Location reference
>{String}</LocationLink>BatchJobId
Batch job identifier
>{Integer}</BatchJobId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>StartedAt
Date and time of the batch job start
>{Datetime}</StartedAt>FinishedAt
Enddate and endtime of the batch job
>{Datetime}</FinishedAt>BatchJobLink
Batch job reference
>{String}</BatchJobLink>UpdatedAt
Date and time demand forecasts were created
>{Datetime}</UpdatedAt>IncludeSalesBacklog
If sales backlog is included, everything from the backlog is added to the demand forecast. Note that backlog from products sales forecasted by customers (through the sales forecast source), will not be included.
>{Boolean}</IncludeSalesBacklog>SalesBacklogExclusion
This field will only have any effect if the “include sales backlog” option is set.
The default (Exclude nothing) is that sales backlog for the same customer and product that exist in the sales forecast will be excluded from the sales and operation planning. This field is used to fine tune what will be included or not from the sales backlog.
Possible domain values can be found here
>{Integer}</SalesBacklogExclusion>IncludeReOrderPointForPurchase
If products which are purchased have specified re-order point for the location used in the S&OP process, the re-order point will be added as a demand. This will then be included in the gross quantity of the purchase requirements. Note that this also includes products with product structures manufactured externally.
>{Boolean}</IncludeReOrderPointForPurchase>IncludeReOrderPointForProduction
If products which are manufactured have specified re-order point quantity for the location used in the S&OP process, the re-order point quantity will be added as a demand. This will then be included in the gross quantity of the production requirements. Note that this does not includes products with product structures manufactured externally.
>{Boolean}</IncludeReOrderPointForProduction>SalesForecastSource
The source to use from the sales forecast
Possible domain values can be found here
>{Integer}</SalesForecastSource>MinimumProbabilityPercent
Minimum probability in percentage to include from the sales forecast
>{Decimal}</MinimumProbabilityPercent>MaximumProbabilityPercent
Maximum probability in percentage to include from the sales forecast
>{Decimal}</MaximumProbabilityPercent>UpdatedAt
Date and time production requirements were updated for this S&OP process
>{Datetime}</UpdatedAt>TreatProductionWorkOrdersAsStock
By enabling this, existing, but not completed, production work orders will be treated as stock. Any production work orders can be used to net off production requirements. By not enabling this, you might end up with creating new production work orders instead off replanning already existing production work orders.
>{Boolean}</TreatProductionWorkOrdersAsStock>UpdatedAt
Date and time purchase requirements was updated in this S&OP process
>{Datetime}</UpdatedAt>TreatSupplierBacklogAsStock
By enabling this all purchase orders and purchase order responses will be treated as stock. Any purchase orders and purchase order responses confirmed in the future (ex. in two months) is available from today and can be used to net off purchase requirements. By not enabling this, you might end up with purchasing products that could instead be aquired by requesting change of delivery date on existing supplier backlog.
>{Boolean}</TreatSupplierBacklogAsStock>RequireMaterialsFromAllProductionWorkOrders
By enabling this option, materials from ALL ongoing- and planned production work orders are included as gross purchase requirements. This means that you might get purchase requirements for materials belonging to production work orders not related to the production requirement plan.
If this option is disabled, only materials needed to fulfill the production requirements are included as gross purchase requirements. Note that even if this option is disabled you will still get purchase requirements for materials in ongoing- and planned production work orders consumed by (net off) the production requirements.
UpdatedAt
Date and time purchase order suggestions were updated for this S&OP process
>{Datetime}</UpdatedAt>RequestedDeliveryDay
Preferred day of delivery. Used to consolidate purchase order suggestions. Default is all days.
Possible domain values can be found here
>{Integer}</RequestedDeliveryDay>SOPProcessId
S&OP (sales and operation planning) process identifier
": "{Integer}",Status
Status of S&OP (sales and production planning) process
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Name
Name of S&OP (Sales and operation planning) process
": "{String}",Description
Description of S&OP (Sales and operations planning) process
": "{String}",Granularity
Granularity used to present the different plans in the S&OP process. Week or month.
Possible domain values can be found here
": "{String}",LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",Name
Name of warehouse location
": "{String}",LocationLink
Location reference
": "{String}"BatchJobId
Batch job identifier
": "{Integer}",Status
Status of batch job
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",StartedAt
Date and time of the batch job start
": "{Datetime}",FinishedAt
Enddate and endtime of the batch job
": "{Datetime}",BatchJobLink
Batch job reference
": "{String}"UpdatedAt
Date and time demand forecasts were created
": "{Datetime}",IncludeSalesBacklog
If sales backlog is included, everything from the backlog is added to the demand forecast. Note that backlog from products sales forecasted by customers (through the sales forecast source), will not be included.
": "{Boolean}",SalesBacklogExclusion
This field will only have any effect if the “include sales backlog” option is set.
The default (Exclude nothing) is that sales backlog for the same customer and product that exist in the sales forecast will be excluded from the sales and operation planning. This field is used to fine tune what will be included or not from the sales backlog.
Possible domain values can be found here
": "{Integer}",IncludeReOrderPointForPurchase
If products which are purchased have specified re-order point for the location used in the S&OP process, the re-order point will be added as a demand. This will then be included in the gross quantity of the purchase requirements. Note that this also includes products with product structures manufactured externally.
": "{Boolean}",IncludeReOrderPointForProduction
If products which are manufactured have specified re-order point quantity for the location used in the S&OP process, the re-order point quantity will be added as a demand. This will then be included in the gross quantity of the production requirements. Note that this does not includes products with product structures manufactured externally.
": "{Boolean}",SalesForecastSource
The source to use from the sales forecast
Possible domain values can be found here
": "{Integer}",MinimumProbabilityPercent
Minimum probability in percentage to include from the sales forecast
": "{Decimal}",MaximumProbabilityPercent
Maximum probability in percentage to include from the sales forecast
": "{Decimal}"UpdatedAt
Date and time production requirements were updated for this S&OP process
": "{Datetime}",TreatProductionWorkOrdersAsStock
By enabling this, existing, but not completed, production work orders will be treated as stock. Any production work orders can be used to net off production requirements. By not enabling this, you might end up with creating new production work orders instead off replanning already existing production work orders.
": "{Boolean}"UpdatedAt
Date and time purchase requirements was updated in this S&OP process
": "{Datetime}",TreatSupplierBacklogAsStock
By enabling this all purchase orders and purchase order responses will be treated as stock. Any purchase orders and purchase order responses confirmed in the future (ex. in two months) is available from today and can be used to net off purchase requirements. By not enabling this, you might end up with purchasing products that could instead be aquired by requesting change of delivery date on existing supplier backlog.
": "{Boolean}",RequireMaterialsFromAllProductionWorkOrders
By enabling this option, materials from ALL ongoing- and planned production work orders are included as gross purchase requirements. This means that you might get purchase requirements for materials belonging to production work orders not related to the production requirement plan.
If this option is disabled, only materials needed to fulfill the production requirements are included as gross purchase requirements. Note that even if this option is disabled you will still get purchase requirements for materials in ongoing- and planned production work orders consumed by (net off) the production requirements.
UpdatedAt
Date and time purchase order suggestions were updated for this S&OP process
": "{Datetime}",RequestedDeliveryDay
Preferred day of delivery. Used to consolidate purchase order suggestions. Default is all days.
Possible domain values can be found here
": "{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 100199 HTTP 404 | Location not found |