| Description | Manage Shopping Cart |
| Name | ManageShoppingCartIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Internal Request Processing |
| Process Component Name | InternalRequestProcessing |
| Process Component Namespace | http://sap.com/xi/AP/Requisitioning/Global |
| Deployment Unit Description | Requisitioning |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to migrate or create shopping cart from a source system or file.
The web service Interface Manage Shopping Cart In enables you to connect external applications to your SAP Business ByDesign system and to create and edit shopping cart in your system. The web service interface Manage Shopping Cart In is relevant if your company wants to access and manage shopping cart data from external applications.
You can create a new shopping cart from Home->Self-Services Overview->Go Shopping
The web service interface Manage Shopping Cart In offers the operations CHECK_MAINTAIN_BUNDLE and MAINTAIN_BUNDLE.
Existence of referenced business documents:
The following business documents are only referenced and will not be created by the service operations. They must exist in the system already at the time the web service is called:
• Business Partners (Supplier, Company Purchasing units)
• Employees (Recipient, Requester, Customer etc)
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 operation
• Provide the same message type as the corresponding Maintain_Bundle operation
• Does not assign internal numbers from a productive number range interval (number range status are not increased)
• Does not change business documents
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. |
| 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 could 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 and to avoid accidental creation of 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 transmitted completely and hence all node elements that are not transmitted remain unchanged. If transmitted node elements in the list can be identified uniquely, the system processes the node elements according the action code. If transmitted node elements in the list cannot be identified uniquely, the system appends the node element to the corresponding list of node elements in the target business document. |
| true | The list of elements is transmitted completely and hence all node elements that are not transmitted are removed. If no node element is transmitted, the complete list is removed. |
Default list complete transmission indicator: false.
Note: The LCTI refers to the completeness of the list of node elements and does not state completeness of sub-elements.
New description with language code DE (German) is created while an existing description with language code EN (English) is updated. Moreover, an existing description with language code FR (French) remains unchanged and any other description (with language code ES (Spanish), for example) is deleted. An error is raised if there is already a German description or if the English or French description does not exist.
Show full documentation
Show full documentation
<Root actionCode="04" descriptionListCompleteTransmissionIndicator="true" >
<Description actionCode="01">
<Description languageCode="DE">neuer deutscher Text
</Description>
<Description actionCode="02">
<Description languageCode="EN">changed english text
</Description>
<Description actionCode="06">
<Description languageCode="FR"></Description>
</Description>
</Root>
Optional leaf elements in request messages that are not transmitted within a web service request are not changed in corresponding business documents.
In updating a postal address of a purchase order , the request updates the city name, street postal code, street name, and house ID. The country code remains unchanged, as the element "CountryCode" is not contained in the XML document (commented out).
<PostalAddress actionCode="02"> <!-- <CountryCode>DE</CountryCode> --> <CityName>Heidelberg</CityName> <StreetPostalCode>69117</StreetPostalCode> <StreetName>Hauptstrasse</StreetName> <HouseID></HouseID> </PostalAddress>
Note: The request deletes the house ID or updates the house ID with its initial value.
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 enforce 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.
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, 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.
Request
<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
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.
Possible scenarios include the following:
• Create one or many of Shopping Cart
| Description | Check shopping cart |
| Name | ManageShoppingCartInCheckMaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To simulate the MAINTAIN_BUNDLE service interface operation of shopping cart.
The request message of the operation Maintain Bundle contains a BasicMessageHeader node element as well as a shopping cart node element that contains the shopping cart data to be created. The detailed structure of the shopping cart node will be explained in the following sub-chapters. The shopping cart node can occur multiple times in the request message – this means that multiple shopping cart can be created through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a Shopping Cart-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as Shopping Cart ID and UUID.
Example: Check Shopping Cart Creation
Web service request
<n0:PurchaseRequestMaintainCheckRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader/>
<ShoppingCartMaintainBundle actionCode="01" ItemListCompleteTransmissionIndicator="true">
<ObjectNodeSenderTechnicalID/>
<ChangeStateID/>
<FinishShoppingCart>true</FinishShoppingCart>
<BuyerParty>
<ObjectNodePartyTechnicalID/>
<PartyKey>
<PartyTypeCode>200</PartyTypeCode>
<PartyID>MC10000</PartyID>
</PartyKey>
<actionCode/>
</BuyerParty>
<EmployeeResponsibleParty>
<ObjectNodePartyTechnicalID/>
<PartyKey>
<PartyTypeCode>147</PartyTypeCode>
<PartyID>MC0678</PartyID>
</PartyKey>
<actionCode/>
</EmployeeResponsibleParty>
<RequestorParty>
<ObjectNodePartyTechnicalID/>
<PartyKey>
<PartyTypeCode>147</PartyTypeCode>
<PartyID>MC0678</PartyID>
</PartyKey>
<actionCode/>
</RequestorParty>
<RecipientParty>
<ObjectNodePartyTechnicalID/>
<PartyKey>
<PartyTypeCode>147</PartyTypeCode>
<PartyID>MC0678</PartyID>
</PartyKey>
<actionCode/>
</RecipientParty>
<AccountingCodingBlockDistribution AccountingCodingBlockAssignmentListCompleteTransmissionIndicator="true">
<UUID/>
<AccountingCodingBlockAssignment>
<Percent>40</Percent>
<AccountingCodingBlockTypeCode>CC</AccountingCodingBlockTypeCode>
<CostCentreID>MC22000</CostCentreID>
</AccountingCodingBlockAssignment>
<AccountingCodingBlockAssignment>
<Percent>60</Percent>
<AccountingCodingBlockTypeCode>CC</AccountingCodingBlockTypeCode>
<CostCentreID>MC23000</CostCentreID>
</AccountingCodingBlockAssignment>
</AccountingCodingBlockDistribution>
<Item ItemImatListCompleteTransmissionIndicator="true">
<ObjectNodeSenderTechnicalID/>
<BusinessTransactionDocumentItemTypeCode>18</BusinessTransactionDocumentItemTypeCode>
<Quantity unitCode="EA">2</Quantity>
<DeliveryPeriod>
<StartDateTime timeZoneCode="UTC-5">2018-04-13T12:00:00.1234567Z</StartDateTime>
<EndDateTime timeZoneCode="UTC-5">2018-04-30T12:00:00.1234567Z</EndDateTime>
</DeliveryPeriod>
<Price>
<ListUnitPrice>
<Amount currencyCode="USD">10</Amount>
<BaseQuantity>2</BaseQuantity>
</ListUnitPrice>
</Price>
<ItemProduct>
<ObjectNodePartyTechnicalID/>
<CashDiscountDeductibleIndicator/>
<ProductKey>
<ProductTypeCode>1</ProductTypeCode>
<ProductIdentifierTypeCode>1</ProductIdentifierTypeCode>
<ProductID>MCF-0001</ProductID>
</ProductKey>
</ItemProduct>
</Item>
</ShoppingCartMaintainBundle>
</n0:PurchaseRequestMaintainCheckRequest>
Web service response
<n0:ShoppingCartBundleMaintainConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS0FCF7F77F27B9A9EA8B0:804"> <ShoppingCart> <ChangeStateID> 20180413070729.0000000</ChangeStateID> <BusinessTransactionDocumentID>##1</BusinessTransactionDocumentID> <UUID>00163e07-3d62-1ed8-8fdd-2a482a44e5d8</UUID> </ShoppingCart> <Log/> </n0:ShoppingCartBundleMaintainConfirmation_sync>
Structure of the request message has the following nodes and elements:
The Shopping Cart node elements contain all general information such as ID, names, and business partners. The data of this node is related to the general data on the Shopping Cart UI.
Shopping Cart ID is the ID with which the shopping cart can be addressed and found.
CurrencyCode is the currency in which the purchase is made.
Date is the creation date of shopping cart.
At header level of shopping cart following three types of parties are important.
BuyerParty: This is the buying company.
Employee Responsible Party: The employee who is requesting the purchase of goods.
Seller Party: The supplier to whom the shopping cart is raised.
Following are the common party type codes existing in the system:
| Party Type Code | Description |
|---|---|
| 154 | Company (Buyer Party) |
| 266 | Supplier |
| 167 | Employee |
The AttachmentFolder node element can be used to add and remove shopping cart attachments. Data for this node can be found on the shopping cart UI as attachments. On the user interface, files and links can be created. In the web service request, links and files are differentiated through the CategoryCode:
| Category Code | Description |
|---|---|
| 2 | Document |
| 3 | Link |
The TypeCode differentiates the different types of attachments
| TypeCode | Description |
|---|---|
| 10001 | Standard Attachment |
| 10068 | Internal Attachment |
To create link attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 3 |
| TypeCode | None |
| AlternativeName | <Document Title> |
| ExternalLinkWebURI | <link URI> |
| Description | <comment> |
To create file attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 2 |
| TypeCode | None |
| Name | <Document Title> |
| AlternativeName | <Document Title> |
| Description | <comment> |
This node is used to maintain Notes on Shopping Cart Header or Item Level. There are different types of notes supported in Shopping Cart:
| TypeCode | Description |
|---|---|
| 10011 | Internal comment |
| 10014 | Remark for Supplier |
This node has information relevant for the shopping cart items like the product, quantity, price, and various item statuses. The attributes here can be seen on the Items view of the Shopping Cart UI.
Following are some of the important attributes on Item node:
Following are the type code for items supported.
| TypeCode | Description |
|---|---|
| 18 | Material |
| 19 | Service |
| 20 | Limit |
Shopping Cart ID and UUID
Change State ID and Sender Technical ID
Log: Containing the error messages from the processing of the request.
| Release | Change Description | Details |
| 1808 | Documentation change | Service Interfaces and Operation, Structure of request message and response message, Example of payload updates |
| Description | Maintain shopping cart |
| Name | ManageShoppingCartInMaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To create one or more shopping cart.
The request message of the operation MaintainBundle contains a Basic Message Header node element as well as a Shopping Cart node element that contains the Shopping Cart data to be created. The detailed structure of the Shopping Cart node will be explained in the following sub-chapters. The Shopping Cart node can occur multiple times in the request message – this means that multiple shopping carts can be created through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a Shopping Cart specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as Shopping Cart ID and UUID.
Example : Create new Shopping Cart
Web service request
<n0:ShoppingCartBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> </BasicMessageHeader> <ShoppingCartMaintainBundle actionCode="01" ItemListCompleteTransmissionIndicator="true"> <ObjectNodeSenderTechnicalID/> <ChangeStateID/> <FinishShoppingCart>true</FinishShoppingCart> <BuyerParty> <ObjectNodePartyTechnicalID/> <PartyKey> <PartyTypeCode>200</PartyTypeCode> <PartyID>MC10000</PartyID> </PartyKey> <actionCode/> </BuyerParty> <EmployeeResponsibleParty> <ObjectNodePartyTechnicalID/> <PartyKey> <PartyTypeCode>147</PartyTypeCode> <PartyID>MC0678</PartyID> </PartyKey> <actionCode/> </EmployeeResponsibleParty> <RequestorParty> <ObjectNodePartyTechnicalID/> <PartyKey> <PartyTypeCode>147</PartyTypeCode> <PartyID>MC0678</PartyID> </PartyKey> <actionCode/> </RequestorParty> <RecipientParty> <ObjectNodePartyTechnicalID/> <PartyKey> <PartyTypeCode>147</PartyTypeCode> <PartyID>MC0678</PartyID> </PartyKey> <actionCode/> </RecipientParty> <AccountingCodingBlockDistribution AccountingCodingBlockAssignmentListCompleteTransmissionIndicator="true"> <UUID/> <AccountingCodingBlockAssignment> <Percent>40</Percent> <AccountingCodingBlockTypeCode>CC</AccountingCodingBlockTypeCode> <CostCentreID>MC22000</CostCentreID> </AccountingCodingBlockAssignment> <AccountingCodingBlockAssignment> <Percent>60</Percent> <AccountingCodingBlockTypeCode>CC</AccountingCodingBlockTypeCode> <CostCentreID>MC23000</CostCentreID> </AccountingCodingBlockAssignment> </AccountingCodingBlockDistribution> <Item ItemImatListCompleteTransmissionIndicator="true"> <ObjectNodeSenderTechnicalID/> <BusinessTransactionDocumentItemTypeCode>18</BusinessTransactionDocumentItemTypeCode> <Quantity unitCode="EA">2</Quantity> <DeliveryPeriod> <StartDateTime timeZoneCode="UTC-5">2018-04-13T12:00:00.1234567Z</StartDateTime> <EndDateTime timeZoneCode="UTC-5">2018-04-30T12:00:00.1234567Z</EndDateTime> </DeliveryPeriod> <Price> <ListUnitPrice> <Amount currencyCode="USD">10</Amount> <BaseQuantity>2</BaseQuantity> </ListUnitPrice> </Price> <ItemProduct> <ObjectNodePartyTechnicalID/> <CashDiscountDeductibleIndicator/> <ProductKey> <ProductTypeCode>1</ProductTypeCode> <ProductIdentifierTypeCode>1</ProductIdentifierTypeCode> <ProductID>MCF-0001</ProductID> </ProductKey> </ItemProduct> </Item> </ShoppingCartMaintainBundle> </n0:ShoppingCartBundleMaintainRequest_sync>
Web service response
<n0:ShoppingCartBundleMaintainConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS0FCF7F77F27B9A9EA8B0:804"> <ShoppingCart> <ChangeStateID> 20180413070729.0000000</ChangeStateID> <BusinessTransactionDocumentID>491</BusinessTransactionDocumentID> <UUID>00163e07-3d62-1ed8-8fdd-2a482a44e5d8</UUID> </ShoppingCart> <Log/> </n0:ShoppingCartBundleMaintainConfirmation_sync>
Structure of the request message has the following nodes and elements:
The shopping cart node elements contain all general information such as ID, names, TypeCode and business partners. The data of this node is related to the General Data on the Shopping Cart UI.
TypeCode : The type code determines the business object. Shopping Cart is identified with type code 16.
CurrencyCode is the currency in which the shopping cart is made.
Date is the creation date of shopping cart.
The following four types of parties are important at header level of shopping cart:
BuyerParty: This is the buying company.
Employee Responsible Party: The employee who is requesting the purchase of goods.
Seller Party: The supplier to whom the shopping cart is raised.
Following are the common party type codes existing in the system:
| Party Type Code | Description |
|---|---|
| 154 | Company (Buyer Party) |
| 266 | Supplier |
| 167 | Employee |
The AttachmentFolder node element can be used to add and remove shopping cart attachments. Data for this node can be found on the shopping cart UI as attachments. On the user interface, files and links can be created. In the web service request, links and files are differentiated through the CategoryCode:
| Category Code | Description |
|---|---|
| 2 | Document |
| 3 | Link |
The TypeCode differentiates the different types of attachments
| TypeCode | Description |
|---|---|
| 10001 | Standard Attachment |
| 10068 | Internal Attachment |
To create link attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 3 |
| TypeCode | None |
| AlternativeName | <Document Title> |
| ExternalLinkWebURI | <link URI> |
| Description | <comment> |
To create file attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 2 |
| TypeCode | None |
| Name | <Document Title> |
| AlternativeName | <Document Title> |
| Description | <comment> |
This node is used to maintain Notes on Shopping Cart Header or Item Level. There are different types of notes supported in Shopping Cart:
| TypeCode | Description |
|---|---|
| 10011 | Internal comment |
| 10014 | Remark for Supplier |
This node has information relevant for the Shopping Cart items like the product, quantity, price, and various item statuses. The attributes here can be seen on the Items view of the Shopping Cart UI.
Following are some of the important attributes on item node:
Following are the type code for items supported:
| TypeCode | Description |
|---|---|
| 18 | Material |
| 19 | Service |
| 20 | Limit |
| 84 | Expense |
Delivery Period: This is the time frame in which the goods must be delivered
Shopping Cart ID and UUID
Change State ID and Sender Technical ID
Log: Containing the error messages from the processing of the request.
| Release | Change Description | Details |
| 1808 | Documentation change | Service Interfaces and Operation, Structure of request message and response message, Example of payload updates |
| 1808 | Reference Field Bundle | RFB created for extension enablement |
| 1808 | Item Enhancement | Product description at item level |