Home / ... / OrderItemList / OrderItem / CustomParameters

CustomParameters


CustomParameters

Path: CnPAPI.Engine.Request.Order.OrderItem.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 MemberID’s being passed back for updating a database.

 Elements

  • Parameter

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.OrderItem.CustomParameters

Elements:

  • Field
  • Value

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>ClientID</Field>

                  <Value>12345</Value>

            </Parameter>

            <Parameter>

                  <Field>MembershipLevel</Field>

                  <Value>Platinum</Value>

            </Parameter>
      </
CustomParameters>

Field

Name  

Field  

Path  

CnPAPI.Engine.Request.Order.OrderItem.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>CustomerID</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.OrderItem.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>ABCD-123456</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>  




     RSS of this page