❗️

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

Schema information for eGift Bulk:

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns="http://tempuri.org/XMLSchema.xsd" xmlns:mstns="http://tempuri.org/XMLSchema.xsd" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://tempuri.org/XMLSchema.xsd" elementFormDefault="qualified">
    <xs:element name="Product">
        <xs:annotation>
            <xs:documentation>Schema for EGift Bulk</xs:documentation>
        </xs:annotation>
        <xs:complexType>
            <xs:attributeGroup ref="ProductAttributes"/>
        </xs:complexType>
    </xs:element>
    <xs:attributeGroup name="ProductAttributes">
        <xs:annotation>
            <xs:documentation>Multiple Ship and ReturnCardNumberAndPIN attributes will be set to "false", RequestId attribute will be set to null</xs:documentation>
        </xs:annotation>
        <xs:attribute name="MultipleShip" type="xs:boolean" use="required"/>
        <xs:attribute name="ReturnCardNumberAndPIN" type="xs:boolean"/>
        <xs:attribute name="RequestId" type="xs:boolean"/>
    </xs:attributeGroup>    
    <xs:element name="Credit_Card_Payment_Information" type="CreditCardPaymentInformation" minOccurs="0"/>

    <xs:complexType name="BillingAddress">
        <xs:sequence>
            <xs:element name="Billing_First_Name" type="RString20"/>
            <xs:element name="Billing_Last_Name" type="RString20"/>
            <xs:element name="Billing_Middle_Initial" type="MiddleInitial" minOccurs="0"/>
            <xs:element name="Address_Line_1" type="RString35"/>
            <xs:element name="Address_Line_2" type="OString35" minOccurs="0"/>
            <xs:element name="Billing_City" type="City"/>
            <xs:element name="Billing_State" type="State"/>
            <xs:element name="Billing_Zip" type="Zip"/>
            <xs:element name="Billing_Country" type="PaymentCountry"/>
            <xs:element name="Billing_Email" type="RString35"/>
        </xs:sequence>
    </xs:complexType>

    <xs:complexType name="CreditCardPaymentInformation">
        <xs:sequence>
            <xs:element name="Card_Type" type="CreditCardType" />
            <xs:element name="Credit_Card_Number" type="BillingCreditCardNumber" />
            <xs:element name="Security_Code" type="BillingCreditCardSecurityCode" />
            <xs:element name="Expiration_Date" type="CreditCardExpirationDate" />
            <xs:element name="Bill_Address" type="BillingAddress" />
            <xs:element name="PO_Number" type="OString50" minOccurs="0"/>
            <xs:element name="Transaction_Data_1" type="OString40" minOccurs="0" />
            <xs:element name="Transaction_Data_2" type="OString40" minOccurs="0" />
            <xs:element name="Transaction_Data_3" type="OString40" minOccurs="0" />
            <xs:element name="Transaction_Data_4" type="OString40" minOccurs="0" />
        </xs:sequence>
    </xs:complexType>

    <xs:simpleType name="BillingCreditCardNumber">
        <xs:restriction base="xs:string">
            <xs:pattern value="\d{16}|\d{15}"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="BillingCreditCardSecurityCode">
        <xs:restriction base="xs:string">
            <xs:pattern value="\d{3}|\d{4}"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="CreditCardExpirationDate">
        <xs:restriction base="xs:string">
            <xs:pattern value="((0[1-9])|(1[02]))/\d{4}"/>
            <xs:maxLength value="8"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="CreditCardType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Visa"/>
            <xs:enumeration value="MasterCard"/>
            <xs:enumeration value="American Express"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="PaymentCountry">
        <xs:restriction base="xs:string">
          <xs:pattern value="CANADA|UNITED STATES"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:complexType name="Order_Item">
        <xs:all>
            <xs:element name="Quantity" type="xs:positiveInteger"/>
            <xs:element name="Transaction_Amount" type="Amount"/>
            <xs:element name="Content_Provider_Code" type="ContentProviderCode" minOccurs="0"/>
        </xs:all>
    </xs:complexType>
    
    <xs:simpleType name="Amount">
        <xs:restriction base="xs:integer">
            <xs:totalDigits value="17"/>
            <xs:minInclusive value="1"/>
        </xs:restriction>
    </xs:simpleType>
        <xs:simpleType name="ContentProviderCode">
        <xs:restriction base="xs:string">
            <xs:maxLength value="118"/>
        </xs:restriction>
    </xs:simpleType>
    
</xs:schema>

Example XML document:

<Product MultipleShip="False">
    <Order_Item>
        <Quantity>100</Quantity>
        <Transaction_Amount>100</Transaction_Amount>
        <Content_Provider_Code>CrackerBarrel50</Content_Provider_Code>
    </Order_Item>
  </Product>

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


Did this page help you?