Account and profile

Retrieving a list of customers

get

Retrieves a list of customer profiles.

Required scopes

This endpoint requires the following scopes:

• : Needed to retrieve customer profiles.
• : Needed by customer to retrieve customer profiles from the same company.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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

qstringOptional

A standard query parameter used to search for specific values.

Example: contactEmail:{email}

sortstringOptional

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.

pageNumberinteger · min: 1Optional

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.

Default: 1

pageSizeinteger · min: 1Optional

Number of customers to be retrieved per page.

Default: 60

expandstringOptional

List of additional attributes to be retrieved, separated by commas. Possible values to be passed in this parameter are:

• addresses
• accounts
• `mixin``
• The order of the attributes has no influence on the response.

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}/customers

HTTPcURLJavaScriptPython

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": "Emporix",
          "contactAssignmentId": "D436432"
        }
      ]
    }
  }
]

Creating a customer

post

Creates a new customer.

Required scopes

This endpoint requires the following scopes:

• : Needed to manage customer profiles.
• : Needed by customer to manage customer profiles from the same company.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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

sendPasswordResetNotificationsbooleanOptional

Flag indicating whether the customer should receive an email with a password reset link once their account is created.

Default: true

Body

application/json

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}/customers

HTTPcURLJavaScriptPython

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"
}

Searching for customers

post

Searches for customer profiles.

Required scopes

This endpoint requires the following scopes:

• : Needed to retrieve customer profiles.
• : Needed by customer to retrieve customer profiles from the same company.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Query parameters

qstringOptional

A standard query parameter used to search for specific values.

Example: contactEmail:{email}

sortstringOptional

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.

pageNumberinteger · min: 1Optional

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.

Default: 1

pageSizeinteger · min: 1Optional

Number of customers to be retrieved per page.

Default: 60

expandstringOptional

List of additional attributes to be retrieved, separated by commas. Possible values to be passed in this parameter are:

• addresses
• accounts
• `mixin``
• The order of the attributes has no influence on the response.

Body

application/json

qstringOptional

A standard query parameter is used to search for specific values.

See: Standard practises - Query parameter

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

post

/customer/{tenant}/customers/search

HTTPcURLJavaScriptPython

POST /customer/{tenant}/customers/search HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "q": "firstName:John"
}

[
  {
    "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": "Emporix",
          "contactAssignmentId": "D436432"
        }
      ]
    }
  }
]

Retrieving a customer profile

get

Retrieves a specified customer profile.

Required scopes

This endpoint requires the following scopes:

• : Needed to retrieve customer profiles.
• : Needed by customer to retrieve customer profiles from the same company.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Query parameters

expandstringOptional

List of additional attributes to be retrieved, separated by commas. Possible values to be passed in this parameter are:

• addresses
• accounts
• `mixin``
• The order of the attributes has no influence on the response.

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

404

Customer with the specified customerNumber doesn't exist.

application/json

get

/customer/{tenant}/customers/{customerNumber}

HTTPcURLJavaScriptPython

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": "Emporix",
        "contactAssignmentId": "D436432"
      }
    ]
  }
}

Upserting a customer profile

put

Updates a specified customer profile or creates a new one if it doesn't exist yet.

Required scopes

This endpoint requires the following scopes:

• : Needed to manage customer profiles.
• : Needed by customer to manage customer profiles from the same company.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Query parameters

sendPasswordResetNotificationsbooleanOptional

Flag indicating whether the customer should receive an email with a password reset link once their account is created.

Default: true

Body

application/jsonapplication/merge-patch+json

Responses

201

Created

application/json

204

No Content - update has been 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

409Error

application/json

put

/customer/{tenant}/customers/{customerNumber}

HTTPcURLJavaScriptPython

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]"
}

application/jsonapplication/merge-patch+json

{
  "id": "34751075"
}

Deleting a customer profile

delete

Deletes a specified customer profile and accounts associated with it.

Required scopes

This endpoint requires the following scopes:

• : Needed to manage customer profiles.
• : Needed by customer to manage customer profiles from the same company.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Responses

202

Accepted

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

404

Customer with the specified customerNumber doesn't exist.

application/json

delete

/customer/{tenant}/customers/{customerNumber}

HTTPcURLJavaScriptPython

DELETE /customer/{tenant}/customers/{customerNumber} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Updating a customer profile

patch

Updates a specified customer profile.

Required scopes

This endpoint requires the following scopes:

• : Needed to manage customer profiles.
• : Needed by customer to manage customer profiles from the same company.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

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

404

Customer with the specified customerNumber doesn't exist.

application/json

patch

/customer/{tenant}/customers/{customerNumber}

HTTPcURLJavaScriptPython

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
}

application/jsonapplication/merge-patch+json

No content

Assigning an account to an existing customer profile

post

Assigns a customer account to an existing customer profile.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Needed to retrieve customer profiles.
• : Needed by customer to retrieve customer profiles from the same company.
• : Needed to manage customer profiles.
• : Needed by customer to manage customer profiles from the same company.

Path parameters

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Query parameters

sendPasswordResetNotificationsbooleanOptional

Flag indicating whether the customer should receive an email with a password reset link once their account is created.

Default: true

Body

application/json

emailstringRequired

Customer email address.

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

404

Customer with the specified customerNumber doesn't exist.

application/json

409Error

application/json

post

/customer/{tenant}/customers/{customerNumber}/accounts/internal

HTTPcURLJavaScriptPython

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"
}