Create a Customer

SCAYLE allows you to create a customer.

Method Signature

let response = await adminApi.apis.Customers.createCustomer({shopKey: shopKey, countryCode: countryCode}, {requestBody: customer});
let customer = response.body;

Parameters

param name	type	description
`referenceKey`	`String`	External reference set by the client to integrate a third party system
`firstName`	`String`	First name of the customer
`lastName`	`String`	Last name of the customer
`gender`	`String`	Gender of the customer mentioned as per defined ENUM as "`m`", "`f`", "`d`"
`birthDate`	`String`	Date of birth of the customer in YYYY-MM-DD format
`email`	`String`	Email address of the customer
`phone`	`String`	Phone number of the customer
`publicKey`	`String`	Public reference set by the client to display to customers in account areas and transactional emails
`title`	`String`	User-defined title. It can be set to NULL otherwise
`identities`	`Array<CustomerIdentityProvider>`	An array of identity providers used by the customer

CustomerIdentityProvider

param name	type	description
`identityProviderCode`	`String`	The code of an Identity Provider
`externalUserId`	`String\|null`	The user ID provided by the Identity Provider

Create a Customer

let customer = {
     "firstName": "John",
     "lastName": "Doe",
     "title": "Prof.",
     "gender": "m",
     "birthDate": "1980-01-01",
     "email": "[email protected]",
     "phone": "0049/1234567890",
     "publicKey": "pubKey-123",
     "referenceKey": "refKey-456"
};

let response = await adminApi.apis.Customers.createCustomer({shopKey: 'ms', countryCode: 'DE'}, {requestBody: customer});
customer = response.body;

console.log(customer.id);

Create with Groups

Create a customer with groups.

let customer = {
  "firstName": "John",
  "lastName": "Doe",
  "title": "Prof.",
  "gender": "m",
  "birthDate": "1980-01-01",
  "email": "[email protected]",
  "phone": "0049/1234567890",
  "publicKey": "customer-1234",
  "groups": [
    "employee"
  ]
};

let response = await adminApi.apis.Customers.createCustomer({shopKey: 'ms', countryCode: 'DE'}, {requestBody: customer});
customer = response.body;

console.log(customer.id);

Create with Identity Providers

Create a customer with one or more identity providers.

let customer = {
     "firstName": "John",
     "lastName": "Doe",
     "title": "Prof.",
     "gender": "m",
     "birthDate": "1980-01-01",
     "email": "[email protected]",
     "phone": "0049/1234567890",
     "publicKey": "pubKey-123",
     "referenceKey": "refKey-456",
     "identities": [
          {
               "identityProviderCode": "keycloak"
          },
          {
               "identityProviderCode": "apple",
               "externalUserId": "qwerty"
          }
     ]
};

let response = await adminApi.apis.Customers.createCustomer({shopKey: 'ms', countryCode: 'DE'}, {requestBody: customer});
customer = response.body;

console.log(customer.id);