Request.Order


Table of Contents  [ Hide]

Path: CnPAPI.Engine.Request.Order

Elements:

Schema

       <xsd:element name="Order">
              <xsd:complexType>
                     <xsd:sequence>
                           <xsd:element ref="OrderMode"/>
                           <xsd:element ref="Tracker" minOccurs="0"/>
                           <xsd:element ref="Campaign" minOccurs="0"/>
                           <xsd:element ref="GiveBigCampaignAlias" minOccurs="0"/>
                           <xsd:element ref="ConnectCampaignAlias" minOccurs="0"/>
                           <xsd:element ref="CampaignList" minOccurs="0"/>
                           <xsd:element ref="IntegratedPartner" minOccurs="0"/>
                           <xsd:element ref="CardHolder" minOccurs="0"/>
                           <xsd:element ref="ThirdParty" minOccurs="0"/>
                           <xsd:element ref="OrderItemList" minOccurs="0"/>
                           <xsd:element ref="Shipping" minOccurs="0"/>
                           <xsd:element ref="Receipt" minOccurs="0"/>
                           <xsd:element ref="Transaction"/>
                           <xsd:element ref="PassThroughList" minOccurs="0"/>
                     </xsd:sequence>
              </xsd:complexType>
       </xsd:element>

Details for each of the elements are listed below:

OrderMode

Name  

OrderMode  

Path  

CnPAPI.Engine.Request.Order.OrderMode  

Description  

Specify the order mode. Test mode may be used for testing and development. In test mode only test credit card numbers may be used. In Production mode transactions are only performed with real credit cards.  

Data Type  

String  

Range  

Production  -Production Environment  

Test:  Test environment  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

yes  

Example  

<OrderMode>Test</OrderMode>  

Schema

 <xsd:element name= "OrderMode" >
  <xsd:simpleType  >
   <xsd:annotation  >
       <xsd:documentation>  Specify the order mode. Test mode may be used for testing and development. In test mode only test credit card numbers may be used. In Production mode transactions are only performed with real credit cards.</xsd:documentation >
   </xsd:annotation  >
   <xsd:restriction base=  "xsd:string" >
    <xsd:enumeration value=  "Production" />
    <xsd:enumeration value=  "Test" />
   </xsd:restriction  >
  </xsd:simpleType  >
 </xsd:element>

Tracker

Name  

Tracker  

Path  

CnPAPI.Engine.Request.Order.Tracker  

Description  

Tracker is a simple text that is an optional parameter which is passed along with each transaction. Transactions may be queried in the reporting section based on the Tracker text.  

Data Type  

String  

Range  

Minimum: blank  

Maximum: 50 characters  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<Tracker>Solicitation20090301</Tracker>

Schema

 <xsd:element name= "Tracker" >
  <xsd:simpleType  >
      <xsd:annotation  >
          <xsd:documentation>  Tracker is a simple text that is an optional parameter which is passed along with each transaction. Transactions may be queried in the reporting section based on the Tracker text.</xsd:documentation >
   </xsd:annotation  >
   <xsd:restriction base=  "xsd:normalizedString" >
    <xsd:minLength value=  "0" />
    <xsd:maxLength value=  "50" />
   </xsd:restriction  >
  </xsd:simpleType  >
 </xsd:element>

Campaign

Name  

Tracker  

Path  

CnPAPI.Engine.Request.Order.Campaign  

Description  

The value for campaign will be matched against the defined campaign in the administrative portal.  It will also post to Salesforce and update the campaign statistics for the matched campaign name.  

Data Type  

String  

Range  

Minimum: blank  

Maximum: 80 characters  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

2.30  

Required  

No  

Example  

<Campaign>Spring2020</Campaign>

Schema




     RSS of this page