Account and profile

Manage customer account details.

Retrieving a customer profile

get

Retrieves a customer profile.

Note: The request needs to be authorized with a customer access token or an anonymous access token.

---

Required scopes

No specific scopes are required.

Authorizations

CustomerAccessTokenAnonymousAccessToken

AuthorizationstringRequired

To generate a customer access token, go to the 'Logging in a customer' endpoint.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Query parameters

expandstringOptional

List of additional attributes to be retrieved, separated by commas. Possible value to be passed in this parameter is addresses. To expand mixins, use the * character: mixin:*.

Example: addresses,mixin:*

Responses

200

OK

application/json

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

get

/customer/{tenant}/me

HTTPcURLJavaScriptPython

GET /customer/{tenant}/me HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "title": "MR",
  "firstName": "John",
  "lastName": "Doe",
  "contactPhone": "123456789",
  "company": "Emporix",
  "preferredLanguage": "en_US",
  "preferredCurrency": "USD",
  "preferredSite": "default",
  "metadata": {
    "mixins": {},
    "version": 2
  },
  "mixins": {},
  "customerNumber": "13869000",
  "id": "13869000",
  "accounts": [
    {
      "id": "[email protected]"
    }
  ],
  "contactEmail": "[email protected]",
  "businessModel": "B2B",
  "b2b": {
    "companyRegistrationId": "123-456-789",
    "legalEntities": [
      {
        "id": "D165356",
        "name": "Emporix",
        "contactAssignmentId": "D436432"
      }
    ]
  }
}

Deleting a customer profile

delete

Deletes a customer profile and the account associated with it.

Note: The request needs to be authorized with a customer access token.

---

Required scopes

No specific scopes are required.

Authorizations

CustomerAccessToken

AuthorizationstringRequired

To generate a customer access token, go to the 'Logging in a customer' endpoint.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Query parameters

tokenstringOptional

Token received by the customer through email.

Responses

202

Customer profile deletion confirmation was successfully accepted

204

Customer profile deletion request was successful

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

delete

/customer/{tenant}/me

HTTPcURLJavaScriptPython

DELETE /customer/{tenant}/me HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Updating a customer profile

patch

Updates a customer profile.

Note: The request needs to be authorized with a customer access token.

---

Required scopes

No specific scopes are required.

Authorizations

CustomerAccessToken

AuthorizationstringRequired

To generate a customer access token, go to the 'Logging in a customer' endpoint.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Body

application/jsonapplication/merge-patch+json

Responses

200

OK

No content

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

patch

/customer/{tenant}/me

HTTPcURLJavaScriptPython

PATCH /customer/{tenant}/me HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 283

{
  "title": "MR",
  "firstName": "John",
  "lastName": "Doe",
  "contactEmail": "[email protected]",
  "contactPhone": "123456789",
  "company": "Emporix",
  "preferredLanguage": "en_US",
  "preferredCurrency": "EUR",
  "preferredSite": "main",
  "b2b": {
    "companyRegistrationId": "123-456-789"
  },
  "metadata": {
    "version": 1
  }
}

application/jsonapplication/merge-patch+json

No content

Assigning an account to a customer profile

post

Assigns a customer account to the customer profile.

Required scopes

This endpoint requires the following scopes:

Authorizations

CustomerAccessToken

AuthorizationstringRequired

To generate a customer access token, go to the 'Logging in a customer' endpoint.

Path parameters

tenantstringRequired

Body

application/json

emailstring · min: 1Required

Customer email address.

passwordstring · min: 6Required

Customer account password.

Responses

201

Created

application/json

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

409Error

application/json

post

/customer/{tenant}/me/accounts/internal

HTTPcURLJavaScriptPython

POST /customer/{tenant}/me/accounts/internal HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "email": "[email protected]",
  "password": "password123"
}

{
  "id": "13869000"
}