| Description | Determine Availability of Products |
| Name | ProductAvailabilityDeterminationIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Product | SAP Business ByDesign |
| Process component | Supply and Demand Matching |
| Process component namespace | http://sap.com/xi/AP/SupplyChainControl/Global |
| Deployment unit | Supply Chain Control |
| Endpoint Activation | By Scoping of Process Component | Operations |
|
| Release Status | Released |
| Technical documentation on the SAP API Business Hub | Determine Availability of Products |
| General web service documentation | A2X Web Services (SOAP) |
An interface to determine product availability.
The ProductAvailabilityDeterminationIn web-service can be used within E-commerce scenarios to enhance E-Shops with central availability information.
The web service ProductAvailabilityDeterminationIn determines some product availability key figures (planned stock, sum of receipts, sum of requirements and available quantity) in a given horizon for a given list of products and a supply planning areas.
This web service has the operation Determine to determine the product availability key figures.
The input for the web service is a list of valid products with or without a product requirement specification in a supply planning area. If a product is not valid in a supply planning area then the web service will return no key figures for this product / supply planning area combination. Valid means that the supply planning area is defined and active in the “planning area” of the product master data.
As ProductTypeCode only the value 1 (= Material) is allowed, because only for materials the availability can be determined.
Indicator (ConsiderScopeOfCheckIndicator): An indicator can only have the values true or false.
Duration (ProductAvailabilityDeterminationHorizonDuration): The duration is is a period of time of a particular length without a fixed start or end time. This period of time is expressed in calendar days and has to be specified in the following format: PnD
For example, a duration of 10 days is specified as P10D.
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
The operation Determine has the following main nodes:
Show full documentation
Show full documentation
<n0:ProductAvailabilityDeterminationQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<ProductAvailabilityDeterminationQuery>
<ConsiderScopeOfCheckIndicator>true</ConsiderScopeOfCheckIndicator>
<ProductAndSupplyPlanningArea>
<ProductAvailabilityDeterminationHorizonDuration>P3D</ProductAvailabilityDeterminationHorizonDuration>
</ProductAvailabilityDeterminationQuery>
</n0:ProductAvailabilityDeterminationQuery_sync>
The ProductAvailabilityDeterminationIn web-service can be used within E-commerce scenarios to enhance E-Shops with central availability information.
| Description | Determine availability of products using selection criteria |
| Name | Determine |
| Synchronous | yes |
| Release Status | Released |
To determine the product availability (sum of receipts, sum of requirements, current planned stock and available quantity) in a given horizon for a given list of product details (product ID and product requirement specification ID) and a supply planning area ID.
The operation Determine calculates based on product data in a supply planning are and an availability horizon the following availability key figures at horizon end:
The ConsiderScopeOfCheckIndicator specifies if the scope of check defined on the product master area ‘availability confirmation’ is considered by the web-service when calculating the availability key figures.
The scope of check defines which receipt elements are considered. There exist 4 different scopes of check which can be defined on the product master:
If the ConsiderScopeOfCheckIndicator is set to TRUE, then the web-service will consider when calculating the key figure ReceiptQuantity, only the receipts which are defined via the scope of check on the product master.
If the ConsiderScopeOfCheck is set to FALSE, then the web-service will consider all receipts idependently on the product master data settings, when calculating the key figure ReceiptQuantity.
The ProductAndSupplyPlanningArea node defines the product with or without product requirement specification in a supply planning area for which the availability key figures are calculated.
It consists of the following sub nodes:
The ProductInternalID specifies the product for which the availability key figures are calculated. The product is mandatory.
The ProductTypeCode has to be set to 1 ( = Material ) because currently this web-service calculates the availability key figures only for materials.
The ProductRequirementSpecificationID specifies the product requirement specification for the given product. It is an optional field.
The ProductRequirementSpecificationVersionID specifies the version of the product requirement specification.
The SupplyPlanningAreaID specifies the supply planning area for which the availability key figures are calculated. The product has to be valid in the supply planning area. The key figures are always calculated for the combination of product and supply planning area. The supply planning area is mandatory.
The ProductAvailabilityDeterminationHorizonDuration is used to calculated the horizon end. The availability key figures are calculated for the period starting today until the horizon end date. The horizon end date is calculated as follows:
HorizonEndDate = Today + ProductAvailabilityDeterminationHorizonDuration
The ProductAvailabilityDeterminationHorizonDuration has to be given in calendar days in the following format: PnD
For example P1D specifies a duration of 1 day.
The ProductAvailabilityDeterminationResponse contains the result of the determine operation. It consists of the following sub nodes:
The node Log contains the error messages which occured during the determine operation.
The following is an example XML file to determine the availability key figures for three product / supply planning area combinations:
<n0:ProductAvailabilityDeterminationQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductAvailabilityDeterminationQuery> <ConsiderScopeOfCheckIndicator>true</ConsiderScopeOfCheckIndicator> <ProductAndSupplyPlanningArea> <ProductInternalID schemeID="" schemeAgencyID="">MCF-0001</ProductInternalID> <ProductTypeCode>1</ProductTypeCode> <ProductRequirementSpecificationID schemeID="" schemeAgencyID="" /> <ProductRequirementSpecificationVersionID /> <SupplyPlanningAreaID schemeID="" schemeAgencyID="">MC64000</SupplyPlanningAreaID> </ProductAndSupplyPlanningArea> <ProductAndSupplyPlanningArea> <ProductInternalID schemeID="" schemeAgencyID="">MCF-0036</ProductInternalID> <ProductTypeCode>1</ProductTypeCode> <ProductRequirementSpecificationID schemeID="" schemeAgencyID="" /> <ProductRequirementSpecificationVersionID /> <SupplyPlanningAreaID schemeID="" schemeAgencyID="">MC64000</SupplyPlanningAreaID> </ProductAndSupplyPlanningArea> <ProductAndSupplyPlanningArea> <ProductInternalID schemeID="" schemeAgencyID="">MCF-0001-TO01</ProductInternalID> <ProductTypeCode>1</ProductTypeCode> <ProductRequirementSpecificationID schemeID="" schemeAgencyID="">PS-000003-TO</ProductRequirementSpecificationID> <ProductRequirementSpecificationVersionID /> <SupplyPlanningAreaID schemeID="" schemeAgencyID="">MC64000</SupplyPlanningAreaID> </ProductAndSupplyPlanningArea> <ProductAvailabilityDeterminationHorizonDuration>P1D</ProductAvailabilityDeterminationHorizonDuration> </ProductAvailabilityDeterminationQuery> </n0:ProductAvailabilityDeterminationQuery_sync>