Customers

Customers represent individual people that interact and spend money within your organization. Besides storing common contact information, customer objects are also responsible for tracking spending behaviors, metadata, and permissions.

Endpoints

The Customer Object

Attributes

_id

Required

string

The ID of the customer

primaryEmail

Required

string email

The primary email of the customer

Optional Attributes

Collapse all

company

Optional

string

The company of the customer

name

Optional

string

The name of the customer collected from first name and last name

prename

Optional

string

The first name of the customer

lastname

Optional

string

The lastname of the customer

image

Optional

Deprecated

string

The image of the customer

number

Optional

number float

The number of the customer. Need to be unique and incrementing

phone

Optional

string

The phone number of the customer

location

Optional

object

The location of the customer

Optional Attributes

Collapse all

location.street

Optional

string

The street of the location

location.line2

Optional

string

The additional address fields of the location

location.postal

Optional

string

The postal of the location

location.city

Optional

string

The city of the location

location.locale

Optional

Deprecated

string

The locale of the location

location.state

Optional

string

The state of the location

location.center

Optional

array<number>

The center of the location

location.country

Optional

string

An ISO-3166-1 Alpha 2 country code of the location

transactions

Optional

array<string>

An array of transactions of the customer

sellerId

Optional

string

The ID of the seller of the customer

notes

Optional

string

Notes of the customer

extraFields

Optional

object

Extra fields of the customer

tags

Optional

array<string>

An array of tags

blocked

Optional

boolean

Whether the customer is blocked

verified

Optional

boolean

Whether the customer is verified

_account

Optional

object

Account specific information about the customer

Optional Attributes

Collapse all

_account.verificationToken

Optional

string

The verification token will be sent to the customer via email within a verification link, which can be used to verify the account of the customer

_account.passwordResetToken

Optional

string

The password reset token will be sent within a password reset link via email, which can be used by the customer to reset its password

_account.limitations

Optional

object

Account specific limitations of the customer

Optional Attributes

Collapse all

_account.limitations.nextVerificationMailRequest

Optional

string date-time

An ISO timestamp indicating when the next verification mail request can be sent

_account.loginType

Optional

string

The login type of the customer.

passwordidentityprovider

Create Customer

Payload

primaryEmail

Required

string email

The primary email of the customer

Optional Attributes

Collapse all

company

Optional

string

The company of the customer

name

Optional

string

The name of the customer collected from first name and last name

prename

Optional

string

The first name of the customer

lastname

Optional

string

The lastname of the customer

number

Optional

number float

The number of the customer. Need to be unique and incrementing

image

Optional

Deprecated

string

The image of the customer

location

Optional

object

The location of the customer

Optional Attributes

Collapse all

location.street

Optional

string

The street of the location

location.line2

Optional

string

The additional address fields of the location

location.postal

Optional

string

The postal of the location

location.city

Optional

string

The city of the location

location.locale

Optional

Deprecated

string

The locale of the location

location.state

Optional

string

The state of the location

location.center

Optional

array<number>

The center of the location

location.country

Optional

string

An ISO-3166-1 Alpha 2 country code of the location

notes

Optional

string

Notes of the customer

extraFields

Optional

object

Extra fields of the customer

tags

Optional

array<string>

An array of tags

verified

Optional

boolean

Whether the customer is verified

Get Customer

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "company": "string",
  "name": "string",
  "prename": "string",
  "lastname": "string",
  "image": "string",
  "primaryEmail": "[email protected]",
  "number": 10.5,
  "phone": "string",
  "location": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "locale": "string",
    "state": "string",
    "center": [
      10.5
    ],
    "country": "string"
  },
  "transactions": [
    "string"
  ],
  "sellerId": "string",
  "notes": "string",
  "extraFields": {},
  "tags": [
    "string"
  ],
  "blocked": true,
  "verified": true,
  "_account": {
    "verificationToken": "string",
    "passwordResetToken": "string",
    "limitations": {
      "nextVerificationMailRequest": "2030-01-23T23:00:00.123Z"
    },
    "loginType": "password"
  },
  "meta": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Update Customer

Payload

Optional Attributes

Collapse all

company

Optional

