| Description | Product Availability Check |
| Name | CustomerRequirementATPCheck |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Customer Requirement Processing |
| Process Component Name | CustomerRequirementProcessing |
| Process Component Namespace | http://sap.com/xi/AP/SupplyChainControl/Global |
| Deployment Unit Description | Supply Chain Control |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
This service interface II_APCRP_CR_ATP_CHECK, allows product availability check without reserving the quantity.
A web service for simulated ATP check which returns the result of the ATP check, similar to a sales order until it is saved.
Product Availability should be scoped in the system.
Request node elements with cardinality > 1 contain an object node sender technical identifier to relate response message elements and log items to corresponding node elements in the request message.
The object node sender technical identifiers are provided as ObjectNodeSenderTechnicalID in request message types and referred to as ReferenceObjectNodeSenderTechnicalID in corresponding response message types.
If the object node sender technical ID is initial, the object node sender technical ID of the parent node element in the request is returned as the reference object node sender technical ID. If the object node sender technical IDs of all parent node elements are initial, the reference object node sender technical ID is returned as initial as well.
Note: The values specified in the ObjectNodeSenderTechnicalID are transient values that establish the correspondence between elements for only a single call. The web service consumer is not required to specify them or to use the same values for different calls. In addition, the service provider does not interpret these values at all, but returns them to the web service consumer instead in the ReferenceObjectNodeSenderTechnicalID elements.
Note: The ObjectNodeSenderTechnicalID is also used to identify failed business document modifications in a mass operation.
Many external applications consuming web services have special requirements and restrictions regarding the format of WSDLs. Some external applications require service definition WSDLs describing the web service signature. This is normally sufficient for the creation of static client-side proxies. Other external applications, normally those that do not create static client-side proxies, require binding WSDLs including the endpoint definition and authentication policy information.
In both cases, it may be the case that the external application imposes special restrictions on the structure or the size of WSDLs.
Microsoft InfoPath requires binding WSDLs and considers elements with the attribute "minOccurs=0" as "mandatory". However "minOccurs=0" means "optional" in SAP web services. In order to circumvent this problem, the WSDL must be saved locally and an additional attribute "nillable=true" must be added to make a query parameter optional for Microsoft InfoPath.
For very small clients such as mobile devices, the size of the WSDL itself may become a problem. In most cases the client only requires a very small part of the signature, but due to the complexity of the WSDL they may end up with long runtime during serialization of the request or deserialization of the response. In order to circumvent this problem, the WSDL must be saved locally and the optional parts of the signature have to be removed before the WSDL is imported or static client-side proxies are generated.
External applications have to take into account that web service request and response message types can be enhanced with additional elements and attributes. Enhancements can be created by SAP, SAP partners, and key users. Enhancements of request message types are always optional elements or attributes. The SAP system does not require the external application to provide values in the request. Enhancements of response message types can contain mandatory elements or attributes. The external application must be able to process the extended response successfully.
XML element and attribute names are always stable. Technical definitions of data types can be enhanced in a compatible way. This may result in changed data type names. External applications can rely on XML element names and attribute names, but should not rely on data type names.
Note: You can download the WSDL file for any web service here:
• Application and User Management work center -> Input Output Management -> Communication Arrangement.
• User Management work center -> Service Explorer view.
You can find the documentation of the global data types in the SAP Community Network: Go to http://scn.sap.com/docs/DOC-17516 and click View Document.
You can find general information about Web services, their structure and consumption in the Web Services documentation.
| Description | Check product availability |
| Name | AvailabilityCheck |
| Synchronous | yes |
| Release Status | Released |
Operation to check for product availability. Input information like product, requested date and quantity will be provided and the output information such as the confirmed dates and quantities will be returned.
The web service can be used for standard products (plain variant with no Kits and no complete delivery), kits, for products with delivery group maintained etc.
The request message of the operation contains information that is used for checking the product availability, and response message contains the result of the check.
Product Availability should be scoped in the system.
The following are the elements of request message
| Elements | Description |
|---|---|
| CustomerRequirement | Availability Query Request Structure |
The following are the attributes of Requested Elements
| Attributes | Description | Mandatory |
|---|---|---|
| ProductID | Product ID | True |
| SupplyPlanningAreaID | If the availability is to be checked in a particular site, then Supply Planning Area ID can be passed in the Request | |
| ProductRequirementSpecificationID | Product Requirement Specification ID | |
| RequestedQuantity | Requested Quantity | True |
| RequestedDate | Requested Delivery Date | True |
| PostalAddress | ShipTo Address containing the country code, region code and postal code | |
| SellerCompany | Selling Company | True |
| CustomerID | Customer ID is used to identify the transportation zone as customer specific transportation zones can be maintained | |
| DeliveryGroupID | Delivery Group ID (Delivery group is a consolidation of items and can be used for complete delivery scenario in which case the Delivery Group ID of all the requests should be same) | |
| SenderTechnicalID | It is used to identify failed business document modifications in a mass operation. Basically, the user will be able to link the response message with the request message. Please refer to the Service Interface documentation for complete information |
| Attributes | Description | Mandatory |
|---|---|---|
| CountryCode | Country Code | True |
| RegionCode | Region Code | |
| PostalCode | Postal Code |
The following are the elements of response message
| Elements | Description |
|---|---|
| Log | Sequence of log messages |
| AvailabilityResults | Result of the Availability Check |
The following are the attributes of Response Elements
| Attributes | Description |
|---|---|
| ProductID | Product ID |
| ProductID | Kit Parent Product ID |
| SupplyPlanningAreaID | Supply Planning Area ID |
| ProductRequirementSpecificationID | Product Requirement Specification ID |
| RequestedQuantity | Requested Quantity |
| RequestedDate | Requested Delivery Date |
| ConfirmedScheduleLines | Confirmation Schedule Lines contain the confirmed quantity and the confirmed date |
| SenderTechnicalID | Sender Technical ID |
| Attributes | Description |
|---|---|
| ConfirmedDate | Confirmed Date according to the availability check |
| ConfirmedQuantity | Confirmed Quantity that is deliverable for the date entered according to the availability check |
1. Items in same delivery group should have the same requested date. Otherwise it results in error response.
2. The Supply Planning Area must belong to the Selling Company.
3. PRS cannot be specified against a Kit Header.
4. If the Delivery Group ID is specified, the delivery rule used for ATP check is Single Delivery Full Quantity.
5. Customer ID should be same if multiple items are part of same request.
6. The master table for the region codes is T005S. However the customers can also get the region codes associated with countries using the drop down available in the Advanced Filter of the Transport Zone OWL.
<n0:ProductAvailabilityCheckRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <CustomerRequirementRequest> <ProductID>MCF-0001</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedQuantity unitCode="EA">15</RequestedQuantity> <RequestedDate>2020-03-24</RequestedDate> <PostalAddress> <CountryCode>US</CountryCode> <RegionCode>NY</RegionCode> <PostalCode>12205</PostalCode> </PostalAddress> <SellingCompany languageCode="EN">MC10000</SellingCompany> <CustomerID>MC9785</CustomerID> <ObjectNodeSenderTechnicalID>20</ObjectNodeSenderTechnicalID> </CustomerRequirementRequest> </n0:ProductAvailabilityCheckRequest>
<n0:ProductAvailabilityCheckResponse xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS6509E338A1A5B294F9DA:804"> <Log/> <AvailabilityResultsStructure> <ProductID>MCF-0001</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedDate>2020-03-24</RequestedDate> <RequestedQuantity unitCode="EA">15.0</RequestedQuantity> <ConfirmedScheduleLine> <ConfirmedDate>2020-04-09</ConfirmedDate> <ConfirmedQuantity unitCode="EA">15.0</ConfirmedQuantity> </ConfirmedScheduleLine> <ObjectSenderTechnicalID>20</ObjectSenderTechnicalID> </AvailabilityResultsStructure> </n0:ProductAvailabilityCheckResponse>
<n0:ProductAvailabilityCheckRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <CustomerRequirementRequest> <ProductID>ABC_123</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedQuantity unitCode="EA">15</RequestedQuantity> <RequestedDate>2020-03-24</RequestedDate> <PostalAddress> <CountryCode>US</CountryCode> <RegionCode>NY</RegionCode> <PostalCode>12205</PostalCode> </PostalAddress> <SellingCompany languageCode="EN">MC10000</SellingCompany> <CustomerID>MC9785</CustomerID> <DeliveryGroupID>1</DeliveryGroupID> <ObjectNodeSenderTechnicalID>10</ObjectNodeSenderTechnicalID> </CustomerRequirementRequest> </n0:ProductAvailabilityCheckRequest>
<n0:ProductAvailabilityCheckResponse xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS6509E338A1A5B294F9DA:804"> <Log> <Item> <SeverityCode>E</SeverityCode> <ReferenceObjectNodeSenderTechnicalID>10</ReferenceObjectNodeSenderTechnicalID> <Note>Product ID ABC_123 is Invalid</Note> </Item> </Log> </n0:ProductAvailabilityCheckResponse>
Note : - Items in same delivery group must have same requested date.
<n0:ProductAvailabilityCheckRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <CustomerRequirementRequest> <ProductID>MCF-0001</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedQuantity unitCode="EA">15</RequestedQuantity> <RequestedDate>2020-03-24</RequestedDate> <PostalAddress> <CountryCode>US</CountryCode> <RegionCode>NY</RegionCode> <PostalCode>12205</PostalCode> </PostalAddress> <SellingCompany languageCode="EN">MC10000</SellingCompany> <CustomerID>MC9785</CustomerID> <DeliveryGroup>1</DeliveryGroup> </CustomerRequirementRequest> <CustomerRequirementRequest> <ProductID>MCA-0009</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedQuantity unitCode="EA">1</RequestedQuantity> <RequestedDate>2020-03-24</RequestedDate> <PostalAddress> <CountryCode>US</CountryCode> <RegionCode>NY</RegionCode> <PostalCode>12205</PostalCode> </PostalAddress> <SellingCompany languageCode="EN">MC10000</SellingCompany> <CustomerID>MC9785</CustomerID> <DeliveryGroup>1</DeliveryGroup> </CustomerRequirementRequest> <CustomerRequirementRequest> <ProductID>MCF-0001</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedQuantity unitCode="EA">2</RequestedQuantity> <RequestedDate>2020-03-24</RequestedDate> <PostalAddress> <CountryCode>US</CountryCode> <RegionCode>NY</RegionCode> <PostalCode>12205</PostalCode> </PostalAddress> <SellingCompany languageCode="EN">MC10000</SellingCompany> <CustomerID>MC9785</CustomerID> <DeliveryGroup>2</DeliveryGroup> </CustomerRequirementRequest> </n0:ProductAvailabilityCheckRequest>
<n0:ProductAvailabilityCheckResponse xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS6509E338A1A5B294F9DA:804"> <Log/> <AvailabilityResultsStructure> <ProductID>MCF-0001</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedDate>2020-03-24</RequestedDate> <RequestedQuantity unitCode="EA">15.0</RequestedQuantity> <ConfirmedScheduleLine> <ConfirmedDate>2020-04-09</ConfirmedDate> <ConfirmedQuantity unitCode="EA">15.0</ConfirmedQuantity> </ConfirmedScheduleLine> </AvailabilityResultsStructure> <AvailabilityResultsStructure> <ProductID>MCA-0009</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedDate>2020-03-24</RequestedDate> <RequestedQuantity unitCode="EA">1.0</RequestedQuantity> <ConfirmedScheduleLine> <ConfirmedDate>2020-04-01</ConfirmedDate> <ConfirmedQuantity unitCode="EA">1.0</ConfirmedQuantity> </ConfirmedScheduleLine> </AvailabilityResultsStructure> <AvailabilityResultsStructure> <ProductID>MCF-0001</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedDate>2020-03-24</RequestedDate> <RequestedQuantity unitCode="EA">2.0</RequestedQuantity> <ConfirmedScheduleLine> <ConfirmedDate>2020-04-09</ConfirmedDate> <ConfirmedQuantity unitCode="EA">2.0</ConfirmedQuantity> </ConfirmedScheduleLine> </AvailabilityResultsStructure> </n0:ProductAvailabilityCheckResponse>
Note : - Items in same delivery group having different requested dates results in error response.
<n0:ProductAvailabilityCheckRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <CustomerRequirementRequest> <ProductID>MCF-0001</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedQuantity unitCode="EA">10</RequestedQuantity> <RequestedDate>2020-03-25</RequestedDate> <PostalAddress> <CountryCode>US</CountryCode> <RegionCode>NY</RegionCode> <PostalCode>12205</PostalCode> </PostalAddress> <SellingCompany languageCode="EN">MC10000</SellingCompany> <CustomerID>MC9785</CustomerID> <DeliveryGroupID>1</DeliveryGroupID> <ObjectNodeSenderTechnicalID>20</ObjectNodeSenderTechnicalID> </CustomerRequirementRequest> <CustomerRequirementRequest> <ProductID>MCA-0009</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedQuantity unitCode="EA">10</RequestedQuantity> <RequestedDate>2020-03-24</RequestedDate> <PostalAddress> <CountryCode>US</CountryCode> <RegionCode>NY</RegionCode> <PostalCode>12205</PostalCode> </PostalAddress> <SellingCompany languageCode="EN">MC10000</SellingCompany> <CustomerID>MC9785</CustomerID> <DeliveryGroupID>1</DeliveryGroupID> <ObjectNodeSenderTechnicalID>20</ObjectNodeSenderTechnicalID> </CustomerRequirementRequest> <CustomerRequirementRequest> <ProductID>MCF-0001</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedQuantity unitCode="EA">2</RequestedQuantity> <RequestedDate>2020-03-29</RequestedDate> <PostalAddress> <CountryCode>US</CountryCode> <RegionCode>NY</RegionCode> <PostalCode>12205</PostalCode> </PostalAddress> <SellingCompany languageCode="EN">MC10000</SellingCompany> <CustomerID>MC9785</CustomerID> <DeliveryGroupID>1</DeliveryGroupID> <ObjectNodeSenderTechnicalID>20</ObjectNodeSenderTechnicalID> </CustomerRequirementRequest> </n0:ProductAvailabilityCheckRequest>
<n0:ProductAvailabilityCheckResponse xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS6509E338A1A5B294F9DA:804"> <Log> <Item> <SeverityCode>E</SeverityCode> <Note>Requested dates for delivery group 1 should be same</Note> </Item> </Log> </n0:ProductAvailabilityCheckResponse>
<n0:ProductAvailabilityCheckRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <CustomerRequirementRequest> <ProductID>MCF-KIT-0001</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedQuantity unitCode="EA">15</RequestedQuantity> <RequestedDate>2020-03-24</RequestedDate> <PostalAddress> <CountryCode>US</CountryCode> <RegionCode>NY</RegionCode> <PostalCode>12205</PostalCode> </PostalAddress> <SellingCompany languageCode="EN">MC10000</SellingCompany> <CustomerID>MC9785</CustomerID> <DeliveryGroupID>1</DeliveryGroupID> <ObjectNodeSenderTechnicalID>10</ObjectNodeSenderTechnicalID> </CustomerRequirementRequest> <CustomerRequirementRequest> <ProductID>MCF-0001</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedQuantity unitCode="EA">15</RequestedQuantity> <RequestedDate>2020-03-24</RequestedDate> <PostalAddress> <CountryCode>US</CountryCode> <RegionCode>NY</RegionCode> <PostalCode>12205</PostalCode> </PostalAddress> <SellingCompany languageCode="EN">MC10000</SellingCompany> <CustomerID>MC9785</CustomerID> <DeliveryGroupID>1</DeliveryGroupID> <ObjectNodeSenderTechnicalID>20</ObjectNodeSenderTechnicalID> </CustomerRequirementRequest> </n0:ProductAvailabilityCheckRequest>
<n0:ProductAvailabilityCheckResponse xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS6509E338A1A5B294F9DA:804"> <Log/> <AvailabilityResultsStructure> <ProductID>MCF-KIT-0001</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedDate>2020-03-24</RequestedDate> <RequestedQuantity unitCode="EA">15.0</RequestedQuantity> <ConfirmedScheduleLine> <ConfirmedDate>2020-04-10</ConfirmedDate> <ConfirmedQuantity unitCode="EA">15.0</ConfirmedQuantity> </ConfirmedScheduleLine> <ObjectSenderTechnicalID>10</ObjectSenderTechnicalID> </AvailabilityResultsStructure> <AvailabilityResultsStructure> <ProductID>MCF-0001</ProductID> <KitParentProductID>MCF-KIT-0001</KitParentProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedDate>2020-03-24</RequestedDate> <RequestedQuantity unitCode="EA">15.0</RequestedQuantity> <ConfirmedScheduleLine> <ConfirmedDate>2020-04-10</ConfirmedDate> <ConfirmedQuantity unitCode="EA">15.0</ConfirmedQuantity> </ConfirmedScheduleLine> <ObjectSenderTechnicalID>10</ObjectSenderTechnicalID> </AvailabilityResultsStructure> <AvailabilityResultsStructure> <ProductID>MCF-0002</ProductID> <KitParentProductID>MCF-KIT-0001</KitParentProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedDate>2020-03-24</RequestedDate> <RequestedQuantity unitCode="EA">30.0</RequestedQuantity> <ConfirmedScheduleLine> <ConfirmedDate>2020-04-10</ConfirmedDate> <ConfirmedQuantity unitCode="EA">30.0</ConfirmedQuantity> </ConfirmedScheduleLine> <ObjectSenderTechnicalID>10</ObjectSenderTechnicalID> </AvailabilityResultsStructure> <AvailabilityResultsStructure> <ProductID>MCF-0001</ProductID> <SupplyPlanningAreaID>MC64000</SupplyPlanningAreaID> <RequestedDate>2020-03-24</RequestedDate> <RequestedQuantity unitCode="EA">15.0</RequestedQuantity> <ConfirmedScheduleLine> <ConfirmedDate>2020-04-10</ConfirmedDate> <ConfirmedQuantity unitCode="EA">15.0</ConfirmedQuantity> </ConfirmedScheduleLine> <ObjectSenderTechnicalID>20</ObjectSenderTechnicalID> </AvailabilityResultsStructure> </n0:ProductAvailabilityCheckResponse>
Show full documentation
Show full documentation