Account and profile
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$
A standard query parameter used to search for specific values.
contactEmail:{email}
List of properties used to sort the results, separated by colons. Possible values:
{fieldName}
{fieldName}:asc
{fieldName}:desc
Note: If you want to sort the results by localized properties, the possible values are:
{fieldName}.{language}
{fieldName}.{language}:asc
{fieldName}.{language}:desc
By default, the fields are sorted in ascending order.
Page number to be retrieved. The number of the first page is 1.
Note: If the pageNumber
parameter is passed, size of the pages must be specified in the pageSize
parameter.
1
Number of customers to be retrieved per page.
60
List of additional attributes to be retrieved, separated by commas. Possible values to be passed in this parameter are:
addresses
accounts
*mixin:*
Order of the attributes has no influence on the response.
OK
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
GET /customer/{tenant}/customers HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"title": "MR",
"firstName": "John",
"lastName": "Doe",
"contactPhone": "123456789",
"company": "Emporix",
"preferredLanguage": "en_US",
"preferredCurrency": "EUR",
"preferredSite": "main",
"mixins": {},
"metadata": {
"mixins": {},
"version": 6
},
"customerNumber": "13869000",
"id": "13869000",
"contactEmail": "[email protected]",
"active": true,
"onHold": false,
"businessModel": "B2B",
"b2b": {
"companyRegistrationId": "123-456-789",
"legalEntities": [
{
"id": "D165356",
"name": "BMW",
"contactAssignmentId": "D436432"
}
]
}
}
]
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$
Flag indicating whether the customer should receive an email with a password reset link once their account is created.
true
Created
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
POST /customer/{tenant}/customers HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 258
{
"contactEmail": "[email protected]",
"title": "MR",
"firstName": "John",
"lastName": "Doe",
"contactPhone": "123456789",
"company": "Emporix",
"preferredLanguage": "en_US",
"preferredCurrency": "EUR",
"preferredSite": "main",
"b2b": {
"companyRegistrationId": "123-456-789"
}
}
{
"id": "34751075"
}
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
List of additional attributes to be retrieved, separated by commas. Possible values to be passed in this parameter are:
addresses
accounts
*mixin:*
Order of the attributes has no influence on the response.
OK
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
Customer with the specified customerNumber
doesn't exist.
GET /customer/{tenant}/customers/{customerNumber} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"title": "MR",
"firstName": "John",
"lastName": "Doe",
"contactPhone": "123456789",
"company": "Emporix",
"preferredLanguage": "en_US",
"preferredCurrency": "EUR",
"preferredSite": "main",
"metadata": {
"version": 6
},
"customerNumber": "13869000",
"id": "13869000",
"contactEmail": "[email protected]",
"active": true,
"onHold": false,
"businessModel": "B2B",
"b2b": {
"companyRegistrationId": "123-456-789",
"legalEntities": [
{
"id": "D165356",
"name": "BMW",
"contactAssignmentId": "D436432"
}
]
}
}
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
Flag indicating whether the customer should receive an email with a password reset link once their account is created.
true
Created
No Content - update has been successful
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
PUT /customer/{tenant}/customers/{customerNumber} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"contactEmail": "[email protected]"
}
{
"id": "34751075"
}
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
Accepted
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
Customer with the specified customerNumber
doesn't exist.
DELETE /customer/{tenant}/customers/{customerNumber} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
OK
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
Customer with the specified customerNumber
doesn't exist.
PATCH /customer/{tenant}/customers/{customerNumber} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"contactEmail": "[email protected]",
"active": true
}
No content
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
Flag indicating whether the customer should receive an email with a password reset link once their account is created.
true
Customer's email address.
Created
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
Customer with the specified customerNumber
doesn't exist.
POST /customer/{tenant}/customers/{customerNumber}/accounts/internal HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"email": "[email protected]"
}
{
"id": "13869000"
}
Was this helpful?