Exporting Balance Updates

Method Description

Invoked with a POST request. Operation name is set up via Maestra framework. Details of method invocation can be found here.

POST https://api.maestra.io/v3/operations/sync?endpointId={unique ID of site/mobile app/etc.}&operation={operation name}

Accept: application/xml
Content-Type: application/xml
Authorization: SecretKey {Secret Key, check with the manager it it’s mandatory}

<operation>
  <sinceDateTimeUtc>{Timestamp of the earliest action (UTC, YYYY-MM-DD hh:mm)}</sinceDateTimeUtc>
  <tillDateTimeUtc>{Timestamp of the latest action (UTC, YYYY-MM-DD hh:mm)}</tillDateTimeUtc>
  <segment>
    <ids>
      <externalId>{Segment external ID}</externalId>
    </ids>
  </segment>
</operation>

Response

<result>
  <status>Success</status>
  <customerActions>
    <customerAction>
      <ids>
        <customerActionId>{Maestra id}</customerActionId>
        <transactionId>{external action ID}</transactionId>
      </ids>
      <actionTemplate>
        <systemName>{internal action template name at Maestra}</systemName>
        <name>{action template name at Maestra}</name>
      </actionTemplate>
      <dateTimeUtc>{date of customer action}</dateTimeUtc>
      <pointOfContact>
        <ids>
          <externalId>{external point of contact ID}</externalId>
        </ids>
      </pointOfContact>
      <customer>
        <ids>
          <customerId>{Maestra id}</customerId>
          <webSiteId>{customer ID}</webSiteId>
        </ids>
      </customer>
      <customerBalanceChanges>
        <customerBalanceChange>
          <changeAmount>{balance update amount}</changeAmount>
          <expirationDateTimeUtc>{bonus points expiry date}</expirationDateTimeUtc>
          <balanceChangeKind>
            <systemName>{balance update type}</systemName>
          </balanceChangeKind>
        </customerBalanceChange>
      </customerBalanceChanges>
    </customerAction>
  </customerActions>
</result>

Balance Update Types

Business meaningUpdate type
Bonus for retail orderRetailOrderBonus
Paying for retail order with bonus pointsRetailOrderPayment
OtherCustom