Skip to main content
GET
/
api
/
v1
/
customers
/
{id}
고객 상세 조회
curl --request GET \
  --url https://api.steppay.kr/api/v1/customers/{id} \
  --header 'Secret-Token: <api-key>'
{
  "id": 1,
  "status": "NORMAL",
  "username": "test@gmail.com",
  "name": "테스트 고객",
  "email": "test@gmail.com",
  "phone": "01012345678",
  "orderCount": 0,
  "totalPurchasedPrice": 0,
  "shipping": null,
  "orders": [],
  "subscriptions": [],
  "paymentMethods": [],
  "code": "customer_AbCdEfGhI",
  "marketingSms": false,
  "marketingEmail": false,
  "marketingKakao": false,
  "attributes": {},
  "createdAt": "9999-01-01T00:00:00",
  "additionalRecipients": []
}

Authorizations

Secret-Token
string
header
required

Path Parameters

id
integer<int64>
required

고객 번호

Response

정상적으로 조회됨

id
integer<int64>
required

고객 번호

orderCount
integer<int32>
required

고객이 주문한 주문 개수

totalPurchasedPrice
number
required

고객이 구매한 전체 금액

orders
고객과 연관된 주소 정보 · object[]
required

고객과 연관된 주소 목록

subscriptions
고객과 연관된 구독 정보 · object[]
required

고객과 연관된 구독 목록

paymentMethods
결제수단 정보 · object[]
required

고객이 사용중인 결제수단 목록

marketingSms
boolean
required

고객이 허가한 마케팅 채널 - SMS

marketingEmail
boolean
required

고객이 허가한 마케팅 채널 - Email

marketingKakao
boolean
required

고객이 허가한 마케팅 채널 - Kakao

attributes
object
required

고객 추가 데이터

createdAt
string<date-time>
required

고객 생성 시점

additionalRecipients
string[]
required

추가 수신인

추가 수신인

region
판매국가 정보 · object
required

지역

status
enum<string>

고객 상태

Available options:
NORMAL,
DORMANT
username
string

고객 아이디

name
string

고객 이름

email
string

고객 이메일

phone
string

고객 전화번호

shipping
배송지 정보 · object

고객이 최근에 사용한 배송지

code
string

고객 코드