톡스토어와 선물하기 상품 등록 시, 필수 입력 정보인 출고지와 반품지를 등록하기 위한 API 입니다.
판매자 주소록 API는 호출 시 판매 채널 정보를 따로 설정하지 않아도 되고,
등록된 판매자 주소록은 톡스토어와 선물하기에 상품 등록 시 공통으로 사용할 수 있습니다.
동일한 주소지 정보(기본주소+상세주소)를 가진 주소록의 중복 등록은 불가합니다.
이미 등록된 주소는 배송지ID로 메시지가 리턴되니, 기존에 등록된 주소록을 활용해 주시기 바랍니다.
1) 요청
|
POST /v1/shopping/bizseller/seller-addresses/register
요청 파라미터는 아래와 같습니다.
| 필드명 |
설명 |
타입 |
필수여부 |
비고 |
| name |
배송지명 |
String |
필수 |
50자 이내 입력 가능
배송지명은 중복 등록 가능
|
| postNo |
우편번호 |
String |
필수 |
|
| addressPost |
기본주소 |
String |
필수 |
500자 이내 입력 가능 |
| addressDetail |
상세주소 |
String |
필수 |
100자 이내 입력 가능 |
| contact |
연락처 |
String |
필수 |
|
| returnFeeAmount |
반품배송비 |
BigDecimal |
비필수 |
반품 배송비 (편도 기준)
0원 이상 50만원 이하 가능
미입력시 0원으로 저장
|
| exchangeFeeAmount |
교환배송비 |
BigDecimal |
비필수 |
교환 배송비 (왕복 기준)
0원 이상 100만원 이하 가능
미입력시 0원으로 저장 |
| basicSenderAddress |
기본 출고지 여부 |
boolean |
비필수 |
동일 주소록으로 기본 출고지&기본 반품지 동시 설정 가능 |
| basicReturnAddress |
기본 반품지 여부 |
boolean |
비필수 |
|
2) 응답
|
|
정상적으로 생성되었을 경우 생성된 주소지 ID를 리턴합니다.
응답바디는 아래와 같습니다.
응답 바디 샘플을 참고해 주세요.
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"id": 100000
}
|
3) 에러 샘플
|
|
각 파라미터에 허용되지 않은 값이 입력된 경우 아래와 같은 에러가 리턴됩니다.
이 경우 요청 파라미터의 값을 확인해주세요.
응답 바디 샘플을 참고해 주세요.
"errorMessage":"유효하지 않은 요청입니다.",
"errorCode":-10001,
"errorName":"validation_error",
"errorCategory":"common",
"validation":{"name":["name을(를) 입력해주세요."],
"postNo":["postNo는 필수값입니다.을(를) 입력해주세요."]}}
|