Price profile

BI

The PriceProfile event is triggered when when a price profile is created or modified. The current status of the price profile is sent.

JSON schema & example

Example payload

{
  "metadata": {
    "traceId": "7d0168f2-1c75-4996-b83d-c55a53488726",
    "occurredAt": "2024-12-24T12:04:06Z",
    "version": "1.0",
    "tenant": "14450",
    "type": "PRICE_PROFILE"
  },
  "id": "57169",
  "number": 1,
  "name": "Standard Price Profile",
  "categories": [
    {
      "id": "800816",
      "number": 1,
      "name": "1. Kategorie",
      "priceProfileId": "57169",
      "printLabels": {
        "document": "First category",
        "AK3": "Premier category"
      }
    },
    {
      "id": "800817",
      "number": 2,
      "name": "2. Kategorie",
      "printLabels": {}
    }
  ],
  "priceLevels": [
    {
      "id": "1998772",
      "number": 1,
      "name": "Ermäßigung",
      "printLabels": {
        "AP1": "Discount price level"
      },
      "tags": [
        "RESALE",
        "DISCOUNT"
      ]
    },
    {
      "id": "1998773",
      "number": 2,
      "name": "Vollpreis",
      "printLabels": {},
      "tags": []
    }
  ]
}

JSON Schema

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "traceId": {
          "type": "string",
          "format": "uuid",
          "description": "Unique identifier to trace the event."
        },
        "occurredAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the event occurred."
        },
        "version": {
          "type": "string",
          "pattern": "^[0-9]+\\.[0-9]+$",
          "description": "The version of the event schema, following semantic versioning."
        },
        "tenant": {
          "type": "string",
          "description": "Identifier of the tenant or organization associated with the event."
        },
        "type": {
          "type": "string",
          "enum": [
            "CUSTOMER",
            "CUSTOMER_DELETED",
            "EVENT",
            "EVENT_CAPACITY",
            "ORDER",
            "CANCELLATION",
            "CREDIT_NOTE",
            "RESERVATION",
            "RESERVATION_CANCELLATION",
            "PRICE_PROFILE",
            "PRICE_PROFILE_DELETED",
            "TICKET"
          ],
          "description": "Identifier of the tenant or organization associated with the event."
        }
      },
      "required": [
        "traceId",
        "occurredAt",
        "version",
        "tenant",
        "type"
      ],
      "additionalProperties": false
    },
    "id": {
      "type": "string",
      "description": "ID of the price profile."
    },
    "number": {
      "type": "number",
      "description": "Unique number of the price profile per organizer."
    },
    "name": {
      "type": "string",
      "description": "Name of the price profile."
    },
    "categories": {
      "type": "array",
      "description": "List of categories belonging to this price profile.",
      "items": {
        "$ref": "#/definitions/Category"
      }
    },
    "priceLevels": {
      "type": "array",
      "description": "List of price levels belonging to this price profile.",
      "items": {
        "$ref": "#/definitions/PriceLevel"
      }
    }
  },
  "required": [
    "id",
    "number",
    "name",
    "categories",
    "priceLevels"
  ],
  "definitions": {
    "Category": {
      "type": "object",
      "description": "Represents a price category.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The globally unique ID of the price category."
        },
        "number": {
          "type": "number",
          "description": "Number of the price category. It's unique per price profile."
        },
        "name": {
          "type": "string",
          "description": "Name of the price category."
        },
        "printLabels": {
          "type": "object",
          "description": "List of the print labels that are assigned to the price category."
        }
      }
    },
    "PriceLevel": {
      "type": "object",
      "description": "Represents a price level.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The globally unique ID of the price level."
        },
        "number": {
          "type": "number",
          "description": "Number of the price level. It's unique per price profile."
        },
        "name": {
          "type": "string",
          "description": "Name of the price level."
        },
        "tags": {
          "$ref": "#/definitions/PriceLevelTags"
        },
        "printLabels": {
          "type": "object",
          "description": "List of the print labels that are assigned to the price level."
        }
      }
    },
    "PriceLevelTags": {
      "type": "array",
      "description": "List of tags assigned to the price level.",
      "items": {
        "type": "string",
        "description": "A tag for the price level, e.g., 'RESALE'."
      }
    }
  }
}