API Documentation - Customer List

Endpoint

GET /CUSTOMER/LIST/

Parameters

The following query parameter can be included in the request:

  • id_client (optional): Specifies the customer ID to filter the list.

Response

The response is a JSON object containing the following fields:

{
    "success": "true or false",
    "message": "Description of the response",
    "result": {
        "customer": [
            {
                "clcleunik": "Unique customer key",
                "customerNumber": "Customer number",
                "groupePrice": "Group price",
                "login": "Login",
                "password": "Password",
                "lastName": "Last name",
                "firstName": "First name",
                "address": "Address",
                "zipcode": "Zip code",
                "city": "City",
                "country": "Country",
                "phone": "Phone",
                "cellphone": "Cellphone",
                "email": "Email",
                "denomination": "Denomination",
                "tvaNumber": "VAT number",
                "addedDate": "Date added",
                "addHour": "Hour added",
                "language": "Language",
                "showPrice": "Show price",
                "webRemise": "Web discount",
                "megawinapp_login": "Megawin app login",
				"notification_accepted": "1"
            }
            // Additional customer items
        ]
    }
}

Error Handling

If an error occurs, the response will contain the following fields:

{
    "success": "false",
    "message": "Error description"
}

Example Request

GET /CUSTOMER/LIST/?id_client=1

Example Response

{
    "success": "true",
    "message": "Customers list",
    "result": {
        "customer": [
            {
                "clcleunik": 1,
                "customerNumber": "C123",
                "groupePrice": "Group A",
                "login": "jdoe",
                "password": "password123",
                "lastName": "Doe",
                "firstName": "John",
                "address": "123 Main St",
                "zipcode": "12345",
                "city": "Anytown",
                "country": "USA",
                "phone": "555-1234",
                "cellphone": "555-5678",
                "email": "jdoe@example.com",
                "denomination": "John Doe Inc.",
                "tvaNumber": "TVA123456",
                "addedDate": "2024-01-01",
                "addHour": "12:34:56",
                "language": "EN",
                "showPrice": true,
                "webRemise": 10,
                "megawinapp_login": "jdoe_mwa"
            }
            // Additional customer items
        ]
    }
}