Check customers

Request

This is the list of fields that can be passed in the request body:

Field	Description	Type	Mandatory
subjectsRecords	Array of attribues objects	See below for the the object structure	✓
returnMappings	A "T" / "F" string that indicates wether to: "T": return the customer code for each system it is defined on; "F": do NOT return the external mappings for the customer	String (defaults to "F")

By default, returnMappings is set to "F" to prefer faster responses. It should be set to "T" only if you really need to know the customer code for external systems (e.g. mail marketing system, Shop system etc)

subjectRecords structure

subjectsRecords: [{
    subjects:{
        customerCode: "13245",
        system: "DW",
        subjectName: "Alessandro",
        subjectName2: "Gino",
        subjectSurname: "Covris",
        subjectCompanyName: "Sinesy",
        subjectType: "FIDELITY",
        subjectSubtype: "4",
        extSubCompanyName: "",
        subjectDenomination: "",
        lawNature: "",
        address1: "via Pordenone 1",
        address2: "",
        zipCode: "33170",
        municipality: "",
        city: "Pordenone",
        province: "PN",
        region: "FVG",
        state: "",
        country: "IT",
        latitude: "",
        longitude: "",
        language: "",
        currency: "EUR",
        note: "",
        sex: "M",
        birthday: "",
        birthPlace: "",
        countryBirth: "IT",
        fiscalCode: "",
        companyVatCode: "",
        idCard: "",
        passport: "",
        maritialStatus: "",
        occupation: "",
        title: "",
        origin: "",
        functionCode: "",
        saleChannel: "",
        organizationLevel: "",
        territory: "",
        purchaseInclination: "",
        employeesNumber: 60,
        employeesDate: "",
        attractionLevel: "",
        identificationLevel: "",
        subjectBlockReason: "",
        oldSubjectCode: "",
        poBox: "",
        payment: "",
        discount: 0,
        decisionLevel: "",
        isCompany: "F", 
        macAddress: "",
        ecommerceLastVisit: "2016-03-24",
        ecommerceLastLogin: "2016-03-24",
        ecommerceGuestRegister: "",
        discountAuthorization: "",
        childNumber: 2,
        foreignPerson: "F",
        maximumValue: 1000
    },
    contacts: [{
        contactType: "PHONE",
        value: "1234567890"
    },{
        contactType: "EMAIL",
        value: "test.test@test.it"
    }],
    privacy: [{
        privacyType: "",
        privacyConsent: "",
        consentDate: "",
        recessDate: ""
    }],
    cards: [{
        cardType: "FIDELITY",
        cardSubtype: "GEN",
        circuit: "SINESY",
        card: "1357924711",
        cardBarcode: "1357924711",
        issueDate: "2016-03-24",
        active: "",
        activationDate: "2016-03-24",
        expirationDate: "2017-03-24",
        cardMaster: "",
        cardFather: "",
        cardMother: "",
        entityCode: "",
        earnedPoints: 0
    }],
    subjectDestinations: [{
        destinationType: "RES",
        address1: "Via Roma",
        address2: "",
        zipCode: "33170",
        municipality: "",
        city: "Pordenone",
        province: "PN",
        region: "",
        state: "",
        country: "IT",
        fax: "",
        mobile: "",
        email: "",
        note: "Note",
        phone: ""
    }]
}]

Not all sections and properties must be set, it depends on what rules uniquely identify a customer in your infrastructure.
Contact support to know which should be set in your case.

Response

The web service response will be composed of:

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

code : HTTP Code for the response

200 means the request was correctly processed

204 means a duplicate record was found in KeepIT, and that no insertion was performed

206 means that not all records were inserted or processed

400 means that the request body is invalid or contains syntax errors

500 means a server error has happened

message: response message for the request (e.g. "Insertion successful" or "Missing required parameter")

foundObjects: Array that contains the found customers

progId: code of the duplicate customer in KeepIT

customerCode: code of the external system that inserted the duplicate customer

emails: list of emails associated with the duplicate customer

Response example

