Path: CnPAPI.Engine.Request.Order.Shipping
Elements:
- ShippingMethod
- ShippingValue
- ShippingTax
- CustomParameters
Schema
<xsd:element name="Shipping">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="ShippingMethod"/>
<xsd:element ref="ShippingValue"/>
<xsd:element ref="ShippingTax" minOccurs="0"/>
<xsd:element ref="CustomParameters" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Example
<Shipping>
<ShippingMethod></ShippingMethod>
<ShippingValue>500</ShippingValue>
<ShippingTax>100</ShippingTax>
</Shipping>
ShippingMethod
|
Name
|
ShippingMethod
|
|
Path
|
CnPAPI.Engine.Request.Order.Shipping.ShippingMethod
|
|
Description
|
The shipping method to be used
for this order. Example: FedEx, UPS, Regular Mail. Shipping method will appear in the receipt
as well as the report.
|
|
Data Type
|
String
|
|
Range
|
Minimum: blank
Maximum: 50 characters
|
|
Default
|
|
|
Operation
|
Transaction Operation only
|
|
Input/output
|
Input
|
|
Version/Release
|
1.2
|
|
Required
|
No
|
|
Example
|
<ShippingMethod>FedEx</ShippingMethod>
|
Schema
<xsd:element name="ShippingMethod">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>The shipping method to be used for
this order. Example: FedEx, UPS, Regular Mail. Shipping method will appear in the receipt as
well as the report.</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:normalizedString">
<xsd:maxLength value="50"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
ShippingValue
Name
|
ShippingValue
|
|
Path
|
CnPAPI.Engine.Request.Order.Shipping.ShippingValue
|
|
Description
|
Total shipping cost of the
order. Shipping cost will appear in
the receipt as well as the report.
|
|
Data Type
|
Int64
|
|
Range
|
Minimum: 0
Maximum: 9999999999
Use
12345 for $123.45 – do not use decimal points. $100 = 10000
|
|
Default
|
|
|
Operation
|
Transaction Operation only
|
|
Input/output
|
Input
|
|
Version/Release
|
1.2
|
|
Required
|
Yes if
ShippingMethod is used.
|
|
Example
|
<ShippingValue>500</ShippingValue>
The above shipping value is
$5.00
|
Schema
<xsd:element name="ShippingValue">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Total shipping cost of the
order. Shipping cost will appear in the
receipt as well as the report.</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:long">
<xsd:minInclusive value="0"/>
<xsd:maxInclusive value="9999999999"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
ShippingTax
|
Name
|
ShippingTax
|
|
Path
|
CnPAPI.Engine.Request.Order.Shipping.ShippingTax
|
|
Description
|
Total shipping tax
|
|
Data Type
|
Int64
|
|
Range
|
Minimum: 0
Maximum: 9999999999
Use
12345 for $123.45 – do not use decimal points. $100 = 10000
|
|
Default
|
|
|
Operation
|
Transaction Operation only
|
|
Input/output
|
Input
|
|
Version/Release
|
1.5
|
|
Required
|
No
|
|
Example
|
<ShippingTax>100</
ShippingTax >
The above shipping value is
$1.00
|
Schema
<xsd:element name="ShippingTax">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation/>
</xsd:annotation>
<xsd:restriction base="xsd:long">
<xsd:minInclusive value="0"/>
<xsd:maxInclusive value="9999999999"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
CustomParameters
Path: CnPAPI.Engine.Request.Order.Shipping.CustomParameters
Custom parameters are additional fields that may be passed as part of each transaction. These parameters will post back in the response. These fields will NOT be included in the receipt and are primarily designed for interaction between external applications. For example FedEX account number being passed back for updating a database.
Elements
Schema
<xsd:element name="CustomParameters">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="Parameter" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Parameter
Path: CnPAPI.Engine.Request.Order.Shipping.CustomParameters
Elements:
Schema
<xsd:element name="Parameter">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="Field"/>
<xsd:element ref="Value"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Example
<CustomParameters>
<Parameter>
<Field>FedEx</Field>
<Value>123456789</Value>
</Parameter>
<Parameter>
<Field>FedEx Method</Field>
<Value>2nd Day Air</Value>
</Parameter>
</CustomParameters>
Field
Name | Field |
Path | CnPAPI.Engine.Request.Order.Shipping.CustomParameters.Parameter.Field |
Description | Additional information collected to be used with the post back |
Data Type | String |
Range | Minimum: blank Maximum: 100 characters |
Default | |
Operation | Transaction Operation only |
Input/output | Input |
Version/Release | 2.34 |
Required | No |
Example | <Field>FedEx</Field> |
Schema
<xsd:element name="Field">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Additional information to be used with post back response</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:normalizedString">
<xsd:maxLength value="100"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
Value
Name | Value |
Path | CnPAPI.Engine.Request.Order.Shipping.CustomParameters.Parameter.Value |
Description | Additional information collected to be used with the post back. The value to be used for the “Field” node. |
Data Type | String |
Range | Minimum: blank Maximum: 300 characters |
Default | |
Operation | Transaction Operation only |
Input/output | Input |
Version/Release | 2.34 |
Required | No |
Example | <Value>123456789</Value> |
Schema
<xsd:element name="Value">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation><![CDATA[Value for the Field.]]></xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:normalizedString">
<xsd:maxLength value="300"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
Uploading ....