Redeemable item event payloads include shiftLocation, the station where the agent had an open shift when the item was purchased or redeemed. When the item is purchased via websales it is an empty object; when created or updated from a shift (e.g. backoffice) it contains the full location. For the full object description (including timeZone, externalId, and other fields), see Shift location (shiftLocation) in the structure documentation.

Events

Payload example

{
  "id": "string",
  "attemptId": "string",
  "livemode": "boolean",
  "created": "int",
  "event": "string",
  "data": {
    "displayItemId": "string",
    "tripType": "string",
    "productType": "string",
    "to": "string'",
    "redeemerEmail": "string",
    "redeemerLastName": "string",
    "redeemTransactionId": "string",
    "accountId": "string",
    "from": "string",
    "taxes": [
      {
        "value": "int",
        "province": "string",
        "name": "string",
        "calculated": "int"
      }
    ],
    "createdQuantity": "int",
    "bundleName": "string",
    "shiftNumber": "string",
    "language": "string",
    "discountPercentage": "int",
    "email": "string",
    "agentId": "string",
    "tripTypeDisplay": "string",
    "firstName": "string",
    "discount": "int",
    "displayDiscount": "int",
    "fromId": "string",
    "redemptionDate": {},
    "status": "string",
    "toId": "string",
    "customerNumber": "string",
    "_id": "string",
    "rounding": {
      "policy": "string",
      "decimals": "string"
    },
    "transactionId": "string",
    "agencyId": "string",
    "price": "int",
    "displayPrice": "int",
    "fare": "string",
    "shiftLocation": {
      "stationId": "string",
      "name": "string",
      "country": "string",
      "province": "string",
      "shortcode": "string",
      "latitude": "string",
      "longitude": "string",
      "costCenter": "string",
      "operatingCompanyId": "string",
      "operatingCompanyName": "string",
      "locationPurchaseLimits": {},
      "primaryCurrencyCode": "string",
      "acceptedCurrencies": [],
      "externalId": "string",
      "timeZone": "string"
    },
    "redeemerFirstName": "string",
    "expiryDate": {
      "value": "string",
      "offset": "int"
    },
    "bundleId": "string",
    "totalTaxes": "int",
    "displayTotalTaxes": "int",
    "redeemTickets": [],
    "fareName": "string",
    "trxId": "string",
    "userId": "string",
    "lastName": "string",
    "total": "int",
    "displayTotal": "int",
    "priceWithTaxes": "int",
    "displayPriceWithTaxes": "int",
    "taxablePrice": "int",
    "displayTaxablePrice": "int",
    "nonTaxablePrice": "int",
    "displayNonTaxablePrice": "int",
    "taxableDiscounts": "int",
    "displayTaxableDiscounts": "int",
    "agencyName": "string",
    "redeemTrxId": "string",
    "redeemByCustomer": "boolean",
    "deleted": "boolean",
    "createdAt": {
      "value": "string",
      "offset": "int"
    },
    "updatedAt": {
      "value": "string",
      "offset": "int"
    },
    "displayCurrency": {
      "buy": "float",
      "sell": "float",
      "isocode": "string",
      "symbol": "string"
    }
  }
}