Bulk Demographic

❗️

If you're looking to start a new integration please see our REST documentation.

Schema information for Demographic Information to Bulk Multiple Ship or Bulk Override:

<?xml version="1.0" encoding="utf-8" ?>
<xs:schema targetNamespace="http://tempuri.org/XMLSchema.xsd" elementFormDefault="qualified"
    xmlns="http://tempuri.org/XMLSchema.xsd" xmlns:mstns="http://tempuri.org/XMLSchema.xsd"
    xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="Product">
        <xs:annotation>
            <xs:documentation>Schema for Demographic info only for Reloadable Bulk Multiple ship or Bulks ship override</xs:documentation>
        </xs:annotation>
        <xs:complexType>
            <xs:attributeGroup ref="ProductAttributes" />
        </xs:complexType>
    </xs:element>
    <xs:attributeGroup name="ProductAttributes">
        <xs:annotation>
            <xs:documentation>Multiple Ship attribute will be set to "True"</xs:documentation>
        </xs:annotation>
        <xs:attribute name="MultipleShip" type="xs:boolean" use="required" />
    </xs:attributeGroup>
    <xs:complexType name="Order_Item">
        <xs:all>
            <xs:element name="Cardholder_PID_Number" type="CardholderPIDNumber" />
            <xs:element name="Title_1" type="Title" minOccurs="0"/>
            <xs:element name="Demo_First_Name" type="RString25"/>
            <xs:element name="Middle_Name_or_Initial" type="OString25" minOccurs="0"/>
            <xs:element name="Demo_Last_Name" type="RString25"/>
            <xs:element name="Title_2" type="String5" minOccurs="0"/>
            <xs:element name="Card_Emboss_Name" type="EmbossName" minOccurs="0"/>
            <xs:element name="Fourth_Line_Emboss_Text" type="EmbossText" minOccurs="0"/>
            <xs:element name="Address_Element_1" type="RString50"/>
            <xs:element name="Address_Element_2" type="OString50" minOccurs="0"/>
            <xs:element name="Address_Element_3" type="OString50" minOccurs="0"/>
            <xs:element name="Address_Element_8" type="City"/>
            <xs:element name="Address_Element_9" type="State"/>
            <xs:element name="Address_Element_10" type="Zip"/>
            <xs:element name="Address_Element_11" type="Zip4" minOccurs="0"/>
            <xs:element name="Phone_Element_2" type="String3" minOccurs="0"/>
            <xs:element name="Phone_Element_3" type="String7" minOccurs="0"/>
            <xs:element name="Phone_Element_4" type="String6" minOccurs="0"/>
            <xs:element name="Program_Participation_Status" type="ParticipationStatus" minOccurs="0"/>
            <xs:element name="Indicative_Data_1" type="String17" minOccurs="0"/>
            <xs:element name="Indicative_Data_2" type="String17" minOccurs="0"/>
            <xs:element name="Indicative_Data_3" type="String17" minOccurs="0"/>
            <xs:element name="Indicative_Data_4" type="String17" minOccurs="0"/>
            <xs:element name="Indicative_Data_5" type="String17" minOccurs="0"/>
            <xs:element name="Internet_Element_1" type="Internet_Address" minOccurs="0"/>
            <xs:element name="Bulk_Ship_Address_Element_1" type="RString50"/>
            <xs:element name="Bulk_Ship_Address_Element_2" type="ReqNotPOBox"/>
            <xs:element name="Bulk_Ship_Address_Element_3" type="OptNotPOBox" minOccurs="0"/>
            <xs:element name="Bulk_Ship_Address_Element_8" type="RString50"/>
            <xs:element name="Bulk_Ship_Address_Element_9" type="State"/>
            <xs:element name="Bulk_Ship_Address_Element_10" type="Zip"/>
            <xs:element name="Bulk_Ship_Address_Element_11" type="Zip4" minOccurs="0"/>
            <xs:element name="Card_Carrier_Message" type="OString80" minOccurs="0" minOccurs="0"/>
        </xs:all>
    </xs:complexType>

    <xs:simpleType name="CardholderPIDNumber">
        <xs:restriction base="RString30">
            <xs:pattern value="[A-Za-z\d\-]+" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="City">
        <xs:restriction base="RString50">
            <xs:pattern value="[\w\s.-]+"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="EmbossName">
        <xs:restriction base="String21">
            <xs:pattern value="(|[-A-Za-z0-9,.\s/']+)"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="EmbossText">
        <xs:restriction base="String21">
            <xs:pattern value="(|[-A-Za-z0-9,.\s/'&amp;]+)" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="Internet_Address">
        <xs:restriction base="OString50">
            <xs:minLength value="0" />
            <xs:pattern value="([\w-_'\.]+)@((\[\d{1,3}\.\d{1,3}\.\d{1,3}\.)|(([\w-_']+\.)+))(\w{2,4}|\d{1,3})(\]?)$"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="OptNotPOBox">
        <xs:restriction base="xs:string">
            <xs:pattern value="(|^(?!([Pp]\.?\s?[Oo]\.?\s))(.)*)" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="OString25">
        <xs:restriction base="xs:string">
            <xs:maxLength value="25" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="OString40">
        <xs:restriction base="xs:string">
            <xs:minLength value="0" />
            <xs:maxLength value="40" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="OString50">
        <xs:restriction base="xs:string">
            <xs:minLength value="0" />
            <xs:maxLength value="50" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="ParticipationStatus">
        <xs:annotation>
            <xs:documentation>A-Active; I-Inactive; C-Cancelled; S-Suspended; R-Under Review; V-VIP</xs:documentation>
        </xs:annotation>
        <xs:restriction base="xs:string">
            <xs:enumeration value="A"/>
            <xs:enumeration value="I"/>
            <xs:enumeration value="C"/>
            <xs:enumeration value="S"/>
            <xs:enumeration value="R"/>
            <xs:enumeration value="V"/>
            <xs:enumeration value=""/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="ReqNotPOBox">
        <xs:restriction base="xs:string">
            <xs:pattern value="^(?!([Pp]\.?\s?[Oo]\.?\s))(.)*" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="RString25">
        <xs:restriction base="xs:string">
            <xs:minLength value="1" />
            <xs:maxLength value="25" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="RString30">
        <xs:restriction base="xs:string">
            <xs:minLength value="1" />
            <xs:maxLength value="30" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="RString50">
        <xs:restriction base="xs:string">
            <xs:minLength value="1" />
            <xs:maxLength value="50" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="State">
        <xs:restriction base="xs:string">
            <xs:enumeration value="AA" />
            <xs:enumeration value="AE" />
            <xs:enumeration value="AP" />
            <xs:enumeration value="AK" />
            <xs:enumeration value="AL" />
            <xs:enumeration value="AR" />
            <xs:enumeration value="AZ" />
            <xs:enumeration value="CA" />
            <xs:enumeration value="CO" />
            <xs:enumeration value="CT" />
            <xs:enumeration value="DC" />
            <xs:enumeration value="DE" />
            <xs:enumeration value="FL" />
            <xs:enumeration value="GA" />
            <xs:enumeration value="GU" />
            <xs:enumeration value="HI" />
            <xs:enumeration value="IA" />
            <xs:enumeration value="ID" />
            <xs:enumeration value="IL" />
            <xs:enumeration value="IN" />
            <xs:enumeration value="KS" />
            <xs:enumeration value="KY" />
            <xs:enumeration value="LA" />
            <xs:enumeration value="MA" />
            <xs:enumeration value="MD" />
            <xs:enumeration value="ME" />
            <xs:enumeration value="MI" />
            <xs:enumeration value="MN" />
            <xs:enumeration value="MO" />
            <xs:enumeration value="MS" />
            <xs:enumeration value="MT" />
            <xs:enumeration value="NC" />
            <xs:enumeration value="ND" />
            <xs:enumeration value="NE" />
            <xs:enumeration value="NH" />
            <xs:enumeration value="NJ" />
            <xs:enumeration value="NM" />
            <xs:enumeration value="NV" />
            <xs:enumeration value="NY" />
            <xs:enumeration value="OH" />
            <xs:enumeration value="OK" />
            <xs:enumeration value="OR" />
            <xs:enumeration value="PA" />
            <xs:enumeration value="PR" />
            <xs:enumeration value="RI" />
            <xs:enumeration value="SC" />
            <xs:enumeration value="SD" />
            <xs:enumeration value="TN" />
            <xs:enumeration value="TX" />
            <xs:enumeration value="UT" />
            <xs:enumeration value="VA" />
            <xs:enumeration value="VI" />
            <xs:enumeration value="VT" />
            <xs:enumeration value="WA" />
            <xs:enumeration value="WI" />
            <xs:enumeration value="WV" />
            <xs:enumeration value="WY" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="String3">
        <xs:restriction base="xs:string">
            <xs:maxLength value="3" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="String5">
        <xs:restriction base="xs:string">
            <xs:maxLength value="5" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="String6">
        <xs:restriction base="xs:string">
            <xs:maxLength value="6" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="String7">
        <xs:restriction base="xs:string">
            <xs:maxLength value="7" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="String17">
        <xs:restriction base="xs:string">
            <xs:maxLength value="17" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="String21">
        <xs:restriction base="xs:string">
            <xs:maxLength value="21" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="String26">
        <xs:restriction base="xs:string">
            <xs:maxLength value="26" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="Title">
        <xs:restriction base="xs:NMTOKEN">
            <xs:enumeration value="Mr" />
            <xs:enumeration value="Mrs" />
            <xs:enumeration value="Miss" />
            <xs:enumeration value="Ms" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="Zip">
        <xs:restriction base="xs:string">
            <xs:pattern value="\d{5}" />
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="Zip4">
        <xs:restriction base="xs:string">
            <xs:pattern value="\d{4}" />
        </xs:restriction>
    </xs:simpleType>
