post
https://{host}/v2/customers/bulk
Lets you batch register customers, or associate a customer with company or hierarchy. This API registers parent and child customers (if not registered), and associates the customer with hierarchy code, company role, parent and child customers.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Batch support is for normal customer registration
Example request
curl -L 'https://eu.api.capillarytech.com/v2/customers/bulk?source=INSTORE' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic bmFtYW5fZG9jOmEzY' \
-H 'Cookie: _cfuvid=nAfguio5PXQ6zxSX8B_GPBt_GJsUWoHZKt0fFxRpkvE-1773126986434-0.0.1.1-604800000' \
-d '[
{
"profiles": [
{
"firstName": "Rajesh",
"lastName": "Sharma",
"source": "INSTORE",
"identifiers": [
{
"type": "mobile",
"value": "919998872122"
}
]
}
],
"loyaltyInfo": {
"loyaltyType": "loyalty"
},
"associationDetails": {
"hierarchyCode": "SIL0101",
"roleCode": "CEO",
"fleetCompany": {
"name": "C Company",
"hierarchyDefinitionCode": "SIL0101",
"externalId": "dc_123"
}
}
},
{
"profiles": [
{
"firstName": "Priya",
"lastName": "Verma",
"source": "INSTORE",
"identifiers": [
{
"type": "mobile",
"value": "919998872123"
}
]
}
],
"loyaltyInfo": {
"loyaltyType": "loyalty"
},
"associationDetails": {
"hierarchyCode": "SIL0101",
"roleCode": "Zonal_Manager",
"fleetCompany": {
"name": "C Company",
"hierarchyDefinitionCode": "SIL0101",
"externalId": "dc_123"
}
}
},
{
"profiles": [
{
"firstName": "Amit",
"lastName": "Patel",
"source": "INSTORE",
"identifiers": [
{
"type": "mobile",
"value": "919998872124"
}
]
}
],
"loyaltyInfo": {
"loyaltyType": "loyalty"
},
"associationDetails": {
"hierarchyCode": "SIL0101",
"roleCode": "City_Manager",
"fleetCompany": {
"name": "C Company",
"hierarchyDefinitionCode": "SIL0101",
"externalId": "dc_123"
}
}
},
{
"profiles": [
{
"firstName": "Sunita",
"lastName": "Reddy",
"source": "INSTORE",
"identifiers": [
{
"type": "mobile",
"value": "919998872125"
}
]
}
],
"loyaltyInfo": {
"loyaltyType": "loyalty"
},
"associationDetails": {
"hierarchyCode": "SIL0101",
"roleCode": "Associate",
"fleetCompany": {
"name": "C Company",
"hierarchyDefinitionCode": "SIL0101",
"externalId": "dc_123"
}
}
},
{
"profiles": [
{
"firstName": "Vikram",
"lastName": "Singh",
"source": "INSTORE",
"identifiers": [
{
"type": "mobile",
"value": "919998872126"
}
]
}
],
"loyaltyInfo": {
"loyaltyType": "loyalty"
},
"associationDetails": {
"hierarchyCode": "SIL0101",
"roleCode": "Drivers",
"fleetCompany": {
"name": "C Company",
"hierarchyDefinitionCode": "SIL0101",
"externalId": "dc_123"
}
}
}
]'Request Body Parameters
| Parameter | Type | Description |
|---|---|---|
| loyaltyType | enum | Loyalty status of the customer. |
| profiles | obj | Meta information of the customer. |
| identifiers | obj | Identifiers of the customer in type and value. |
| type | enum | Type of the customer identifier. . |
| value | string | Value of the specified identifier. |
| seriesId | int | Card series ID (for card series generated in Capillary). . |
| seriesCode | string | Unique card series code (for external card series). |
| statusLabel | string | User defined card status. |
| lastViewedDate | Date | Date when the customer recently opened the app. |
| hierarchyCode | string | Unique code of the hierarchy to associate with the customer/company. All configurations set for the hierarchy will be applicable to the customer/company. |
| roleCode | string | Pre defined role code - Role of the customer in the hierarchy. |
| parentCustomer | obj | User profile of the parent customer. |
| fleetCompany | obj | Details of the company the customer is associated with. |
| childCustomers | obj | Profiles of the child customers. |
| externalId | string | External ID of the company. |
| profiles | obj | Details of the customer to associate. |
| Firstname | string | First name of the customer. |
| Lastname | string | Last name of the customer. |
| identifiers | obj | Identifiers of the customer in type and value. |
| type | enum | Type of the customer identifier. |
| value | string | Value of the specified identifier. |
| commChannels | obj | Available communication channels of the customer. |
| createDate | date-time | Time and date of registration in YYYY-MM-DDTHH:MM:SS+HH:MM format. |
| associatedWith | string | The TILL code associated with the customer registration. |
| extendedFields | obj | Customer level extended field details of the customer in key:value pairs. |
| fields | obj | Custom field details of customers in key-value pairs. |
Response parameter
| Parameter | Description |
|---|---|
| id | Unique ID of the entity. |
| profiles | Array of profiles associated with the entity. |
| firstName | First name of the profile. |
| lastName | Last name of the profile. |
| attribution | Information about the profile's creation and modification. |
| fields | Additional fields associated with the profile. |
| identifiers | Array of identifiers associated with the profile. |
| commChannels | Communication channels (like email, mobile) associated with the profile. |
| source | Source of the profile. |
| userId | User ID associated with the profile. |
| accountId | Account ID associated with the profile. |
| conflictingProfileList | List of profiles that have conflicts. |
| autoUpdateTime | Time of automatic update of the profile. |
| loyaltyInfo | Loyalty information associated with the entity. |
| segments | Segments associated with the entity. |
| referralCode | Referral code for the entity. |
| associationDetails | Details about the association of the entity. |
| extendedFields | Extended fields associated with the entity. |
| warnings | Array of warnings related to the entity. |
| childEntities | Array of child entities associated with the main entity. |
| childCount | Total count of child entities. |
| childFailureCount | Count of child entities that failed. |
| childSuccessCount | Count of child entities that succeeded. |