Returns the customer for the passed fidelity card barcode.

The web service response will be composed of:

success: Boolean that indicated wether the request was successful or not

customer: Customer Data

NB: if you want the user's barcode in a non-standard field, this field must be specified in pkFieldName

Actors

API Client: The system or user initiating the request.

4ws.trade: The backend system that processes the request.

Fields

Customer data

Field	Description	Type
address1	Main address	String
birthday	Birthday in format with format "yyyy-MM-dd HH:mm:ss", using GMT time	String
branchCode	Branch code	Number
cardBarcode	customer barcode	String
cardSubtypeDescription	Default	String
cardSubtype	Card subtype	String
circuit	Card circuit	String
city	City	String
companyId	Company id	String
country	Country (ISO2)	String
earnedPoints	Earned points	Number
email	Customer email	String
entityCode	Entity code	Number
flgFreeServices	Y/N if user has free services	String
foreignPerson	Y/N if is a foreign person	String
isCompany	Y/N if is a company	String
province	Province (ISO2)	String
siteId	Site id	Number
subjectCode	Subject KeepIT code	String
subjectDenomination	Sujbect denomination	String
subjectName	Subject name	String
subjectSubtype	Subject subtype	String
subjectSurname	Subject name	String
subjectTypeDescription	Subject type description	String
identifier	ex of customer id field specify in pkFieldName	String

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Get Customer - success response

application/json

Body

Example

{
    "success": true,
    "customer": {
        "address1": "Via Pascoli",
        "birthday": "1969-05-06 00:00:00",
        "branchCode": 1150,
        "cardBarcode": "0000004385257",
        "cardSubtypeDescription": "Default",
        "cardSubtype": "1",
        "circuit": "SINESY",
        "city": "Bologna",
        "companyId": "SVILU",
        "country": "IT",
        "earnedPoints": 0,
        "email": "andrea.camilla@sinesy.it",
        "entityCode": 500,
        "flgFreeServices": "N",
        "foreignPerson": "F",
        "isCompany": "N",
        "province": "BO",
        "siteId": 500,
        "subjectCode": "143434",
        "subjectDenomination": "Camilla Andrea",
        "subjectName": "Andrea",
        "subjectSubtype": "4",
        "subjectSurname": "Camilla",
        "subjectTypeDescription": "Fidelity",
        "identifier": "0000004385257"
    }
}

🟢200Get Customer - fail customer not found

🟠422Unique constraint error

Get Customer

Actors#

Fields#

Customer data#

Request

Request Code Samples

Responses

Actors

Fields

Customer data