• Entity Posting API
• >>
• Customer Add/Update

Entity Posting API - Customer Add/Update

If the CustomerId does not exist, a new Customer record will be created. If it does, it will be updated.

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 Entity:

• ID attribute: Unique identifier for customer
  String
  (required)
• Name: Customer name
  String
• LastName: Customer last name
  String
• Type: Base categorisation for customer
  String
• Deleted: Deleted flag for a customer record. This should be set to true when the customer is flagged as deleted in the POS system. Anonymization of identifable information may also be required
  true/false
• Enabled: Enabled flag
  true/false
• Gender: Customer gender
  M/F
• DateOfBirth: Customer date of birth
  yyyy-mm-dd
• Telephone: Customer contact telephone number
  String
• Email: Customer contact email address
  String
• Address: Customer's home address
  • Line1: Line1 of customer's home address
    String
  • Line2: Line2 of customer's home address
    String
  • Line3: Line3 of customer's home address
    String
  • Town: Town/City of customer's home address
    String
  • Region: Region/County of customer's home address
    String
  • Country: Country of customer's home address
    String
    (required)
  • PostCode: Postcode/Zip code of customer's home address
    String
• SignedUpSiteId: Unique identifier for site that the customer signed up to
  String
• UpdateDateTime: Marketable status update date time
  ISO-8601 datetime
• CustomerAccounts:
  Details of the different accounts the customer belongs to.
  • ID attribute: Unique identifier for customer account
    String
    (required)
  • Name: Account name
    String
  • TypeId: Base categorisation for customer account
    String
  • CardId: account's card number
    String
  • Cost:
    Integer
    • Precision attribute: The number of Integer places in the Cost field
      Integer
      (required)
  • CustomerAccountActivities:
    • Id attribute:
      String
      (required)
    • StartDate:
      yyyy-mm-dd
    • EndDate:
      yyyy-mm-dd
    • SchemeId: The name of the Scheme this account belongs to
      String
    • TierId: The name of the Tier within the Scheme that this account belongs to
      String
    • IsRenewal:
      true/false
      (required)
  • CustomerAccountBenefits:
  • Id attribute:
    String
    (required)
  • Name:
    String
  • Units:
    String
  • TypeId:
    String
  • ExpiryDate:
    yyyy-mm-dd
  • Deleted:
    true/false
  • CustomerAccountPromotions:
  • Id attribute:
    String
    (required)
  • Name:
    String
  • Units:
    String
  • PromotionId:
    String
  • ExpiryDate:
    yyyy-mm-dd
• VisitsCounts:
  • Type attribute:
    String
    (required)
  • Period attribute:
    String
    (required)
• Groups:
  • Active attribute:
    true/false
    (required)
• Sites: List of sites that the customer subscribed to
  • Delete attribute: Flag to delete customer's site
    true/false
• Preferences: List of preferences that the customer subscribed to
• Channels: List of channels that the customer subscribed to
• Genres: List of genres that the customer subscribed to
• MarketingNewsLetter: Indicator whether customer agreed to receive the newsletter
  true/false
• MarketingAcceptPostal: Indicator whether customer agreed to be contacted by postal address
  true/false
• MarketingAcceptEmail: Indicator whether customer agreed to be contacted by email address
  true/false
• MarketingAcceptTelephone: Indicator whether customer agreed to be contacted by telephone
  true/false
• Language:
  ISO-639-1 Code e.g. en
• LastActiveTimestamp:
  ISO-8601 datetime
• Origin:
  String

Customer accounts are automatically created as a function of the Account Movements

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>
	<Customers>
		<Customer id="XXX">
			<Name>XXX</Name>
			<LastName>XXX</LastName>
			<Type>XXX</Type>
			<Deleted>XXX</Deleted>
			<Enabled>XXX</Enabled>
			<Gender>XXX</Gender>
			<DateOfBirth>XXX</DateOfBirth>
			<Telephone>XXX</Telephone>
			<Email>XXX</Email>
			<Address>
				<Line1>XXX</Line1>
				<Line2>XXX</Line2>
				<Line3>XXX</Line3>
				<Town>XXX</Town>
				<Region>XXX</Region>
				<Country>XXX</Country>
				<PostCode>XXX</PostCode>
			</Address>
			<SignedUpSiteId>XXX</SignedUpSiteId>
			<UpdateDateTime>XXX</UpdateDateTime>
			<CustomerAccounts>
				<CustomerAccount id="XXX">
					<Name>XXX</Name>
					<TypeId>XXX</TypeId>
					<CardId>XXX</CardId>
					<Cost precision="XXX">XXX</Cost>
					<CustomerAccountActivities>
						<CustomerAccountActivity id="XXX">
							<StartDate>XXX</StartDate>
							<EndDate>XXX</EndDate>
							<SchemeId>XXX</SchemeId>
							<TierId>XXX</TierId>
							<IsRenewal>XXX</IsRenewal>
						</CustomerAccountActivity>
					</CustomerAccountActivities>
					<CustomerAccountBenefits>
						<CustomerAccountBenefit id="XXX">
							<Name>XXX</Name>
							<TypeId>XXX</TypeId>
							<Units>XXX</Units>
							<ExpiryDate>XXX</ExpiryDate>
							<Deleted>XXX</Deleted>
						</CustomerAccountBenefit>
					</CustomerAccountBenefits>
					<CustomerAccountPromotions>
						<CustomerAccountPromotion id="XXX">
							<Name>XXX</Name>
							<TypeId>XXX</TypeId>
							<Units>XXX</Units>
							<PromotionId>XXX</PromotionId>
							<ExpiryDate>XXX</ExpiryDate>
						</CustomerAccountPromotion>
					</CustomerAccountPromotion>
				</CustomerAccount>
			</CustomerAccounts>
			<VisitsCounts>
				<VisitsCount type="XXX" period="XXX"/>XXX</VisitsCount>
			</VisitsCounts>
			<Groups>
				<Group active="XXX"/>XXX</Group>
			</Groups>
			<Sites>
				<Site delete="XXX"/>XXX</Site>
			</Sites>
			<Preferences>
				<Preference/>XXX</Preference>
			</Preferences>
			<Channels>
				<Channel/>XXX</Channel>
			</Channels>
			<Genres>
				<Genre/>XXX</Genre>
			</Genres>
			<MarketingNewsLetter>XXX</MarketingNewsLetter>
			<MarketingAcceptPostal>XXX</MarketingAcceptPostal>
			<MarketingAcceptEmail>XXX</MarketingAcceptEmail>
			<MarketingAcceptTelephone>XXX</MarketingAcceptTelephone>
			<Language>XXX</Language>
			<LastActiveTimestamp>XXX</LastActiveTimestamp>
			<Origin>XXX</Origin>
		</Customer>
	</Customers>
</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 customer, same as passed in post message
• entity attribute: Key to identify the entity type for customer
• 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" entity="Customer">
            <Status>XXX</Status>
            <Warnings>
            	<Warning>XXX</Warning>
            </Warnings>
            <Errors>
            	<Error>XXX</Error>
            </Errors>
        </Response>
    </Responses>
</ShowTimeAnalyticsResponse>