I Revision History
This appendix lists the changes made to the Batch Processing & Web Services Guide by release.
Customer Engagement Cloud Services 18.0
The following changes were made to the Batch Processing & Web Services Guide.
Table I-1 Guide Changes for Release 18.0
| Message/Data Type | Description of Change |
|---|---|
|
CARD SERVICES, VERSION 3.2 - New Chapter |
|
|
CardProgramType |
New class. |
|
CreateAccount |
New method. |
|
DeleteAccount |
New method. |
|
GetCardPrograms |
New method. |
|
GetCardProgramsResponse |
New class. |
|
GetCardProgramsResponse2 |
New class. |
|
Card Program |
New class. |
|
Enumerated Values |
Added ProgramType. |
|
ENTITLEMENT ENGINE MESSAGES |
|
|
shipChargeCode |
New value. |
|
shipAwardType |
New value. |
|
shipCntries |
Newly implemented value. |
|
shipMethods |
Newly implemented value. |
|
shipScfs |
Newly implemented value. |
|
shipUS48Only |
Newly implemented value. |
|
Bulk Imports through Oracle Cloud Data Service (OCDS) - New chapter |
|
|
Promote API - New chapter |
|
Customer Engagement Cloud Services 17.0.1
The following changes were made to the Batch Processing & Web Services Guide.
Table I-2 Guide Changes for Release 17.0.1
| Message/Data Type | Description of Change |
|---|---|
|
CUSTOMER SERVICES, all versions |
|
|
deleteCustomer |
The customer is deleted, not merely flagged as inactive. |
|
BI/Analytics Batch Sync Processing |
Noted that the deleteCustomer request also deletes customers. |
|
CUSTOMER SERVICES, VERSION 1.0 |
Added note: This version of the web service will be removed from the standard product functionality. Not recommended for use. Use of a later version is recommended. |
|
DATA PRIVACY SERVICES, VERSION 1.0 - New Chapter |
|
|
CUSTOMER ENGAGEMENT USER SERVICES, VERSION 4.0 - New Chapter |
|
|
ENUMERATED VALUES |
|
|
UserSearchFieldType |
Renamed RelateUserSearchFieldType to UserSearchFieldType and update one of the values. |
|
Marketing Batch Sync Processing chapter: Changed field names for Loyalty Accounts Sync Export file from FIRST_USE_DATE and LAST_USE_DATE to FIRST_USED_DATE and LAST_USED_DATE. |
|
Customer Engagement Cloud Services 17.0
The following changes were made to the Batch Processing & Web Services Guide.
Table I-3 Guide Changes for Release 17.0
| Message/Data Type | Description of Change |
|---|---|
|
CUSTOMER |
Added action, sequence, and privateFlag to CustomerNote element. |
|
LOYALTY |
Added PostEngagementAction and ActivityImport. |
|
ATTRIBUTE SERVICES, VERSION 3.3 - New Chapter |
|
|
addOrUpdateAttribute |
New method. |
|
retrieveAttributes |
Response includes the publish to batch exporter flag. |
|
CUSTOMER SERVICES, VERSION 3.1 - New Chapter |
|
|
Version 3.1 of the API supports adding, updating, and deleting customer notes; also, the currency code was added to the retrieveCustomer method and the CustomerResponseType class. |
|
|
LOYALTY ACCOUNT SERVICES, VERSION 3.3 |
|
|
postEngagementAction |
New method. |
|
getEngagementRules |
New method. |
|
SEGMENT SERVICES, VERSION 3.0 |
|
|
deleteSegment |
New method. |
|
TASK SERVICES, VERSION 3.0 - New Chapter |
|
|
Version 3.0 of the API supports paging for the getTaskList and passing the securityUserId for various methods. |
|
|
ENUMERATED VALUES |
|
|
AttributeDataType |
Enumerated values are Character, Number, Currency, Date, Logical, List. |
|
CustomerNotesActionType |
Enumerated values are ADD, UPDATE, and DELETE. |
|
Introduction: Added reference to Batch Process Tracking, and updated information on Batch Import Review. |
|
|
Various: Added note indicating that securityUserId provided within a message must be assigned the proper Security Group permission. |
|
|
BI/Analytics Batch Sync Processing: Added Loyalty Program Export Sync, Loyalty Account Activity Export Sync, Loyalty Account Sync, and Loyalty Award Transaction Export Sync. |
|
|
Marketing Batch Sync Processing - Added note to Customer Export that customer records are included only if they have email addresses, and removed note from Promotion Import that promotion ID is required. Added Customer Activity Sync and Points/Award Notification Sync. |
|
Customer Engagement Cloud Services 16.0
The following changes were made to the Batch Processing & Web Services Guide.
Table I-4 Guide Changes for Release 16.0
| Message/Data Type | Description of Change |
|---|---|
|
INTRODUCTION |
|
|
XML Messages |
Only batch processing is now supported for XML. Since interactive XML Messages are no longer supported, removed all references, including Processing Modes section, XML Formatting Guidelines, and XML Message. |
|
Batch Import Review |
Replaced XML API Reader section with Batch Import Review. |
|
CUSTOMER REQUESTS |
|
|
XML |
Messages Removed references. |
|
Customer Lookup |
Removed. |
|
Customer Search |
Removed. |
|
Retrieve Customer |
Removed. |
|
TRANSACTIONS |
|
|
XML Messages |
Removed references. |
|
Calculate Proforma |
Removed. |
|
ITEM REQUESTS |
|
|
XML |
Messages Removed references. |
|
RETAIL LOCATION REQUESTS |
|
|
XML Messages |
Removed references. |
|
CARDS |
|
|
XML Messages |
Removed references. |
|
Card Inquiry |
Removed. |
|
MERCHANDISE HIERARCHY |
|
|
XML Messages |
Removed references. |
|
LOYALTY |
|
|
XML Messages |
Removed references. |
|
Loyalty Transaction Points Inquiry |
Removed. |
|
MERCHANDISE HIERARCHY |
|
|
XML Messages |
Removed references. |
|
STORED VALUE |
|
|
Chapter removed because all existing stored value message processing was interactive. |
|
|
AWARDS |
|
|
Chapter removed because all existing awards message processing was interactive. |
|
|
PROMOTIONS |
|
|
XML Messages |
Removed references. |
|
USERS |
|
|
XML Messages |
Removed references. |
|
INTRODUCTION TO ORACLE RETAIL CUSTOMER ENGAGEMENT APIS |
|
|
Web Service Tracking |
Added brief introduction to Web Service Tracking option in UI. |
|
ATTRIBUTE SERVICES, VERSION 3.2 - New Chapter |
|
|
Only difference from version 3.1 is addition of Wishlist to enumerated values for AttributesIntendedUserType. |
|
|
LOYALTY ACCOUNT SERVICES, VERSION 3.3 - New Chapter |
|
|
Version 3.3 of the API supports returning a list of EAwards through the ImmediateAwardsType class. |
|
|
POSLOG SERVICES, VERSION 3.3 - New Chapter |
|
|
Version 3.3 of the API supports returning a list of EAwards through the ImmediateAwardsType class. |
|
|
REGISTRY SERVICES, VERSION 3.1 - New Chapter |
|
|
RegistryResponseType |
Added RegistryType element. |
|
RegistryRequestType |
Added RegistryType element. |
|
RegistrySummaryType |
Added RegistryType element. |
|
ENUMERATED VALUES |
|
|
AttributesIntendedUseType |
Added Wishlist to enumerated values. |
|
RegistryType |
Enumerated values are GIFT_REGISTRY and WISH_LIST. |
|
RegistrySearchFieldType |
Added RegistryType to enumerated values. |
|
Entitlement Engine Services - New Chapter |
|
|
Marketing Batch Sync Processing - New Chapter |
|
|
BI/Analytics Batch Sync Processing - New Chapter |
|
|
Tender Account Batch Sync Processing - New Chapter |
|
|
ALL WEB SERVICES |
|
|
Updated Web Service URLs. |
|
|
Changed the default port to <portNumber> for all web service messages. |
|
Customer Engagement Cloud Services 15.0
The following changes were made to the Batch Processing & Web Services Guide.
Table I-5 Guide Changes for Release 15.0
| Message/Data Type | Description of Change |
|---|---|
|
zz |
|
|
INTRODUCTION |
|
|
Fileset processing |
The Batch File Input Directory property in System Configuration now specifies the location of the fileset directory. |
|
XML API File Reader |
Changed the URL, and login is now accomplished through a valid Customer Engagement user ID and password. |
|
Changed the default port to 443 for all web service messages. |
|
|
CUSTOMERS |
|
|
Customer Requests |
No longer validates against partial address for customer. Removed <SortingName> from requests. Updated references to prevent card association with multiple customers. Removed reference to instrument ID as a valid card/customer association. |
|
TRANSACTIONS |
|
|
Transaction Requests |
Removed <CardNumber> as identifier for entitlement promotion processing. Removed sample of Sale with Entitlement, since no longer supported. |
|
POS Logs |
Removed Issue Bounce Back Coupon section. |
|
CARDS |
|
|
Card Inquiry |
Added <CardTypeAttribute> element to the <Instrument> element: <CardTypeAttribute> <AttrName>Available Designs</AttrName> <AttrDataType>Enumerated</AttrDataType> <AttrValue>US Flag</AttrValue> </CardTypeAttribute> |
|
Generate Card |
Added <Attribute> element to the <CardSeries> element: <Attribute id="95" name="Series Colors" editable="true" unique="false" required="false" intendedUse="CardSeries"> <AttributeValue>Red</AttributeValue> </Attribute> |
|
AWARD ACCOUNT SERVICES, VERSION 3.1 - New Chapter |
|
|
expireCoupons |
New method. |
|
automaticRedeem |
Now returns AwardResponseType instead of awardTransactionResult. |
|
inquiry |
Now returns AwardResponseType instead of awardTransactionResult. |
|
issueCoupon |
Now returns AwardResponseType instead of awardTransactionResult. Also, added dealId and couponType elements. |
|
redeemCoupons |
Now returns AwardResponseType instead of awardTransactionResult. |
|
reverse |
Now returns AwardResponseType instead of awardTransactionResult. |
|
AwardAccountType |
New element. |
|
AwardProgramType |
New element. |
|
AwardResponseType |
New element. |
|
AwardRespProgramType |
New element. |
|
CouponListType |
New element. |
|
CouponType |
New element. |
|
EntitlementCouponListType |
New element. |
|
EntitlementCouponType |
New element. |
|
EntitlementDealType |
New element. |
|
ReferencedDealType |
New element. |
|
ResponseStatusType |
New element. |
|
CARD SERVICES, VERSION 3.1 - New Chapter |
|
|
addOrUpdateCardAttributes |
New method. |
|
getCardInquiryData |
Added AttributeSearchType. |
|
AttributeRequestType |
New element. |
|
AttributeResponseType |
New element. |
|
AttributeSearchType |
New element. |
|
CardAttributesResponseType |
New element. |
|
CardInqAwardAccount |
Added EntitlementCouponList element. |
|
CardInqEntitlementAccount |
Removed element. |
|
CardInqEntitlementCoupon |
New element. |
|
CardInqEntitlementCouponList |
New element. |
|
CardInqEntitlementDealType |
New element. |
|
CardInqInstrument |
New Attribute element. Removed EntitlementAccount element. |
|
CardInqReferencedDealType |
New element. |
|
CardInqTypeAttribute |
Removed element. |
|
EntitlementAccountActivityListType |
Removed element. |
|
EntitlementAccountActivityType |
Removed element. |
|
EntitlementDealListType |
Removed element. |
|
EntitlementProgramType |
Removed element. |
|
ENTITLEMENT ACCOUNT SERVICES, VERSION 3.0 - Removed Chapter (deprecated) |
|
|
LOYALTY ACCOUNT SERVICES, VERSION 3.2 - New Chapter |
|
|
getLoyaltyAwardRules |
New element. |
|
EntitlementDealType |
New element. |
|
ImmediateAwardEntitlementType |
New element. |
|
ImmediateAwardsType |
New element. |
|
ImmediateEAwardCouponType |
New element. |
|
ImmediateEAwardType |
New element. |
|
ImmediateEntitlementCouponType |
New element. |
|
ImmediateMovementType |
New element. |
|
LoyaltyAwardRuleParametersType |
New element. |
|
LoyaltyAwardRulesRespType |
New element. |
|
LoyaltyAwardRuleType |
New element. |
|
LoyaltyPointsType |
New element. |
|
PointsBalanceType |
New element. |
|
PointsEntryType |
New element. |
|
ReferencedDealType |
New element. |
|
TransactionPointsType |
New element. |
|
TransactionReturnType |
New element. |
|
POSLOG SERVICES, VERSION 3.2 - New Chapter |
|
|
ImmediateAwardEntitlementType |
New element. |
|
ImmediateEAwardCouponType |
New element. |
|
ImmediateEntitlementCouponType |
New element. |
|
PROMOTION EVENT SERVICES, VERSION 3.1 - New Chapter |
|
|
retrieveDeal |
New method. |
|
AwardType |
New element. |
|
DealsAttributeType |
New element. |
|
DealType |
New element. |
|
FranchiseeType |
New element. |
|
FranchiseesType |
New element. |
|
ItemAttributeGroup |
New element. |
|
ItemAttributeType |
New element. |
|
ItemSetType |
New element. |
|
ItemSpecifierType |
New element. |
|
TimeRuleType |
New element. |
|
RETAIL LOCATION LOOKUP SERVICES, VERSION 3.1 - New Chapter |
|
|
RetailLocationType |
Removed UserOrganization element. |
|
TASK SERVICES, VERSION 1.2 - New Chapter |
|
|
TaskNoteType |
Changed createDate from date to datetime. |
|
ENUMERATED VALUES |
|
|
AttributesIntendedUseType |
Added CardType and CardSeries to enumerated values. |
|
IssueAwardCouponType |
New element. |
Relate 11.4, Doc Version 02
The following changes were made to the Batch Processing & Web Services Guide.
Table I-6 Guide Changes for Relate 11.4, Doc Version 02
| Relate 11.4, Doc Version 02 |
|---|
|
Corrected authentication procedure in all Customer Engagement Cloud Services services chapters. |
Relate 11.4
The following changes were made to the Batch Processing & Web Services Guide.
Table I-7 Guide Changes for Relate 11.4
| Message/Data Type | Description of Change |
|---|---|
|
ATTRIBUTES SERVICES, VERSION 3.0 - New Chapter |
|
|
retrieveAttributesWithGroup |
Removed method. |
|
GroupAttributeType |
Removed element. |
|
ITEM SERVICES, VERSION 3.1 - New Chapter |
|
|
addOrUpdateItem |
Added securityUserId variable. |
|
addOrUpdateItemAttribute |
Changed name of userId to securityUserId. Changed securityUserId to be a required variable. |
|
addOrUpdateItemCrossReference |
Added securityUserId variable. |
|
ItemFranchiseeRequestType |
New element. |
|
ItemFranchiseeType |
New element. |
|
ItemFranchiseesType |
New element. |
|
removeItem |
Added securityUserId variable. |
|
removeItemCrossReference |
Added securityUserId variable. |
|
LOYALTY ACCOUNT SERVICES, VERSION 3.1 - New Chapter |
|
|
POSLOG SERVICES, VERSION 3.1 - New Chapter |
|
|
ImmediateAwardsType |
New element. |
|
ImmediateEAwardType |
New element. |
|
ImmediateMovementType |
New element. |
|
LoyaltyPointsType |
Added ImmediateAwards element. |
|
PROMOTION EVENT SERVICES, VERSION 3.0 - New Chapter |
|
|
PromoAddTargetRequestType |
Added SecurityUserId element. |
|
PromoAttributeType |
New element. |
|
PromotionType |
Added PromotionAttributes element. |
|
PromotionsRequestType |
Added SecurityUserId element. |
|
retrievePromotionDeals |
Added SecurityUserId variable. |
|
SEGMENT SERVICES, VERSION 3.0 - New Chapter |
|
|
addCustomerToSegment |
Added securityUserId variable. Added return type of string[]. |
|
addOrDeleteSegmentFranchisee |
New method. |
|
createManualSegment |
Added securityUserId variable. Added return type of long. |
|
getCustomersOfSegment |
Added securityUserId variable. |
|
getMyManualSegments |
Added securityUserId variable. |
|
getSegments |
Added securityUserId variable. |
|
removeCustomerFromSegment |
Added securityUserId variable. Added return type of string[]. |
|
updateManualSegment |
Added securityUserId variable. |
|
ENUMERATED VALUES |
|
|
AttributesIntendedIndustryType |
New element. Added return type of long. |
Relate 11.0 Doc Version 02
The following changes were made to the Batch Processing & Web Services Guide.
Table I-8 Guide Changes for Relate 11.0 Doc Version 02
| Message/Data Type | Description of Change |
|---|---|
|
TRANSACTIONS |
|
|
Transactions Added |
<OriginalBusinessDate> element to
<Transaction> element: <POSLog> <Transaction> <OriginalBusinessDate> Added <CardNumber> element to <RetailPriceModifier> element: <POSLog> <Transaction> <RetailTransaction> <LineItem> <Sale> <RetailPriceModifier> <CardNumber> |
|
ITEM REQUESTS |
|
|
Add Item Update Item |
Added <IntendedIndustry> to <Item> element:
<ItemMaintenance> <Item> <IntendedIndustry> |
|
AWARD ACCOUNT SERVICES, VERSION 3.0 - New Chapter |
|
|
automaticRedeem |
Added securityUserId variable. |
|
awardInstrumentData |
Removed instrumentID element. |
|
getAwardAccountHistory |
Removed instrumentID variable. Added securityUserId variable. |
|
inquiry |
Added securityUserId variable. |
|
issueCoupon |
Removed instrumentID variable. |
|
Added |
securityUserId variable. |
|
redeemCoupons |
Added securityUserId variable. |
|
reverse |
Added securityUserId variable. |
|
CARD SERVICES, VERSION 3.0 - New Chapter |
|
|
AlterKeyLookupType |
New element. |
|
CardInqAwardAccount |
Changed name of awardProgram to AwardProgram. |
|
CardInqAwardAccountActivity |
Added ReasonCode, ExpirationDate, and SequenceNumber. |
|
CardInqEntitlementAccount |
New element. |
|
CardInqError |
Added CardNumber element. |
|
CardInqInstrument |
Added CardTypeAttribute, TenderAccount, and EntitlementAccount elements. |
|
CardInqTypeAttribute |
New element. |
|
CardInquiryResponse |
Added PageResultType element. Added startIndex, morePages, and pageSize attributes. |
|
EntitlementAccountActivityListType |
New element. |
|
EntitlementAccountActivityType |
New element. |
|
EntitlementDealTimeRuleType |
New element. |
|
EntitlementProgramType |
New element. |
|
EntitlementDealListType |
New element. |
|
EntitlementDealType |
New element. |
|
ExcludeStoreLocationsType |
New element. |
|
extendExpirationDate |
Added securityUserId variable. |
|
FridayType |
New element. |
|
getCardInquiryData |
Added updateUserId variable. Changed securityUserId variable to [REQUIRED]. |
|
getCustomerCardsInquiryData |
New method. |
|
IncludeStoreLocationsType |
New element. |
|
PageResultType |
New element. |
|
RetailLocationGroupType |
New element. |
|
RetailLocationType |
New element. |
|
SaturdayType |
New element. |
|
SundayType |
New element. |
|
ThursdayType |
New element. |
|
TuesdayType |
New element. |
|
VelocityType |
New element. |
|
WednesdayType |
New element. |
|
CUSTOMER SERVICES, VERSION 3.0 - New Chapter |
|
|
addOrDeleteCustomerFranchisees |
New method. |
|
CustomerFranchiseeContainerReturnType |
New element. |
|
CustomerFranchiseeContainerType |
New element. |
|
CustomerFranchiseeRequestType |
New element. |
|
CustomerFranchiseeReturnType |
New element. |
|
CustomerFranchiseeType |
New element. |
|
Added “Entitlement Account Services, Version 3.0” Chapter |
|
|
Added “franchise Services, Version 3.0” Chapter. |
|
|
ITEM SERVICES, VERSION 3.0 - New Chapter |
|
|
ItemAttributeCodeValueType |
New element. |
|
ItemAttributeType |
Added AttributeCodeValue element. |
|
LOYALTY ACCOUNT SERVICES, VERSION 3.0 - New Chapter |
|
|
getLoyaltyAccountHistory |
Removed instrumentId variable. Added securityUserId variable. |
|
getLoyaltyTransactionDetail |
Removed instrumentId variable. Changed name of clientUserId variable to updateUserId. Added securityUserId variable. Changed return type to loyaltyActivityList. |
|
issuePoints |
Removed instrumentId variable. Changed name of clientUserId variable to updateUserId. Added securityUserId variable. |
|
moveLoyaltyLevel |
Changed name of clientUserId variable to updateUserId. Added securityUserId variable. |
|
recoverLoyaltyPoints |
Changed name of clientUserId variable to updateUserId. Added securityUserId variable. |
|
redeemPointsForAward |
Removed instrumentId variable. Changed name of clientUserId variable to updateUserId. Added securityUserId variable. |
|
POSLOG, VERSION 3.0 - New Chapter |
|
|
AuthorizationType |
Changed order of elements: RequestAmount moved to the end of the structure. |
|
CustomerAccountType |
Added CardNumber element. Removed LoyaltyAccount element. |
|
EntitlementRedemptionType |
New element. |
|
EntitlementRedemptionsType |
New element. |
|
LineItemType |
Changed BeginDateTime to type string from dateTime. Changed EndDateTime to type string from dateTime. |
|
LoyaltyAccountType |
Removed. |
|
PoslogCustomerType |
Added CustomerID element. Removed AccountNumber element. |
|
TransactionReturnType |
Added EntitlementSystemDetails and EntitlementRedemptions elements. |
|
TransactionType |
Added VoidFlag, OriginalBusinessDate, OrgCurrencyCode, and ExchangeRate. |
|
VoucherType |
Changed ExpirationDate to type string from dateTime. |
|
REGISTRY SERVICES, VERSION 3.0 - New Chapter |
|
|
RegistryDetailResponseType |
Added SecurityPrivilege element. |
|
RegistryResponseType |
Added SecurityPrivilege element. |
|
Added “Relate User Services, Version 3.0” Chapter |
|
|
RETAIL LOCATION LOOKUP SERVICES, VERSION 3.0 - New Chapter |
|
|
addOrUpdateLocation |
Added securityUserId variable. |
|
getAllUserOrgs |
Removed method. |
|
RetailLocationRequestType |
Removed UserOrganization element. Removed FranchiseLocationFlag element. Added FranchiseName element. |
|
RetailLocationType |
Added FranchiseName element. |
|
wsUserOrganization |
Removed element. |
|
SOCIAL MEDIA SERVICES, VERSION 3.0 - New Chapter |
|
|
STORED VALUE CARD TRANSACTION SERVICES, VERSION 3.0 - New Chapter |
|
|
activateInstrument |
Changed name of rtpTransationId variable to rtpTransactionId. Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
cashout |
Changed name of rtpTransationId variable to rtpTransactionId. Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
changeAccountExpirationDate |
Changed name of rtpTransationId variable to rtpTransactionId. Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
changeAuth |
Changed name of rtpTransationId variable to rtpTransactionId. Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
deactivateInstrument |
Changed name of rtpTransationId variable to rtpTransactionId. Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
FranchiseeListType |
New element. |
|
FranchiseeType |
New element. |
|
generateCard |
Changed name of rtpTransationId variable to rtpTransactionId. Removed userId variable. Added cardNumber variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
generateMultipleCards |
New method. |
|
getLastXTransactions |
New method. |
|
inquiry |
Changed name of rtpTransationId variable to rtpTransactionId. Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
InstrumentStateType |
Added CardSerialNumber element. Added AuthorizedFranchisees element. Removed AuthorizedUserOrganizations element. |
|
postAuth |
Changed name of rtpTransationId variable to rtpTransactionId Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
preAuth |
Changed name of rtpTransationId variable to rtpTransactionId Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
ProgramType |
Added Rechargeable attribute. |
|
recharge |
Changed name of rtpTransationId variable to rtpTransactionId Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
redeem |
Changed name of rtpTransationId variable to rtpTransactionId Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
releaseAuth |
Changed name of rtpTransationId variable to rtpTransactionId Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
replace |
Changed name of rtpTransationId variable to rtpTransactionId Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
RespInstrumentType |
Removed AuthorizedUserOrganizations element. Added AuthorizedFranchisees element. |
|
returnForStoreCredit |
Changed name of rtpTransationId variable to rtpTransactionId Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
reverseTrans |
Changed name of rtpTransationId variable to rtpTransactionId Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
serviceCharge |
Changed name of rtpTransationId variable to rtpTransactionId Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
unblockTenderAccount |
Changed name of rtpTransationId variable to rtpTransactionId Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
UserOrgListType |
Removed element. |
|
UserOrgType |
Removed element. |
|
verifyAuth |
Changed name of rtpTransationId variable to rtpTransactionId Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
voidTrans |
Changed name of rtpTransationId variable to rtpTransactionId Removed userId variable. Added updateUserId variable. Added securityUserId variable. Removed userOrganization variable. |
|
ENUMERATED TYPE |
|
|
EntitlementAccountRedemptionType |
New element. |
|
VelocityPeriodType |
New element. |
Relate 10.8, Doc Version 3
The following changes were made to the Batch Processing & Web Services Guide.
Table I-9 Guide Changes for Relate 10.8, Doc Version 3
| Description of Change |
|---|
|
“Introduction” ChapterIn the section “XML API File Reader”, changed the URL for the File Reader to: https://<hostname>:8443/XmlApiFileReader/ The port was changed from 8084 and the “http” prefix was changed to “https”. These changes reflect the fact that the File Reader requires an SSL for the install. |
Relate 10.8, Doc Version 2
The following changes were made to the Batch Processing & Web Services Guide.
Table I-10 Guide Changes for Relate 10.8, Doc Version 2
| Description of Change |
|---|
|
CUSTOMER REQUESTS In the section “Customer Validation”, changed the section “Address” to indicate that, if an incomplete address is submitted, the address will not be added to the database. |
Relate 10.8
The following changes were made to the Batch Processing & Web Services Guide.
Table I-11 Guide Changes for Relate 10.8
| Message/Data Type | Description of Change |
|---|---|
|
CUSTOMER SERVICES, VERSION 2.4 - New Chapter. |
|
|
AlterKeyLookupType |
New element. |
|
CustomerLookupType |
Added BusinessName element. Changed AlternateKey element to AlterKeyLookupType type. |
|
CustomerResponseType |
Added SystemCurrencyCode element. |
|
PersonalSummaryType |
Added Anniversary element. |
|
PersonalSummaryReturnType |
Added Anniversary element. |
|
PromotionEventReturnType |
Added SystemCurrencyCode element. |
|
SegmentStrataType |
New element. |
|
SegmentType |
Added Type and Strata elements. |
|
PROMOTION EVENT, VERSION 2.2 - New Chapter. |
|
|
DealAttributeType |
New element. |
|
PromoDealAttributeType |
New element. |
|
PromoDealType |
Added DealAttribute and PromoDealAttribute elements. |
|
SOCIAL MEDIA, VERSION 1.0 - New Chapter. |
|
|
ENUMERATED VALUES |
|
|
SocialMediaActionType |
New enumerated type. |
|
SocialMediaType |
New enumerated type. |
|
AttributesIntendedUseType |
Added values PromoDeal and Deal. |
Relate 10.5
The following changes were made to the Batch Processing & Web Services Guide.
Table I-12 Guide Changes for Relate 10.5
| Message/Data Type | Description of Change |
|---|---|
|
zz |
|
|
USERS - New chapter |
|
|
Add User |
New message. |
|
Update User |
New message. |
|
CARDS |
|
|
Generate Card |
Removed note: “A card can only be associated with one customer; however, a customer can be associated with more than one card.” This is no longer true. Card Group Activate Removed. No longer in use. Card Group Change ExpiryDate Removed. No longer in use. Card Group Deactivate Removed. No longer in use. |
|
INTRODUCTION TO RELATE APIS |
|
|
Moved AttributeException type to “Common Elements” section and removed full description of AttributeException from several chapters. |
|
|
AWARD ACCOUNT SERVICES, VERSION 1.1 |
|
|
automaticRedeem |
Added reasonCode and ignoreExpirationDate variables. |
|
inquiry |
Added ignoreExpirationDate variable. |
|
issueCoupon |
Added reasonCode variable. |
|
redeemCoupons |
Added reasonCode and ignoreExpirationDate variables. |
|
reverse |
Added reasonCode variable. |
|
AWARD ACCOUNT SERVICES, VERSION 1.2 - New Chapter |
|
|
issueCoupon |
Added couponPrefix variable. |
|
CARD SERVICES, VERSION 1.0 |
|
|
CardInqLoyaltyAccount |
Changed attribute to TypeCode from Type. |
|
CARD SERVICES, VERSION 2.0 |
|
|
CardInqInstrument |
Added CardExpirationDate element. |
|
CardInqLoyaltyAccount |
Changed attribute to TypeCode from Type. |
|
CARD SERVICES, VERSION 2.1 - New Chapter |
|
|
AwardProgramType |
New element. |
|
CardInqAwardAccount |
Added awardProgram element. |
|
CardInqAwardAccountActivity |
Added ReasonCode element. Added ExpirationDate element. Added SequenceNumber element. |
|
CardInqInstrument |
Added CardExpirationDate element. |
|
CardInqLoyaltyAccount |
Changed attribute to TypeCode from Type. |
|
CardInqLoyaltyActivity |
Added RequestedAmount element. Added RequestedCurrencyCode element. Added ExchangeRate element. Added ConvertedAmount element. |
|
CardInquiryResponse |
Added OtherAssociatedCustomers element. |
|
extendExpirationDate |
Added updateUserId variable. |
|
getCardInquiryData |
Changed clientUserId variable to securityUserId. |
|
RTPTransaction |
New element. |
|
RTPAmount |
New element. |
|
updateCardToCustomerAssociations |
Added updateUserId variable. Changed clientUserId variable to securityUserId. |
|
CUSTOMER SERVICES, VERSION 2.1 |
|
|
TransactionType |
Added full description of this element. |
|
CUSTOMER SERVICES, VERSION 2.2 |
|
|
TransactionType |
Added full description of this element. |
|
CUSTOMER SERVICES, VERSION 2.3 - New Chapter |
|
|
addCustomerNote |
Added updateUserId variable. Changed UserId variable to securityUserId. |
|
addOrUpdateCustomer |
Changed UserId variable to securityUserId. |
|
addOrUpdatePreferenceCenter |
Changed clientUserId variable to securityUserId. |
|
addWishlistItems |
Changed UserId variable to securityUserId. |
|
associateCardToCustomer |
Changed clientUserId variable to securityUserId. Changed name of transactionInfo to TransactionInfo. |
|
changeItemDisplayStatus |
Changed UserId variable to securityUserId. |
|
CustomerNotesContainerReturnType |
Changed the order in which the elements appear. |
|
CustomerType |
Added PreferenceCenters element. |
|
deleteCustomer |
Added securityUserId variable. |
|
deleteWishlistItems |
Changed UserId variable to securityUserId. |
|
EmailReturnType |
Added ValidFlag attribute. |
|
EMailType |
Added FormatPreferenceCode attribute. |
|
getAssociateAssignment |
Changed UserId variable to securityUserId. |
|
getCustomerImage |
Changed UserId variable to securityUserId. |
|
getCustomerNotes |
Changed clientUserId variable to securityUserId. Changed return type to a single CustomerNotesContainerReturnType, instead of an array. |
|
getItemHistory |
Changed UserId variable to securityUserId. |
|
getPreferenceCenter |
New method. |
|
getPreferenceTypes |
New method. |
|
getPromotionHistoryWithDateRange |
Changed UserId variable to securityUserId. |
|
getPromotionHistoryWithDateRangeMaxResult |
Changed UserId variable to securityUserId. getTransactionHistory Changed UserId variable to securityUserId. |
|
getVisualizerItems |
Changed UserId variable to securityUserId. |
|
InstrumentReturnType |
Added PrimaryAccountHolderFlag element. |
|
mergeCustomers |
Changed UserId variable to securityUserId. Added updateUserId variable. |
|
PreferenceCenterChannelReqType |
New element. |
|
PreferenceCenterContainerRequestType |
New element. |
|
PreferenceCenterReqType |
New element. |
|
retrieveCustomer |
Changed UserId variable to securityUserId. |
|
RTPTransaction |
New element. |
|
RTPAmount |
New element. |
|
searchCustomers |
Changed UserId variable to securityUserId. |
|
SegmentMessageType |
Added CustomerMessage and ReceiptMessage elements. |
|
SegmentType |
Added OpenAccess and PublishToPromote elements. |
|
TelephoneReturnType |
Added ValidFlag attribute. |
|
TransactionType |
Added full description of this element and all its subelements to the chapter. |
|
updateAssociateAssignment |
Changed UserId variable to securityUserId. |
|
WishlistItemType |
Added publishExternally attribute. |
|
LOYALTY ACCOUNT SERVICES, VERSION 1.2 - New Chapter |
|
|
This services uses the elements described in Card Services 2.1. The methods and elements are otherwise unchanged. |
|
|
PROMOTION EVENT SERVICES, VERSION 2.1 - New Chapter |
|
|
PromoDealsResponseType Removed OrganizationId element. |
|
|
REGISTRY SERVICES, VERSION 1.0 |
|
|
addOrUpdateRegistryDetail |
Added updateUserId variable. |
|
RegistrySummaryType |
Changed eventDate to type string. |
|
searchRegistry |
Removed IllegalRetailTranIdException fault. |
|
REGISTRY SERVICES, VERSION 1.1 |
|
|
addOrUpdateRegistryDetail |
Added updateUserId variable. |
|
RegistryResponseType |
Changed EventDate to type dateTime. Change ExpirationDate to type dateTime. |
|
RegistrySummaryType |
Changed eventDate to type dateTime. |
|
searchRegistry |
Removed IllegalRetailTranIdException fault. |
|
REGISTRY SERVICES, VERSION 1.2 - New Chapter |
|
|
addOrUpdateRegistryDetail |
Added updateUserId variable. Changed userId variable to securityUserId. |
|
addOrUpdateRegistry |
Added updateUserId variable. Changed userId variable to securityUserId. |
|
customerRegistryAssociation |
Changed userId variable to securityUserId. |
|
deleteRegistry |
Added updateUserId variable. Changed userId variable to securityUserId. |
|
getRegistry |
Changed userId variable to securityUserId. |
|
getRegistryDetail |
Changed userId variable to securityUserId. |
|
RegistryResponseType |
Changed EventDate to type dateTime. Change ExpirationDate to type dateTime. |
|
RegistrySummaryType |
Changed eventDate to type dateTime. |
|
searchRegistry |
Removed IllegalRetailTranIdException fault. Changed userId variable to securityUserId. |
|
sellOrReturnRegistryItems |
Changed userId variable to securityUserId. |
|
SEGMENT SERVICES, VERSION 1.1 - New Chapter |
|
|
createManualSegment |
Added clientelingFlag variable. |
|
SegmentAttributeType |
New element. |
|
SegmentAttributeValueType |
New element. |
|
updateManualSegment |
New method. |
|
wsAttributeValue |
New element. |
|
wsSegmentAttribute |
New element. |
|
wsSegmentSummaryWithAttribute |
Changed name from wsSegmentSummary. Added attributeGroup element. |
|
STORED VALUE CARD TRANSACTION, VERSION 1.1 - New Chapter |
|
|
RespInstrumentType |
Added AuthenticationData element. |
|
TASK SERVICE, VERSION 1.1 - New Chapter |
|
|
TaskRelateUserType |
Removed organizationId element. |
|
TaskCustomerType |
Removed organizationId element. |
|
ENUMERATED VALUES |
|
|
PreferenceCenterActionType |
New enumerated type. |
|
PreferenceChannelType |
New enumerated type. |
Relate 10.0, Doc Version 3
The following changes were made to the Batch Processing & Web Services Guide.
Table I-13 Guide Changes for Relate 10.0, Doc Version 3
| Message/Data Type | Description of Change |
|---|---|
|
LOYALTY ACCOUNT SERVICES, VERSION 1.0 |
|
|
getLoyaltyTransactionDetail |
Reversed descriptions of transaction and transactionLookup variables to show correct descriptions. |
|
LOYALTY ACCOUNT SERVICES, VERSION 1.1 |
|
|
getLoyaltyTransactionDetail |
Reversed descriptions of transaction and transactionLookup variables to show correct descriptions. |
Relate 10.0, Doc Version 2
The following changes were made to the Batch Processing & Web Services Guide.
Table I-14 Guide Changes for Relate 10.0, Doc Version 2
| Message/Data Type | Description of Change |
|---|---|
|
INTRODUCTION TO RELATE APIS - New chapter. |
|
|
RelateProcessingException |
Moved definition to “Introduction To Relate APIs and Web Services” chapter. |
|
GIFT REGISTRY, VERSION 1.0 |
|
|
addOrUpdateRegistry |
Added AttributeException fault. |
|
AttributeException |
Added missing information. |
|
ITEM, VERSION 1.0 |
|
|
addOrUpdateItemAttribute |
Added AttributeException fault. |
|
AttributeException |
New element. |
|
errorProperty |
New element. |
Relate 10.0
The following changes were made to the Batch Processing & Web Services Guide.
Table I-15 Guide Changes for Relate 10.0
| Message/Data Type | Description of Change |
|---|---|
|
ATTRIBUTES, VERSION 1 |
|
|
GroupAttributeType |
New element. |
|
retrieveAttributesWithGroup |
New method. |
|
ATTRIBUTES SERVICES, VERSION 1.1 - New chapter |
|
|
attributesType |
Added attributeId element. |
|
GroupAttributeType |
Added attributeId element. |
|
CARD SERVICES, VERSION 2 |
|
|
getCardInquiryData |
Removed instrumentId variable. |
|
CUSTOMER, VERSION 2.2 |
|
|
getTransactionHistory |
Added LineItemTypeCode variable. |
|
GIFT REGISTRY, VERSION 1 |
|
|
AttributeException |
New element. |
|
CustAddressType |
Replaced AddressType element. |
|
CustEmailType |
Replaced EmailType element. |
|
CustTelephoneType |
Replaced TelephoneType element. |
|
CustContactInformationType |
Made corrections to element and subelements. |
|
errorProperty |
New element. |
|
GIFT REGISTRY, VERSION 1.1 |
|
|
AttributeException |
New element. |
|
AttributeValueType |
New element. |
|
CustAddressType |
New element. |
|
CustEmailType |
New element. |
|
CustTelephoneType |
New element. |
|
CustContactInformationType |
Made corrections to element and subelements. |
|
deleteRegistry |
Changed registryId and userId variables to [REQUIRED]. |
|
errorProperty |
New element. |
|
getRegistry |
Changed registryId and userId variables to [REQUIRED]. |
|
getRegistryDetail |
Changed registryId variable to [REQUIRED]. |
|
RegAttributeType |
Changed element to reflect that now represents an Attribute Group, rather than an Attribute. |
|
RegistrySummaryType |
Added EventPlace value. |
|
searchRegistry |
Added userId variable. |
|
LOYALTY, VERSION 1.1 |
|
|
redeemPointsForAward |
Added reasonCode variable. |
|
RETAIL LOCATION, VERSION 1.1z |
|
|
addOrUpdateLocation |
Changed retailLocData variable to RetailLocationRequestType from RetailLocationType. |
|
RetailLocationRequestType |
New element. |
|
STORED VALUE CARD TRANSACTION, VERSION 1 |
|
|
changeAuth |
Added newAuthenticationData variable. |
|
replace |
Removed svaTransactionId and authNumber variables. |
Relate 9.7 Doc Version 4
The following changes were made to the Batch Processing & Web Services Guide.
Table I-16 Guide Changes for Relate 9.7 Doc Version 4
| Message/Data Type | Description of Change |
|---|---|
|
CARD SERVICES, VERSION 2 |
|
|
getCardInquiryData |
Changed clientUserId variable to show it is required. |
|
updateCardToCustomerAssociations |
Changed expirationDate to clientUserId. |
|
SEGMENT |
|
|
createManualSegment |
Changed userId variable to show it is required. |
|
TASKS |
|
|
addTaskNotes |
Changed userId variable to show it is required. |
|
getTaskNotes |
Changed userId variable to show it is required. |
|
saveOrUpdateTask |
Changed userId variable to show it is required. |
|
saveTaskStatus |
Changed userId variable to show it is required. |
Relate 9.7 Doc Version 3
The following changes were made to the Batch Processing & Web Services Guide.
Table I-17 Guide Changes for Relate 9.7 Doc Version 3
| Message/Data Type | Description of Change |
|---|---|
|
Added descriptions of variables passed to all methods in all WSDL web services. |
|
|
ITEM SERVICES |
|
|
addOrUpdateItemCrossReference |
Added method. |
|
removeItem |
Added method. |
|
removeItemCrossReference |
Added method. |
Relate 9.7 Doc Version 2
The following changes were made to the Batch Processing & Web Services Guide.
Table I-18 Guide Changes for Relate 9.7 Doc Version 2
| Message/Data Type | Description of Change |
|---|---|
|
TRANSACTIONS |
|
|
POS Logs |
Added “Issue Bounce Back Coupon” section. |
|
Post POSLog Transaction |
In the “Request” section, removed mention of the (removed) PaidInFullFlag. |
|
ITEM REQUESTS |
|
|
Overview |
Added description of Item Attributes. |
|
Add Item |
Added the following error codes: UNKNOWN_ATTRIBUTE_TYPE MULTIPLE_VALUES_ON_UNIQUE_ATTRIBUTE_TYPE INVALID_ATTRIBUTE_VALUE VALUE_NOT_IN_ENUMERATED_ATTRIBUTE_TYPE_VALUES INVALID_DATE_FORMAT |
|
Update Item |
Added the following error codes: UNKNOWN_ATTRIBUTE_TYPE MULTIPLE_VALUES_ON_UNIQUE_ATTRIBUTE_TYPE INVALID_ATTRIBUTE_VALUE VALUE_NOT_IN_ENUMERATED_ATTRIBUTE_TYPE_VALUES INVALID_DATE_FORMAT |
|
Added "Store Value Card Services" Chapter |
|
Customer Engagement Cloud Services xx
The following changes were made to the Batch Processing & Web Services Guide.
Table I-19 Guide Changes for Release xx
| Message/Data Type | Description of Change |
|---|---|
|
Added "Customer Services, Version 2.2" Chapter |
|
|
CUSTOMER SERVICES, VERSION 2.2 |
|
|
getCustomerNotes |
Changed return type. |
|
getPromotionHistoryWithDateRange |
Changed return type. |
|
getTransactionHistory |
Changed return type. |
|
PromotionEventContainerReturnType |
Added new class. |
|
PromotionEventReturnType |
Added new class. |
|
PromotionEventType |
Added new class. |
|
TransactionContainerReturnType |
Added new class. |
|
TransactionReturnType |
Added new class. |
|
wsCustomerPromotionEvent |
Removed class. |
|
LOYALTY ACCOUNT SERVICES, VERSION 1.1 |
|
|
moveLoyaltyLevel |
Added new message. |
|
Added "Promotion Event Services, Version 2.0" Chapter |
|
|
PROMOTION EVENT SERVICES, VERSION 2.0 |
|
|
addOrUpdatePromotionTarget |
Added new message. |
|
PromoAddTargetRequestType |
Added new class. |
|
Added "Registry Services" Chapter |
|
|
ENUMERATED VALUES |
|
|
RegistryActionType |
Added new class. |
|
RegistryItemsActionType |
Added new class. |
|
RegistrySearchFieldType |
Added new class. |
Relate 9.6, Doc Version 2
The following changes were made to the Batch Processing & Web Services Guide.
Table I-20 Guide Changes for Relate 9.6, Doc Version 2
| Message/Data Type | Description of Change |
|---|---|
|
LOYALTY |
|
|
Issue Points |
Added REASON_CODE_REQUIRED error. |
|
Redeem Points for Award |
Added REASON_CODE_REQUIRED error. |
|
STORED VALUE |
|
|
Activate InstrumentRequest |
Added REASON_CODE_REQUIRED error. |
|
Deactivate Instrument |
Added REASON_CODE_REQUIRED error. |
|
Redemption |
Added REASON_CODE_REQUIRED error. |
|
Recharge |
REASON_CODE_REQUIRED error. |
|
Added |
REASON_CODE_REQUIRED error. |
|
Cashout Added |
REASON_CODE_REQUIRED error. |
|
Return Added |
REASON_CODE_REQUIRED error. |
|
Preauthorization Added |
REASON_CODE_REQUIRED error. |
|
Postauthorization Added |
REASON_CODE_REQUIRED error. |
|
Release Added |
REASON_CODE_REQUIRED error. |
|
Reverse Added |
REASON_CODE_REQUIRED error. |
|
Void Added |
REASON_CODE_REQUIRED error. |
|
Replace Added |
REASON_CODE_REQUIRED error. |
|
Service Charge Added |
REASON_CODE_REQUIRED error. |
|
Change Authorization Added |
REASON_CODE_REQUIRED error. |
|
AWARDS |
|
|
Redeem Coupon Added |
REASON_CODE_REQUIRED error. |
|
Issue Coupon Added |
REASON_CODE_REQUIRED error. |
|
Issue Added |
REASON_CODE_REQUIRED error. |
|
Void Added |
REASON_CODE_REQUIRED error. |
Relate 9.6
The following changes were made to the Batch Processing & Web Services Guide.
Table I-21 Guide Changes for Relate 9.6
| Message/Data Type | Description of Change |
|---|---|
|
ITEM |
|
|
Add Item & Update Item |
Added <ItemAttribute> element and its <AttributeValue> subelement. <ItemMaintenance> <Item> <ItemAttribute> <!-- New --> <AttributeValue> <!-- New --> |
|
Added "Attribute Services" Chapter |
|
|
Added "Item Services" Chapter |
|
|
AWARD SERVICES, VERSION 1.1 |
|
|
automaticRedeem |
Added reasonCode and ignoreExpirationDate variables. |
|
issueCoupon |
Added reasonCode and ignoreExpirationDate variables. |
|
redeemCoupon |
Added reasonCode and ignoreExpirationDate variables. |
|
reverse |
Added reasonCode variable. |
|
CARD SERVICES, VERSION 2.0 |
|
|
extendExpirationDate |
Added new message. |
|
updateCardToCustomerAssociations |
Added new message. |
|
CardCustAssociationType |
Added new class. |
|
CardInqAssocCustomer |
Added new class. |
|
CardInquiryResponse |
Added CardInqAssociateCustomer element. |
|
CUSTOMER SERVICES, VERSION 2.1 |
|
|
associateCardToCustomer |
Removed cardSerialNumber variable. |
|
deleteCustomer |
Removed cardSerialNumber variable. |
|
getAssociateAssignment |
Removed cardSerialNumber variable. |
|
getCustomerNotes |
Removed cardSerialNumber variable. |
|
getItemHistory |
Removed cardSerialNumber variable. |
|
getPromotionHistoryWithDateRange |
Removed cardSerialNumber variable. |
|
getPromotionHistoryWithDateRangeMaxResult |
Removed cardSerialNumber variable. |
|
getTransactionHistory |
Removed cardSerialNumber variable. |
|
getVisualizerItems |
Removed cardSerialNumber variable. |
|
retrieveCustomer |
Removed cardSerialNumber variable. |
|
CustomAttributeReturnType |
Added editable attribute. |
|
LOYALTY ACCOUNT SERVICES, VERSION 1.1 |
|
|
issuePoints |
Added reasonCode variable. |
|
recoverLoyaltyPoints |
Added reasonCode variable. |
|
redeemPointsForAward |
Added reasonCode variable. |
Relate 9.5 Doc Version 2
The following changes were made to the Batch Processing & Web Services Guide.
Table I-22 Guide Changes for Relate 9.5 Doc Version 2
| Message/Data Type | Description of Change |
|---|---|
|
CUSTOMER |
|
|
Customer Search response |
Added <CustomAttribute> element and <AttributeValue> subelement. <Customers> <Customer> <CustomAttribute> <!-- New --> <AttributeValue> <!-- New --> |
|
Customer Lookup & Customer Retrieve responses |
Added <YearToDateActivitySummary> element and its subelements to <Individual> element. <Customers> <Customer> <EntityInformation> <Individual> <YearToDateActivitySummary> <!-- New --> <YearToDateReturnsAmount> <!-- New --> <YearToDateSalesAmount> <!-- New --> <YearToDateTransactionCount> <!-- New - -> <YearToDateItemsSoldCount> <!-- New --> <YearToDateItemsReturnedCount> <!-- New --> |
|
TRANSACTION |
|
|
POSLog |
Added <DocumentType> and <ActivityCode> elements to <LineItem> element. Added "IssueBounceBack" value to Action element for <Amount> element. <POSLog> <Transaction> <RetailTransaction> <LineItem> <DocumentType> <!-- New --> <ActivityCode> <!-- New --> <RetailPriceModifier> <Amount Action="IssueBounceBack"> <!-- New --> Added notes to POSLog message indicating where bounceback information is included in a transaction. |
|
STORED VALUE |
|
|
Activate Instrument Request Response Deactivate Instrument Request Response Recharge Request Response Cashout Request Response Return Request Response Preauthorization Request Response Postauthorizaton Request Response Release Preauthorization Response Reverse Request Response Void Request Response Service Charge Request Response Change Authorization Request Response Verify Authorization Request Response Change Account Expiry Request Response |
Added <CardName>, <CardNumber>, <CardSerialNumber>, and <AuthorizedUserOrganizations> element to <InstrumentState> element. Added <Program> element to <AccountState> element. <*********Response> <!-- Where ********* is the request --> <InstrumentState> <CardName> <!-- New --> <CardNumber> <!-- New --> <CardSerialNumber> <!-- New --> <AuthorizedUserOrganizations> <!-- New --> <UserOrganization> <!-- New --> <Name> <!-- New --> <AccountState> <Program> <!-- New --> Added <AuthorizedUserOrganizations> element to <InstrumentState> element. |
|
CARD SERIES |
|
|
Generate Card Request |
Added <UserOrganization> element to <CardSeries> element. <CardSeriesMaintenance> <CardSeries Action="GenerateCard"> <UserOrganization> <!-- New --> |
|
ITEMS |
|
|
Add Item RequestUpdate Item Request |
Added <ItemImageUrl> element to <Item> element. <ItemMaintenance> <Item> <ItemImageUrl> <!-- New --> |
Relate 9.5
The following changes were made to the Batch Processing & Web Services Guide.
Table I-23 Guide Changes for Relate 9.5
| Message/Data Type | Description of Change |
|---|---|
|
CUSTOMER, VERSION 2 |
|
|
addCustomerNote |
Added new message. |
|
addOrUpdateCustomer |
Added UserId field to message. |
|
addWishlistItems |
Added new message. |
|
associateCardToCustomer |
Added clientUserId field to message. |
|
deleteCustomer |
Added UserId field to message. |
|
deleteWishlistItems |
Added new message. |
|
getAssociateAssignment |
Added new message. |
|
getCustomerImage |
Added new message. |
|
getCustomerNotes |
Added clientUserId field to message. |
|
getItemHistory |
Added new message. |
|
getPromotionHistoryWithDateRange |
Added UserId field to message. |
|
getPromotionHistoryWithDateRangeMaxResultResponse |
Added UserId field to message. |
|
getTransactionHistory |
Added UserId field to message. |
|
getVisualizerItems |
Added new message. |
|
mergeCustomers |
Added UserId field to message |
|
retrieveCustomer |
Added UserId field to message |
|
searchCustomers |
Added UserId and AssociateId fields to message. |
|
updateAssociateAssignment |
Added new message. |
|
<CustomerType> |
Added CustomerOwnerID and AssociateAssignments. |
|
POSLOG Added PosLog Services chapter. |
|
|
PROMOTION EVENT Added Promotion Event Services chapter. |
|
|
SEGMENT Added Segment Services chapter. |
|
|
TASK Added Task Services chapter. |
|
Revision History 9.0, Doc Version 03
Complete editing and error checking corrections through all messages and information in the manual.
Revision History 9.0
The following changes were made to the Batch Processing & Web Services Guide.
Table I-24 Guide Changes for Revision History 9.0
| Message/Data Type | Description of Change |
|---|---|
|
CARD SERIES |
|
|
Generate Card |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. Changed Errors table to show error message names, rather than descriptions of the errors. |
|
Card Inquiry |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Card Group Activate |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
STORED VALUE |
|
|
Inquiry Request |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Activate InstrumentRequest |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Redemption Request |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Recharge Request |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Cashout Request |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Return Request |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Preauthorization Request |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Postauthorization Request |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Release Preauthorization |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Reverse Request |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. Added PREAUTH_NOT_VOIDABLE error. Changed error ORIGINAL_TRANSACTION_NOT_LAST to ACTIVATION_NOT_VOIDABLE_WHEN_ACCT_HAS_ACTIVITY. |
|
Void Request |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. Added PREAUTH_NOT_VOIDABLE error. Changed error ORIGINAL_TRANSACTION_NOT_LAST to ACTIVATION_NOT_VOIDABLE_WHEN_ACCT_HAS_ACTIVITY. |
|
Service Charge Request |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
AWARDS |
|
|
Award Account Inquiry |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Redeem Coupon |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Automatic Redeem |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Issue Coupon |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. |
|
Void |
Added FOREIGN_CURRENCY_NOT_ALLOWED error. Changed error ORIGINAL_TRANSACTION_NOT_LAST to ACTIVATION_NOT_VOIDABLE_WHEN_ACCT_HAS_ACTIVITY. |
Revision History 8.9
Added Revision History section.
Table I-25 Guide Changes for Revision History 8.9
| Date | Description of Change |
|---|---|
|
February 2010 |
Added Serialized Coupon Chapter. |
Revision History 8.8, Doc Version 02
Added Revision History section.
Table I-26 Guide Changes for Revision History 8.8, Doc Version 02
| Date | Description of Change |
|---|---|
|
September 2010 |
Removed information describing necessary steps in fileset processing. Customer Engagement Cloud Services can now always handle files in the fileset folder when they were placed in the folder using Windows Explorer. |
Revision History
The following changes were made to the Batch Processing & Web Services Guide.
Table I-27 Guide Changes or Additions since Relate version 8.5
| Message/Data Type | Description of Change |
|---|---|
|
Activate |
New |
|
Change Expiry Date |
New |
|
Deactivate |
New |
|
Activate Instrument |
Changed/Added: <RTPTransaction> <RTPTransactionID>22000000</RTPTransactionID> <OperatorID>10</OperatorID> <LocationID>99901</LocationID> <TransactionDateTime>2010-01-10T03:59:00</ TransactionDateTime> <DeviceID>10</DeviceID> <BusinessDate>2010-01-10</BusinessDate> <RTPAmount> <CurrencyID>USD</CurrencyID> <Amount>50</Amount> <AwardAmount>50</AwardAmount> <LoyaltyAmount>50</LoyaltyAmount> </RTPAmount> </RTPTransaction> <AwardAmount>50</AwardAmount> <LoyaltyAmount>50</LoyaltyAmount> |
|
Generate Card |
Added: <RTPTransaction> <RTPTransactionID>22000000</RTPTransactionID> <OperatorID>10</OperatorID> <LocationID>99901</LocationID> <TransactionDateTime>2010-01-10T03:59:00</ TransactionDateTime> <DeviceID>10</DeviceID> <BusinessDate>2010-01-10</BusinessDate> <RTPAmount> <CurrencyID>USD</CurrencyID> <Amount>100</Amount> <AwardAmount>25.50</AwardAmount> <LoyaltyAmount>50</LoyaltyAmount> </RTPAmount> </RTPTransaction> <!-- Associating a Customer to card is optional -- > <Customer> <CustomerID/> <AlternateKey TypeCode="XSTORE_ID"> <AlternateID>1010001000040</AlternateID> </AlternateKey> </Customer> |
|
Add Add Or Update Update |
Added: type, createDate, createUser & location to Notes. Customer Notes will default to COMMENT type code if no note type is provided. <CustomerNotes> <CustomerNote type="SHIPPING-NOTES" createDate="2010-09-10T10:51:29.647" createUser="TestUser" location="55002"> Deliver only to loading dock</CustomerNote> <CustomerNote type="MISC-NOTES" createDate="2010- 09-11T10:51:29.647" createUser="TestUser" location="55002"> Customer likes gummy bears</CustomerNote> </CustomerNotes> |
|
Add Update |
Changed: Custom Attribute names must be pre-defined. <StoreAttribute name="Outlet-Store"> <AttributeValue>false</AttributeValue> </StoreAttribute> <StoreAttribute name="Additional-Departments"> <AttributeValue>Bakery</AttributeValue> <AttributeValue>Florist</AttributeValue> <AttributeValue>Beer - Wine</AttributeValue> </StoreAttribute> <StoreAttribute name="Location"> <AttributeValue>OH</AttributeValue> </StoreAttribute> |
Revision History 8.5
The Web Services and Batch Processing manual was previously divided into two manuals beginning with Relate version 7.0: the Web Services Guide and the Batch Processing Guide. Beginning with Relate version 8.5, these manuals have been combined once more into one complete manual. Because this manual was once two separate manuals, the Revision History for each of the previous manuals is included in the following table.
Table I-28 Guide Changes for Release 8.5
| Doc Revision | Relate Version | Date | Description of Change |
|---|---|---|---|
|
4.1 |
8.5 |
June 2010 |
Item Requests - Corrected default Level names in <MerchandiseHierarchy> element. Store Value - Added missing link to Release message in Overview. Introduction - Added important information describing necessary steps in fileset processing. |
|
4.0 |
8.5 |
May 2010 |
Combined Web Services Guide and Batch Processing Guide into one document. Corrected errors, transpositions, and missing information in the message formats and examples. Updated: Customer - Indicated that UpdateType="Set" is ignored for Alternate Keys. Removed: Transactions - <SortOrder> element. Description of alternate lookup. |