</xs:schema>

Example XML document for Demographic Information to Bulk Multiple Ship or Bulk Override:

<Product MultipleShip="True">
  <Order_Item>
    <Cardholder_PID_Number>312345678</Cardholder_PID_Number>
    <Demo_First_Name>Mickey</Demo_First_Name>
    <Demo_Last_Name>Mouse</Demo_Last_Name>
    <Card_Emboss_Name>MICKEY MOUSE</Card_Emboss_Name>
    <Fourth_Line_Emboss_Text>DALEY CARE MGMT. INC.</Fourth_Line_Emboss_Text>
    <Address_Element_1>2609 Marlynn Drive</Address_Element_1>
    <Address_Element_2>Mail Stop 15</Address_Element_2>
    <Address_Element_8>Springfield</Address_Element_8>
    <Address_Element_9>VA</Address_Element_9>
    <Address_Element_10>22153</Address_Element_10>
    <Phone_Element_2>123</Phone_Element_2>
    <Phone_Element_3>1234567</Phone_Element_3>
    <Phone_Element_4>1234</Phone_Element_4>
    <Indicative_Data_1>Mouse</Indicative_Data_1>
    <Internet_Element_1>[email protected]</Internet_Element_1>
    <Bulk_Ship_Address_Element_1>Daley Care management Company Tom Thumb</Bulk_Ship_Address_Element_1>
    <Bulk_Ship_Address_Element_2>456 AnyWay Street</Bulk_Ship_Address_Element_2>
    <Bulk_Ship_Address_Element_8>Tempe</Bulk_Ship_Address_Element_8>
    <Bulk_Ship_Address_Element_9>AZ</Bulk_Ship_Address_Element_9>
    <Bulk_Ship_Address_Element_10>92067</Bulk_Ship_Address_Element_10>
  </Order_Item>
  <Order_Item>
    <Cardholder_PID_Number>812345678</Cardholder_PID_Number>
    <Demo_First_Name>Lauren</Demo_First_Name>
    <Demo_Last_Name>Bacall</Demo_Last_Name>
    <Card_Emboss_Name>LAUREN BACALL</Card_Emboss_Name>
    <Fourth_Line_Emboss_Text>DALEY CARE MGMT. INC.</Fourth_Line_Emboss_Text>
    <Address_Element_1>34 Smoke Tree</Address_Element_1>
    <Address_Element_8>Springfield</Address_Element_8>
    <Address_Element_9>VA</Address_Element_9>
    <Address_Element_10>22153</Address_Element_10>
    <Indicative_Data_1>Bacall</Indicative_Data_1>
    <Internet_Element_1>[email protected]</Internet_Element_1>
    <Bulk_Ship_Address_Element_1>Daley Care management Company Tom Thumb</Bulk_Ship_Address_Element_1>
    <Bulk_Ship_Address_Element_2>456 AnyWay Street</Bulk_Ship_Address_Element_2>
    <Bulk_Ship_Address_Element_8>Tempe</Bulk_Ship_Address_Element_8>
    <Bulk_Ship_Address_Element_9>AZ</Bulk_Ship_Address_Element_9>
    <Bulk_Ship_Address_Element_10>92067</Bulk_Ship_Address_Element_10>
  </Order_Item>
</Product>

Reward cards are issued in connection with a loyalty, award or promotion program.


Did this page help you?