Home / ... / Request.Order / CardHolder / ShippingInformation

ShippingInformation


Path: CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation

Elements:

  • ShippingContactInformation
  • ShippingAddress

Schema

 <xsd:element name="ShippingInformation">

 <xsd:complexType >  

 <xsd:sequence >  

 <xsd:element ref= "ShippingContactInformation" minOccurs="0" />  

 <xsd:element ref= "ShippingAddress" minOccurs="0" />  

 </xsd:sequence >  

 </xsd:complexType >  

 </xsd:element>

ShippingContactInformation

Path: CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation. ShippingContactInformation

Elements

  • ShippingFirstName
  • ShippingMI
  • ShippingLastName
  • ShippingEmail
  • ShippingPhone

Schema

 <xsd:element name= "ShippingContactInformation" >  

 <xsd:complexType >  

 <xsd:sequence >  

 <xsd:element ref= "ShippingFirstName" />  

 <xsd:element ref= "ShippingMI" minOccurs="0" />  

  <xsd:element ref= "ShippingLastName" />  

 <xsd:element ref= "ShippingEmail" minOccurs="0" />  

 <xsd:element ref= "ShippingPhone" minOccurs="0" />  

 </xsd:sequence >  

 </xsd:complexType >  

 </xsd:element>

ShippingFirstName

Name  

ShippingFirstName  

Path  

CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation. ShippingContactInformation.ShippingFirstName  

Description  

First name of the person receiving the shipment  

Data Type  

String  

Range  

Minimum: 1 character  

Maximum: 50 characters  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

2.8  

Required  

No  

Example  

<ShippingFirstName>John</ShippingFirstName>  

  Schema

 <xsd:element name= "ShippingFirstName" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation />  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:minLength value= "1" />  

 <xsd:maxLength value= "50" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

ShippingMI

Name  

ShippingMI  

Path  

CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation. ShippingContactInformation.ShippingMI  

Description  

Middle initial of the person receiving the shipment  

Data Type  

String  

Range  

Minimum: blank  

Maximum: 1 character  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

2.8  

Required  

No  

Example  

<ShippingMI>W</ShippingMI>  

  Schema

 <xsd:element name= "ShippingMI" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation />  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:maxLength value= "1" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

ShippingLastName

Name  

ShippingLastName  

Path  

CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation. ShippingContactInformation.ShippingLastName  

Description  

Last name of the person receiving the shipment  

Data Type  

String  

Range  

Minimum: 1 character  

Maximum: 50 character  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

2.8  

Required  

No  

Example  

<ShippingLastName>Smith</ShippingLastName>  

Schema

 <xsd:element name= "ShippingLastName" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation />  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:minLength value= "1" />  

 <xsd:maxLength value= "50" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

ShippingEmail

Name  

ShippingEmail  

Path  

CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation. ShippingContactInformation.ShippingEmail  

Description  

Email address of the person receiving the shipment  

Data Type  

String  

Range  

Minimum: 6 characters  

Maximum: 50 characters  

 

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

2.8  

Required  

No  

Example  

<ShippingEmail>Support@ClickandPledge.com </ShippingEmail>  

Schema

 <xsd:element name="ShippingEmail">

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation />  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:string" >  

 <xsd:minLength value= "6" />  

 <xsd:maxLength value= "50" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

ShippingPhone

Name  

ShippingPhone  

Path  

CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation. ShippingContactInformation.ShippingPhone  

Description  

Phone number of the person receiving the shipment  

Data Type  

String  

Range  

Minimum: 6 characters  

Maximum: 50 characters  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

2.8  

Required  

No  

Example  

< ShippingPhone>5409619811</ShippingPhone>  

Schema

 <xsd:element name="ShippingPhone">

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation />  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:string" >  

 <xsd:minLength value= "6" />  

 <xsd:maxLength value= "50" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

ShippingAddress

Path: CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation.ShippingAddress

Elements:

  • ShippingAddress1
  • ShippingAddress2
  • ShippingAddress3
  • ShippingCity
  • ShippingStateProvince
  • ShippingPostalCode
  • ShippingCountryCode

Schema

 <xsd:element name= "ShippingAddress" >  

 <xsd:complexType >  

 <xsd:sequence >  

 <xsd:element ref= "ShippingAddress1" />  

 <xsd:element ref= "ShippingAddress2" minOccurs="0" />  

 <xsd:element ref= "ShippingAddress3" minOccurs="0" />  

 <xsd:element ref= "ShippingCity" />  

 <xsd:element ref= "ShippingStateProvince" />  

 <xsd:element ref= "ShippingPostalCode" />  

 <xsd:element ref= "ShippingCountryCode" />  

 </xsd:sequence >  

 </xsd:complexType >  

 </xsd:element>

