Gift certificates

The Operations API exposes GET /operations/gift-certificates to list paid gift certificates for a customer (query: customer, optional page). That endpoint is read-only and does not emit any webhooks.

The events below are emitted when gift certificates are purchased or used (e.g. via Sales or other services), not by the Operations list endpoint.

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

Events

Action Event name
purchasing a gift certificate giftcertificate.created
paying with a gift certificate giftcertificate.updated

Payload example

{
  "id": "string",
  "attemptId": "string",
  "livemode": "boolean",
  "created": "int",
  "event": "string",
  "data": {
    "_id": "string",
    "userId": "string",
    "trxId": "string",
    "transactionsPaid": [],
    "transactionId": "string",
    "total": "int",
    "displayTotal": "int",
    "taxes": [
      {
        "value": "int",
        "name": "string",
        "calculated": "int"
      }
    ],
    "taxable": "boolean",
    "status": "string",
    "shiftNumber": "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"
    },
    "shiftId": "string",
    "rounding": {
      "policy": "string",
      "decimals": "string"
    },
    "price": "int",
    "displayPrice": "int",
    "lastName": "string",
    "firstName": "string",
    "fees": [],
    "email": "string",
    "description": "string",
    "customerNumber": "string",
    "certDefId": "string",
    "balance": "int",
    "agencyName": "string",
    "agencyId": "string",
    "accountId": "string",
    "deleted": "boolean",
    "createdAt": {
      "value": "string",
      "offset": "int"
    },
    "updatedAt": {
      "value": "string",
      "offset": "int"
    },
    "displayCurrency": {
      "buy": "float",
      "sell": "float",
      "isocode": "string",
      "symbol": "string"
    }
  }
}