| Description | Manage Customer Return Notification |
| Name | ManageCustomerReturnNotificationIn |
| 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 | Released |
| Technical documentation on the SAP API Business Hub | Manage Customer Return Notification |
| General web service documentation | A2X Web Services (SOAP) |
An interface to manage customer return notifications.
The web service Manage Customer Return Notification In enables you to connect external applications to your SAP Business by Design system and to create general information and items for customer return notification.
The web service interface Manage Customer Return Notification In offers the operation CreateBundle.
The CreateBundle operation is used to create one or more customer 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.
| Description | Create customer return notifications |
| Name | CreateBundle |
| Synchronous | yes |
| Release Status | Released |
To create customer return notifications.
The create bundle operation is used to create one or more customer return notifications.
The following are the elements of Customer Return Notification Bundle Create Request
| Elements | Description |
|---|---|
| BasicMessageHeader | Message header |
| CustomerReturnNotification | Customer Return Notification Structure |
Details of message sub node Customer Return Notification
The cardinality of the node is 0..*, which implies that multiple customer 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 customer return notification |
| ProcessingTypeCode | Processing type code |
| DeliveryDate | Delivery date of customer 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 customer return notification, the processing type code must be set as "CRD".
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 |
| OutboundDeliveryID | Outbound delivery ID |
| OutboundDeliveryItemID | Outbound delivery item ID |
| SalesOrderID | Sales order ID |
| SalesOrderItemID | Sales order item ID |
| CustomerInvoiceID | Customer invoice ID |
| CustomerInvoiceItemID | Customer invoice item ID |
| CustomerInvoiceRequestID | Customer invoice request ID |
| CustomerInvoiceRequestItemID | Customer invoice request item ID |
Request xml to create customer return notification
<n0:CustomerReturnNotificationBundleCreateRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader xmlns=""/>
<CustomerReturnNotification ActionCode="01">
<DeliveryNotificationID>CRN_001</DeliveryNotificationID>
<ProcessingTypeCode>CRD</ProcessingTypeCode>
<DeliveryDate>
<StartDateTime timeZoneCode="CET">2022-02-01T12:30:00Z</StartDateTime>
<EndDateTime timeZoneCode="CET">2022-02-01T12:30:01Z</EndDateTime>
</DeliveryDate>
<ProductRecipientID>MC10000</ProductRecipientID>
<ShipToLocationID>MC64000</ShipToLocationID>
<VendorID>MC9785</VendorID>
<Item ActionCode="01">
<LineID>10</LineID>
<ItemProduct>
<ProductID>MCF-0001</ProductID>
</ItemProduct>
<DeliveryQuantity unitCode="EA">10</DeliveryQuantity>
<ReturnFollowupActivityCode>1</ReturnFollowupActivityCode>
<ExternalDocumentIndicator>true</ExternalDocumentIndicator>
<ItemBusinessTransactionDocumentReference>
<SalesOrderID>X</SalesOrderID>
<SalesOrderItemID>X</SalesOrderItemID>
</ItemBusinessTransactionDocumentReference>
</Item>
</CustomerReturnNotification>
</n0:CustomerReturnNotificationBundleCreateRequest_sync>
Response containing created customer return notification ID and UUID
<n0:CustomerReturnNotificationBundleCreateConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE27A2107078B2D3F083E1:804"> <CustomerReturnNotificationConfirmationBody> <ReferenceObjectNodeSenderTechnicalID> </ReferenceObjectNodeSenderTechnicalID> <ChangeStateID> 20210430042120.9019690</ChangeStateID> <DeliveryNotificationID>CRN_RES</DeliveryNotificationID> <UUID>00163eac-aef4-1edb-aaad-705476e6f7ac</UUID> </CustomerReturnNotificationConfirmationBody> <Log/> </n0:CustomerReturnNotificationBundleCreateConfirmation_sync>
| Description | Update customer return notifications |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To udapte customer return notifications.
The update bundle operation is used to update one or more customer return notifications.
The following are the elements of Customer Return Notification Bundle Update Request
| Elements | Description |
|---|---|
| BasicMessageHeader | Message header |
| CustomerReturnNotification | Customer Return Notification Structure |
Details of message sub node Customer Return Notification
The cardinality of the node is 0..*, which implies that multiple customer return notifications can be Updated together.
The following are the attributes of Requested Elements
| Attributes | Description |
|---|---|
| ActionCode | Determine the action that will be executed |
| DeliveryNotificationID | Alternative key for Update customer return notification |
| ProcessingTypeCode | Processing type code |
| DeliveryDate | Delivery date of customer 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 Update the customer return notification, the processing type code must be set as "CRD".
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 |
| OutboundDeliveryID | Outbound delivery ID |
| OutboundDeliveryItemID | Outbound delivery item ID |
| SalesOrderID | Sales order ID |
| SalesOrderItemID | Sales order item ID |
| CustomerInvoiceID | Customer invoice ID |
| CustomerInvoiceItemID | Customer invoice item ID |
| CustomerInvoiceRequestID | Customer invoice request ID |
| CustomerInvoiceRequestItemID | Customer invoice request item ID |
Request xml to update customer return notification and add item
<n0:CustomerReturnNotificationBundleUpdateRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader xmlns=""/>
<CustomerReturnNotification ActionCode="02">
<UUID>00163eac-af3d-1edb-a79a-3afd2a53a52e</UUID>
<Item ActionCode="01">
<LineID>50</LineID>
<ItemProduct>
<ProductID>MCF-0001</ProductID>
</ItemProduct>
<DeliveryQuantity unitCode="EA">10</DeliveryQuantity>
<ReturnFollowupActivityCode>1</ReturnFollowupActivityCode>
<ExternalDocumentIndicator>true</ExternalDocumentIndicator>
<ItemBusinessTransactionDocumentReference>
<SalesOrderID>X</SalesOrderID>
<SalesOrderItemID>X</SalesOrderItemID>
</ItemBusinessTransactionDocumentReference>
</Item>
</CustomerReturnNotification>
</n0:CustomerReturnNotificationBundleUpdateRequest_sync>
Response containing updated customer return notification ID and UUID
<n0:CustomerReturnNotificationBundleUpdateConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE852091ABC7819DA46054:804"> <CustomerReturnNotificationConfirmationBody> <ReferenceObjectNodeSenderTechnicalID> </ReferenceObjectNodeSenderTechnicalID> <ChangeStateID>20210414091456.3410830</ChangeStateID> <DeliveryNotificationID>CRN_352</DeliveryNotificationID> <UUID>00163eac-af3d-1edb-a79a-3afd2a53a52e</UUID> </CustomerReturnNotificationConfirmationBody> </n0:CustomerReturnNotificationBundleUpdateConfirmation_sync>
Request xml to update customer return notification and update item quantity
<n0:CustomerReturnNotificationBundleUpdateRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader xmlns=""/> <CustomerReturnNotification ActionCode="02"> <UUID>00163eac-aef4-1eeb-a2dc-6ff41998cbf9</UUID> <Item ActionCode="02"> <UUID>00163eac-aef4-1eeb-a2dc-6ff419996bf9</UUID> <DeliveryQuantity unitCode="EA">30</DeliveryQuantity> </Item> </CustomerReturnNotification> </n0:CustomerReturnNotificationBundleUpdateRequest_sync>
Response containing updated customer return notification ID and UUID
<n0:CustomerReturnNotificationBundleUpdateConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE852091ABC7819DA46054:804"> <CustomerReturnNotificationConfirmationBody> <ReferenceObjectNodeSenderTechnicalID> </ReferenceObjectNodeSenderTechnicalID> <ChangeStateID>20210414091456.3410830</ChangeStateID> <DeliveryNotificationID>CRN_171</DeliveryNotificationID> <UUID>00163eac-aef4-1eeb-a2dc-6ff41998cbf9</UUID> </CustomerReturnNotificationConfirmationBody> </n0:CustomerReturnNotificationBundleUpdateConfirmation_sync>
Show full documentation