sayren Docs
구매자

구매자 목록 조회

GET
/v1/customers
AuthorizationBearer <token>

userToken(계정 스코프) 또는 storeToken(스토어 스코프)

In: header

Query Parameters

q?string

검색어 — 이름·이메일(포함). 숫자 4자리면 휴대폰 뒤 4자리로도 찾는다

joinedFrom?string

가입일 시작(YYYY-MM-DD, KST, 포함)

joinedTo?string

가입일 끝(YYYY-MM-DD, KST, 포함)

marketing?string

마케팅 수신 동의 필터. 생략하면 전체

Value in

  • "agreed"
  • "declined"
sort?string

정렬. joined_desc(기본, 최근 가입순)·joined_asc·total_paid_desc(구매 금액순)·order_count_desc(주문 수순)·last_ordered_desc(최근 주문순)

Value in

  • "joined_desc"
  • "joined_asc"
  • "total_paid_desc"
  • "order_count_desc"
  • "last_ordered_desc"
page?string

페이지 번호 (1부터, 기본 1)

size?string

페이지 크기 (기본 20, 최대 100)

Response Body

application/json

curl -X GET "https://example.com/v1/customers"
{  "meta": {    "status": 200,    "code": "OK",    "message": "OK",    "isSuccess": true  },  "data": {    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0,    "contents": [      {        "customerId": "string",        "name": "string",        "email": "string",        "maskedPhone": "string",        "joinedAt": "string",        "point": 0,        "marketingAgreed": true,        "orderCount": 0,        "totalPaid": 0,        "lastOrderedAt": "string"      }    ]  },  "error": null}