Get Customers Filter

GET /customers/filter

Parameters

• customerId (string, query, optional): The ID of the customer.
• merchantId (string, query, optional): The ID of the merchant.
• tenantId (string, query, optional): The ID of the tenant.
• countryCode (string, query, optional): The country code.
• from (string, query, optional): Start date for filtering (ISO 8601 format).
• to (string, query, optional): End date for filtering (ISO 8601 format).
• locale.baseLocale.language (string, query, optional): The base language of the locale.
• locale.baseLocale.script (string, query, optional): The base script of the locale.
• locale.baseLocale.region (string, query, optional): The base region of the locale.
• locale.baseLocale.variant (string, query, optional): The base variant of the locale.
• page (integer, query, optional): One-based page index (1..N). Default value: 1.
• size (integer, query, optional): The size of the page to be returned. Default value: 20.
• sort (array[string], query, optional): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

200 OK

• Media Type: application/json

Example Value

{
  "message": "string",
  "data": [
    {
      "customerId": "string",
      "merchantId": "string",
      "tenantId": "string",
      "countryCode": "string",
      "customer": {
        "country": {
          "code": "string",
          "name": "string",
          "currency": "string"
        },
        "firstName": "string",
        "lastName": "string",
        "wallet": {
          "userId": "string",
          "virtualBankCode": "string",
          "floatAccountId": "string",
          "floatAccountUuid": "string",
          "floatAccountNumber": "string",
          "commissionAccountId": "string"
        },
        "city": {
          "code": "string",
          "name": "string"
        },
        "phone": "string",
        "profileTenant": "string",
        "photo": "string",
        "get_id": "string",
        "state": {
          "code": "string",
          "name": "string"
        },
        "username": "string",
        "status": "string",
        "profileOwners": [
          "string"
        ],
        "businesses": [
          {
            "get_id": "string",
            "name": "string",
            "email": "string",
            "photo": "string",
            "wallet": {
              "userId": "string",
              "virtualBankCode": "string",
              "floatAccountId": "string",
              "floatAccountUuid": "string",
              "floatAccountNumber": "string",
              "commissionAccountId": "string"
            },
            "address": {
              "country": "string",
              "latitude": 0,
              "lga": "string",
              "name": "string",
              "state": "string",
              "longitude": 0
            },
            "location": {
              "coordinates": [
                0
              ],
              "type": "string"
            },
            "user": "string",
            "owner": {
              "profileTenant": "string",
              "city": {
                "code": "string",
                "name": "string"
              },
              "country": {
                "code": "string",
                "name": "string",
                "currency": "string"
              },
              "firstName": "string",
              "lastName": "string",
              "phone": "string",
              "photo": "string",
              "state": {
                "code": "string",
                "name": "string"
              },
              "username": "string",
              "wallet": {
                "userId": "string",
                "virtualBankCode": "string",
                "floatAccountId": "string",
                "floatAccountUuid": "string",
                "floatAccountNumber": "string",
                "commissionAccountId": "string"
              },
              "id": "string",
              "fullName": "string"
            },
            "businessHandle": "string",
            "shippingFee": 0,
            "phone": "string",
            "category": "string",
            "active": true,
            "acceptingOrder": true,
            "isDistributor": true,
            "isManufacturer": true,
            "isHead": true,
            "extraLocationPrice": 0,
            "distance": 0,
            "kycDetails": {
              "additionalProp1": {},
              "additionalProp2": {},
              "additionalProp3": {}
            },
            "pickUpAddresses": [
              {
                "country": "string",
                "latitude": 0,
                "lga": "string",
                "name": "string",
                "state": "string",
                "longitude": 0,
                "location": {
                  "coordinates": [
                    0
                  ],
                  "type": "string"
                }
              }
            ],
            "priceMargin": {
              "type": "FIXED",
              "source": "BUSINESS",
              "value": 0,
              "enabled": true
            }
          }
        ],
        "address": "string",
        "fullName": "string"
      }
    }
  ],
  "meta": {
    "currentPage": 0,
    "from": 0,
    "to": 0,
    "perPage": 0,
    "total": 0,
    "lastPage": 0
  }
}