Locate customer.

post https://virtserver.swaggerhub.com/customers/v1/customers/search/{page}

Search for customers.

Response Code	Fault Code	Fault	Suggested User Message
tbc	tbc	New API created for 1.5	tbc

Path Params

page

integer

required

The specific page of results to retrieve

Query Params

pagesize

integer

5 to 100

Defaults to 20

The number of results to show on a single page. Value should be between 5 and 100 inclusive. If not supplied or not valid, defaults to 20.

orderBy

string

Field and direction to order results. Supported order fields are customerId, externalUniqueIdentifier, csn, username, email, lastName.

searchId

string

Used for matching search requests and responses where clients may be making multiple concurrent requests

Body Params

The search details used to locate the customer.

transactionId

string

An ID representing a payment transaction made by the customer. May not include wildcards.

paymentMethod

object

Details of a payment method associated with the customer.

csn

string

The customer reference number (CSN). May include wildcards. If supplied for searching, at least 3 non-wildcard characters are required

username

string

The username for the customer. May include wildcards. If supplied for searching, at least 3 non-wildcard characters are required.

firstName

string

The first name of the customer. May include wildcards. If supplied for searching, at least 1 non-wildcard character is required.

lastName

string

The last name of the customer. May include wildcards. If supplied for searching, at least 1 non-wildcard character is required.

addressLine1

string

The first line of the customer's main address. May include wildcards. If supplied for searching, at least 3 non-wildcard characters are required.

postCode

string

The postcode/zip code for the customer's main address. May include wildcards. If supplied for searching, at least 3 non-wildcard characters are required.

string

The customer's email address. May include wildcards. If supplied for searching, at least 3 non-wildcard characters are required.

phone

string

The customer's phone number. May include wildcards. If supplied for searching, at least 3 non-wildcard characters are required.

externalUniqueIdentifier

string

The unique external customer identifier. May include wildcards. If supplied for searching, at least 3 non-wildcard characters are required.

vcn

string

The customer's VCN (Sky viewing card number). Numeric only, may not include wildcards.

orderId

string

The ID of an order placed by the customer. Numeric only, may not include wildcards.

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

Language


xxxxxxxxxx
11
1
curl --request POST \
2
     --url 'https://virtserver.swaggerhub.com/customers/v1/customers/search/page?pagesize=20' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "paymentMethod": {
8
    "lastFourPANCheck": false
9
  }
10
}
11
'

Choose an example:

application/json

200OK

400Bad request