• Entity Posting API
• >>
• Customer Account Movement

Entity Posting API - Customer Account Movement

If the CustomerId does not exist, an error will be returned. If the AccountId does not exist for the Customer, a new Account record will be created. If it does, then a new history record will be written.

Triggered Updates:

• No other data effected

Standard ShowTimeAnalytics Message Parameters:

• DataSupplierID: Assigned unique identifier for your account
  String
  (required)
• MessageSequence: Unique sequence number incremented for each message posted
  Long
  (required)
• CallbackUrl: Dataprovider defined URL that result of processing the message is posted back to
  String

Fields for Customer Account Entity (AccountMovement):

• ID attribute: Unique identifier for account movement
  String
  (required)
• SiteID attribute: Unique identifier for site that holds the account
  String
  (required)
• CustomerId: Unique identifier for customer (link to Customer entity)
  String
  (required)
• AccountId: Unique identifier for account (link to Account under Customer entity)
  String
  (required)
• AccountType: Base categorisation for account movement e.g. Earned, Redemption String
  String
• Name: Name for account
  String
  (required)
• Description: Reason movement occurred on account
  String
• CustomerEmail: Customer contact email address
  String
• CustomerName: Customer name
  String
• CustomerLastName: Customer last name
  String
• Type: Base categorisation for account
  String
• Tags: User defined list of tags they might want to filter on
  String
• PointsDelta: Amount of points rewarded/redeemed for the transaction
  Integer
  (required)
  • Precision attribute: The number of Integer places in the PointsDelta field
    Integer
• PointsBalance: Balance of points for the account
  Integer
  (required)
  • Precision attribute: The number of Integer places in the PointsBalance field
    Integer
• TransactionDate: The date the transaction occurred which caused the movement
  ISO-8601 datetime
  (required)
• OrderId attribute: If the loyalty application is separate to the POS system, posting the rewards points with the order transaction record may not always be possible. Therefore, the orderId can be passed here and the order in the system will be updated
  String

PLEASE NOTE: All field and attribute names are case sensitive

Message Structure - XML:

<?xml version="1.0" encoding="UTF-8"?>
<ShowTimeAnalytics dataSupplierId="XXX" messageSequence="XXX">
	<CallbackUrl>https://XXX</CallbackUrl>
	<AccountMovements>
		<AccountMovement id="XXX" siteId="XXX">
			<CustomerId>XXX</CustomerId>
			<AccountId>XXX</AccountId>
			<Name>XXX</Name>
			<Description>XXX</Description>
			<Type>XXX</Type>
			<AccountType>XXX</AccountType>
			<Tags>
				<Tag>XXX</Tag>
			</Tags>
			<PointsDelta precision="XXX">XXX</PointsDelta>
			<PointsBalance precision="XXX">XXX</PointsBalance>
			<TransactionDate>XXX</TransactionDate>
			<OrderId>XXX</OrderId>
		</AccountMovement>
	</AccountMovements>
</ShowTimeAnalytics>

Callback Post Fields:

• DataSupplierID: Unique identifier for your account, same as passed in post message
• MessageSequence: Unique sequence number for message, same as passed in post message
• ID attribute: Unique identifier for account movement, same as passed in post message
• Status: Processing result flag - ok/error
• Error: If the status flag is "error", list of warning messages during processing

Message Structure - XML:

<?xml version="1.0" encoding="UTF-8"?>
<ShowTimeAnalyticsResponse dataSupplierId="XXX" messageSequence="XXX">
    <Responses>
        <Response id="XXX" siteId="XXX" entity="AccountMovement">
            <Status>XXX</Status>
            <Warnings>
            	<Warning>XXX</Warning>
            </Warnings>
            <Errors>
            	<Error>XXX</Error>
            </Errors>
        </Response>
    </Responses>
</ShowTimeAnalyticsResponse>