Fares

Events

Action Event name
create a new fare type fare.created
update an existing fare type fare.updated

Payload example created

{
  "attemptId": "069c78d2-afe1-4c77-aaf5-4638719394da",
  "created": 1623793046,
  "data": {
    "requiresCompanion": false,
    "disabled": true,
    "createdAt": {
      "offset": 0,
      "value": "2021-06-15T21:37:23.632Z"
    },
    "saveExtraUserInput": false,
    "userId": "55fc2f318791db6e1a0000b6",
    "requiresExtraUserInput": false,
    "extraUserInputMask": "",
    "extraUserInputValidation": "",
    "adjustmentType": "%",
    "dimensions": {},
    "minimumValue": 0,
    "indexableName": "tt2",
    "requiresDimensions": false,
    "ord": 0,
    "displayOnCombo": false,
    "hideInSalesUI": false,
    "channels": {
      "agency-backoffice": {
        "available": true,
        "maxQty": 50
      },
      "agency-websales": {
        "adjustment": 0,
        "available": true
      },
      "backoffice": {
        "available": true,
        "maxQty": 50
      },
      "websales": {
        "adjustment": 0,
        "adjustmentType": "%",
        "available": true,
        "maxQty": 50
      }
    },
    "adjustmentsOverrides": [],
    "requiresCompanionErrMsg": "",
    "isBaseFare": false,
    "minQtyForVolumeDiscount": 0,
    "_id": "60c91d933d6d6319a44fff7c",
    "productTypes": [
      "reservation"
    ],
    "createdBy": "55fc2f318791db6e1a0000b6",
    "volumeDiscountType": "%",
    "updatedBy": "55fc2f318791db6e1a0000b6",
    "name": "tt2",
    "defaultQty": 0,
    "volumeDiscount": 0,
    "deleted": false,
    "updatedAt": {
      "offset": 0,
      "value": "2021-06-15T21:37:23.632Z"
    },
    "adjustment": 0,
    "isCompanion": false,
    "description": "",
    "lexiconKeys": {
      "description": "fares-description-52a377ec430c7d4e220001fc-47943fae-1834-478b-bcac-a71972529517",
      "extraUserInputHint": "fares-extraUserInputHint-52a377ec430c7d4e220001fc-1bde77d8-f37d-4d80-beb4-c55405505a52",
      "extraUserInputLabel": "fares-extraUserInputLabel-52a377ec430c7d4e220001fc-18dd3c13-c498-4ed3-9ea5-e09838ed0acc",
      "name": "fares-name-52a377ec430c7d4e220001fc-cd6a15e0-7411-41aa-b78d-eabb052c7841",
      "requiresCompanionErrMsg": "fares-requiresCompanionErrMsg-52a377ec430c7d4e220001fc-0904b595-bb1f-4252-90f7-94855cbb10d8"
    },
    "accountId": "52a377ec430c7d4e220001fc",
    "productIds": [
      "52a377ec430c7d4e220001fe"
    ]
  },
  "event": "fare.created",
  "id": "592184ca-1993-4d20-b0e3-af4b59c6c19a",
  "livemode": true
}

Payload example updated

{
  "attemptId": "2b7fd02c-57a5-45cb-b32f-a936ec61fbf5",
  "created": 1623793063,
  "data": {
    "requiresCompanion": false,
    "disabled": true,
    "createdAt": {
      "offset": 0,
      "value": "2021-06-15T21:37:23.632Z"
    },
    "saveExtraUserInput": false,
    "userId": "55fc2f318791db6e1a0000b6",
    "requiresExtraUserInput": false,
    "extraUserInputMask": "",
    "extraUserInputValidation": "",
    "adjustmentType": "%",
    "dimensions": {},
    "minimumValue": 0,
    "indexableName": "tt3",
    "requiresDimensions": false,
    "ord": 0,
    "displayOnCombo": false,
    "hideInSalesUI": false,
    "channels": {
      "agency-backoffice": {
        "available": true,
        "maxQty": 50
      },
      "agency-websales": {
        "adjustment": 0,
        "available": true
      },
      "backoffice": {
        "available": true,
        "maxQty": 50
      },
      "websales": {
        "adjustment": 0,
        "adjustmentType": "%",
        "available": true,
        "maxQty": 50
      }
    },
    "adjustmentsOverrides": [],
    "requiresCompanionErrMsg": "",
    "isBaseFare": false,
    "minQtyForVolumeDiscount": 0,
    "_id": "60c91d933d6d6319a44fff7c",
    "productTypes": [
      "reservation"
    ],
    "createdBy": "55fc2f318791db6e1a0000b6",
    "volumeDiscountType": "%",
    "updatedBy": "55fc2f318791db6e1a0000b6",
    "name": "tt3",
    "defaultQty": 0,
    "volumeDiscount": 0,
    "deleted": false,
    "updatedAt": {
      "offset": 0,
      "value": "2021-06-15T21:37:35.623Z"
    },
    "adjustment": 0,
    "isCompanion": false,
    "description": "",
    "lexiconKeys": {
      "description": "fares-description-52a377ec430c7d4e220001fc-47943fae-1834-478b-bcac-a71972529517",
      "extraUserInputHint": "fares-extraUserInputHint-52a377ec430c7d4e220001fc-1bde77d8-f37d-4d80-beb4-c55405505a52",
      "extraUserInputLabel": "fares-extraUserInputLabel-52a377ec430c7d4e220001fc-18dd3c13-c498-4ed3-9ea5-e09838ed0acc",
      "name": "fares-name-52a377ec430c7d4e220001fc-cd6a15e0-7411-41aa-b78d-eabb052c7841",
      "requiresCompanionErrMsg": "fares-requiresCompanionErrMsg-52a377ec430c7d4e220001fc-0904b595-bb1f-4252-90f7-94855cbb10d8"
    },
    "accountId": "52a377ec430c7d4e220001fc",
    "productIds": [
      "52a377ec430c7d4e220001fe"
    ]
  },
  "event": "fare.updated",
  "id": "ea539eec-8510-4ade-9dae-6804a5a3b638",
  "livemode": true
}