| Description | Manage Promotions |
| Name | ManagePromotionIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Promotion Management |
| Process Component Name | PromotionManagement |
| Process Component Namespace | http://sap.com/xi/AP/CRM/Global |
| Deploymnent Unit Description | Customer Relationship Management |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Deprecated |
An interface to create, update or delete an promotion which can be used for promotion migration or replication.
The web service interface Manage Promotion In enables you to connect external applications to your SAP system and to create and edit promotions within your system. The web service interface Manage Promotion In is relevant if your company wants to access and manage Promotion data from external applications.
The web service interface Manage Promotion In offers the operations MaintainBundle and CheckMaintainBundle.
Existence of required master data and related business documents in the system, like:
Master data of BusinessPartner: SalesUnit, SalesOrganization, Employee, Customer, etc.
Product Master data: Material
Maintain Bundle operations enable external applications to create and change business document data. Check Maintain Bundle operations enable external applications to simulate maintain bundle requests without changing business document data. In particular, Check Maintain Bundle operations have the following functions:
Return system messages similar to corresponding maintain bundle operations
Provide the same message type as the corresponding operation Maintain Bundle
Do not assign internal numbers from a productive number range interval (number range statuses are not increased)
Do not change business documents
Action codes represent an instruction to the recipient of the web service request to process transmitted message node elements.
| Action Code | Description |
|---|---|
| 01 | Create; the system returns an error message if the node element already exists. |
| 02 | Update; the system returns an error message if the node element does not exist. |
| 03 | Delete; the system returns an error message if the node element does not exist. |
| 04 | Save; the system creates or changes the node element data. |
| 05 | Remove; the system deletes the node element. If the node element does not exist, the system does not send an error message. |
| 06 | No Action; the system does not change the node element. |
Default action code: 04 (Save).
Note: Action code 04 (Save) creates business documents if the system can not identify a matching target business document. This applies in particular if no business document ID or UUID is provided by the web service consumer. The web service consumer (external application) is responsible for providing correct business document IDs or UUIDs. This will avoid accidentially creating duplicate business documents.
The processing of node elements with cardinality > 1 (for example a list of descriptions in different languages or a list of telephone numbers) can be controlled using List Complete Transmission Indicators (LCTI). The LCTI indicates whether a list of node elements is transmitted completely. The LCTI of a node element with cardinality > 1 is modeled as an attribute of its parent node element (attribute name: <name of child element>ListCompleteTransmissionIndicator).
| LCTI | Description |
|---|---|
| false | The list of node elements is not completely transmitted. Hence, all node elements that are not transmitted remain unchanged. If transmitted node elements in the list can be uniquely identified, the system processes the node elements according to the action code. If transmitted node elements in the list cannot be uniquely identified, the system appends the node element to the corresponding list of node elements in the target business document. |
| true | The list of elements is completely transmitted. Hence, all node elements that are not transmitted are deleted. If no node element is transmitted, all the node elements in the system will be removed. |
Default list complete transmission indicator: false.
Note: The LCTI refers to the completeness of the list of node elements and does not imply completeness of sub-elements.
Optional leaf elements in request messages that are not transmitted within a web service request are not changed in corresponding business documents.
Maintain bundle and check maintain bundle operations are mass-enabled stateless synchronous web service operations. 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.
Maintain bundle and check maintain bundle operations support exactly one execution (idem potency). 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.
Using change state identifier (element name ChangeStateID), external applications can ensure that a modifying operation is not executed because the state of the business document has changed since the external application last read its data.
The change state ID is an uninterpretable string that is provided by query and read operations and can be utilized by all modifying operations. If the change state identifier is provided when calling a modifying operation, the system does not perform the operation if the state of the business document instance has changed since the change state ID was computed. If the change state ID is not provided by the web service consumer, the system performs the web service operation without checking the state of the business document.
The web service consumer (external application) is responsible for preventing accidental changes to business documents.
Note: For this web service the change state ID does not apply to the ContactPerson, Relationship, CommunicationArrangement, DirectResponsibility, SalesArrangement, or PaymentData node elements.
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. Also, the service provider does not interpret these values at all. Instead, the service provider returns them to the web service consumer in the ReferenceObjectNodeSenderTechnicalID elements.
Note: The ObjectNodeSenderTechnicalID is also used to identify failed business document modifications in a mass operation.
Example
Request:
Show full documentation
Show full documentation
<Child>
<ObjectNodeSenderTechnicalID>999_A<ObjectNodeSenderTechnicalID>
<Content>Child A: Some correct content</Content>
</Child>
<Child>
<ObjectNodeSenderTechnicalID>999_B<ObjectNodeSenderTechnicalID>
<Content>Child B: Some erroneous content</Content>
</Child>
Response:
<Log>
<Item>
<ReferenceObjectNodeSenderTechnicalID>999_B </ReferenceObjectNodeSenderTechnicalID>
<Note>Error message for Child B</Note>
</Item>
</Log>
The structure of the response message consists of two parts:
A business document-specific part containing information about IDs and UUIDs of the created and changed business documents
Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Possible scenarios include the following:
Create a Promotion
The MaintainBundle operation is used to create a promotion
Update an Promotion
The MaintainBundle operation is used to change or delete an existing promotion
| Description | Check promotions |
| Name | CheckMaintainBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To check if promotion data can be created, updated, or deleted without errors.
The web service request- and response message types for the CheckMaintainBundle operation are the same as those of the Maintain Bundle operation. The explanations given can therefore also be applied to the CheckMaintainBundle operation.
| Description | Maintain promotions |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To create, update, or delete an Promotion.
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as an Promotion node element that contains the promotion data to be created or updated. The detailed structure of the Promotion node will be explained in the following sub-chapters. The Promotion node can occur multiple times in the request message. This means that multiple promotions can be created and updated through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information, and an opportunity-specific node with ReferenceObjectNodeSenderTecnicalID, ChangeStateID, as well as Promotion ID.
The Promotion node element contains all general Promotion information such as ID, Name, and other forms of identification.
The data for this node is related to General data on the Promotion UI.
The ID is a unique identifier of the Promotion. In creation case, it is automatically generated by the system. In update or deletion case, the ID must be provided
The name is the subject of an Promotion. It is mandatory and will be shown in the UI.
The Priority Code specifies the priority of an Promotion by the following codes:
| PriorityCode | Description |
|---|---|
| 1 | Immediate |
| 2 | Urgent |
| 3 | Normal |
| 7 | Low |
The LifeCycleStatusCode indicates roughly the status of the promotion
The employee responsible party is the employee who's mainly responsible for the promotion. It can be specified either by the Business partner ID or the Employee ID.
The Promotion Type indicates the type of the promotion
List of products in the promotion
List of trade spend in the promotion
The Text Node Element allows you to set texts for the promotion. The following text types are allowed:
| TextTypeCode | Description |
|---|---|
| 10011 | Description |
| 10024 | Objective |
There can be multiple Additional External Comments and Competitor Notes. For each of them a timestamp as CreationDateTime can be provided to capture a sequence of comments.
The AttachmentFolder node element can be used to add or remove attachments in the promotion.
An attachment can be either a file or a link with the following CategoryCode:
| Category code | Description |
|---|---|
| 2 | Document |
| 3 | Link |
The following attachment type is supported in the promotion:
| Type code | Description |
|---|---|
| 10001 | Standard attachment |
To create link attachments, document elements must be like the following:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 3 |
| TypeCode | <none> |
| AlternativeName | <Document Title> |
| ExternalLinkWebURI | <link URI> |
| Description | <Comment> |
To create file attachments, document elements must be like the following:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 2 |
| TypeCode | <none> |
| Name | <Document Title> |
| AlternativeName | <Document Title> |
| Description | <Comment> |