EEE Web Service API Documentation

IMPORTANT NOTICE:

Whilst every effort has been made to ensure the accuracy of this document, it is recommended that users of the web services utilise the service description available from the web service installation location (e.g. http://localhost/eeewebservice/eeewebserviceauth.asmx?WSDL) as this will always contain the deployed parameter names and data types.

Contents

Document History. 10

Recommended Method Usage. 15

EEEWebService Usage. 17

RecordLaybyPayment. 22

Customer Methods. 23

GetCustomDemographics. 23

Customer Registration. 25

Customer Registration_Merge (EEEWebserviceauth.asmx only). 28

CustomerChargeStatus_Get (EEEWebserviceauth.asmx only). 29

Customer Confirmation. 30

Customer Confirmation With Details. 31

CustomerValidateLogin. 35

Customer Offline Login. 36

CustomerDetails. 37

CustomerDetailsByCustomerCode. 42

CustomerDetailsWithParameters. 46

CustomerForgotPassword. 51

Customer_SetPassword. 52

CustomerEmailExists. 54

CustomerDetailsExtended. 55

CustomerDetailsExtendedWithParameters. 57

CustomerConfirmationWithDetailsExtended. 60

CustomerSegmentMembership_Lookup. 62

ItemsToPromoteToCustomer. 63

Customer_Invoice. 66

Loyalty Rewards Methods. 69

Customer Loyalty Card Details. 69

LoyaltyGiftCardStatus. 71

CustomerLoyaltyStatement. 72

LoyaltyPointsTransfer. 74

Customer Promotion Coupon Methods. 75

CouponRedemption. 75

CouponRedemptionById. 76

CouponValid. 77

CouponsAvailableToCustomer. 78

CouponsAvailableToCustomer2. 80

CouponRedemptionConfirm.. 81

CouponRedemptionReverse. 83

CustomerCoupon_Get (EEEWebserviceauth.asmx only). 84

CustomerCoupon_AcknowledgeGet (EEEWebserviceauth.asmx only). 85

CustomerPoints_Get (EEEWebserviceauth.asmx only). 86

CustomerPoints_AcknowledgeGet (EEEWebserviceauth.asmx only). 87

Email Statistics Methods. 88

EmailStatistics. 88

Website Synchronisation Methods. 91

Overview.. 91

Usage. 91

How to use full load. 91

Sample usage for full load. 91

Sample usage for periodic synchronization. 92

Methods. 92

Product_Get. 92

Product_AcknowledgeGet. 95

ProductExtended_Get. 96

ProductExtended_AcknowledgeGet. 102

ProductPromotion_Get. 103

ProductPromotion_AcknowledgeGet. 104

ProductPromotionPrice_Get. 105

ProductPromotionPrice_AcknowledgeGet. 107

Inventory. 108

Inventory _Get. 108

Inventory_AcknowledgeGet. 109

Inventory_LookUp. 110

Inventory_LookUps. 111

Price. 112

Price_Get. 112

Price _AcknowledgeGet. 115

Price_LookUp. 116

CustomerCategoryPrice_Get. 117

CustomerCategoryPrice _AcknowledgeGet. 118

Cost. 119

Cost_Get. 119

Cost _AcknowledgeGet. 121

Colour. 122

Colour_Get. 122

Colour_AcknowledgeGet. 124

Size. 125

Size_Get. 125

Size_AcknowledgeGet. 126

Style. 127

Style_Get. 127

Style_AcknowledgeGet. 129

StyleExtended_Get. 130

StyleExtended_AcknowledgeGet. 136

Analysis1. 137

Analysis1_Get. 137

Analysis1_AcknowledgeGet 138

Analysis2. 139

Analysis2_Get. 139

Analysis2_AcknowledgeGet 141

Analysis3. 142

Analysis3_Get. 142

Analysis3_AcknowledgeGet 143

Analysis4. 144

Analysis4_Get. 144

Analysis4_AcknowledgeGet 146

Product Images. 147

ProductImage_Get. 147

ProductImage _AcknowledgeGet. 149

Customers. 150

Customer_Get. 150

Customer_AcknowledgeGet. 153

Master Customers. 154

MasterCustomer_Get. 154

MasterCustomer_AcknowledgeGet. 156

Promotion Customers. 157

PromotionCustomer_Get. 157

PromotionCustomer_AcknowledgeGet. 158

Promotion Headers. 159

PromotionHeader_Get. 159

PromotionHeader_AcknowledgeGet. 161

Price Book. 162

PriceBook_Get. 162

PriceBook_AcknowledgeGet. 163

Search Hierarchy. 164

SearchHierarchy_Get. 164

SearchHierarchyHighResGraphic_Get. 167

SearchHierarchyItemGroup_Get. 169

SearchHierarchyItemGroup_AcknowledgeGet. 171

SearchHierarchyItem_Get. 172

SearchHierarchyItem_AcknowledgeGet. 173

Branch. 174

Branch_Get. 174

Branch_AcknowledgeGet. 177

Brand. 178

Brand_Get. 178

Brand_AcknowledgeGet 180

Coupon Detail 181

CouponDetail_Get. 181

CouponDetail_AcknowledgeGet. 183

Supplier. 184

Supplier_Get. 184

Supplier_AcknowledgeGet. 186

SupplierInventory. 187

SupplierInventory_Get. 187

SupplierInventory_AcknowledgeGet. 189

Suburb. 190

Suburb_Get. 190

Suburb_AcknowledgeGet. 192

URL. 193

Url_Insert. 193

External Feeds. 194

ExternalFeed_Get. 195

ExternalFeed_AcknowledgeGet. 196

Shipping Provider. 197

ShippingProvider_Get. 197

ShippingProvider_AcknowledgeGet. 199

ShippingProviderDispatchPoint_Get. 200

ShippingProviderDispatchPoint_AcknowledgeGet. 202

ShippingProviderContract_Get. 203

ShippingProviderContract_AcknowledgeGet. 205

ChargeZone_Get 206

ChargeZone_AcknowledgeGet 208

ChargeZonePostcodeRange_Get. 209

ChargeZonePostcodeRange_AcknowledgeGet. 211

ChargeZoneCountry_Get. 212

ChargeZoneCountry_AcknowledgeGet. 214

ChargeZoneRate_Get. 215

ChargeZoneRate_AcknowledgeGet. 217

Sales. 218

Sale_Insert. 218

Sale_Insert_With_Result (EEEWebserviceauth.asmx only). 225

Sales_Insert (EEEWebserviceauth.asmx only). 228

Sales_History. 232

Sales_Get. 235

Sales_GetData. 236

Sales_AcknowledgeGet. 240

Journal_Get (EEEWebserviceauth.asmx only). 241

GoodwillCredit_Insert (EEEWebserviceauth.asmx only). 243

Returns_Get (EEEWebserviceauth.asmx only). 245

Returns_AcknowledgeGet (EEEWebserviceauth.asmx only). 248

Customer Orders. 249

CustomerOrder_Insert. 249

CustomerOrder_InsertPayment. 255

CustomerOrderLineStatus_Get. 257

CustomerOrderLineStatus_AcknowledgeGet. 260

CustomerOrder_History. 261

CustomerOrderMessage_Insert. 264

CustomerOrderSpecial_Insert. 265

EEE / POS Internal Messages. 266

Message_Insert. 266

Referral Cards. 268

ReferralCardValidate. 268

ReferralCardRedeem.. 269

Debtors. 270

DebtorAuthorisation. 270

Gift Cards. 271

GiftCardBalance. 271

GiftCardRedeem.. 273

GiftCardRedeemWithDate. 276

GiftCardRedeemReverse. 279

GiftCardActivate. 281

GiftCardVirtualReserve. 282

GiftCardVirtualReserveIssue. 283

GiftCardIssue. 285

GiftCardIssueReverse. 289

GiftCardReturn. 292

GiftCardReturnReverse. 295

GiftCard_Get (EEEWebserviceauth.asmx only). 298

GiftCard_AcknowledgeGet (EEEWebserviceauth.asmx only). 299

Customer Communications. 300

CustomerCommunication_GetAvailable. 300

CustomerCommunication_Get. 301

CustomerCommunication_AcknowledgeGet. 307

CustomerCommunication_GetAttachments. 308

CustomerCommunication_GetArchived. 309

CustomerCommunication_GetCustomer (EEEWebserviceauth.asmx only). 310

Customer Product Enquiry. 311

CustomerProductEnquiry_Insert. 311

ERP Web Service Usage. 313

General Ledger Methods. 313

GeneralLedger_Get. 313

GeneralLedger_AcknowledgeGet. 314

Inventory Methods. 315

StockAdjustment_Put. 315

TransferOut_Put. 317

TransferIn_Put. 318

Host Log Methods. 320

HostLog_Get. 320

HostLog_AcknowledgeGet. 321

GoodsReceipt_Put. 322

RTS_Put. 324

Appendix A – Exceptions. 326

Appendix B – EEE Configuration Options. 328

Web service user permissions. 328

Customise Website Fields. 328

Appendix C: Demographic Questions and Demographic Responses definition. 328

Question Type TEXT. 329

Question Type DATE. 329

Question Type BOOL. 329

Question Type MLIST. 329

Question Type SLIST. 330

Depends On Question types. 330

Repeating Demographic Questions and Associated Answers definition. 331

Appendix D: EEE web service interface versions. 332

Appendix E: Statuses and their meaning. 332

Appendix F: Address System.. 332

Appendix G: ISO Codes in Addresses. 333

Appendix H: Sale Insert Return Codes. 333

Appendix I: Good Will Credit Insert Return Codes. 335

Document History

Document Date	EEE Versions	Change Desciption
06-08-2012	1.62.5
22-08-2012	1.64.1	CustomerOrder_History method added Sales_History method documentation updated
05-10-2012	1.66.0	ERPWebService end point added. GeneralLedger_Get method added to ERPWebService end point. GeneralLedger_AcknowledgeGet method added to ERPWebService end point.
10-10-2012	1.64.5	CustomerOrder_History interface version 2 added CustomerOrderLineStatus_Get interface version 3 added
26-10-2012	1.64.6	Customer_Get interface version 2 added
01-11-2012	1.66.0	CustomerDetailsExtended interface version 2 added CustomerDetailsExtendedWithParameters interface version 2 added CustomerConfirmationWithDetailsExtended interface version 2 added
30-11-2012	1.66.2	CustomerLoyaltyStatement interface version 3 added
23-01-2013	1.64.10	CustomerCategoryprice_Get interface version 2 added
08-03-2013	1.68.0	CustomerConfirmationWithDetails interface version 2 added CustomerDetails interface version 2 added CustomerDetailsByCustomerCode interface version 2 added CustomerDetailsWithParameters interface version 2 added CustomerConfirmationWithDetailsExtended interface version 3 added CustomerDetailsExtended interface version 3 added CustomerDetailsExtendedWithParameters interface version 3 added
08-04-2013	1.68.2	Added Customer_SetPassword method
15-04-2013		Added Recommended Method Usage
18-04-2013	1.68.3	Added CouponsAvailableToCustomer2 method
09-07-2013	1.68.9	Added CustomerCategoryPrice_Get interface version 3
22-10-2013	1.72.0	Added CustomerCommunication_GetArchived
08-01-2014	1.72.0	Added Style_Get interface version 2
27-03-2014	1.74.0	Support for PreAuthorizationCode in CustomerOrder_Insert Tender element
14-04-2014	1.74.0	Add proposed customer order management methods.
02-06-2014		Add Appendix E: Statuses and their meaning
15-10-2014	1.76.0	Added GiftCardIssue and GiftCardIssueReverse
23-12-2014	1.74.12	Added Customer_Get interface version 3
13-01-2015	1.74.0	Support for ISO8601 standard date strings in: · CustomerOrder_Insert o Order/Customer/DateCustomerCreated o Order/OrderDate · Sale_Insert o Sale/TranDate
13-01-2015	1.74.12	Added Customer_Get interface version 4
09-02-2015	1.76.0	Added new method Branch_Get
11-02-2015	1.76.0	Gift Card methods updated to support 40 char reference2-4. Added GiftCardReturn and GiftCardReturnReverse Auditing for Gift Card Reversals
16-02-2015	1.76.0	Add interface version 2 to ProductImage_Get
19-02-2015	1.76.0	Added SearchHierarchy_Get interface version 2
26-02-2015	1.76.0	Transaction Reference optional in: GiftCardIssue GiftCardIssueReverse GiftCardRedeem (v2) GiftCardRedeemWithDate (v2) GiftCardReturn GiftCardReturnReverse
10-03-2015	1.76.0	Allow incremental calls to Branch_Get Added New method Supplier_Get
11-03-2015	1.76.0	SearchHierarchy modifications
23-03-2015	1.76.0	Added Url_Insert Added links to PHP sample for Customer_Get and CustomerRegistration Updated CustomerRegistration sample XML
01-04-2015	1.76.0, 1.74.14	ProductImage_Get v2; Track Priority in deletes
02-04-2015	1.76.0	Added SearchHierarchyHighResGraphic_Get
13-04-2015	1.76.1, 1.78.0	Added ExternalFeed_Get
15-04-2015	1.78.0	Added support for multiple Customer Addresses in CustomerRegistration, v5 of Customer_Get
27-04-2015	1.76.2, 1.78.0	Added Preferences, CustomerDisabled in Customer_Get output. Respects new configuration setting to send Disabled Customers to website.
25-05-2015	1.76.4, 1.78.0	Added Customer_Get v7
29-05-2015	1.76.4, 1.78.0	Added SearchHierarchy_Get v3, updated SearchHieararchyHighResGraphic_Get to support HighResGraphic2-3
09-06-2015	1.76.05, 1.78.0	Added v3 for Customer Details, CustomerDetailsByCustomerCode and CustomerDetailsWithParameters and v5 for CustomerDetailsExtended and CustomerDetailsExtendedWithParameters
12-06-2015	1.76.05, 1.78.0	Added new ShippingProvider and related methods; Accept ShippingProviderId in CustomerOrder_Insert; Supplier_Get v2
26-06-2015	1.74.18, 1.76.06, 1.78.0	ProductImage_Get behavioural changes
26-06-2015	1.76.06,1.78.0	Add ExternalFeed_AcknowledgeGet and parameters to ExternalFeed_Get
07-07-2015	1.76.06,1.78.0	Added New method Suburb_Get
10-07-2015	1.76.06,1.78.0	Added FreeText1 – 8 in CustomerOrderExchange.xsd and CustomerOrderExchangeOptional.xsd
01-09-2015	1.76.09, 1.78.0	Added WebDetail, LinkRewrite, MetaTitle, MetaDescription, MetaKeywords in Branch_Get v2
14-09-2015	1.76.09, 1.78.0	Add BillingDetail support for CustomerOrder_Insert
13-11-2015	1.76.12, 1.78.0	Add SortOrder in Size_Get v2
17-02-2016	1.78.0	Add GiftCardType and VirtualGiftCardDetail elements to CustomerOrderExchange.xsd and CustomerOrderExchangeOptional.xsd
29-03-2016	1.78.1, 1.80.0	Added CustomerProductEnquiry_Insert
18-08-2017	1.80.02, 1.82.0	Added CouponRedemptionConfirm, CouponRedemptionReverse Added DiscountDetails elements to CustomerOrderExchange.xsd and CustomerOrderExchangeOptional.xsd
23-10-2018	1.82.02, 1.84	Added CustomeSegmentMembership_Lookup
05-06-2019	1.84.04, 1.86	Add CustomerOrderLineStatus_Get v5; corrected method name
16-07-2019	1.84.06, 1.86	Add Authorised By to StockAdjustment_Put method
03-09-2019	1.84.07, 1.86	Updates to support Fastway integration
10-11-2019	1.84.09, 1.86	Add Feefo Places feed update
30-09-2020	-	Added details about using Discounts in CustomerOrder_Insert, specifically loyalty reward coupons. Corrected casing for ProductImage_Get parameter “priority”
23-09-2021	1.88.07, 1.90	Added Sale_Insert_With_Result and Appendix H – Sale insert return codes
27-09-2021	1.88.07, 1.90	Added GoodwillCredit_Insert
15-08-2022	1.88.17, 1.90	Customer_Get interface version 14 added CustomerDetails interface version 6 added CustomerDetailsExtended interface version 9 added IsMobileVerified is added to Customer Registration
01-11-2022	1.88.19, 1.90	Customer_Get interface version 15 added CustomerDetails interface version 7 added CustomerDetailsExtended interface version 10 added ExternalId2 is added to Customer Registration and CustomerOrder_Insert
09-04-2023	1.92.08, 1.94.00	Review samples and include unzipped content samples. Minor fixes as needed to align samples with xsds.
18-04-2024	1.92.12, 1.94.04	SupplierInventory_Get added SupplierInventory_AcknowledgeGet added
18-07-2024	1.92.12, 1.94.04, 1.96
09-08-2024	1.92.12, 1.94.04, 1.96	Inventory_Get interface version 3 added
13-08-2024	1.92.12, 1.94.04, 1.96	Brand_Get interface version 5 added
03-02-2026	1.96.11, 1.98.00	PromotionHeader_Get and PromotionHeader_AcknowledgeGet added

Recommended Method Usage

Section	Case	Recommended webservice method unless advised otherwise by Magenta Support	Notes
Customer Maintenance	Register a new customer	CustomerRegistration	For a new customer, the customercode should be passed through as an empty string. EEE will assign a customer code and pass this back to you
	Retrieve existing customer details	CustomerDetailsExtended	Interface version 3 of this method returns Customer details, customer coupons and customer loyalty card details in a single call
	Update existing customer details	CustomerRegistration	Because this is an existing customer record the CustomerCode must be supplied
	Verify a customers email address	CustomerConfirmation	When a customer adds an email address (either instore or online) EEE can send a verification email to them. This will contain a link to a page on the website which passes parameters through to the EEE web service to mark the email a verified in the EEE database
	Verify if a customers email already exists	CustomerEmailExists	Used to prevent customers creating multiple accounts with the same email address. If EEE is configured to not allow duplicate email addresses, calling CustomerRegistration with an email address that has already been used will raise an exception
	Login an existing customer that signed up in store	CustomerValidateLoginOffline	This returns a customer code that can then be used to retrieve the customers details
	Login an existing customer that signed up in store and return their customer details	CustomerDetailsExtendedWithParameters	A single call to locate the customer and retrieve their details if they signed up in store.

	The following methods are only applicable if EEE is managing customer passwords
	Login an existing customer	CustomerValidateLogin
	Send a Forgot Password email	CustomerForgotPassword
	Set a customers password	Customer_SetPassword

Customer Coupons	Get a customers available coupons	CouponsAvailableToCustomer	A separate call to get only a customers available coupons (if using CustomerDetailsExtended interface version 2 or higher this call may not be required as this data will have already been supplied to you)
	Redeem a customers coupon	CouponRedemptionById
	Check is a customers coupon is still valid	CouponValid

Customer Loyalty Details	Get a customers loyalty card details	CustomerLoyaltyCardDetails	A separate call to get only a customers loyalty card details
	Get a customer loyalty statement	CustomerLoyaltyStatement
	Transfer loyalty points from one customer to another	LoyaltyPointsTransfer	This transfers loyalty POINTS only, not loyalty card $ values
	Get the status of a customers loyalty card	LoyaltyGiftCardStatus

Gift Cards	Check a gift card balance	GiftCardBalance
	Redeem value from a gift card	GiftCardRedeemWithDate
	Activate an inactive gift card	GiftCardActivate

Sales	Record a new sale	Sale_Insert
	Record new sales in a batch	Sales_Insert
	Get a customers sales history	Sales_History

Customer Orders	Record a new customer order	CustomerOrder_Insert
	Get the status of customer orders	CustomerOrderLineStatus_Get	Must be followed by a call to CustomerOrderLineStatus_AcknowledgeGet
	Get a customers customer order history	CustomerOrder_History

LayBys	Get the details of a Layby	RetrieveLayby
	Record a layby payment	RecordLaybyPayment

Debtors	Check that an amount can be charge to a customers account	DebtorAuthorisation	This is only valid when a customers details contains ChargeAccount = 1

Customer Communications	Get the list of customers to send communications to	CustomerCommunication_Get CustomerCommunication_AcknowledgeGet

EEEWebService Usage

The uri for the web service is the path to the host (e.g. http://localhost/eeewebservice) and

· With EEE web service user authorisation ENABLED – eeewebserviceauth.asmx

· With EEE web service user authorisation DISABLED – eeewebservice.asmx

All methods listed below are for the eeewebserviceauth.asmx. The eeewebservice.asmx uses the same methods however it does not implement the websiteUserCode and websitePassword parameters on any methods. The eeewebservice.asmx also only supports interface version 1.

Common Methods

EEEVersion

Method

EEEVersion

Intended Usage

Version of EEE connected to

Parameters

Name	Type	Max Len	Description
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

String

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<webSitePassword>MWSTEST</webSitePassword>

</EEEVersion>

</soap:Body>

</soap:Envelope>

Sample Soap Response

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

</EEEVersionResponse>

</soap:Body>

</soap:Envelope>

GetBranchList

Method

GetBranchList

Intended Usage

Gets a list of branches (stores) from EEE that are not flagged as Offline.

Parameters

Name	Type	Max Len	Description
includeOfflineStores	boolean		True to include offline stores in the output
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

Xml that conforms to GetBranchList.xsd which is in the form of a .NET data table

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<includeOfflineStores>false</includeOfflineStores>

<webSitePassword>MWSTEST</webSitePassword>

</GetBranchList>

</soap:Body>

</soap:Envelope>

Sample Soap Response

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">

<xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Data" msdata:UseCurrentLocale="true">

<xs:complexType>

<xs:choice minOccurs="0" maxOccurs="unbounded">

<xs:element name="Data">

<xs:complexType>

<xs:sequence>

<xs:element name="BranchCode" type="xs:string" minOccurs="0" />

<xs:element name="BranchDescription" type="xs:string" minOccurs="0" />

<xs:element name="RegionCode" type="xs:string" minOccurs="0" />

<xs:element name="RegionDescription" type="xs:string" minOccurs="0" />

<xs:element name="Offline" type="xs:boolean" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:choice>

</xs:complexType>

</xs:element>

</xs:schema>

<diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1">

<BranchDescription>Brisbane CBD</BranchDescription>

<RegionDescription>Queensland</RegionDescription>

<Offline>false</Offline>

</Data>

<BranchDescription>Sydney CBD </BranchDescription>

<RegionDescription>New South Wales</RegionDescription>

<Offline>false</Offline>

</Data>

</DocumentElement>

</diffgr:diffgram>

</GetBranchListResult>

</GetBranchListResponse>

</soap:Body>

</soap:Envelope>

Layby Methods

RetrieveLayby

Method

RetrieveLayby

Intended Usage

Retrieve the details of a layby for a customer

Parameters

Name	Type	Max Len	Description
customerSurname	string	60	The customers surname
laybyNumber	string	20	The layby reference number
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

Xml that conforms to RetrieveLayby.xsd which is in the form of a .NET data table

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<customerSurname>smith</customerSurname>

<websiteUserCode>MWSTEST</websiteUserCode>

</RetrieveLayby>

</soap:Body>

</soap:Envelope>

Sample Soap Response

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">

<xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:MainDataTable="Data" msdata:UseCurrentLocale="true">

<xs:complexType>

<xs:choice minOccurs="0" maxOccurs="unbounded">

<xs:element name="Data">

<xs:complexType>

<xs:sequence>

<xs:element name="LaybyNumber" type="xs:string" minOccurs="0" />

<xs:element name="CustomerCode" type="xs:string" minOccurs="0" />

<xs:element name="CreationDate" type="xs:dateTime" minOccurs="0" />

<xs:element name="DueDate" type="xs:dateTime" minOccurs="0" />

<xs:element name="LastPaymentDate" type="xs:dateTime" minOccurs="0" />

<xs:element name="Total" type="xs:decimal" minOccurs="0" />

<xs:element name="TotalPaymentsToDate" type="xs:decimal" minOccurs="0" />

<xs:element name="Balance" type="xs:decimal" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:choice>

</xs:complexType>

</xs:element>

</xs:schema>

<diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1">

</Data>

</DocumentElement>

</diffgr:diffgram>

</DataTable>

</RetrieveLaybyResult>

</RetrieveLaybyResponse>

</soap:Body>

</soap:Envelope>

RecordLaybyPayment

Method

RecordLaybyPayment

Intended Usage

Record a layby payment for a customers’ layby

Parameters

Name	Type	Max Len	Description
laybyNumber	string	20	The layby reference number
transactionNumber	String	20	The external transaction number
line	int		The line number of the layby that the payment is being made against
websiteId	String	20	The Id of the website that is the source of the payment. This site must be registered in EEE. This is also known in EEE as a website code.
paymentDate	String	8	The payment date in the format YYYYMMDD (E.g. 20090916)
amount	Double		The payment amount
narration	String	100	Any notes accompanying the payment
websiteUserCode	string	20	Usercode (see user permissions)
websitePassword	string	20	Password (see user permissions)

Returns

Boolean – true if payment recorded successfully, false otherwise.

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<websiteId>MAGENTA</websiteId>

<narration>Deposit online</narration>

<websiteUserCode>MWSTEST</websiteUserCode>

</RecordLaybyPayment>

</soap:Body>

</soap:Envelope>

Sample Soap Response

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

</RecordLaybyPaymentResponse>

</soap:Body>

</soap:Envelope>

Customer Methods

GetCustomDemographics

Method

GetCustomDemographics

Intended Usage

Gets a list of available customer custom demographic questions and where applicable their available responses. This data is relatively static and the method should only be called once a day at most.

Parameters

Name	Type	Description
websiteUserCode	string	Usercode (see user permissions)
webSitePassword	string	Password (see user permissions)

Returns

XML that conforms to GetCustomDemographics.xsd.

See GetCustomDemographics.xml for sample xml

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<websiteUserCode>MWSTEST</websiteUserCode>

</GetCustomDemographics>

</soap:Body>

</soap:Envelope>

Sample Soap Response

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<?xml version="1.0" encoding="utf-8" ?>

</DemographicQuestions>

</DemographicQuestions>

</CustomDemographics>

</GetCustomDemographicsResult>

</GetCustomDemographicsResponse>

</soap:Body>

</soap:Envelope>

Xml Deserialized Content

<?xml version="1.0" encoding="utf-8" ?>

</DemographicQuestions>

</DemographicQuestions>

</CustomDemographics>

Customer Registration

Method

CustomerRegistration

Intended Usage

This method accepts an xml string of customer data that conforms to Customer.xsd and then returns the Customer Code on successful save. Throws a SoapFault on failure.

Notes

If the CustomerCode is empty, a new customer record will be added (assuming EEE is configured to automatically generate customer codes. If the CustomerCode is not empty, the existing customer record will be updated, or if EEE is NOT configured to automatically generate customer codes and the customer code supplied does NOT exist then a new record will be inserted. In the Customer node, the attributes are mapped into the same fields in a Customer record in EEE.

Parameters

Name	Type	Max Len	Description
customerXmlString	string		The customer xml string. Conforms to Customer.xsd.
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

string Customer Code

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<websiteUserCode>MWSTEST</websiteUserCode>

<webSitePassword>FaGx8MuVqI</webSitePassword>

</CustomerRegistration>

</soap:Body>

</soap:Envelope>

Sample Decoded Request Content

</DemographicQuestions>

</EEECustomerTable>

</EEECustomer>

Sample Soap Response

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

</CustomerRegistrationResponse>

</soap:Body>

</soap:Envelope>

Xml Input Definition

See Customer.xsd for xml structure definition. See Appendix for Demographic Questions definition and description.

Multiple Customer addresses are supported via the Addresses/Address element sequence. See Appendix for ISO Codes in Addresses for details about the codes used in Addresses.

As of EEE 1.76.2 a new, optional Addresses node is supported in the incoming XML.

It is up to the client to choose whether to:

Keep using the existing address system

To do this, omit the Addresses node entirely from the XML and provide values for the address fields within the Customer record

If the Addresses node is not present in the XML, EEE will continue to import the Address fields within the Customer record as usual. In addition, this will also update the customer’s address records so as to keep them in sync.

Use the new address system

To do this, provide an Addresses node in the XML and supply all addresses for the Customer as children of this node (No need to provide values for address fields within the Customer record). You will also need to respect unique descriptions used by EEE to ensure that address changes flow through to the Customer record so that it may be used by other systems that interface with EEE, including POS.

The presence of this Addresses node (even if it is empty, e.g. <Addresses />) indicates to EEE that the new address system is being used, and the call will update EEE with the addresses specified within this element (if provided). This means that for the customer, any new addresses (that are not in EEE but is present in the XML) will be created, existing addresses will be updated and any missing addresses (that are in EEE that but not in the XML) will be deleted. The Description field is used to uniquely identify each address for these purposes. This also means that providing an empty Addresses node (e.g. <Addresses />) will remove all addresses in EEE for the Customer and clear the address fields in the Customer’s record.

See Appendix for New Customer System for more information.

Sample Xml

See CustomerRegistrationSample.xml for sample input xml.

PHP Sample

See http://theoracle.magentaretail.com.au/EEE_WebService

Customer Registration_Merge (EEEWebserviceauth.asmx only)

Method

CustomerRegistration_Merge

Intended Usage

Copy fields from a source customer record to a destination customer record then disable the source customer record.

Notes

If the copyFields is empty then no fields will be copied from the source customer record and the destination record will be disabled.

Parameters

Name	Type	Max Len	Description
sourceCustomerCode	string	20	Source customer code. Required.
destinationCustomerCode	string	20	Destination customer code. Required.
copyFields	string	Max	Comma delimited string of column names from the Customer table. If this value is empty then no fields will be copied from the source customer.
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

boolean

Sample Soap Request

<?xml version="1.0" encoding="utf-16"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<CustomerRegistration_Merge xmlns="http://www.magentaretail.com.au/">

<copyFields>Address1,Address2,Address3</copyFields>

<websiteUserCode>MWSTEST</websiteUserCode>

<websitePassword>lJVlU8EKsY</websitePassword>

</CustomerRegistration_Merge>

</soap:Body>

</soap:Envelope>

Sample Soap Response

<?xml version="1.0" encoding="utf-16"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<CustomerRegistration_MergeResponse xmlns="http://www.magentaretail.com.au/">

<CustomerRegistration_MergeResult>true</CustomerRegistration_MergeResult>

</CustomerRegistration_MergeResponse>

</soap:Body>

</soap:Envelope>

CustomerChargeStatus_Get (EEEWebserviceauth.asmx only)

Method

CustomerChargeStatus_Get

Intended Usage

Retreive the Charge Account Details of the Customer

Latest Interface Version

Parameters

Name	Type	Max Length	Description
customerCode	string	20	The customers customer code
websiteUserCode	string	20	Usercode (see user permissions)
websitePassword	string	20	Password (see user permissions)

Returns

GZipped byte array containing Xml that conforms to CustomerChargeStatus.xsd

Note:

· CreditLimit will have xsi:nil="true" when the Customer does not have a credit limit. Otherwise, CreditLimit will contain the Customers Credit Limit.

· AvailableCredit will have xsi:nil="true" when the Customer does not have a credit limit. Otherwise AvailableCredit will contain Customer Credit Limit – Total Balance.

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<CustomerChargeStatus_Get xmlns="http://www.magentaretail.com.au/">

<websiteUserCode>MWSTEST</websiteUserCode>

<websitePassword>lJVlU8EKsY</websitePassword>

</CustomerChargeStatus_Get>

</soap:Body>

</soap:Envelope>

Sample Soap Response

(Version 2)

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<CustomerChargeStatus_GetResponse xmlns="http://www.magentaretail.com.au/">

<CustomerChargeStatus_GetResult>

H4sIAAAAAAAACm3RTQrCMBCG4b3gHUIOYH/ThaQF7VZwUS8Q7aCBtCnppHh8a4PFhGY33/Pu

wms7ou7A1C9hntCgQDuSddQtlDT+voRW+x0h/KZRqLNQon9AxVh8SGbkkTcv4XUC01pY018Z

7EvboB5qA63EpJqT/zPw1Pc09Mz3LPTc9zx05jsLvfC9cO6Oi+wkkvcoj71UJUVjgZLIFadJ

SCXuCly6VfFo6y9m+ADMFg4cpAEAAA==

</CustomerChargeStatus_GetResult>

</CustomerChargeStatus_GetResponse>

</soap:Body>

</soap:Envelope>

Sample Unzipped Response Content

(Version 2)

</CustomerChargeStatus>

Customer Confirmation

Method

CustomerConfirmation

Intended Usage

Used to confirm a customers’ email address. If so configured, when a customer is registered EEE can send an email address confirmation email to the customer. This should contain a link to a page on the site which invokes this method.

Parameters

Name	Type	Max Len	Description
emailId	string		A unique email Id that is in the email sent to the end user to confirm the email address. E.g. BA70B12D-40B0-4050-BBAA-AB19C4C0B2BC
customerCode	string	20	The customer code included in the email sent
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

String – returns the customerCode if the confirmation is successful. If an empty string or an exception are returned then the confirmation failed.

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<websiteUserCode>MWSTEST</websiteUserCode>

</CustomerConfirmation>

</soap:Body>

</soap:Envelope>

Sample Soap Response

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

</CustomerConfirmationResponse>

</soap:Body>

</soap:Envelope>

Customer Confirmation With Details

Method

CustomerConfirmationWithDetails

Latest Interface Version

Intended Usage

Parameters

Name	Type	Max Len	Description
emailId	string		A unique email Id that is in the email sent to the end user to confirm the email address. E.g. BA70B12D-40B0-4050-BBAA-AB19C4C0B2BC
customerCode	string	20	The customer code included in the email sent
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

Xml that conforms to CustomerDetails.xsd for the configured version. It is in the form of a .NET data set.

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<websiteUserCode>MWSTEST</websiteUserCode>

</CustomerConfirmationWithDetails>

</soap:Body>

</soap:Envelope>

Sample Soap Response

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">

<xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:UseCurrentLocale="true">

<xs:complexType>

<xs:choice minOccurs="0" maxOccurs="unbounded">

<xs:element name="Table">

<xs:complexType>

<xs:sequence>

<xs:element name="customercode" type="xs:string" minOccurs="0" />

<xs:element name="LoyaltyCardNumber" type="xs:string" minOccurs="0" />

<xs:element name="surname" type="xs:string" minOccurs="0" />

<xs:element name="firstname" type="xs:string" minOccurs="0" />

<xs:element name="salutation" type="xs:string" minOccurs="0" />

<xs:element name="address1" type="xs:string" minOccurs="0" />

<xs:element name="address2" type="xs:string" minOccurs="0" />

<xs:element name="address3" type="xs:string" minOccurs="0" />

<xs:element name="address4" type="xs:string" minOccurs="0" />

<xs:element name="postCode" type="xs:string" minOccurs="0" />

<xs:element name="state" type="xs:string" minOccurs="0" />

<xs:element name="country" type="xs:string" minOccurs="0" />

<xs:element name="email" type="xs:string" minOccurs="0" />

<xs:element name="phone" type="xs:string" minOccurs="0" />

<xs:element name="mobile" type="xs:string" minOccurs="0" />

<xs:element name="dob" type="xs:string" minOccurs="0" />

<xs:element name="gender" type="xs:string" minOccurs="0" />

<xs:element name="ConsentGiven" type="xs:boolean" minOccurs="0" />

<xs:element name="ConsentDateTime" type="xs:dateTime" minOccurs="0" />

<xs:element name="OptOutEmail" type="xs:boolean" minOccurs="0" />

<xs:element name="OptOutMobile" type="xs:boolean" minOccurs="0" />

<xs:element name="DoNotContact" type="xs:boolean" minOccurs="0" />

<xs:element name="CustomerCategoryCode" type="xs:string" minOccurs="0" />

<xs:element name="ParentCustomerCode" type="xs:string" minOccurs="0" />

<xs:element name="CustomerSubCategoryCode" type="xs:string" minOccurs="0" />

<xs:element name="ExternalId" type="xs:string" minOccurs="0" />

<xs:element name="MasterCustomerCode" type="xs:string" minOccurs="0" />

<xs:element name="MasterCustomerAssociationDate" type="xs:dateTime" minOccurs="0" />

<xs:element name="MasterCustomerAssociationExpiryDate" type="xs:dateTime" minOccurs="0" />

<xs:element name="PriceBookCode" type="xs:string" minOccurs="0" />

<xs:element name="OptOutPost" type="xs:boolean" minOccurs="0" />

<xs:element name="MarketingOptin" type="xs:boolean" minOccurs="0" />

<xs:element name="MarketingOptInDate" type="xs:dateTime" minOccurs="0" />

<xs:element name="IsCorporate" type="xs:boolean" minOccurs="0"/>

<xs:element name="TradeReferralCode" type="xs:string" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="Table1">

<xs:complexType>

<xs:sequence>

<xs:element name="Id" type="xs:int" minOccurs="0" />

<xs:element name="ParentId" type="xs:int" minOccurs="0" />

<xs:element name="QuestionId" type="xs:int" minOccurs="0" />

<xs:element name="Answer" type="xs:string" minOccurs="0" />

<xs:element name="ResponseId" type="xs:int" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:choice>

</xs:complexType>

</xs:element>

</xs:schema>

<diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1">

<surname>Jones</surname>

<address1>1 ItsNotUnusual St</address1>

<address3>Springwood</address3>

<OptOutEmail>false</OptOutEmail>

<OptOutMobile>false</OptOutMobile>

<DoNotContact>false</DoNotContact>

</Table>

<Answer>False</Answer>

</Table1>

</NewDataSet>

</diffgr:diffgram>

</CustomerConfirmationWithDetailsResult>

</CustomerConfirmationWithDetailsResponse>

</soap:Body>

</soap:Envelope>

CustomerValidateLogin

Method

CustomerValidateLogin

Intended Usage

When email addresses and passwords are being stored in EEE, this method can be used to validate a customers’ login to the website.

Parameters

Name	Type	Max Len	Description
loyaltycardnumber	string	20	The customers loyalty card number
	OR
emailaddress	string	254	The customers email address
password	string	60	The customer password
	AND
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

The customers CustomerCode if successful. An exception is thrown if unsuccessful.

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<emailaddress>testcustomer@gmail.com</emailaddress>

<password>testpassw0rd</password>

<websiteUserCode>MWSTEST</websiteUserCode>

</CustomerValidateLogin>

</soap:Body>

</soap:Envelope>

Sample Soap Response

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

</CustomerValidateLoginResponse>

</soap:Body>

</soap:Envelope>

Customer Offline Login

Method

CustomerValidateLoginOffline

Intended Usage

If a customer signs up in store, they can use their loyalty card number or customercode plus 2 other pieces of information to associate their online account with their in store account.

Parameters

Name	Type	Max Len	Description
loyaltycardnumber	String	20	The card number
	OR
customerCode	String	20	The customers customer code
	Plus at least 2 of the following items
dob	String	8	The customers date of birth in the format ‘YYYYMMDD’
surname	String	60	The customers surname
emailAddress	String	254	The customers email address
postCode	String	8	The customers postcode
phone	String	20	The customers phone number
mobile	String	20	The customers mobile phone number
	AND
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

The customers CustomerCode if successful. An exception is thrown if unsuccessful.

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<surname>Smith</surname>

<websiteUserCode>MWSTEST</websiteUserCode>

</CustomerValidateLoginOffline>

</soap:Body>

</soap:Envelope>

Sample Soap Response

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

</CustomerValidateLoginOfflineResponse>

</soap:Body>

</soap:Envelope>

CustomerDetails

Method

CustomerDetails

Latest Interface Version

Intended Usage

Retrieve the details for a single customer

Parameters

Name	Type	Max Length	Description
emailaddress	string	254	The customers email address
password	string	20	The customers password
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

Xml that conforms to CustomerDetails.xsd

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<emailaddress> michael.jones@magentaretail.com.au</emailaddress>

<password>password</password>

<websiteUserCode>MWSTEST</websiteUserCode>

<webSitePassword>KXHCQsxzIh</webSitePassword>

</CustomerDetails>

</soap:Body>

</soap:Envelope>

Sample Soap Response

(version 8)

<diffgr:diffgram xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">

<surname>Jones</surname>

<firstname>Michael</firstname>

<address1>14 Some Street</address1>

<address3>BRISBANE CITY</address3>

<country>Australia</country>

<email>michael.jones@magentaretail.com.au</email>

<OptOutEmail>false</OptOutEmail>

<DoNotContact>false</DoNotContact>

</Table>

<Answer>False</Answer>

</Table1>

<Answer>Aerobics / Fitness / Cardio</Answer>

</Table1>

<Answer>Rowing</Answer>

</Table1>

<Answer>Rugby Union</Answer>

</Table1>

</Table1>

</Table1>

<Answer>Skate, Scooter and In-line</Answer>

</Table1>

<Answer>Snow Sports (Ski & Snowboard)</Answer>

</Table1>

<Answer>False</Answer>

</Table1>

<Answer>False</Answer>

</Table1>

<Answer>Aquarobics</Answer>

</Table1>

<Answer>False</Answer>

</Table1>

<Answer>False</Answer>

</Table1>

<Answer>Athletics / Track and Field</Answer>

</Table1>

<Answer>Australian Rules Football</Answer>

</Table1>

<Answer>Badminton</Answer>

</Table1>

</Table1>

<Description>In-store address</Description>

<Surname>Jones</Surname>

<FirstName>Michael</FirstName>

<AddressLine1>1 Some Street</AddressLine1>

<AddressLine3>BRISBANE CITY</AddressLine3>

<ShippingDPID>AABBCC</ShippingDPID>

</Table2>

<Description>In-store delivery address</Description>

<Surname>Jones</Surname>

<FirstName>Michael</FirstName>

<AddressLine1>10 Some Streets</AddressLine1>

<AddressLine3>BRISBANE CITY</AddressLine3>

</Table2>

</NewDataSet>

</diffgr:diffgram>

Notes

The following nodes are nullable and will not be present in the dataset if the Customer has a null value for these fields:

· SubCategoryCode

· MasterCustomerCode

· MasterCustomerAssociationDate

· MasterCustomerAssociationExpiryDate

See Demographic Questions and Associated Answers for information on the relationships of Answers.

The default interface version is 8. Samples for other interface versions are available.

CustomerDetailsByCustomerCode

Method

CustomerDetailsByCustomerCode

Latest Interface Version

Intended Usage

Retreive the details for a single customer using their CustomerCode

Parameters

Name	Type	Max Length	Description
customerCode	string	20	The customers EEE customer code
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

Xml that conforms to CustomerDetails.xsd

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<websiteUserCode>MWSTEST</websiteUserCode>

</CustomerDetailsByCustomerCode>

</soap:Body>

</soap:Envelope>

Sample Soap Response

(version 8)

<diffgr:diffgram xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">

<surname>Jones</surname>

<firstname>Michael</firstname>

<address1>14 Some Street</address1>

<address3>BRISBANE CITY</address3>

<country>Australia</country>

<email>michael.jones@magentaretail.com.au</email>

<OptOutEmail>false</OptOutEmail>

<DoNotContact>false</DoNotContact>

</Table>

<Answer>False</Answer>

</Table1>

<Answer>Aerobics / Fitness / Cardio</Answer>

</Table1>

<Answer>Rowing</Answer>

</Table1>

<Answer>Rugby Union</Answer>

</Table1>

</Table1>

</Table1>

<Answer>Skate, Scooter and In-line</Answer>

</Table1>

<Answer>Snow Sports (Ski & Snowboard)</Answer>

</Table1>

<Answer>False</Answer>

</Table1>

<Answer>False</Answer>

</Table1>

<Answer>Aquarobics</Answer>

</Table1>

<Answer>False</Answer>

</Table1>

<Answer>False</Answer>

</Table1>

<Answer>Athletics / Track and Field</Answer>

</Table1>

<Answer>Australian Rules Football</Answer>

</Table1>

<Answer>Badminton</Answer>

</Table1>

</Table1>

<Description>In-store address</Description>

<Surname>Jones</Surname>

<FirstName>Michael</FirstName>

<AddressLine1>1 Some Street</AddressLine1>

<AddressLine3>BRISBANE CITY</AddressLine3>

<ShippingDPID>AABBCC</ShippingDPID>

</Table2>

<Description>In-store delivery address</Description>

<Surname>Jones</Surname>

<FirstName>Michael</FirstName>

<AddressLine1>10 Some Streets</AddressLine1>

<AddressLine3>BRISBANE CITY</AddressLine3>

</Table2>

</NewDataSet>

</diffgr:diffgram>

CustomerDetailsWithParameters

Method

CustomerDetailsWithParameters

Latest Interface Version

Intended Usage

Retreive the details of a customer using their loyalty card number or email address.

The method can be configured to require X number of additional pieces of information to associate their online account with their in-store account. X can be configured 0 – 6. Participating fields:

· dob

· surname

· emailAddress

· postcode

· phone

· mobile

Parameters

Name	Type	Max Len	Description
loyaltycardnumber	String	20	The card number. Loyalty card number or email address must be supplied (but not both).
emailaddress	String	254	The customers email address. Loyalty card number or email address must be supplied (but not both).
dob	String	8	The customers date of birth in the format ‘YYYYMMDD’. Participating field.
surname	String	60	The customers surname. Participating field.
emailAddress	String	254	The customers email address. Participating field.
postCode	String	8	The customers postcode. Participating field.
phone	String	20	The customers phone number. Participating field.
mobile	String	20	The customers mobile phone number. Participating field.
websiteUserCode	string	20	Usercode (see user permissions). Mandatory.
webSitePassword	string	20	Password (see user permissions). Mandatory.

Returns

Xml that conforms to CustomerDetails.xsd

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<emailaddress>michael.jones@magentaretail.com.au</emailaddress>

<surname>Jones</surname>

<websiteUserCode>MWSTEST</websiteUserCode>

</CustomerDetailsWithParameters>

</soap:Body>

</soap:Envelope>

Sample Soap Response

(version 8)

<diffgr:diffgram xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">

<surname>Jones</surname>

<firstname>Michael</firstname>

<address1>14 Some Street</address1>

<address3>BRISBANE CITY</address3>

<country>Australia</country>

<email>michael.jones@magentaretail.com.au</email>

<OptOutEmail>false</OptOutEmail>

<DoNotContact>false</DoNotContact>

</Table>

<Answer>False</Answer>

</Table1>

<Answer>Aerobics / Fitness / Cardio</Answer>

</Table1>

<Answer>Rowing</Answer>

</Table1>

<Answer>Rugby Union</Answer>

</Table1>

</Table1>

</Table1>

<Answer>Skate, Scooter and In-line</Answer>

</Table1>

<Answer>Snow Sports (Ski & Snowboard)</Answer>

</Table1>

<Answer>False</Answer>

</Table1>

<Answer>False</Answer>

</Table1>

<Answer>Aquarobics</Answer>

</Table1>

<Answer>False</Answer>

</Table1>

<Answer>False</Answer>

</Table1>

<Answer>Athletics / Track and Field</Answer>

</Table1>

<Answer>Australian Rules Football</Answer>

</Table1>

<Answer>Badminton</Answer>

</Table1>

</Table1>

<Description>In-store address</Description>

<Surname>Jones</Surname>

<FirstName>Michael</FirstName>

<AddressLine1>1 Some Street</AddressLine1>

<AddressLine3>BRISBANE CITY</AddressLine3>

<ShippingDPID>AABBCC</ShippingDPID>

</Table2>

<Description>In-store delivery address</Description>

<Surname>Jones</Surname>

<FirstName>Michael</FirstName>

<AddressLine1>10 Some Streets</AddressLine1>

<AddressLine3>BRISBANE CITY</AddressLine3>

</Table2>

</NewDataSet>

</diffgr:diffgram>

CustomerForgotPassword

Method

CustomerForgotPassword

Intended Usage

Sends the customer a forgot your password style email from EEE if EEE is being used for customer communications

Parameters

Name	Type	Max Len	Description
loyaltycardnumber	String	20	The card number. Loyalty card number or email address must be supplied (but not both).
emailAddress	String	254	The customers email address. Loyalty card number or email address must be supplied (but not both).
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

True if sending the email was successful

False if not successful or a password has not been set.

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<emailAddress>test@magentaretail.com.au</emailAddress>

<websiteUserCode>MWSTEST</websiteUserCode>

</CustomerForgotPassword>

</soap:Body>

</soap:Envelope>

Sample Soap Response

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

</CustomerForgotPasswordResponse>

</soap:Body>

</soap:Envelope>

Customer_SetPassword

Method

Customer_SetPassword

Intended Usage

Updates a customers password with the newPassword sent to this method

Parameters

Name	Type	Max Len	Description
communicationWebReferenceId	string	36	The unique identifier of the email that was sent to the user prompting them to reset their password
customerCode	string	20	The customers customercode
newPassword	string	255	The customers new password
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

Xml that conforms to CustomerDetailsExtended xsd for the selected interface version if the password reset was successful. Otherwise a soap exception is returned.

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<Customer_SetPassword xmlns="http://www.magentaretail.com.au/">

<newPassword>newpassword</newPassword>

<websiteUserCode>MWSTEST</websiteUserCode>

</Customer_SetPassword>

</soap:Body>

</soap:Envelope>

Sample Soap Response

(version 11)

<CustomerRecord

Address1="10 Some Street" Address2="" Address3="BRISBANE CITY"

Address4="" Postcode="4000" State="QLD" ConsentDateTime="2012-06-07T14:51:42"

ConsentGiven="1" Country="Australia" CustomerCategoryCode="LOYALTY"

CustomerCode="000001" CustomerSubCategoryCode="" DOB="1968-06-09T00:00:00"

Delivery1="10 Some Street" Delivery2="" Delivery3="BRISBANE CITY" Delivery4=""

DeliveryPostcode="4000" DeliveryState="QLD" Demographic1="" Demographic10=""

Demographic11="" Demographic12="" Demographic13="" Demographic14=""

Demographic15="" Demographic16="" Demographic17="" Demographic18=""

Demographic19="test" Demographic2="" Demographic20="" Demographic3=""

Demographic4="" Demographic5="" Demographic6="" Demographic7=""

Demographic8="" Demographic9="" DoNotContact="0"

Email="joan.smith@magentaretail.com.au" ExternalId="test"

FirstName="Joan" Gender="F" LoyaltyNumber="GC100000000000075638"

MasterCustomerAssociationDate="2012-08-10T00:00:00" MasterCustomerCode="MAGENTA"

Mobile="" OptOutEmail="0" OptOutMobile="0" ParentCustomerCode=""

Phone="07 883 7843" Postcode="4000" Salutation="Mrs" State="QLD"

Surname="Smith" MasterCustomerAssociationExpiryDate="" PriceBookCode=""

OptOutPost="" BranchCode="" BranchDescription="" SignUpCouponIssued=""

MarketingOptin="1" IsCorporate="1" TradeReferralCode="0000000003"

IsGuest="1" IsMobileVerified="1" ExternalId2="AXC001927394739"

IsSuspended="0"/>

<Coupon

CouponCode="0000001G1" CouponDollarValue="50.00" CouponNumber="52"

CouponPercentageValue="0.00" CustomerCode="000001" EndDate="1900-01-01T00:00:00"

ExpiryDate="2011-06-03T00:00:00" IssueDate="2011-05-03T00:00:00"

PromotionCode="VIP201101" PromotionCouponId="54"

PromotionDescription="VIP Signup Sale" PromotionType="VIP Signup"

RedeemDate="1900-01-01T00:00:00" StartDate="2011-01-01T00:00:00"/>

</CouponsAvailableToCustomer>

<CustomerLoyaltyCard

AccumulatedPoints="2098.1320" CustomerCode="000001" ExpiryDate="2013-02-10T00:00:00"

IssueDate="2010-07-27T11:45:40" LoyaltyCardNumber="GC100000000000075638"

RemainingValue="45.0000"/>

</CustomerLoyaltyCardDetails>

<Address

Description="In-store address" Surname="Smith" FirstName="Joan"

AddressLine1="10 Some Street" AddressLine2="" AddressLine3="BRISBANE CITY"

AddressLine4="" IsoCountryCode="AU" IsoSubdivisionCode="AU-QLD"

PostCode="4000" Notes="Leave unattended if not present."

ShippingDPID="auspostdpid" ShippingEmail="joan.smith@magentaretail.com.au" />

<Address

Description="In-store delivery address" Surname="Smith" FirstName="Joan"

AddressLine1="10 Some Street" AddressLine2="" AddressLine3="BRISBANE CITY"

AddressLine4="" IsoCountryCode="AU" IsoSubdivisionCode="AU-QLD"

PostCode="4000" />

<Address

Description="Other Address" Surname="Smith" IsoCountryCode="AU"

IsoSubdivisionCode="AU-QLD" />

</CustomerAddresses>

</EEECustomerTable>

CustomerEmailExists

Method

CustomerEmailExists

Intended Usage

Determine if the customer email address is already in use in EEE.

Parameters

Name	Type	Max Length	Description
emailAddress	string	254	The customers email address
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

Boolean – true if the email address exists in the customer database.

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<emailAddress>test@magentaretail.com.au</emailAddress>

<websiteUserCode>MWSTEST</websiteUserCode>

</CustomerEmailExists>

</soap:Body>

</soap:Envelope>

Sample Soap Response

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

</CustomerEmailExistsResponse>

</soap:Body>

</soap:Envelope>

CustomerDetailsExtended

Method

CustomerDetailsExtended

Latest interface version

Intended Usage

Returns the customers demographic detail, available coupons and loyalty card details

Parameters

Name	Type	Max Len	Description
customerCode	string	20	The customers customer code
websiteUserCode	string	20	Usercode (see user permissions)
webSitePassword	string	20	Password (see user permissions)

Returns

Xml that conforms to CustomerDetailsExtended xsd for the selected interface version

Sample Soap Request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<websiteUserCode>MWSTEST</websiteUserCode>

</CustomerDetailsExtended>