개발자센터
V1
V2
파트너 정산 릴리즈 노트 기술 블로그

고객사관리 관련 API - 별도 계약 필요

고객사관리에 관련된 API 를 확인할 수 있습니다.

⌨ 하위상점 다건 조회

GET https://api.portone.io/v2/stores

하위상점 다건 조회

하위상점 다건 조회

Parameters

Authorization*
string

jwt 토큰 헤더

Responses

200
조회 성공

stores * Array[PublicStoreResponse]

store 목록

PublicStoreResponse

id * string

상점 아이디


name * string

상점 이름


tier_code * string

상점 식별 코드 ex) ABC 영문, 숫자 3자리


service_urls * Array[string]

서비스 url 리스트


manager_name string

담당자명


manager_phone_number string

담당자 휴대폰번호


manager_email string

담당자 이메일


representative * PublicStoreRepresentativeResponse

상점 대표자 정보


business_license * PublicStoreBusinessLicense

사업자 정보



400
요청 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



401
토큰 인증 실패

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



403
권한 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



500
서버 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



⌨ 하위상점 생성

POST https://api.portone.io/v2/stores

하위상점 생성

하위상점 생성

Parameters

Header

Authorization*
string

jwt 토큰 헤더

Body

name*
string

상점 이름

tier_code*
string

상점 식별 코드 ex) ABC 영문, 숫자 3자리

service_urls*
Array\[string]

서비스 url 리스트

manager_name*
string

담당자명

manager_phone_number*
string

담당자 휴대폰번호

manager_email*
string

담당자 이메일

representative*
PublicStoreRepresentativeRequest

상점 대표자 정보

business_license*
PublicStoreBusinessLicense

사업자 정보

terms_agreed*
Array\[boolean]

약관 동의 여부, 두 가지 필수 약관 모두 동의 필요 첫번째 약관: 개인정보 수집 동의 두번째 약관: 상위 고객사에게 상점 정보 제공 동의 ex) 두 약관 모두 동의 [true, true]

Responses

200
등록 성공

id * string

상점 아이디


name * string

상점 이름


tier_code * string

상점 식별 코드 ex) ABC 영문, 숫자 3자리


service_urls * Array[string]

서비스 url 리스트


manager_name string

담당자명


manager_phone_number string

담당자 휴대폰번호


manager_email string

담당자 이메일


representative * PublicStoreRepresentativeResponse

상점 대표자 정보

PublicStoreRepresentativeResponse

name_ko * string

대표자 이름


name_en string

대표자 영문 이름


email * string

대표자 이메일


phone_number * string

대표자 전화번호


birth_date string

대표자 생년월일 format: yyyy-MM-dd ex) 2000-01-01



business_license * PublicStoreBusinessLicense

사업자 정보

PublicStoreBusinessLicense

taxation_type * TaxationType

사업자 구분

"PERSON", "CORPORATE"


company_name * string

회사명


registration_number * string

사업자번호


business_location * string

회사 주소


business_location_detail * string

회사 상세 주소


postal_code * string

우편번호


business_types * Array[string]

업태


business_items * Array[string]

종목


corporate_registration_number string

법인등록번호 - 법인 only


headquarter_location string

본사 주소 - 법인 only


business_establishment_date string

개업 연월일


issuance_date string

사업자등록증 발급일


issuance_reason string

발급 사유



400
요청 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



401
토큰 인증 실패

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



403
권한 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



404
존재하지 않는 리소스 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



500
서버 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



taxation_type * TaxationType

사업자 구분

"PERSON", "CORPORATE"


company_name * string

회사명


registration_number * string

사업자번호


business_location * string

회사 주소


business_location_detail * string

회사 상세 주소


postal_code * string

우편번호


business_types * Array[string]

업태


business_items * Array[string]

종목


corporate_registration_number string

법인등록번호 - 법인 only


headquarter_location string

본사 주소 - 법인 only


business_establishment_date string

개업 연월일


issuance_date string

사업자등록증 발급일


issuance_reason string

발급 사유


⌨ 하위상점 단건 조회