{
    success: true,
    code: 200,
    message: "Check duplicati riuscito con successo.",
    errorObjects: “”,
    foundObjects: [
        {
            progId: 2000,
            customerCode: "456",
            emails: [
                "xxx@xxx.it",
                "yyy@yyy.it"
            ]
        },
        {
            progId: 1000,
            customerCode: "123",
            emails: [
                "xxx@xxx.it"
            ]
        }
    ]
}

Notes

There's a limit of 100 calls for this API.

Request

Query Params

Header Params

Body Params application/json

Example

{
  "subjectsRecords": [
    {
      "subjects":{
        "customerCode" : "13245",
        "system" : "DW",
        "subjectName" : "Alessandro",
        "subjectName2" : "Gino",
        "subjectSurname" : "Covris",
        "subjectCompanyName" : "Sinesy",
        "subjectType" : "FIDELITY",
        "subjectSubtype" : "4",
        "extSubCompanyName" : "",
        "subjectDenomination" : "",
        "lawNature" : "",
        "address1" : "via Pordenone 1",
        "address2" : "",
        "zipCode" : "33170",
        "municipality" : "",
        "city" : "Pordenone",
        "province" : "PN",
        "region" : "FVG",
        "state" : "",
        "country" : "IT",
        "latitude" : "",
        "longitude" : "",
        "language" : "",
        "currency" : "EUR",
        "note" : "",
        "sex" : "M",
        "birthday" : "",
        "birthPlace" : "",
        "countryBirth" : "IT",
        "fiscalCode" : "",
        "companyVatCode" : "",
        "idCard" : "",
        "passport" : "",
        "maritialStatus" : "",
        "occupation" : "",
        "title" : "",
        "origin" : "",
        "functionCode" : "",
        "saleChannel" : "",
        "organizationLevel" : "",
        "territory" : "",
        "purchaseInclination" : "",
        "employeesNumber" : 60,
        "employeesDate" : "",
        "attractionLevel" : "",
        "identificationLevel" : "",
        "subjectBlockReason" : "",
        "oldSubjectCode" : "",
        "poBox" : "",
        "payment" : "",
        "discount" : 0,
        "decisionLevel" : "",
        "isCompany" : "F", 
        "macAddress" : "",
        "ecommerceLastVisit" : "2016-03-24",
        "ecommerceLastLogin" : "2016-03-24",
        "ecommerceGuestRegister" : "",
        "discountAuthorization" : "",
        "childNumber" : 2,
        "foreignPerson" : "F",
        "maximumValue" : 1000
      },
      
      "contacts" : [
        {
          "contactType" : "PHONE",
          "value" : "1234567890"
        },
        {
          "contactType" : "EMAIL",
          "value" : "test.test@test.it"
        }
      ] ,

      "privacy" : [
        {
          "privacyType" : "",
          "privacyConsent" : "",
          "consentDate" : "",
          "recessDate" : ""
        }
      ],

      "cards": [
        {
          "cardType" : "FIDELITY",
          "cardSubtype" : "GEN",
          "circuit" : "SINESY",
          "card" : "1357924711",
          "cardBarcode" : "1357924711",
          "issueDate" : "2016-03-24",
          "active" : "",
          "activationDate" : "2016-03-24",
          "expirationDate" : "2017-03-24",
          "cardMaster" : "",
          "cardFather" : "",
          "cardMother" : "",
          "entityCode" : "",
          "earnedPoints" : 0
        }
      ],

      "subjectDestinations": [
        {
          "destinationType" : "RES",
          "address1" : "via Tolmiech",
          "address2" : "",
          "zipCode" : "33170",
          "municipality" : "",
          "city" : "Pordenone",
          "province" : "PN",
          "region" : "",
          "state" : "",
          "country" : "IT",
          "fax" : "",
          "mobile" : "",
          "email" : "",
          "note" : "Test note",
          "phone" : ""
        }
      ]
    }
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Check Clienti - Success 1 duplicato

text/html

Body

Example

{"success":true,"code":200,"message":"Check duplicati riuscito con successo.","errorObjects":"","foundObjects":[{"progId":1234,"customerCode":"99887773","emails":["email@email.com"]}]}

🟢200Check Clienti - Success nessun duplicatio

🟠422Unique constraint error

Request#

Response#

Request

Request Code Samples

Responses

Request

Response