Skip to main content
POST
/
api
/
v1
/
customers
고객 생성
curl --request POST \
  --url https://api.steppay.kr/api/v1/customers \
  --header 'Content-Type: application/json' \
  --header 'Secret-Token: <api-key>' \
  --data '
{
  "name": "테스트 고객",
  "username": "test@gmail.com",
  "email": "test@gmail.com",
  "phone": "010-1234-5678"
}
'
{
  "id": 1,
  "username": "test@gmail.com",
  "name": "테스트 고객",
  "email": "test@gmail.com",
  "phone": "01012345678",
  "code": "customer_AbCdEfGhI",
  "marketingSms": false,
  "marketingEmail": false,
  "marketingKakao": false,
  "createdAt": "9999-01-01T00:00:00.000000"
}

Authorizations

Secret-Token
string
header
required

Body

application/json

고객 생성 데이터

username
string
required

고객 아이디 (미입력 시 email을 username으로 사용합니다.)

Required string length: 1 - 64
email
string
required

이메일

name
string
required

이름

phone
string

전화번호

shipping
배송지 정보 데이터 · object

배송지 정보

marketingEmail
boolean

고객이 허가한 마케팅 채널 - Email (기본값: false)

marketingSms
boolean

고객이 허가한 마케팅 채널 - SMS (기본값: false)

marketingKakao
boolean

고객이 허가한 마케팅 채널 - Kakao (기본값: false)

attributes
object

고객의 추가 정보 (커스텀 필드)

Response

정상적으로 생성됨

id
integer<int64>
required

고객 번호

username
string
required

고객 아이디

createdAt
string<date-time>
required

고객 생성 시점

name
string

고객 이름

email
string

고객 이메일

phone
string

고객 전화번호

code
string

고객 코드

marketingSms
boolean

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

marketingEmail
boolean

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

marketingKakao
boolean

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