LoyaltyPath Web Service

LoyaltyPath

Click here for a complete list of operations.

EnrollNewCardmemberV12

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /LoyaltyPath.asmx HTTP/1.1
Host: posapi.loyaltypath.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://posapi.loyaltypath.com/EnrollNewCardmemberV12"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <EnrollNewCardmemberV12 xmlns="https://posapi.loyaltypath.com/">
      <username>string</username>
      <password>string</password>
      <storeId>int</storeId>
      <cardNumber>string</cardNumber>
      <enrollmentLocation>string</enrollmentLocation>
      <firstName>string</firstName>
      <lastName>string</lastName>
      <emailAddress>string</emailAddress>
      <namePrefix>string</namePrefix>
      <streetAddressLine1>string</streetAddressLine1>
      <streetAddressLine2>string</streetAddressLine2>
      <city>string</city>
      <state>string</state>
      <zip>string</zip>
      <country>string</country>
      <phoneNumber1>string</phoneNumber1>
      <phoneNumber2>string</phoneNumber2>
      <phoneNumber3>string</phoneNumber3>
      <phoneNumber4>string</phoneNumber4>
      <phoneNumber5>string</phoneNumber5>
      <phoneNumber6>string</phoneNumber6>
      <phoneNumber7>string</phoneNumber7>
      <phoneNumber8>string</phoneNumber8>
      <phoneNumber9>string</phoneNumber9>
      <phoneNumber10>string</phoneNumber10>
      <birthday>string</birthday>
      <weddingAnniversary>string</weddingAnniversary>
      <numInHousehold>string</numInHousehold>
      <spouseFirstName>string</spouseFirstName>
      <spouseLastName>string</spouseLastName>
      <spouseEmailAddress>string</spouseEmailAddress>
      <spouseBirthday>string</spouseBirthday>
      <childFirstName1>string</childFirstName1>
      <childBirthday1>string</childBirthday1>
      <childFirstName2>string</childFirstName2>
      <childBirthday2>string</childBirthday2>
      <childFirstName3>string</childFirstName3>
      <childBirthday3>string</childBirthday3>
      <childFirstName4>string</childFirstName4>
      <childBirthday4>string</childBirthday4>
      <childFirstName5>string</childFirstName5>
      <childBirthday5>string</childBirthday5>
      <childFirstName6>string</childFirstName6>
      <childBirthday6>string</childBirthday6>
      <childFirstName7>string</childFirstName7>
      <childBirthday7>string</childBirthday7>
      <childFirstName8>string</childFirstName8>
      <childBirthday8>string</childBirthday8>
      <childFirstName9>string</childFirstName9>
      <childBirthday9>string</childBirthday9>
      <childFirstName10>string</childFirstName10>
      <childBirthday10>string</childBirthday10>
      <clerkNumber>string</clerkNumber>
      <referralCode>string</referralCode>
      <signUpDate>string</signUpDate>
      <storeVariableField1>string</storeVariableField1>
      <storeVariableField2>string</storeVariableField2>
      <storeVariableField3>string</storeVariableField3>
      <storeVariableField4>string</storeVariableField4>
      <storeVariableField5>string</storeVariableField5>
      <storeVariableField6>string</storeVariableField6>
      <storeVariableField7>string</storeVariableField7>
      <storeVariableField8>string</storeVariableField8>
      <storeVariableField9>string</storeVariableField9>
      <storeVariableField10>string</storeVariableField10>
      <chainVariableField1>string</chainVariableField1>
      <chainVariableField2>string</chainVariableField2>
      <chainVariableField3>string</chainVariableField3>
      <chainVariableField4>string</chainVariableField4>
      <chainVariableField5>string</chainVariableField5>
      <chainVariableField6>string</chainVariableField6>
      <chainVariableField7>string</chainVariableField7>
      <chainVariableField8>string</chainVariableField8>
      <chainVariableField9>string</chainVariableField9>
      <chainVariableField10>string</chainVariableField10>
      <textOptIn>string</textOptIn>
      <txtPhone>string</txtPhone>
      <cellNetwork>string</cellNetwork>
      <bilingualOption>string</bilingualOption>
      <communityConnectionGroupId>string</communityConnectionGroupId>
      <customerNotes>string</customerNotes>
      <pointBalance>string</pointBalance>
      <pointBalanceBonus>string</pointBalanceBonus>
      <pointBalanceLT>string</pointBalanceLT>
      <hashedPassword>string</hashedPassword>
      <welcomeAlreadySent>string</welcomeAlreadySent>
      <campaign>string</campaign>
    </EnrollNewCardmemberV12>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <EnrollNewCardmemberV12Response xmlns="https://posapi.loyaltypath.com/">
      <EnrollNewCardmemberV12Result>string</EnrollNewCardmemberV12Result>
    </EnrollNewCardmemberV12Response>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /LoyaltyPath.asmx HTTP/1.1