string

The company of the customer

name

Optional

string

The name of the customer collected from first name and last name

image

Optional

Deprecated

string

The image of the customer

transactions

Optional

array<string>

An array of transactions of the customer

location

Optional

object

The location of the customer

Optional Attributes

Collapse all

location.street

Optional

string

The street of the location

location.line2

Optional

string

The additional address fields of the location

location.postal

Optional

string

The postal of the location

location.city

Optional

string

The city of the location

location.locale

Optional

Deprecated

string

The locale of the location

location.state

Optional

string

The state of the location

location.center

Optional

array<number>

The center of the location

location.country

Optional

string

An ISO-3166-1 Alpha 2 country code of the location

tags

Optional

array<string>

An array of tags

extraFields

Optional

object

Extra fields of the customer

verified

Optional

boolean

Whether the customer is verified

Delete Customer

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "company": "string",
  "name": "string",
  "prename": "string",
  "lastname": "string",
  "image": "string",
  "primaryEmail": "[email protected]",
  "number": 10.5,
  "phone": "string",
  "location": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "locale": "string",
    "state": "string",
    "center": [
      10.5
    ],
    "country": "string"
  },
  "transactions": [
    "string"
  ],
  "sellerId": "string",
  "notes": "string",
  "extraFields": {},
  "tags": [
    "string"
  ],
  "blocked": true,
  "verified": true,
  "_account": {
    "verificationToken": "string",
    "passwordResetToken": "string",
    "limitations": {
      "nextVerificationMailRequest": "2030-01-23T23:00:00.123Z"
    },
    "loginType": "password"
  },
  "meta": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get all Customers

Query

name

Optional

string

The name of the customer collected from prename and lastname

Optional

string

The email of the customer

company

Optional

string

The company of the customer

tags

Optional

string

Tags of the customer

updatedAt

Optional

object

Range of dates indicating when the customer was last updated in ISO format.

Optional Attributes

Collapse all

updatedAt.$gt

Optional

string date-time

value is greater than

updatedAt.$gte

Optional

string date-time

value is greater than or equal

updatedAt.$lt

Optional

string date-time

value is less than

updatedAt.$lte

Optional

string date-time

value is less than or equal

updatedAt.$eq

Optional

string date-time

value is equal

updatedAt.$ne

Optional

string date-time

value is not equal

top

Optional

integer

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

integer

The number of objects to skip for the requested result

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "docs": [
    {
      "_id": "string",
      "company": "string",
      "name": "string",
      "prename": "string",
      "lastname": "string",
      "image": "string",
      "primaryEmail": "[email protected]",
      "number": 10.5,
      "phone": "string",
      "location": {
        "street": "string",
        "line2": "string",
        "postal": "string",
        "city": "string",
        "locale": "string",
        "state": "string",
        "center": [
          10.5
        ],
        "country": "string"
      },
      "transactions": [
        "string"
      ],
      "sellerId": "string",
      "notes": "string",
      "extraFields": {},
      "tags": [
        "string"
      ],
      "blocked": true,
      "verified": true,
      "_account": {
        "verificationToken": "string",
        "passwordResetToken": "string",
        "limitations": {
          "nextVerificationMailRequest": "2030-01-23T23:00:00.123Z"
        },
        "loginType": "password"
      },
      "meta": {},
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z"
    }
  ],
  "total": 1
}

Get all Customer tags

Query

No supported query parameters

200

401

Unauthorized

Was this section helpful?

Yes No

[
  "string"
]

Create account for Customer

Payload

Optional Attributes

Collapse all

suppressEmail

Optional

boolean

Whether the email of the customer should be suppressed in the account of the customer

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "suppressEmail": true
}

{
  "_id": "string",
  "company": "string",
  "name": "string",
  "prename": "string",
  "lastname": "string",
  "image": "string",
  "primaryEmail": "[email protected]",
  "number": 10.5,
  "phone": "string",
  "location": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "locale": "string",
    "state": "string",
    "center": [
      10.5
    ],
    "country": "string"
  },
  "transactions": [
    "string"
  ],
  "sellerId": "string",
  "notes": "string",
  "extraFields": {},
  "tags": [
    "string"
  ],
  "blocked": true,
  "verified": true,
  "_account": {
    "verificationToken": "string",
    "passwordResetToken": "string",
    "limitations": {
      "nextVerificationMailRequest": "2030-01-23T23:00:00.123Z"
    },
    "loginType": "password"
  },
  "meta": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get current customer

