Quandoo · Schema

MerchantCustomerData

MerchantCustomerData schema from Quandoo Public Partner API

RestaurantReservationsBookingAvailabilityMerchantsMarketplace

Properties

Name Type Description
id string The id of the customer.
customerRef string Customer reference
marketingFlags array Marketing flags for customer.
title string Title of the customer.
firstName string First name of the customer.
lastName string Last name of the customer.
email string Email of the customer.
phoneNumber string Fixed line phone number of the customer.
mobileNumber string Mobile phone number of the customer.
locale string Locale of the customer.
links array The links related to this entity.
subscriptions array The newsletter subscriptions, e.g. QUANDOO, MERCHANT.
statistics object
updatedAt string The date the review created on. Format: yyyy-MM-ddTHH:mm:ssZ
View JSON Schema on GitHub

JSON Schema

quandoo-public-partner-api-merchant-customer-data-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "MerchantCustomerData",
  "description": "MerchantCustomerData schema from Quandoo Public Partner API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/quandoo/refs/heads/main/json-schema/quandoo-public-partner-api-merchant-customer-data-schema.json",
  "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": {
        "type": "object",
        "properties": {
          "marketingSettingType": {
            "type": "string",
            "enum": [
              "SMART_OFFERS_AND_DEALS",
              "PROMO_CODES",
              "RESTAURANT_RECOMMENDATIONS",
              "NEWSLETTERS"
            ]
          },
          "marketingSettingStatus": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "INACTIVE"
            ]
          }
        }
      }
    },
    "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": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "format": "url"
          },
          "method": {
            "type": "string"
          },
          "rel": {
            "type": "string",
            "enum": [
              "DETAILS",
              "WIDGET",
              "WIDGET_DETAILS",
              "GET_MERCHANT",
              "PARENT",
              "SELF",
              "SETTINGS",
              "AVAILABILITY_DAYS",
              "AVAILABILITIES",
              "CREATE_RESERVATION",
              "GET_RESERVATION",
              "UPDATE_RESERVATION",
              "GET_CUSTOMER_RESERVATION",
              "GET_REVIEW",
              "PORTAL_PREORDER_FORM",
              "RESERVATION_CHECKOUT_PAGE",
              "CREDIT_CARD_DETAILS_PAGE",
              "CUSTOMER_EDIT_RESERVATION"
            ]
          }
        }
      }
    },
    "subscriptions": {
      "type": "array",
      "description": "The newsletter subscriptions, e.g. QUANDOO, MERCHANT.",
      "uniqueItems": true,
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "enum": [
              "QUANDOO",
              "MERCHANT"
            ]
          }
        }
      }
    },
    "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"
        },
        "reservationCancelledCount": {
          "type": "integer",
          "format": "int32",
          "description": "The number of reservations made by the customer that were cancelled before taking place"
        },
        "reservationNoShowCount": {
          "type": "integer",
          "format": "int32",
          "description": "The number of reservations made by the customer that he did not show up"
        }
      }
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The date the review created on. Format: yyyy-MM-ddTHH:mm:ssZ"
    }
  }
}