Quandoo · Schema

CustomerDataList

CustomerDataList schema from Quandoo Public Partner API

RestaurantReservationsBookingAvailabilityMerchantsMarketplace

Properties

Name Type Description
result array
offset integer
limit integer
View JSON Schema on GitHub

JSON Schema

quandoo-public-partner-api-customer-data-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CustomerDataList",
  "description": "CustomerDataList schema from Quandoo Public Partner API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/quandoo/refs/heads/main/json-schema/quandoo-public-partner-api-customer-data-list-schema.json",
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "customerRef",
          "email",
          "firstName",
          "id",
          "lastName",
          "links",
          "locale",
          "marketingFlags",
          "mobileNumber",
          "phoneNumber",
          "statistics",
          "subscriptions",
          "title"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The id of the customer."
          },
          "customerRef": {
            "type": "string",
            "description": "Customer reference "
          },
          "marketingFlags": {
            "type": "array",
            "description": "Marketing flags for customer.",
            "items": {
              "$ref": "#/components/schemas/MarketingSettingDto"
            }
          },
          "title": {
            "type": "string",
            "description": "Title of the customer."
          },
          "firstName": {
            "type": "string",
            "description": "First name of the customer."
          },
          "lastName": {
            "type": "string",
            "description": "Last name of the customer."
          },
          "email": {
            "type": "string",
            "description": "Email of the customer."
          },
          "phoneNumber": {
            "type": "string",
            "description": "Fixed line phone number of the customer."
          },
          "mobileNumber": {
            "type": "string",
            "description": "Mobile phone number of the customer."
          },
          "locale": {
            "type": "string",
            "description": "Locale of the customer."
          },
          "links": {
            "type": "array",
            "description": "The links related to this entity.",
            "items": {
              "$ref": "#/components/schemas/LinkRelationDto"
            }
          },
          "subscriptions": {
            "type": "array",
            "description": "The newsletter subscriptions, e.g. QUANDOO, MERCHANT.",
            "uniqueItems": true,
            "items": {
              "$ref": "#/components/schemas/MerchantSubscription"
            }
          },
          "statistics": {
            "type": "object",
            "required": [
              "reservationCancelledCount",
              "reservationNoShowCount",
              "reservationSuccessfulCount"
            ],
            "properties": {
              "reservationSuccessfulCount": {
                "type": "integer",
                "format": "int32",
                "description": "The number of reservations made by the customer that were actually seated",
                "example": 4
              },
              "reservationCancelledCount": {
                "type": "integer",
                "format": "int32",
                "description": "The number of reservations made by the customer that were cancelled before taking place",
                "example": 4
              },
              "reservationNoShowCount": {
                "type": "integer",
                "format": "int32",
                "description": "The number of reservations made by the customer that he did not show up",
                "example": 4
              }
            }
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date the review created on. Format: yyyy-MM-ddTHH:mm:ssZ"
          }
        }
      }
    },
    "offset": {
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    }
  }
}