Query

No supported query parameters

200

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "company": "string",
  "name": "string",
  "prename": "string",
  "lastname": "string",
  "image": "string",
  "primaryEmail": "[email protected]",
  "number": 10.5,
  "phone": "string",
  "location": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "locale": "string",
    "state": "string",
    "center": [
      10.5
    ],
    "country": "string"
  },
  "transactions": [
    "string"
  ],
  "sellerId": "string",
  "notes": "string",
  "extraFields": {},
  "tags": [
    "string"
  ],
  "blocked": true,
  "verified": true,
  "_account": {
    "verificationToken": "string",
    "passwordResetToken": "string",
    "limitations": {
      "nextVerificationMailRequest": "2030-01-23T23:00:00.123Z"
    },
    "loginType": "password"
  },
  "meta": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get transactions of customer

Query

locale

Optional

string

subscriptionId

Optional

string

checkoutId

Optional

string

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "transactions": [
    {
      "tid": "string",
      "secret": "string",
      "tickets": [],
      "products": [],
      "realPrice": 10.5,
      "currency": "EUR",
      "vouchers": [
        "string"
      ],
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "_id": "string",
            "code": "string",
            "redeemedAmount": 10.5
          }
        ]
      },
      "email": "[email protected]",
      "status": "NEW",
      "company": "string",
      "name": "string",
      "prename": "string",
      "lastname": "string",
      "street": "string",
      "line2": "string",
      "postal": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "createdAt": "2030-01-23T23:00:00.123Z",
      "eventId": "string",
      "paymentStatus": "AWAITING",
      "outerCharge": 10.5,
      "paymentMethod": "adyen",
      "preferredLanguage": "de",
      "extraFields": {},
      "underShop": "string",
      "paymentInfoMethod": "string",
      "coupons": [
        "string"
      ]
    }
  ],
  "events": [
    {
      "_id": "string",
      "sellerId": "string",
      "meta": {},
      "eventType": "SINGLE",
      "name": "string",
      "start": "2030-01-23T23:00:00.123Z",
      "end": "2030-01-23T23:00:00.123Z",
      "url": "string",
      "slogan": "string",
      "description": "string",
      "image": "string",
      "pageStyle": "white",
      "styleOptions": {
        "headerStyle": "default",
        "hideLocationMap": false,
        "hideLocationAddress": false,
        "categoryAlignment": 0,
        "showAvailabilityIndicator": false,
        "availabilityIndicatorThresholds": [
          0.3,
          0.7
        ]
      },
      "video": {
        "youtubeID": "string"
      },
      "gallery": [
        {
          "_id": "string",
          "title": "string",
          "description": "string",
          "copyright": "string",
          "index": 10.5,
          "image": "string"
        }
      ],
      "checkinInformation": {
        "_id": "string",
        "checkinStarts": "2030-01-23T23:00:00.123Z"
      },
      "accentColor": "#006DCC",
      "tickets": [
        {
          "_id": "string",
          "name": "string",
          "description": "string",
          "image": "string",
          "color": "string",
          "price": 10.5,
          "amount": 10.5,
          "active": true,
          "posActive": true,
          "categoryRef": "string",
          "ignoredForStartingPrice": true,
          "conditionalAvailability": true,
          "ticketBackground": "string",
          "rules": [
            {
              "_id": "string",
              "ticketGroup": "string",
              "min": 10.5,
              "max": 10.5
            }
          ],
          "requiresPersonalization": true,
          "requiresPersonalizationMode": "ENABLED",
          "requiresExtraFields": true,
          "requiresExtraFieldsMode": "ENABLED",
          "repersonalizationFee": 10.5,
          "sortingKey": 10.5,
          "enableHardTicketOption": true,
          "forceHardTicketOption": true,
          "maxAmountPerOrder": 10.5,
          "minAmountPerOrder": 10.5,
          "minAmountPerOrderRule": 10.5,
          "taxRate": 10.5,
          "styleOptions": {},
          "priceCategoryId": "string",
          "entryPermissions": [],
          "ignoreForMaxAmounts": true,
          "expirationSettings": {},
          "barcodePrefix": "string",
          "salesStart": {
            "target": "string",
            "unit": "hours",
            "offset": 1
          },
          "salesEnd": {
            "target": "string",
            "unit": "hours",
            "offset": 1
          },
          "transferSettings": {},
          "scanSettings": {
            "feedback": "highlight"
          },
          "meta": {}
        }
      ],
      "ticketExtraFields": [
        {
          "_id": "string",
          "name": "string",
          "description": "string",
          "required": true,
          "deleted": true,
          "type": "text",
          "options": [
            "string"
          ],
          "onlyForCertainTicketTypes": true,
          "allowedTicketTypes": [],
          "printable": true,
          "conditions": [
            {
              "_id": "string",
              "baseSlug": "string",
              "value": [],
              "operator": "equals"
            }
          ]
        }
      ],
      "ticketDesign": {
        "_id": "string",
        "useCustomDesign": true,
        "customDesignURL": "string",
        "footerDesignURL": "string",
        "disclaimer": "string",
        "infoColor": "string",
        "showTimeRange": true,
        "hideDates": true,
        "hideTimes": true
      },
      "extraFields": [
        {
          "_id": "string",
          "name": "string",
          "description": "string",
          "required": true,
          "deleted": true,
          "type": "text",
          "options": [
            "string"
          ],
          "onlyForCertainTicketTypes": true,
          "allowedTicketTypes": [],
          "printable": true,
          "conditions": [
            {
              "_id": "string",
              "baseSlug": "string",
              "value": [],
              "operator": "equals"
            }
          ]
        }
      ],
      "showCountdown": true,
      "showOtherEvents": true,
      "hardTicketSettings": {
        "_id": "string",
        "enabled": true,
        "fulfillmentType": "self",
        "printingMethod": "preprinted",
        "hardTicketOuterCharge": 10.5,
        "hardTicketInnerCharge": 10.5,
        "hardTicketPreviewURL": "string",
        "promotionName": "string",
        "promotionText": "string",
        "requiredDays": 1
      },
      "tracking": {
        "facebookPixel": {
          "active": true,
          "pixelId": "string"
        },
        "tagging": {
          "enabled": true,
          "tags": [
            "string"
          ]
        }
      },
      "seoSettings": {
        "_id": "string",
        "tags": [
          "string"
        ],
        "noIndex": true,
        "title": "string",
        "description": "string"
      },
      "soldOutFallback": {
        "_id": "string",
        "soldOutFallbackType": "default",
        "soldOutFallbackLink": "string"
      },
      "reservationSettings": {
        "option": "noReservations"
      },
      "customTextConfig": {
        "_id": "string",
        "buyTicketsCTA": "string"
      },
      "timezone": "string",
      "ticketSettings": {},
      "rootId": "string",
      "customSettings": {},
      "upsellSettings": {
        "_id": "string",
        "active": true,
        "productStream": "string",
        "headerImage": "string",
        "crossSells": {
          "eventIds": [
            "string"
          ]
        }
      },
      "category": "string",
      "subCategory": "string",
      "showTimeRangeInTicket": true,
      "showTimeRangeInListing": true,
      "showStartDate": true,
      "showStartTime": true,
      "showEndDate": true,
      "showEndTime": true,
      "accountSettings": {
        "_id": "string",
        "enforceAccounts": true,
        "enforceAuthentication": "DISABLED"
      },
      "location": {
        "locationName": "string",
        "locationStreet": "string",
        "locationCity": "string",
        "locationPostal": "string",
        "locationCountry": "string",
        "geoCode": {
          "_id": "string",
          "lat": 10.5,
          "lng": 10.5
        }
      }
    }
  ]
}

Get undershops of customer

Query

eventId

Required

string

The event ID to get the undershops of the customer

locale

Optional

string

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "shops": [
    {
      "_id": "string",
      "name": "string"
    }
  ]
}