Customers

Customers Management

This section provides a comprehensive guide to managing the customers in our system. You will find various options for retrieving, filtering, and setting Customer information, each tailored to different requirements.

Customer Retrieval

Get All Customers

  • Endpoint: /get_customers
  • Description: This endpoint is designed to retrieve the complete list of customers available in our database, providing a comprehensive overview of all customers without applying any filters.
  • Usage Notes:
    • Pagination: To manage data effectively, this endpoint supports fetching up to 50 customers at a time.
    • Parameters:
    • offset - Specify the starting point of the row from which to begin fetching customers.
    • limit - Control the number of customers returned in a single request. The maximum limit is 50, but you can opt for a smaller number based on your needs.
    • Method: This functionality can be utilized by including payload or parameters in your POST request to manage the offset and limit.

These features are particularly useful for handling large datasets and for applications requiring batch processing of Customer information.



Customer Login

For fetching specific customer data used for LOGIN forms using email and password from your applications you may use /get_customer endpoint to make a call which is usually used for customer Login attempts.



Filters

IN / NOT_IN Filter

  • Endpoint: /get_customers
  • Description: Use this endpoint to filter customers based on specific Customer IDs. It supports both inclusion (IN) and exclusion (NOT_IN) filters for Customer IDs.
  • Parameters:
    • IN - Specify the Customer IDs to find specific customers.
    • NOT_IN - Specify the Customer IDs to find all customers excluded these IDs.
    • You can use these parameters as arrays or single integers for more flexibility.

email Filter

  • Endpoint: /get_customers
  • Description: Use this filter using this endpoint to filter customers based on specific Customers filtered by email adderss.
  • Parameters:
    • email - Specify the email address to find specific customer.

customer_id Filter

  • Endpoint: /get_customers
  • Description: Use this filter using this endpoint to filter customers based on specific Customers filtered by customer_id.
  • Parameters:
    • customer_id - Specify the Customer ID to find specific customer.
    • You can use these parameters as arrays or single integers for more flexibility.



Setting Customer Information

Set Customer / Update Customer Information

  • Endpoint: set_customer_update_profile setter API call is a public API call to update a single customer data.
  • Full Documentation and Practical Examples: Update Profile

Set Customer / Register New Customer

  • Endpoint: set_customer_register setter API call is a public API call to Register a new customer.
  • Full Documentation and Practical Examples: Registration

Set Customer / Reset Customer Password

  • Endpoint: set_customer_password_reset_request setter API call is a public API call to reset a single customer password by sending customer a password recovery using email.
  • Full Documentation and Practical Examples: Password Reset Request

Set Customer / Delete Customer Information

  • Endpoint: set_customer_delete_account setter API call is a public API call to delete a single customer data.
  • Full Documentation and Practical Examples: Delete Customer Data



For further assistance or API integration support, please refer to our API Support or contact our technical support team.