| Description | Manage Parts Return Notification |
| Name | ManagePartsReturnNotificationIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Product | SAP Business ByDesign |
| Process component | Inbound Delivery Processing |
| Process component namespace | http://sap.com/xi/AP/LogisticsExecution/Global |
| Deployment unit | Production and Site Logistics Execution |
| Endpoint Activation | By Scoping of Process Component | Operations |
|
| Release Status | Not Released |
| Technical documentation on the SAP API Business Hub | Manage Parts Return Notification |
| General web service documentation | A2X Web Services (SOAP) |
An interface to manage parts return notifications.
The web service Manage Parts Return Notification In enables you to connect external applications to your SAP Business by Design system and to create general information and items for parts return notification.
The web service interface Manage Parts Return Notification In offers the operation CreateBundle.
The CreateBundle operation is used to create one or more parts return notifications.
Due to the stateless behavior of A2X service operations, it is not possible to enforce any kind of transactional or logical locking.Despite this, clients may be required to enforce that a modifying operation is not executed because the state of the underlying business object instance in the database has changed since the client read its data.
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Action codes represent an instruction to the recipient of the web service request to process transmitted message node elements. Following are the existing action codes and their description.
| Action Code | Description |
|---|---|
| 01 | Create; the system returns an error message if the node element already exists. |
Create bundle operation is mass-enabled stateless synchronous web service operation. Transferring or requesting amounts of data that are too large causes communication timeouts. The web service consumer is responsible for ensuring reasonable sizes of data for mass operations.
Create bundle operation support exactly one execution (idempotency). To ensure exactly one execution of web service requests, the web service consumer has to provide unique values for the elements ID or UUID of the BasicMessageHeader node element.
<n0:PartReturnNotificationBundleCreateRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader/>
<PartReturnNotification ActionCode="01">
<DeliveryNotificationID>PRN_REQ_1</DeliveryNotificationID>
<ProcessingTypeCode>PR</ProcessingTypeCode>
<DeliveryDate>
<StartDateTime timeZoneCode="EST">2021-10-02T13:24:54Z</StartDateTime>
<EndDateTime timeZoneCode="EST">2021-10-02T13:24:54Z</EndDateTime>
</DeliveryDate>
<ShipToLocationID>MC64000</ShipToLocationID>
<ProductRecipientID>MC10000</ProductRecipientID>
<VendorID>MC9785</VendorID>
<Item ActionCode="01">
<LineID>10</LineID>
<ItemProduct ActionCode="01">
<ProductID>MCF-0001</ProductID>
</ItemProduct>
<DeliveryQuantity unitCode="EA">1</DeliveryQuantity>
</Item>
</PartReturnNotification>
</n0:PartReturnNotificationBundleCreateRequest_sync>
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 runtimes 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.
You can download the WSDL file for any web service here:
Application and User Management work center -> Service Explorer view
| Description | Update parts return notifications |
| Name | UpdateBundle |
| Synchronous | yes |
| Release Status | Released |
To update part return notifications.
The update bundle operation is used to update one or more part return notifications.
The following are the elements of Part Return Notification Bundle Update Request
| Elements | Description |
|---|---|
| BasicMessageHeader | Message header |
| PartReturnNotification | Part Return Notification Structure |
Details of message sub node Part Return Notification
The cardinality of the node is 0..*, which implies that multiple part return notifications can be created together.
The following are the attributes of Requested Elements
| Attributes | Description |
|---|---|
| ActionCode | Determine the action that will be executed |
| ProcessingTypeCode | Processing type code |
| DeliveryDate | Delivery date of part return notification |
| GrossWeight | Gross weight |
| GrossVolume | Gross volume |
| IncotermsClassificationCode | Incoterms classification code |
| IncotermsTransferLocationName | Incoterms transfer location name |
| ShipToLocationID | Ship to location ID |
| FunctionalUnitID | Functional unit ID |
| ProductRecipientID | Product recipient ID |
| VendorID | Vendor ID |
| FreightForwarderID | Freight forwarder ID |
| WithWarehouseProviderBusinessProcessVariantTypeCode | With warehouse provider business process variant type code |
| WarehouseProviderID | Warehouse provider ID |
| Item | Item |
| AttachmentFolder | Attachment folder |
| TextCollection | Text collection |
| TransportationTerms | Details of transportation tracking like tracking ID and tracking URL |
To create the part return notification, the processing type code must be set as "PR".
The coded representation of Incoterms classification code has been given as below:
| Incoterms Classification Code Value | Description |
|---|---|
| CFR | Cost and freight |
| CIF | Cost, insurance and freight |
| CIP | Carriage and insurance paid to |
| CPT | Carriage paid to |
| DAF | Delivered at frontier |
| DAP | Delivered at place |
| DAT | Delivered terminal |
| DDP | Delivered duty paid |
| DDU | Delivered duty unpaid |
| DEQ | Delivered ex quay (duty paid) |
| DES | Delivered ex ship |
| EXW | Ex works |
| FAS | Free alongside ship |
| FCA | Free carrier |
| FOB | Free on board |
The following are the attributes of customer return notification items
| Attributes | Description |
|---|---|
| ActionCode | Determine the action that will be executed |
| LineID | Line item ID |
| ItemProduct | Product information of item |
| DeliveryQuantity | Delivery quantity |
| CustomerReturnReasonCode | Code of customer return reason |
| SellerPartyID | Seller party ID |
| BuyerPartyID | Buyer party ID |
| ProcessingTypeCode | Item processing type code |
| ReturnFollowupActivityCode | Return follow up activity code |
| IdentifiedStockID | Identified stock ID |
| IdentifiedStockProductID | Identified stock product ID |
| IdentifiedStockTypeCode | Identified stock type code |
| ProductRequirementSpecificationID | Product requirement specification ID |
| ItemBusinessTransactionDocumentReference | Referenced business transaction document |
This is a coded representation of return follow up activity code.
| Return Follow up Activity Code Value | Description |
|---|---|
| 1 | Post to Own Stock |
| 3 | Repair at Own Service Center |
The following are the attributes of item business transaction document reference
| Attributes | Description |
|---|---|
| ActionCode | Determine the action that will be executed |
| ContractID | Contract ID |
| ContractItemID | Contract item ID |
Request xml to update parts return notification
<n0:PartReturnNotifBundleUpdateRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader/>
<PartReturnNotification ActionCode="02">
<UUID>00163eac-af0a-1eeb-a7a1-a6651e99238f</UUID>
<ShipToLocationID>MC67100</ShipToLocationID>
<Item ActionCode="01">
<LineID>20</LineID>
<ItemProduct ActionCode="01">
<ProductID>MCF-0001</ProductID>
</ItemProduct>
<DeliveryQuantity unitCode="EA">1</DeliveryQuantity>
</Item>
</PartReturnNotification>
</n0:PartReturnNotifBundleUpdateRequest_sync>
Response containing updated parts return notification ID and UUID
<n0:PartReturnNotifBundleUpdateConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAEF7B0A55AEA5B1D15AEAE:804"> <PartReturnNotificationConfirmationBody> <ReferenceObjectNodeSenderTechnicalID> </ReferenceObjectNodeSenderTechnicalID> <ChangeStateID>20210414112930.2245370</ChangeStateID> <DeliveryNotificationID>PRN_901</DeliveryNotificationID> <UUID>00163eac-af0a-1eeb-a7a1-a6651e99238f</UUID> </PartReturnNotificationConfirmationBody> <Log/> </n0:PartReturnNotifBundleUpdateConfirmation_sync>
Response containing updated consignment custodian goods return notification
<n0:PartReturnNotifBundleUpdateRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader/>
<PartReturnNotification ActionCode="02">
<UUID>00163eac-af0a-1eeb-9de1-bbd7f1513faa</UUID>
<ShipToLocationID>MC67100</ShipToLocationID>
<Item ActionCode="01">
<LineID>20</LineID>
<ItemProduct ActionCode="01">
<ProductID>MCF-0001</ProductID>
</ItemProduct>
<DeliveryQuantity unitCode="EA">1</DeliveryQuantity>
</Item>
</PartReturnNotification>
</n0:PartReturnNotifBundleUpdateRequest_sync>
| Description | Create parts return notifications |
| Name | CreateBundle |
| Synchronous | yes |
| Release Status | Released |
To create part return notifications.
The create bundle operation is used to create one or more part return notifications.
The following are the elements of Part Return Notification Bundle Create Request
| Elements | Description |
|---|---|
| BasicMessageHeader | Message header |
| PartReturnNotification | Part Return Notification Structure |
Details of message sub node Part Return Notification
The cardinality of the node is 0..*, which implies that multiple part return notifications can be created together.
The following are the attributes of Requested Elements
| Attributes | Description |
|---|---|
| ActionCode | Determine the action that will be executed |
| DeliveryNotificationID | Alternative key for create part return notification |
| ProcessingTypeCode | Processing type code |
| DeliveryDate | Delivery date of part return notification |
| GrossWeight | Gross weight |
| GrossVolume | Gross volume |
| IncotermsClassificationCode | Incoterms classification code |
| IncotermsTransferLocationName | Incoterms transfer location name |
| ShipToLocationID | Ship to location ID |
| FunctionalUnitID | Functional unit ID |
| ProductRecipientID | Product recipient ID |
| VendorID | Vendor ID |
| FreightForwarderID | Freight forwarder ID |
| WithWarehouseProviderBusinessProcessVariantTypeCode | With warehouse provider business process variant type code |
| WarehouseProviderID | Warehouse provider ID |
| Item | Item |
| AttachmentFolder | Attachment folder |
| TextCollection | Text collection |
| TransportationTerms | Details of transportation tracking like tracking ID and tracking URL |
To create the part return notification, the processing type code must be set as "PR".
The coded representation of Incoterms classification code has been given as below:
| Incoterms Classification Code Value | Description |
|---|---|
| CFR | Cost and freight |
| CIF | Cost, insurance and freight |
| CIP | Carriage and insurance paid to |
| CPT | Carriage paid to |
| DAF | Delivered at frontier |
| DAP | Delivered at place |
| DAT | Delivered terminal |
| DDP | Delivered duty paid |
| DDU | Delivered duty unpaid |
| DEQ | Delivered ex quay (duty paid) |
| DES | Delivered ex ship |
| EXW | Ex works |
| FAS | Free alongside ship |
| FCA | Free carrier |
| FOB | Free on board |
The following are the attributes of customer return notification items
| Attributes | Description |
|---|---|
| ActionCode | Determine the action that will be executed |
| LineID | Line item ID |
| ItemProduct | Product information of item |
| DeliveryQuantity | Delivery quantity |
| CustomerReturnReasonCode | Code of customer return reason |
| SellerPartyID | Seller party ID |
| BuyerPartyID | Buyer party ID |
| ProcessingTypeCode | Item processing type code |
| ReturnFollowupActivityCode | Return follow up activity code |
| IdentifiedStockID | Identified stock ID |
| IdentifiedStockProductID | Identified stock product ID |
| IdentifiedStockTypeCode | Identified stock type code |
| ProductRequirementSpecificationID | Product requirement specification ID |
| ItemBusinessTransactionDocumentReference | Referenced business transaction document |
This is a coded representation of return follow up activity code.
| Return Follow up Activity Code Value | Description |
|---|---|
| 1 | Post to Own Stock |
| 3 | Repair at Own Service Center |
The following are the attributes of item business transaction document reference
| Attributes | Description |
|---|---|
| ActionCode | Determine the action that will be executed |
| ContractID | Contract ID |
| ContractItemID | Contract item ID |
Request xml to create parts return notification
<n0:PartReturnNotificationBundleCreateRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader/>
<PartReturnNotification ActionCode="01">
<DeliveryNotificationID>PRN_901</DeliveryNotificationID>
<ProcessingTypeCode>PR</ProcessingTypeCode>
<DeliveryDate>
<StartDateTime timeZoneCode="EST">2021-10-02T13:24:54Z</StartDateTime>
<EndDateTime timeZoneCode="EST">2021-10-02T13:24:54Z</EndDateTime>
</DeliveryDate>
<ShipToLocationID>MC64000</ShipToLocationID>
<ProductRecipientID>MC10000</ProductRecipientID>
<VendorID>MC9785</VendorID>
<Item ActionCode="01">
<LineID>10</LineID>
<ItemProduct ActionCode="01">
<ProductID>MCF-0001</ProductID>
</ItemProduct>
<DeliveryQuantity unitCode="EA">1</DeliveryQuantity>
</Item>
</PartReturnNotification>
</n0:PartReturnNotificationBundleCreateRequest_sync>
Response containing created parts return notification ID and UUID
<n0:PartReturnNotificationBundleCreateConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE4A29BD60B6646756D20A:804"> <PartReturnNotificationConfirmationBody> <ReferenceObjectNodeSenderTechnicalID> </ReferenceObjectNodeSenderTechnicalID> <ChangeStateID>20210414103558.9830220</ChangeStateID> <DeliveryNotificationID>PRN_901</DeliveryNotificationID> <UUID>00163eac-af0a-1eeb-a7a1-a6651e99238f</UUID> </PartReturnNotificationConfirmationBody> <Log/> </n0:PartReturnNotificationBundleCreateConfirmation_sync>
Request xml to create consignment custodian goods return notification
<n0:PartReturnNotificationBundleCreateRequest_syncxmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader/> <PartReturnNotificationActionCode="01"> <DeliveryNotificationID>PRN_K05</DeliveryNotificationID> <ProcessingTypeCode>PR</ProcessingTypeCode> <DeliveryDate> <StartDateTimetimeZoneCode="EST">2021-10-02T13:24:54Z</StartDateTime> <EndDateTimetimeZoneCode="EST">2021-10-02T13:24:54Z</EndDateTime> </DeliveryDate> <ShipToLocationID>MC64000</ShipToLocationID> <ProductRecipientID>MC10000</ProductRecipientID> <VendorID>MC9785</VendorID> <ConsignmentReturn>true</ConsignmentReturn> <ItemActionCode="01"> <LineID>10</LineID> <ItemProductActionCode="01"> <ProductID>MCF-0001</ProductID> </ItemProduct> <DeliveryQuantityunitCode="EA">1</DeliveryQuantity> <AccountID>MC9785</AccountID> <ShipFromLocationID>MC64000</ShipFromLocationID> </Item> </PartReturnNotification> </n0:PartReturnNotificationBundleCreateRequest_sync>
Show full documentation