고객 조회 | Bootpay 커머스 매뉴얼

등록된 고객 목록을 조회해요.

API 엔드포인트

GEThttps://api.bootapi.com/v1/usersBasic Auth

요청 파라미터

파라미터	타입	필수	설명
`keyword`	String	선택	검색 키워드 (이름, 이메일, 전화번호)
`user_group_id`	String	선택	그룹 ID 필터
`membership_type`	Integer	선택	회원 유형 (1: 회원, 2: 비회원)
`page`	Integer	선택	페이지 번호 (기본: 1)
`limit`	Integer	선택	페이지당 데이터 수 (기본: 20)

코드 예제

const { BootpayCommerce } = require('@bootpay/backend-js')

const commerce = new BootpayCommerce({
    client_key: 'your-commerce-client-key',
    secret_key: 'your-commerce-secret-key',
    mode: 'production'
})

const response = await commerce.user.list({
    page: 1,
    limit: 20,
    keyword: '홍길동'
})
console.log(response)javascript

from bootpay_backend import BootpayCommerce

commerce = BootpayCommerce(
    client_key='your-commerce-client-key',
    secret_key='your-commerce-secret-key',
    mode='production'
)

response = commerce.user.list(page=1, limit=20, keyword='홍길동')
print(response)python

use Bootpay\ServerPhp\BootpayCommerceApi;

$commerce = new BootpayCommerceApi("your-commerce-client-key", "your-commerce-secret-key");
$response = $commerce->userList([
    'page' => 1,
    'limit' => 20,
    'keyword' => '홍길동'
]);
print_r($response);php

import kr.co.bootpay.store.BootpayStore;
import kr.co.bootpay.store.model.request.TokenPayload;

import java.util.HashMap;

TokenPayload tp = new TokenPayload("your-commerce-client-key", "your-commerce-secret-key");
BootpayStore commerce = new BootpayStore(tp);
HashMap<String, Object> params = new HashMap<>();
params.put("page", 1);
params.put("limit", 20);
params.put("keyword", "홍길동");

HashMap<String, Object> response = commerce.userList(params);
System.out.println(response);java

commerce = BootpayStore::Api.new('your-commerce-client-key', 'your-commerce-secret-key')
response = commerce.user_list(
  page: 1,
  limit: 20,
  keyword: '홍길동'
)
puts responseruby

commerce := bootpay.NewCommerceApi("your-commerce-client-key", "your-commerce-secret-key")
response, err := commerce.UserList(map[string]interface{}{
    "page":    1,
    "limit":   20,
    "keyword": "홍길동",
})
fmt.Println(response)go

using Bootpay.Commerce;

var commerce = new BootpayCommerceApi("your-commerce-client-key", "your-commerce-secret-key");
var response = await commerce.UserList(new {
    page = 1,
    limit = 20,
    keyword = "홍길동"
});
Console.WriteLine(response);csharp

응답

성공 응답

{
  "count": 5,
  "list": [
    {
      "user_id": "67e4b4425ec892162491d0ec",
      "login_id": "user001",
      "name": "홍길동",
      "email": "user@example.com",
      "phone": "01012345678",
      "membership_type": 1,
      "status": 1,
      "created_at": "2025-03-27T11:13:23+09:00"
    }
  ]
}json

응답 필드 설명

필드	타입	설명
`count`	Integer	총 고객 수
`list`	Array	고객 목록
`list[].user_id`	String	고객 고유 ID
`list[].login_id`	String	로그인 아이디
`list[].name`	String	고객 이름
`list[].membership_type`	Integer	회원 유형 (1: 회원, 2: 비회원)
`list[].status`	Integer	계정 상태 (1: 활성)