Customers

In the Babel Licensing Service API, the 'Customers' section is dedicated to managing the details and interactions of customers who use or are affected by the licensing system. This segment is pivotal in maintaining a comprehensive database of customer information, which is crucial for a variety of business operations including licensing, support, and relationship management.

Get

Roles: Administrator, Sales

This method is used to obtain detailed information about customers registered in the system. It enables the querying and viewing of customer profiles, including contact details, licensing information, and historical interactions. This functionality is crucial for providing customer support, understanding customer needs, and maintaining accurate records for communication and relationship management.

Retrieves a list of customers.

GET/v1/customers

Query parameters

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

customersarray of Customer (object)

customers is the list of customers.

totalCustomersCountinteger (int32)

total_customers_count is the total number of customers.

Request

JavaScriptCurl

const response = await fetch('/v1/customers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "customers": [
    {
      "title": "text",
      "firstName": "text",
      "lastName": "text",
      "company": "text",
      "code": "text",
      "vatCode": "text",
      "invoiceCode": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "address": "text",
      "address1": "text",
      "address2": "text",
      "postalCode": "text",
      "region": "text",
      "city": "text",
      "country": "text",
      "countryCode": "text",
      "mapCoordinates": "text",
      "mapZoomLevel": 0,
      "email": "text",
      "phone": "text",
      "mobile": "text",
      "fax": "text",
      "website": "text",
      "notes": "text",
      "isReseller": false,
      "image": "text",
      "contacts": [
        {
          "title": "text",
          "firstName": "text",
          "lastName": "text",
          "email": "text",
          "phone": "text",
          "mobile": "text",
          "fax": "text",
          "details": "text"
        }
      ]
    }
  ]
}

Post

Roles: Administrator, Sales

The POST method facilitates the addition of new customer records to the system. It is used to input new customer data, such as personal details, contact information, and relevant notes. This method is essential for onboarding new customers, ensuring their information is captured accurately and efficiently for future interactions and licensing management.

Inserts a new customer.

POST/v1/customers

Body

application/json

customerCustomer (object)

Defines a customer in Babel Licensing.

Response

200default

Success

Body

application/json

customerIdinteger (int32)

customer_id is the ID of the inserted customer.

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

customerCodestring

customer_code is the code of the inserted customer.

Request

JavaScriptCurl

const response = await fetch('/v1/customers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "customerCode": "text"
}

Put

Roles: Administrator, Sales

Utilizing the PUT method allows for the modification of existing customer records. It is employed to update details such as contact information, customer preferences, or any other relevant data points. This method is vital for keeping customer information current and relevant, reflecting any changes in their status or preferences.

Updates an existing customer.

PUT/v1/customers

Body

application/json

customerCustomer (object)

Defines a customer in Babel Licensing.

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

Request

JavaScriptCurl

const response = await fetch('/v1/customers', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}

Delete

Roles: Administrator, Sales

The DELETE method is used to remove customer records from the system. This may be necessary in cases where a customer relationship ends, or data needs to be purged for compliance reasons. It is an important aspect of data management, ensuring that the system reflects the current and active customer base and complies with data retention policies.

Deletes a customer by ID.

DELETE/v1/customers/{customerId}

Path parameters

customerId*integer (int32)

customer_id is the ID of the customer to delete.

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

Request

JavaScriptCurl

const response = await fetch('/v1/customers/{customerId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}