Show Schema

Properties for members are defined as part of the loyalty club they belong to.

To describe member properties we use JSON Schema definition.
Properties of each member must conform to the defined schema.

We support JSON schema Draft V4 with format extension for date (YYYY-MM-DD).

Response Body

Key	Description	Type
identifiers	Fields that are set to identify member	string[]
consents	Definition of available consents. Versions are now `''`.	JSON Object
languages	Languages set up in loyalty club	string[]
default_language	Default language used in loyalty club and also used for mappings to Api v2	string
version	Version of schema, currently the newest is `v2`	string
products	Properties scoping and ordering by product name, default one is `default`	object
required	Required properties for member	integer (timestamp)
properties	Properties describing member	object

Example

When successful, returns JSON structured like this:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "identifiers": ["email"],
  "consents": {
    "consent1": { "version": "", "required": true, "show_in_profile": true, "show_at_registration": true },
    "consent2": { "version": "", "required": true, "show_in_profile": true, "show_at_registration": true }
  },
  "languages": ["en", "no"],
  "default_language": "no",
  "version": "v2",
  "properties": {
    "email": {
      "type": "string",
      "format": "email"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "birthday": {
      "type": "string",
      "format": "date"
    },
    "interests": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "bikes_and_cars",
          "sportwear"
        ]
      }
    }
  },
  "required": [
    "first_name",
    "last_name",
    "birthday"
  ]
}

Request

Path Params

loyalty_club_slug

string

required

Example:

infinity-mall

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Response Body#

Example#

Request

Request samples

Responses

Response Body

Example