Host: posapi.loyaltypath.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <EnrollNewCardmemberV12 xmlns="https://posapi.loyaltypath.com/">
      <username>string</username>
      <password>string</password>
      <storeId>int</storeId>
      <cardNumber>string</cardNumber>
      <enrollmentLocation>string</enrollmentLocation>
      <firstName>string</firstName>
      <lastName>string</lastName>
      <emailAddress>string</emailAddress>
      <namePrefix>string</namePrefix>
      <streetAddressLine1>string</streetAddressLine1>
      <streetAddressLine2>string</streetAddressLine2>
      <city>string</city>
      <state>string</state>
      <zip>string</zip>
      <country>string</country>
      <phoneNumber1>string</phoneNumber1>
      <phoneNumber2>string</phoneNumber2>
      <phoneNumber3>string</phoneNumber3>
      <phoneNumber4>string</phoneNumber4>
      <phoneNumber5>string</phoneNumber5>
      <phoneNumber6>string</phoneNumber6>
      <phoneNumber7>string</phoneNumber7>
      <phoneNumber8>string</phoneNumber8>
      <phoneNumber9>string</phoneNumber9>
      <phoneNumber10>string</phoneNumber10>
      <birthday>string</birthday>
      <weddingAnniversary>string</weddingAnniversary>
      <numInHousehold>string</numInHousehold>
      <spouseFirstName>string</spouseFirstName>
      <spouseLastName>string</spouseLastName>
      <spouseEmailAddress>string</spouseEmailAddress>
      <spouseBirthday>string</spouseBirthday>
      <childFirstName1>string</childFirstName1>
      <childBirthday1>string</childBirthday1>
      <childFirstName2>string</childFirstName2>
      <childBirthday2>string</childBirthday2>
      <childFirstName3>string</childFirstName3>
      <childBirthday3>string</childBirthday3>
      <childFirstName4>string</childFirstName4>
      <childBirthday4>string</childBirthday4>
      <childFirstName5>string</childFirstName5>
      <childBirthday5>string</childBirthday5>
      <childFirstName6>string</childFirstName6>
      <childBirthday6>string</childBirthday6>
      <childFirstName7>string</childFirstName7>
      <childBirthday7>string</childBirthday7>
      <childFirstName8>string</childFirstName8>
      <childBirthday8>string</childBirthday8>
      <childFirstName9>string</childFirstName9>
      <childBirthday9>string</childBirthday9>
      <childFirstName10>string</childFirstName10>
      <childBirthday10>string</childBirthday10>
      <clerkNumber>string</clerkNumber>
      <referralCode>string</referralCode>
      <signUpDate>string</signUpDate>
      <storeVariableField1>string</storeVariableField1>
      <storeVariableField2>string</storeVariableField2>
      <storeVariableField3>string</storeVariableField3>
      <storeVariableField4>string</storeVariableField4>
      <storeVariableField5>string</storeVariableField5>
      <storeVariableField6>string</storeVariableField6>
      <storeVariableField7>string</storeVariableField7>
      <storeVariableField8>string</storeVariableField8>
      <storeVariableField9>string</storeVariableField9>
      <storeVariableField10>string</storeVariableField10>
      <chainVariableField1>string</chainVariableField1>
      <chainVariableField2>string</chainVariableField2>
      <chainVariableField3>string</chainVariableField3>
      <chainVariableField4>string</chainVariableField4>
      <chainVariableField5>string</chainVariableField5>
      <chainVariableField6>string</chainVariableField6>
      <chainVariableField7>string</chainVariableField7>
      <chainVariableField8>string</chainVariableField8>
      <chainVariableField9>string</chainVariableField9>
      <chainVariableField10>string</chainVariableField10>
      <textOptIn>string</textOptIn>
      <txtPhone>string</txtPhone>
      <cellNetwork>string</cellNetwork>
      <bilingualOption>string</bilingualOption>
      <communityConnectionGroupId>string</communityConnectionGroupId>
      <customerNotes>string</customerNotes>
      <pointBalance>string</pointBalance>
      <pointBalanceBonus>string</pointBalanceBonus>
      <pointBalanceLT>string</pointBalanceLT>
      <hashedPassword>string</hashedPassword>
      <welcomeAlreadySent>string</welcomeAlreadySent>
      <campaign>string</campaign>
    </EnrollNewCardmemberV12>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <EnrollNewCardmemberV12Response xmlns="https://posapi.loyaltypath.com/">
      <EnrollNewCardmemberV12Result>string</EnrollNewCardmemberV12Result>
    </EnrollNewCardmemberV12Response>
  </soap12:Body>
</soap12:Envelope>