Get Customers Export
Deprecated
POST
/api
Last modified:2024-08-21 09:23:38
POST call, passing a JSON body as specified below.| Field | Description | Type | Mandatory |
|---|---|---|---|
| languageId | Language for the article localized strings ( IT or EN, defaults to user languare or IT if omitted) | String | |
| completeExtraction | If set to T, extracts ALL the customers (even the ones before the last request) | Char(1) |
completeExtraction is not T the web service will retrieve all the modified customers since the last request (in this case, the parameter system must be set in the body request, representing the system the recalls will be retrieved from).| Field | Description | Type | Mandatory |
|---|---|---|---|
| start | Pagination offset parameter. (only if completeExtraction is T)The WS will retrieve the elements starting from the one with the index specified here. For example, if 'start' is set to 23, the customers from the 23rd to the 43rd will be returned. | Number |
| Field | Description | Type | Mandatory |
|---|---|---|---|
| subjectCode | Code of the customer | Varchar(250) | |
| subjectName | Name of the customer | Varchar(250) | |
| subjectSurname | Surname of the customer | Varchar(250) | |
| subjectCompanyName | Company name related to the customer | Varchar(250) | |
| address1 | Address of the customer | Varchar(100) | |
| address2 | Address of the customer | Varchar(100) | |
| zipCode | Zip code of the address | Varchar(20) | |
| municipality | Municipality | Varchar(250) | |
| city | City of the customer | Varchar(250) | |
| state | State of the address (used for USA states) | Varchar(250) | |
| country | Code of country of the address | Varchar(3) | |
| language | Language of the customer | Varchar(250) | |
| currency | Currency of the customer | Char(3) | |
| sex | Sex of the customer | Char(1) | |
| birthday | Date of birth | Date | |
| fiscalCode | Fiscal code | Varchar(50) | |
| companyVatCode | Vat code of the company | Varchar(50) | |
| idCard | Number of the identity card | Varchar(100) | |
| passport | Number of the passport | Varchar(100) | |
| cardBarcode | Code of the card | Varchar(250) | |
| earnedPoints | Points earned related to the card | Decimal(10,0) | |
| entityCode | Code of store that issued the fidelity | Varchar(250) | |
Email address of the customer | Varchar(250) | ||
| phone | Phone Number of the customer | Varchar(250) | |
| createDate | Create date subject | Datetime | |
| lastUpdate | Update date subject | Datetime |
| Field | Description | Type | Mandatory |
|---|---|---|---|
| privacyType | Code of privacy type | Varchar(250) | |
| privacyTypeDescription | Description of privacy type | Varchar(250) | |
| privacyConsent | Privacy concession for data treatment | Char(1) | |
| consentDate | Date of consent for data treatment | Datetime | |
| recessDate | Date of recess for data treatment | Datetime |
{
"success": true,
"valueObjectList": [
{
"subject": {
"subjectCode": "100020",
"subjectName": "BRACCIO",
"subjectSurname": "VANNI",
"subjectCompanyName": null,
"address1": "PIAZZA MARTIRI, 8 -",
"address2": null,
"zipCode": "06028",
"municipality": null,
"city": "SIGILLO",
"state": null,
"country": "IT",
"language": "IT",
"currency": null,
"sex": null,
"birthday": "1944-05-07 00:00:00",
"fiscalCode": "VANBRA19A0209355",
"companyVatCode": null,
"idCard": null,
"passport": null,
"createDate": "2022-06-23 14:32:54",
"lastUpdate": null,
"cardBarcode": "8000000314215",
"earnedPoints": 0,
"entityCode": "9",
"entityDescription": "Negozio 9",
"email": "_Braccio.Vanni@nomail.com",
"phone": "0985104416"
},
"privacy": [
{
"privacyType": "TRATTA_DATI",
"privacyTypeDescription": "Consenso al trattamento dei dati",
"privacyConsent": "T",
"consentDate": null,
"recessDate": null
},
{
"privacyType": "MARKETING",
"privacyTypeDescription": "Consenso a ricevere comunicazioni marketing",
"privacyConsent": "F",
"consentDate": null,
"recessDate": null
},
{
"privacyType": "PROFILAZIONE",
"privacyTypeDescription": "Consenso alla profilazione",
"privacyConsent": "T",
"consentDate": null,
"recessDate": null
}
]
}]
}
Request
Query Params
Header Params
Body Params application/json
Request Code Samples
Responses
Modified at 2024-08-21 09:23:38