Locate customer.

post https://virtserver.swaggerhub.com/customers/v1/customer/search

Search for a customer. This search matches the exact terms in the request and returns a single result if a match is located.
Response Code | Fault Code | Fault | Suggested User Message
------------- | ---------- | ----- | ----------------------
tbc | tbc | New API created for 1.5 | tbc

Body Params

The search details used to locate the customer.

customerId

uuid

The unique customer identifier.

externalUniqueIdentifier

string

length ≤ 200

The unique external customer identifier.

string

length ≤ 200

The customers email address.

referAFriendCode

string

length ≤ 8

The customers Refer a Friend code.

Headers

tenantId

string

The tenant ID for which the operation is being carried out. This will be automatically generated during the authentication process.

userId

string

The ID of a user who is performing the operation. This will be automatically generated during the authentication process.

source

string

The source of whether records are updated by HMAC or a USER. This will be automatically generated during the authentication process. For customers accessing the service the source will be set to CUSTOMER.

Responses

Response body

object

customerId

uuid

The unique customer identifier.

externalUniqueIdentifier

string

length ≤ 200

The unique external customer identifier.

username

string

length ≤ 200

The customers username.

csn

string

A unique numeric customer identintifier

string

length ≤ 200

The customers email address.

title

string

length ≤ 20

The customers title.

firstName

string

length ≤ 50

The customers forename.

lastName

string

length ≤ 50

The customers surname.

dateOfBirth

date

The customers date of birth, format must be [YYYY-MM-DD].

phone

string

length ≤ 20

The customers phone number.

mobile

string

length ≤ 20

The customers mobile phone number.

addresses

array of objects

length ≤ 1

The list of addresses associated with the customer.

addresses

object

number

The unique identifier for the address

building

string

length ≤ 50

Building of the address.

line1

string

length ≤ 50

First line of the address.

line2

string

length ≤ 50

Second line of the address.

line3

string

length ≤ 50

Third line of the address.

city

string

length ≤ 40

The city name of the address.

area

string

length ≤ 40

The area of the address.

countryCode

string

length ≤ 3

The 3 character country code of the address.

postCode

string

length ≤ 10

The post code of the address.

addressType

string

required

Defaults to HOME

The type of the address.

HOME WORK OTHER

isDefault

boolean

Whether this is the default (main) address for the customer

auditInfo

object

Standard fields appearing on any object which has audit information

consents

object

The entities that have been provided with consent to process the customers data.

contactMethods

array of strings

contactMethods

consentPrefs

array of strings

consentPrefs

customAttributes

array of objects

The bespoke client fields associated with the customer.

customAttributes

object

name

string

required

Key name of the attribute.

value

string

required

The value of the attribute.

referAFriend

object

Details of a customers Refer a Friend code.

code

string

required

length ≤ 8

The customers Refer a Friend code.

active

boolean

required

Indicates if the customers Refer a Friend code is active.

paymentCount

number

The number of payments the customer has made

requiredPaymentCount

number

The number of payments the customer must make before the refer a friend code becomes active (unless overridden).

active

boolean

Defaults to true

True if the customer is active, false if cancelled.

vip

boolean

Indicates whether this customer is a VIP

customerType

string

Indicates the type of customer, normally Standard or VIP but additional types may be available if configured.

displayName

string

The name to be displayed for this customer

securityCode

string

defaultCurrency

string

The currency in which the customer will purchase.

gender

string

The customer's optionally declared gender

nationality

string

The customer's nationality.

auditInfo

object

Standard fields appearing on any object which has audit information

createdByUser

string

The ID of the user who originally created this.

creationDate

date-time

The date and time of creation, in ISO8601 date/time format in UTC time zone

modifiedByUser

string

The ID of the last user to modify this

modifiedDate

date-time

The date and time of last modification, in ISO8601 date/time format in UTC time zone

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://virtserver.swaggerhub.com/customers/v1/customer/search \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

200OK

400Bad request

404No customer found