Perform Cart Action - Input Parameters

Perform Cart Action - Input Parameters

Tag	Data Type	Description	Required	Comments
Username	String (20)	Only SAP CPQ users can execute this function. SAP CPQ user is defined in SAP CPQ admin.	Yes	Username of API user
Password	String (25)	Only SAP CPQ users can execute this function. Password is defined in SAP CPQ admin.	Yes	Password of API user
compositeCartId	Number (8)	Order# (8-digit number)	Yes	SAP CPQ System quotation number
erpId	String(255)	Not Used	No	This field is kept for backwards compatibility purpose - it is ignored today
ActionXML	XML	Action description	Yes	It is recommended to obtain a list of available actions using “GetActionList” API call prior to executing an action using this function (PerformCartAction).

Input XML definition

Element Name	Data Type	Description	Required	Comments
Action/Name		Tag containing action name	Y	Name of the SAP CPQ Workflow action
Action/Parameters		Additional parameters	N	One node for each action parameter

The Reassign action is not supported by API.

Input XML Example

<ACTION>
  <NAME>Change Status</NAME>
  <PARAMETER name="NewStatus">Order Placed</PARAMETER>
</ACTION>

Input XML Example with <COMMENTS> Node

<?xml version="1.0" encoding="utf-8"?>
<ACTION>
    <NAME>Accept Proposal</NAME>
    <ORDER_ID>123456</ORDER_ID>
    <EXTERNAL_QUOTE_STATUS>Ordered</EXTERNAL_QUOTE_STATUS>
    <COMMENTS>
        <CommentSource>SAP Commerce Cloud</CommentSource>
        <CartComments>
            <CartComment>
                <UserFullName>Sandra Smith</UserFullName>
                <UserEmail>sandra_smith@zoho.com</UserEmail>
                <UserCompany>Acme</UserCompany>
                <Comment>Comment on the Cart Level</Comment>
            </CartComment>
        </CartComments>
        <ItemComments>
            <ItemComment>
                <ItemId>4280</ItemId>
                <UserFullName>Sandra Smith</UserFullName>
                <UserEmail>sandra_smith@zoho.com</UserEmail>
                <UserCompany>Acme</UserCompany>
                <Comment>Comment on the item level</Comment>
            </ItemComment>
        </ItemComments>
    </COMMENTS>
</ACTION>

<COMMENTS> Node Details

<CommentSource>

The node is not required and refers to the system from which the comment originates (SAP Commerce Cloud, SAP CLM or SAP CPQ).

<CartComments>

The <UserFullName> subnode is required.
The <UserEmail> subnode is required.
The <UserCompany> subnode is optional.
The <Comment> subnode refers to the comment on the cart level and is optional. However, if the subnode is provided empty, the comment will not be saved.

<ItemComments>

The <ItemId> subnode refers to the cart item ID in SAP CPQ and is required.
The <UserFullName> subnode is required.
The <UserEmail> subnode is required.
The <UserCompany> subnode is optional.
The <Comment> subnode refers to the comment on the item level and is optional. However, if the subnode is provided empty, the comment will not be saved.