Example

 <ShippingAddress>

 <ShippingAddress1>123 Shipping Avenue</ShippingAddress1>

 <ShippingAddress2>Suite 1234</ShippingAddress2>

  <ShippingAddress3></ShippingAddress3>

 <ShippingCity>John City</ShippingCity>

 <ShippingStateProvince>Big State</ShippingStateProvince>

 <ShippingPostalCode>12345-4564</ShippingPostalCode>

 <ShippingCountryCode>840</ShippingCountryCode>

 </ShippingAddress>

 </ShippingInformation>

ShippingAddress1

Name  

ShippingAddress1  

Path  

CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation. ShippingAddress. ShippingAddress1  

Description  

Line 1 of the shipping address.  

Data Type  

String  

Range  

Minimum: 2 characters  

Maximum: 100 characters  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<ShippingAddress1>123 Delivery Street</ShippingAddress1>

Schema

 <xsd:element name= "ShippingAddress1" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> Line 1 of the shipping address.</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:minLength value= "2" />  

 <xsd:maxLength value= "100" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

ShippingAddress2

Name  

ShippingAddress2  

Path  

CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation. ShippingAddress. ShippingAddress2  

Description  

Line 2 of the shipping address.  

Data Type  

String  

Range  

Minimum: blank  

Maximum: 100 characters  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<ShippingAddress2>Suite 34B</ShippingAddress2>  

Schema

 <xsd:element name= "ShippingAddress2" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> Line 2 of the shipping address.</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:maxLength value= "100" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

ShippingAddress3

Name  

ShippingAddress3  

Path  

CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation. ShippingAddress. ShippingAddress3  

Description  

Line 3 of the shipping address.  

Data Type  

String  

Range  

Minimum: blank  

Maximum: 100 characters  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<ShippingAddress3></ShippingAddress3>  

Schema

 <xsd:element name= "ShippingAddress3" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> Line 3 of the shipping address.</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:maxLength value= "100" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

ShippingCity

Name  

ShippingCity  

Path  

CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation.ShippingAddress.ShippingCity  

Description  

Shipping address city.  

Data Type  

String  

Range  

Minimum: 2  

Maximum: 50 characters  

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

 

<ShippingCity>Germantown</ShippingCity>  

Schema

 <xsd:element name= "ShippingCity" >  

  <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> Shipping address city.</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:minLength value= "2" />  

 <xsd:maxLength value= "50" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

ShippingStateProvince

Name  

ShippingStateProvince  

Path  

CnPAPI.Engine.Request.Order.CardHolder.ShipingInformation. ShippingAddress. ShippingStateProvince  

Description  

Shipping address state or province  

Data Type  

String  

Range  

Minimum: 2 characters  

Maximum: 50 characters  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<ShippingStateProvince>Maryland</ShippingStateProvince>  

Schema

 <xsd:element name= "ShippingStateProvince" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> Shipping address state or province</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

  <xsd:minLength value= "2" />  

 <xsd:maxLength value= "50" />  

 </xsd:restriction >  

 </xsd:simpleType>
 </
xsd:element >  

ShippingPostalCode

Name  

ShippingPostalCode  

Path  

CnPAPI.Engine.Request.Order. CardHolder.ShipingInformation. ShippingAddress. ShippingPostalCode  

Description  

Shipping address zip or postal code  

Data Type  

String  

Range  

Minimum: 2 characters  

Maximum: 20 characters  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<ShippingPostalCode>20874</ShippingPostalCode>  

Schema

 <xsd:element name= "ShippingPostalCode" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> Shipping address zip or postal code</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:minLength value= "2" />  

 <xsd:maxLength value= "20" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>

ShippingCountryCode

Name  

ShippingCountryCode  

Path  

CnPAPI.Engine.Request.Order. CardHolder.ShipingInformation. ShippingAddress. ShippingCountryCode  

Description  

Shipping address ISO country code. Refer to appendix A for details  

Data Type  

String  

Range  

Minimum: 111  

Maximum: 999  

3 digits ISO country code: See appendix A  

Default  

 

Operation  

Transaction Operation only  

Input/output  

Input  

Version/Release  

1.2  

Required  

No  

Example  

<ShippingCountryCode>840</ShippingCountryCode>   

Schema

 <xsd:element name= "ShippingCountryCode" >  

 <xsd:simpleType >  

 <xsd:annotation >  

 <xsd:documentation> Shipping address ISO country code. Refer to appendix A for details</xsd:documentation >  

 </xsd:annotation >  

 <xsd:restriction base= "xsd:normalizedString" >  

 <xsd:minLength value= "3" />  

 <xsd:maxLength value= "3" />  

 </xsd:restriction >  

 </xsd:simpleType >  

 </xsd:element>




     RSS of this page