GET https://api.portone.io/v2/stores/{store-id}

하위상점 단건 조회

하위상점 단건 조회

Parameters

Header

Authorization*
string

jwt 토큰 헤더

Path

store-id*
string

store의 id

Responses

200
조회 성공

id * string

상점 아이디


name * string

상점 이름


tier_code * string

상점 식별 코드 ex) ABC 영문, 숫자 3자리


service_urls * Array[string]

서비스 url 리스트


manager_name string

담당자명


manager_phone_number string

담당자 휴대폰번호


manager_email string

담당자 이메일


representative * PublicStoreRepresentativeResponse

상점 대표자 정보

PublicStoreRepresentativeResponse

name_ko * string

대표자 이름


name_en string

대표자 영문 이름


email * string

대표자 이메일


phone_number * string

대표자 전화번호


birth_date string

대표자 생년월일 format: yyyy-MM-dd ex) 2000-01-01



business_license * PublicStoreBusinessLicense

사업자 정보

PublicStoreBusinessLicense

taxation_type * TaxationType

사업자 구분

"PERSON", "CORPORATE"


company_name * string

회사명


registration_number * string

사업자번호


business_location * string

회사 주소


business_location_detail * string

회사 상세 주소


postal_code * string

우편번호


business_types * Array[string]

업태


business_items * Array[string]

종목


corporate_registration_number string

법인등록번호 - 법인 only


headquarter_location string

본사 주소 - 법인 only


business_establishment_date string

개업 연월일


issuance_date string

사업자등록증 발급일


issuance_reason string

발급 사유



400
요청 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



401
토큰 인증 실패

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



403
권한 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



404
존재하지 않는 리소스 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



500
서버 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



⌨ 하위상점 수정

PUT https://api.portone.io/v2/stores/{store-id}

하위상점 수정

하위상점 수정

Parameters

Header

Authorization*
string

jwt 토큰 헤더

Path

store-id*
string

store의 id

Body

name*
string

상점 이름

service_urls*
Array\[string]

서비스 url 리스트

manager_name*
string

담당자명

manager_phone_number*
string

담당자 휴대폰번호

manager_email*
string

담당자 이메일

representative*
PublicStoreRepresentativeRequest

상점 대표자 정보

business_license*
UpdatePublicStoreBusinessLicenseRequest

사업자 정보

Responses

200
등록 성공

id * string

상점 아이디


name * string

상점 이름


tier_code * string

상점 식별 코드 ex) ABC 영문, 숫자 3자리


service_urls * Array[string]

서비스 url 리스트


manager_name string

담당자명


manager_phone_number string

담당자 휴대폰번호


manager_email string

담당자 이메일


representative * PublicStoreRepresentativeResponse

상점 대표자 정보

PublicStoreRepresentativeResponse

name_ko * string

대표자 이름


name_en string

대표자 영문 이름


email * string

대표자 이메일


phone_number * string

대표자 전화번호


birth_date string

대표자 생년월일 format: yyyy-MM-dd ex) 2000-01-01



business_license * PublicStoreBusinessLicense

사업자 정보

PublicStoreBusinessLicense

taxation_type * TaxationType

사업자 구분

"PERSON", "CORPORATE"


company_name * string

회사명


registration_number * string

사업자번호


business_location * string

회사 주소


business_location_detail * string

회사 상세 주소


postal_code * string

우편번호


business_types * Array[string]

업태


business_items * Array[string]

종목


corporate_registration_number string

법인등록번호 - 법인 only


headquarter_location string

본사 주소 - 법인 only


business_establishment_date string

개업 연월일


issuance_date string

사업자등록증 발급일


issuance_reason string

발급 사유



400
요청 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



401
토큰 인증 실패

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



403
권한 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



404
존재하지 않는 리소스 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



500
서버 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



name_ko * string

대표자 이름


name_en * string

대표자 영문 이름


email * string

대표자 이메일


phone_number * string

대표자 전화번호


birth_date * string

대표자 생년월일 format: yyyy-MM-dd ex) 2000-01-01