Sold item event payloads include shiftLocation, the station where the agent had an open shift when the item was purchased or updated. For the full object description (including timeZone, externalId, and other fields), see Shift location (shiftLocation) in the structure documentation.

When the sold item has reached a paid state, payloads also include paidAt as a UTC BzDate ({ value, offset }). This value is set once on first paid transition and preserved on later updates/retries.

Events

Payload example

{
  "id": "string",
  "attemptId": "string",
  "livemode": "boolean",
  "created": "int",
  "event": "string",
  "data": {
    "accountId": "string",
    "taxes": [
      {
        "value": "int",
        "name": "string",
        "calculated": "int",
        "displayCalculated": "int",
        "isBorder": "boolean",
        "province": "string"
      }
    ],
    "taxable": "boolean",
    "taxExempted": "boolean",
    "shiftNumber": "string",
    "shiftId": "string",
    "quantity": "string",
    "email": "string",
    "agentId": "string",
    "firstName": "string",
    "productId": "string",
    "refundId": "string",
    "amountEditable": "boolean",
    "soldItemNumber": "string",
    "name": "string",
    "fields": {
      "notes": {
        "required": "boolean",
        "predefaultValue": "string",
        "order": "int",
        "displayName": "string",
        "display": "boolean"
      },
      "description": {
        "required": "boolean",
        "predefaultValue": "string",
        "order": "int",
        "displayName": "string",
        "display": "boolean"
      }
    },
    "paymentRates": [
      {
        "displayTotal": "int",
        "itemDisplayId": "string",
        "itemId": "string",
        "rates": [
          {
            "ratio": "string",
            "type": "string"
          }
        ],
        "total": "int"
      }
    ],
    "ratios": [
      {
        "displayTotal": "int",
        "total": "int",
        "type": "string"
      }
    ],
    "revenueOperatingCompany": {
      "id": "string",
      "name": "string"
    },
    "extra": {
      "phone": "string"
    },
    "status": "string",
    "paidAt": {
      "value": "string",
      "offset": "int"
    },
    "createdBy": "string",
    "createdByUserEmail": "string",
    "customerNumber": "string",
    "_id": "string",
    "rounding": {
      "policy": "string",
      "decimals": "string"
    },
    "userComments": "string",
    "transactionId": "string",
    "agencyId": "string",
    "type": "string",
    "price": "int",
    "pricesIncludeTaxes": "boolean",
    "displayPrice": "int",
    "productName": "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"
    },
    "sourceItemId": "string",
    "fees": [
      {
        "valueType": "string",
        "value": "int",
        "taxable": "boolean",
        "subTotal": "int",
        "rules": {
          "item": "int"
        },
        "products": {
          "paid_in": "int"
        },
        "name": "string",
        "isRefundable": "boolean",
        "internalId": "string",
        "calculated": "int"
      }
    ],
    "trxId": "string",
    "userId": "string",
    "lastName": "string",
    "total": "int",
    "displayTotal": "int",
    "agencyName": "string",
    "associatedTicketInformation": {
      "time": "string",
      "scheduleId": "string",
      "routeId": "string",
      "date": {}
    },
    "ticketId": "string",
    "refId": "string",
    "totalForTransaction": "int",
    "deleted": "boolean",
    "createdAt": {
      "value": "string",
      "offset": "int"
    },
    "updatedAt": {
      "value": "string",
      "offset": "int"
    },
    "qrCodeString": "string",
    "displayCurrency": {
      "buy": "float",
      "sell": "float",
      "isocode": "string",
      "symbol": "string"
    },
    "displayTotalForTransaction": "int",
    "displayTaxableDiscounts": "int",
    "displayNonTaxablePrice": "int",
    "displayTaxablePrice": "int",
    "displayPriceWithTaxes": "int",
    "displayTotalTaxes": "int",
    "displayDiscounts": "int",
    "discounts": "int",
    "taxableDiscounts": "int",
    "totalTaxes": "int",
    "taxablePrice": "int",
    "taxablePercentage": "int",
    "nonTaxablePrice": "int",
    "priceWithTaxes": "int",
    "subDomain": "string",
    "segmentName": "string",
    "ticketNumber": "string",
    "cancellable": "boolean",
    "changeable": "boolean",
    "printable": "boolean",
    "productFamily": "string",
    "passengerId": "string",
    "productType": "string",
    "sku": "string",
    "fulfiller": "string",
    "fulfillmentStatus": "string",
    "fulfillmentLogs": []
  }
}