Get Merchant Customers

GET {{baseUrl}}/customers?pageNo=&pageSize=

Description

This endpoint is used to retrieve all merchant customers.

Request

• Headers:
  • (Required) userId:
  • (Required) tenantId:
• URL:
  • Raw: {{baseUrl}}/customers?pageNo=&pageSize=
  • Host: {{baseUrl}}
  • Path: /customers
• Query Parameters:
  • pageNo:
  • pageSize:

Response

• Status: OK (200)

HEADERS

• userId: <string> (Required)
• tenantId: <string> (Required)
• Accept: */*

PARAMS

• pageNo: <integer>
• pageSize: <integer>

Sample Request

curl --location -g '{{baseUrl}}/customers?pageNo=%3Cinteger%3E&pageSize=%3Cinteger%3E' \
--header 'userId: <string>' \
--header 'tenantId: <string>' \
--header 'Accept: */*'

Sample Response

{
  "message": "<string>",
  "data": {
    "totalElements": "<long>",
    "totalPages": "<integer>",
    "pageable": {
      "pageNumber": "<integer>",
      "pageSize": "<integer>",
      "offset": "<long>",
      "sort": {
        "sorted": "<boolean>",
        "empty": "<boolean>",
        "unsorted": "<boolean>"
      },
      "paged": "<boolean>",
      "unpaged": "<boolean>"
    },
    "size": "<integer>",
    "content": [
      {
        "id": "<long>",
        "uuid": "<string>",
        "createdAt": "<dateTime>",
        "updatedAt": "<dateTime>",
        "customerId": "<string>",
        "newCustomerDetail": {
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "country": {
            "code": "<string>",
            "name": "<string>",
            "currency": "<string>"
          },
          "state": {
            "code": "<string>",
            "name": "<string>"
          }
        },
        "merchantId": "<string>",
        "tenantId": "<string>",
        "countryCode": "<string>"
      },
      {
        "id": "<long>",
        "uuid": "<string>",
        "createdAt": "<dateTime>",
        "updatedAt": "<dateTime>",
        "customerId": "<string>",
        "newCustomerDetail": {
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "country": {
            "code": "<string>",
            "name": "<string>",
            "currency": "<string>"
          },
          "state": {
            "code": "<string>",
            "name": "<string>"
          }
        },
        "merchantId": "<string>",
        "tenantId": "<string>",
        "countryCode": "<string>"
      }
    ],
    "number": "<integer>",
    "sort": {
      "sorted": "<boolean>",
      "empty": "<boolean>",
      "unsorted": "<boolean>"
    },
    "numberOfElements": "<integer>",
    "first": "<boolean>",
    "last": "<boolean>",
    "empty": "<boolean>"
  },
  "meta": {
    "currentPage": "<long>",
    "from": "<long>",
    "to": "<long>",
    "perPage": "<long>",
    "total": "<long>",
    "lastPage": "<long>"
  }
}